Attachment #5027 for bug #6741

View | Details | Raw Unified | Return to bug 6741
Collapse All | Expand All





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
  -D, --debug [area=n,...]  Print debugging messages
  --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
  --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



=over 4

=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<loadplugin> or C<tryplugin> 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


	sa-update --channel foo.example.com --channel bar.example.com

=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<-D> [I<area,...>], B<--debug> [I<area,...>]

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<file>.sha1 and B<file>.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<sa-update> multiple times with different
B<--channel> and B<--install> switches, e.g.:

Produce debugging output.  If no areas are listed, all debugging information is
printed.  Diagnostic output can also be enabled for each area individually;
I<area> is the area of the code to instrument. For example, to produce
diagnostic output on channel, gpg, and http, use:

        sa-update -D channel,gpg,http

For more information about which areas (also known as channels) are
available, please see the documentation at
L<http://wiki.apache.org/spamassassin/DebugChannels>.

=item B<--gpg>, B<--nogpg>


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<sa-update> 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

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<sa-update> 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


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<file>.sha1 and B<file>.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<sa-update> 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

the wrong directory, you probably need to rebuild SpamAssassin with different
C<Makefile.PL> arguments, instead of overriding sa-update's runtime behaviour.

=item B<-v>, B<--verbose>

Be verbose, like print updated channel names; For more verbosity
specify multiple times.
I<area> is the area of the code to instrument. For example, to produce
diagnostic output on channel, gpg, and http, use:

=item B<-V>, B<--version>

Print sa-update version and exit.
available, please see the documentation at
L<http://wiki.apache.org/spamassassin/DebugChannels>.

=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
- 

Return to bug 6741

Lines 1698-1730 B<sa-update> [options] Link Here

(-)a/sa-update.raw (-59 / +67 lines)
1698		1698
1699	Options:	1699	Options:
1700		1700
		1701	-4 Force using the inet protocol (IPv4), not inet6
		1702	-6 Force using the inet6 protocol (IPv6), not inet
		1703	--allowplugins Allow updates to load plugin code
		1704	--checkonly Check for update availability, do not install
1701	--channel channel Retrieve updates from this channel	1705	--channel channel Retrieve updates from this channel
1702	Use multiple times for multiple channels	1706	Use multiple times for multiple channels
1703	--channelfile file Retrieve updates from the channels in the file	1707	--channelfile file Retrieve updates from the channels in the file
1704	--checkonly Check for update availability, do not install	1708	-D, --debug [area=n,...] Print debugging messages
1705	--install filename Install updates directly from this file. Signature
1706	verification will use "file.asc" and "file.sha1"
1707	--allowplugins Allow updates to load plugin code
1708	--gpgkey key Trust the key id to sign releases
1709	Use multiple times for multiple keys
1710	--gpgkeyfile file Trust the key ids in the file to sign releases
1711	--gpghomedir path Store the GPG keyring in this directory
1712	--gpg and --nogpg Use (or do not use) GPG to verify updates	1709	--gpg and --nogpg Use (or do not use) GPG to verify updates
1713	(--gpg is assumed by use of the above	1710	(--gpg is assumed by use of the above
1714	--gpgkey and --gpgkeyfile options)	1711	--gpgkey and --gpgkeyfile options)
		1712	--gpghomedir path Store the GPG keyring in this directory
		1713	--gpgkey key Trust the key id to sign releases
		1714	Use multiple times for multiple keys
		1715	--gpgkeyfile file Trust the key ids in the file to sign releases
1715	--import file Import GPG key(s) from file into sa-update's	1716	--import file Import GPG key(s) from file into sa-update's
1716	keyring. Use multiple times for multiple files	1717	keyring. Use multiple times for multiple files
		1718	--install filename Install updates directly from this file. Signature
		1719	verification will use "file.asc" and "file.sha1"
		1720	--refreshmirrors Force the MIRRORED.BY file to be updated
1717	--updatedir path Directory to place updates, defaults to the	1721	--updatedir path Directory to place updates, defaults to the
1718	SpamAssassin site rules directory	1722	SpamAssassin site rules directory
1719	(default: @@LOCAL_STATE_DIR@@/@@VERSION@@)	1723	(default: @@LOCAL_STATE_DIR@@/@@VERSION@@)
1720	--refreshmirrors Force the MIRRORED.BY file to be updated
1721	-D, --debug [area=n,...] Print debugging messages
1722	-v, --verbose Be verbose, like print updated channel names;	1724	-v, --verbose Be verbose, like print updated channel names;
1723	For more verbosity specify multiple times	1725	For more verbosity specify multiple times
1724	-V, --version Print version	1726	-V, --version Print version
1725	-h, --help Print usage message	1727	-h, --help Print usage message
1726	-4 Force using the inet protocol (IPv4), not inet6
1727	-6 Force using the inet6 protocol (IPv6), not inet
1728		1728
1729	=head1 DESCRIPTION	1729	=head1 DESCRIPTION
1730		1730
Lines 1756-1762 that sets the umask prior to calling sa-update. For example: Link Here
1756		1756
1757	=over 4	1757	=over 4
1758		1758
1759	=item B<--channel>	1759	=item B<-4, -6>
		1760
		1761	Force using the inet protocol IPv4 or IPv6.
		1762
		1763	=item B<--allowplugins>
		1764
		1765	Allow downloaded updates to activate plugins. The default is not to
		1766	activate plugins; any C<loadplugin> or C<tryplugin> lines will be commented
		1767	in the downloaded update rules files.
		1768
		1769	=item B<--checkonly>
		1770
		1771	Only check if an update is available, don't actually download and install it.
		1772	The exit code will be C<0> or C<1> as described below.
		1773
		1774	=item B<--channel> CHANNEL
1760		1775
1761	sa-update can update multiple channels at the same time. By default, it will	1776	sa-update can update multiple channels at the same time. By default, it will
1762	only access "updates.spamassassin.org", but more channels can be specified via	1777	only access "updates.spamassassin.org", but more channels can be specified via
Lines 1765-1803 multiple times, once per channel. i.e.: Link Here
1765		1780
1766	sa-update --channel foo.example.com --channel bar.example.com	1781	sa-update --channel foo.example.com --channel bar.example.com
1767		1782
1768	=item B<--channelfile>	1783	=item B<--channelfile> FILE
1769		1784
1770	Similar to the B<--channel> option, except specify the additional channels in a	1785	Similar to the B<--channel> option, except specify the additional channels in a
1771	file instead of on the commandline. This is useful when there are a	1786	file instead of on the commandline. This is useful when there are a
1772	lot of additional channels.	1787	lot of additional channels.
1773		1788
1774	=item B<--checkonly>	1789	=item B<-D> [I<area,...>], B<--debug> [I<area,...>]
1775
1776	Only check if an update is available, don't actually download and install it.
1777	The exit code will be C<0> or C<1> as described below.
1778
1779	=item B<--install>
1780
1781	Install updates "offline", from the named tar.gz file, instead of performing
1782	DNS lookups and HTTP invocations.
1783
1784	Files named B<file>.sha1 and B<file>.asc will be used for the SHA-1 and GPG
1785	signature, respectively. The filename provided must contain a version number
1786	of at least 3 digits, which will be used as the channel's update version
1787	number.
1788
1789	Multiple B<--channel> switches cannot be used with B<--install>. To install
1790	multiple channels from tarballs, run C<sa-update> multiple times with different
1791	B<--channel> and B<--install> switches, e.g.:
1792		1790
1793	sa-update --channel foo.example.com --install foo-34958.tgz	1791	Produce debugging output. If no areas are listed, all debugging information is
1794	sa-update --channel bar.example.com --install bar-938455.tgz	1792	printed. Diagnostic output can also be enabled for each area individually;
		1793	I<area> is the area of the code to instrument. For example, to produce
		1794	diagnostic output on channel, gpg, and http, use:
1795		1795
1796	=item B<--allowplugins>	1796	sa-update -D channel,gpg,http
1797		1797
1798	Allow downloaded updates to activate plugins. The default is not to	1798	For more information about which areas (also known as channels) are
1799	activate plugins; any C<loadplugin> or C<tryplugin> lines will be commented	1799	available, please see the documentation at
1800	in the downloaded update rules files.	1800	L<http://wiki.apache.org/spamassassin/DebugChannels>.
1801		1801
1802	=item B<--gpg>, B<--nogpg>	1802	=item B<--gpg>, B<--nogpg>
1803		1803
Lines 1815-1820 override B<--nogpg> and keep GPG verification enabled. Link Here
1815	Note: Currently, only GPG itself is supported (ie: not PGP). v1.2 has been	1815	Note: Currently, only GPG itself is supported (ie: not PGP). v1.2 has been
1816	tested, although later versions ought to work as well.	1816	tested, although later versions ought to work as well.
1817		1817
		1818	=item B<--gpghomedir>
		1819
		1820	Specify a directory path to use as a storage area for the C<sa-update> GPG
		1821	keyring. By default, this is
		1822
		1823	@@LOCAL_RULES_DIR@@/sa-update-keys
		1824
1818	=item B<--gpgkey>	1825	=item B<--gpgkey>
1819		1826
1820	sa-update has the concept of "release trusted" GPG keys. When an archive is	1827	sa-update has the concept of "release trusted" GPG keys. When an archive is
Lines 1841-1853 Similar to the B<--gpgkey> option, except specify the additional keys in a file Link Here
1841	instead of on the commandline. This is extremely useful when there are a lot	1848	instead of on the commandline. This is extremely useful when there are a lot
1842	of additional keys that you wish to trust.	1849	of additional keys that you wish to trust.
1843		1850
1844	=item B<--gpghomedir>
1845
1846	Specify a directory path to use as a storage area for the C<sa-update> GPG
1847	keyring. By default, this is
1848
1849	@@LOCAL_RULES_DIR@@/sa-update-keys
1850
1851	=item B<--import>	1851	=item B<--import>
1852		1852
1853	Use to import GPG key(s) from a file into the sa-update keyring which is	1853	Use to import GPG key(s) from a file into the sa-update keyring which is
Lines 1862-1867 To import multiple keys, use the option multiple times. i.e.: Link Here
1862		1862
1863	Note: use of this option automatically enables GPG verification.	1863	Note: use of this option automatically enables GPG verification.
1864		1864
		1865	=item B<--install>
		1866
		1867	Install updates "offline", from the named tar.gz file, instead of performing
		1868	DNS lookups and HTTP invocations.
		1869
		1870	Files named B<file>.sha1 and B<file>.asc will be used for the SHA-1 and GPG
		1871	signature, respectively. The filename provided must contain a version number
		1872	of at least 3 digits, which will be used as the channel's update version
		1873	number.
		1874
		1875	Multiple B<--channel> switches cannot be used with B<--install>. To install
		1876	multiple channels from tarballs, run C<sa-update> multiple times with different
		1877	B<--channel> and B<--install> switches, e.g.:
		1878
		1879	sa-update --channel foo.example.com --install foo-34958.tgz
		1880	sa-update --channel bar.example.com --install bar-938455.tgz
		1881
1865	=item B<--refreshmirrors>	1882	=item B<--refreshmirrors>
1866		1883
1867	Force the list of sa-update mirrors for each channel, stored in the MIRRORED.BY	1884	Force the list of sa-update mirrors for each channel, stored in the MIRRORED.BY
Lines 1881-1907 to download updated rulesets for a scanner, and sa-update is placing updates in Link Here
1881	the wrong directory, you probably need to rebuild SpamAssassin with different	1898	the wrong directory, you probably need to rebuild SpamAssassin with different
1882	C<Makefile.PL> arguments, instead of overriding sa-update's runtime behaviour.	1899	C<Makefile.PL> arguments, instead of overriding sa-update's runtime behaviour.
1883		1900
1884	=item B<-D> [I<area,...>], B<--debug> [I<area,...>]	1901	=item B<-v>, B<--verbose>
1885		1902
1886	Produce debugging output. If no areas are listed, all debugging information is	1903	Be verbose, like print updated channel names; For more verbosity
1887	printed. Diagnostic output can also be enabled for each area individually;	1904	specify multiple times.
1888	I<area> is the area of the code to instrument. For example, to produce
1889	diagnostic output on channel, gpg, and http, use:
1890		1905
1891	sa-update -D channel,gpg,http	1906	=item B<-V>, B<--version>
1892		1907
1893	For more information about which areas (also known as channels) are	1908	Print sa-update version and exit.
1894	available, please see the documentation at
1895	L<http://wiki.apache.org/spamassassin/DebugChannels>.
1896		1909
1897	=item B<-h>, B<--help>	1910	=item B<-h>, B<--help>
1898		1911
1899	Print help message and exit.	1912	Print help message and exit.
1900		1913
1901	=item B<-V>, B<--version>
1902
1903	Print sa-update version and exit.
1904
1905	=back	1914	=back
1906		1915
1907	=head1 EXIT CODES	1916	=head1 EXIT CODES
1908	-