From cc92de8b460e90bba4456b96c4337b93995bbd6b Mon Sep 17 00:00:00 2001 From: Jari Aalto Date: Wed, 28 Dec 2011 09:25:33 +0200 Subject: [PATCH] sa-update.raw: (SYNOPSIS, OPTIONS): order alphabetically Organization: Private Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: 8bit Add and fix missing items in OPTIONS section: --channel (add ARG), --channelfile (add ARG), --verbose (missing). Put help option last (GNU's suggested convention). Signed-off-by: Jari Aalto --- sa-update.raw | 125 ++++++++++++++++++++++++++++++-------------------------- 1 files changed, 67 insertions(+), 58 deletions(-) diff --git a/sa-update.raw b/sa-update.raw index 27e787c..0b5f8b5 100755 --- a/sa-update.raw +++ b/sa-update.raw @@ -1698,33 +1698,33 @@ B [options] Options: + -4 Force using the inet protocol (IPv4), not inet6 + -6 Force using the inet6 protocol (IPv6), not inet + --allowplugins Allow updates to load plugin code + --checkonly Check for update availability, do not install --channel channel Retrieve updates from this channel Use multiple times for multiple channels --channelfile file Retrieve updates from the channels in the file - --checkonly Check for update availability, do not install - --install filename Install updates directly from this file. Signature - verification will use "file.asc" and "file.sha1" - --allowplugins Allow updates to load plugin code - --gpgkey key Trust the key id to sign releases - Use multiple times for multiple keys - --gpgkeyfile file Trust the key ids in the file to sign releases - --gpghomedir path Store the GPG keyring in this directory + -D, --debug [area=n,...] Print debugging messages --gpg and --nogpg Use (or do not use) GPG to verify updates (--gpg is assumed by use of the above --gpgkey and --gpgkeyfile options) + --gpghomedir path Store the GPG keyring in this directory + --gpgkey key Trust the key id to sign releases + Use multiple times for multiple keys + --gpgkeyfile file Trust the key ids in the file to sign releases --import file Import GPG key(s) from file into sa-update's keyring. Use multiple times for multiple files + --install filename Install updates directly from this file. Signature + verification will use "file.asc" and "file.sha1" + --refreshmirrors Force the MIRRORED.BY file to be updated --updatedir path Directory to place updates, defaults to the SpamAssassin site rules directory (default: @@LOCAL_STATE_DIR@@/@@VERSION@@) - --refreshmirrors Force the MIRRORED.BY file to be updated - -D, --debug [area=n,...] Print debugging messages -v, --verbose Be verbose, like print updated channel names; For more verbosity specify multiple times -V, --version Print version -h, --help Print usage message - -4 Force using the inet protocol (IPv4), not inet6 - -6 Force using the inet6 protocol (IPv6), not inet =head1 DESCRIPTION @@ -1756,7 +1756,22 @@ that sets the umask prior to calling sa-update. For example: =over 4 -=item B<--channel> +=item B<-4, -6> + +Force using the inet protocol IPv4 or IPv6. + +=item B<--allowplugins> + +Allow downloaded updates to activate plugins. The default is not to +activate plugins; any C or C lines will be commented +in the downloaded update rules files. + +=item B<--checkonly> + +Only check if an update is available, don't actually download and install it. +The exit code will be C<0> or C<1> as described below. + +=item B<--channel> CHANNEL sa-update can update multiple channels at the same time. By default, it will only access "updates.spamassassin.org", but more channels can be specified via @@ -1765,39 +1780,24 @@ multiple times, once per channel. i.e.: sa-update --channel foo.example.com --channel bar.example.com -=item B<--channelfile> +=item B<--channelfile> FILE Similar to the B<--channel> option, except specify the additional channels in a file instead of on the commandline. This is useful when there are a lot of additional channels. -=item B<--checkonly> - -Only check if an update is available, don't actually download and install it. -The exit code will be C<0> or C<1> as described below. - -=item B<--install> - -Install updates "offline", from the named tar.gz file, instead of performing -DNS lookups and HTTP invocations. - -Files named B.sha1 and B.asc will be used for the SHA-1 and GPG -signature, respectively. The filename provided must contain a version number -of at least 3 digits, which will be used as the channel's update version -number. - -Multiple B<--channel> switches cannot be used with B<--install>. To install -multiple channels from tarballs, run C multiple times with different -B<--channel> and B<--install> switches, e.g.: +=item B<-D> [I], B<--debug> [I] - sa-update --channel foo.example.com --install foo-34958.tgz - sa-update --channel bar.example.com --install bar-938455.tgz +Produce debugging output. If no areas are listed, all debugging information is +printed. Diagnostic output can also be enabled for each area individually; +I is the area of the code to instrument. For example, to produce +diagnostic output on channel, gpg, and http, use: -=item B<--allowplugins> + sa-update -D channel,gpg,http -Allow downloaded updates to activate plugins. The default is not to -activate plugins; any C or C lines will be commented -in the downloaded update rules files. +For more information about which areas (also known as channels) are +available, please see the documentation at +L. =item B<--gpg>, B<--nogpg> @@ -1815,6 +1815,13 @@ override B<--nogpg> and keep GPG verification enabled. Note: Currently, only GPG itself is supported (ie: not PGP). v1.2 has been tested, although later versions ought to work as well. +=item B<--gpghomedir> + +Specify a directory path to use as a storage area for the C GPG +keyring. By default, this is + + @@LOCAL_RULES_DIR@@/sa-update-keys + =item B<--gpgkey> sa-update has the concept of "release trusted" GPG keys. When an archive is @@ -1841,13 +1848,6 @@ Similar to the B<--gpgkey> option, except specify the additional keys in a file instead of on the commandline. This is extremely useful when there are a lot of additional keys that you wish to trust. -=item B<--gpghomedir> - -Specify a directory path to use as a storage area for the C GPG -keyring. By default, this is - - @@LOCAL_RULES_DIR@@/sa-update-keys - =item B<--import> Use to import GPG key(s) from a file into the sa-update keyring which is @@ -1862,6 +1862,23 @@ To import multiple keys, use the option multiple times. i.e.: Note: use of this option automatically enables GPG verification. +=item B<--install> + +Install updates "offline", from the named tar.gz file, instead of performing +DNS lookups and HTTP invocations. + +Files named B.sha1 and B.asc will be used for the SHA-1 and GPG +signature, respectively. The filename provided must contain a version number +of at least 3 digits, which will be used as the channel's update version +number. + +Multiple B<--channel> switches cannot be used with B<--install>. To install +multiple channels from tarballs, run C multiple times with different +B<--channel> and B<--install> switches, e.g.: + + sa-update --channel foo.example.com --install foo-34958.tgz + sa-update --channel bar.example.com --install bar-938455.tgz + =item B<--refreshmirrors> Force the list of sa-update mirrors for each channel, stored in the MIRRORED.BY @@ -1881,27 +1898,19 @@ to download updated rulesets for a scanner, and sa-update is placing updates in the wrong directory, you probably need to rebuild SpamAssassin with different C arguments, instead of overriding sa-update's runtime behaviour. -=item B<-D> [I], B<--debug> [I] +=item B<-v>, B<--verbose> -Produce debugging output. If no areas are listed, all debugging information is -printed. Diagnostic output can also be enabled for each area individually; -I is the area of the code to instrument. For example, to produce -diagnostic output on channel, gpg, and http, use: +Be verbose, like print updated channel names; For more verbosity +specify multiple times. - sa-update -D channel,gpg,http +=item B<-V>, B<--version> -For more information about which areas (also known as channels) are -available, please see the documentation at -L. +Print sa-update version and exit. =item B<-h>, B<--help> Print help message and exit. -=item B<-V>, B<--version> - -Print sa-update version and exit. - =back =head1 EXIT CODES -- 1.7.7.3