1SA-COMPILE(1)         User Contributed Perl Documentation        SA-COMPILE(1)
2
3
4

NAME

6       sa-compile - compile SpamAssassin ruleset into native code
7

SYNOPSIS

9       sa-compile [options]
10
11       Options:
12
13         --list                        Output base string list to STDOUT
14         --sudo                        Use 'sudo' for privilege escalation
15         --keep-tmps                   Keep temporary files instead of deleting
16         -C path, --configpath=path, --config-file=path
17                                       Path to standard configuration dir
18         -p prefs, --prefspath=file, --prefs-file=file
19                                       Set user preferences file
20         --siteconfigpath=path         Path for site configs
21                                       (default: /etc/mail/spamassassin)
22         --updatedir=path              Directory to place updates
23                 (default: /var/lib/spamassassin/compiled/<perlversion>/3.003001)
24         --cf='config line'            Additional line of configuration
25         -D, --debug [area=n,...]      Print debugging messages
26         -V, --version                 Print version
27         -h, --help                    Print usage message
28

DESCRIPTION

30       sa-compile uses "re2c" to compile the site-wide parts of the
31       SpamAssassin ruleset. No part of user_prefs or any files included from
32       user_prefs can be built into the compiled set.
33
34       This compiled set is then used by the
35       "Mail::SpamAssassin::Plugin::Rule2XSBody" plugin to speed up
36       SpamAssassin's operation, where possible, and when that plugin is
37       loaded.
38
39       "re2c" can match strings much faster than perl code, by constructing a
40       DFA to match many simple strings in parallel, and compiling that to
41       native object code.  Not all SpamAssassin rules are amenable to this
42       conversion, however.
43
44       This requires "re2c" (see "http://re2c.org/"), and the C compiler used
45       to build Perl XS modules, be installed.
46
47       Note that running this, and creating a compiled ruleset, will have no
48       effect on SpamAssassin scanning speeds unless you also edit your
49       "v320.pre" file and ensure this line is uncommented:
50
51         loadplugin Mail::SpamAssassin::Plugin::Rule2XSBody
52

OPTIONS

54       --list
55           Output the extracted base strings to STDOUT, instead of generating
56           the C extension code.
57
58       --sudo
59           Use sudo(8) to run code as 'root' when writing files to the
60           compiled-rules storage area (which is
61           "/var/lib/spamassassin/compiled/5.010/3.003001" by default).
62
63       --quiet
64           Produce less diagnostic output.  Errors will still be displayed.
65
66       --keep-tmps
67           Keep temporary files after the script completes, instead of
68           deleting them.
69
70       -C path, --configpath=path, --config-file=path
71           Use the specified path for locating the distributed configuration
72           files.  Ignore the default directories (usually
73           "/usr/share/spamassassin" or similar).
74
75       --siteconfigpath=path
76           Use the specified path for locating site-specific configuration
77           files.  Ignore the default directories (usually
78           "/etc/mail/spamassassin" or similar).
79
80       --updatedir
81           By default, "sa-compile" will use the system-wide rules update
82           directory:
83
84                   /var/lib/spamassassin/compiled/5.010/3.003001
85
86           If the updates should be stored in another location, specify it
87           here.
88
89           Note that use of this option is not recommended; if sa-compile is
90           placing the compiled rules the wrong directory, you probably need
91           to rebuild SpamAssassin with different "Makefile.PL" arguments,
92           instead of overriding sa-compile's runtime behaviour.
93
94       --cf='config line'
95           Add additional lines of configuration directly from the command-
96           line, parsed after the configuration files are read.   Multiple
97           --cf arguments can be used, and each will be considered a separate
98           line of configuration.
99
100       -p prefs, --prefspath=prefs, --prefs-file=prefs
101           Read user score preferences from prefs (usually
102           "$HOME/.spamassassin/user_prefs") .
103
104       -D [area,...], --debug [area,...]
105           Produce debugging output.  If no areas are listed, all debugging
106           information is printed.  Diagnostic output can also be enabled for
107           each area individually; area is the area of the code to instrument.
108
109           For more information about which areas (also known as channels) are
110           available, please see the documentation at
111           <http://wiki.apache.org/spamassassin/DebugChannels>.
112
113       -h, --help
114           Print help message and exit.
115
116       -V, --version
117           Print sa-compile version and exit.
118

SEE ALSO

120       Mail::SpamAssassin(3) spamassassin(1) spamd(1)
121

PREREQUESITES

123       "Mail::SpamAssassin" "re2c" "Mail::SpamAssassin::Plugin::Rule2XSBody"
124

BUGS

126       See <http://issues.apache.org/SpamAssassin/>
127

AUTHORS

129       The Apache SpamAssassin(tm) Project <http://spamassassin.apache.org/>
130

132       SpamAssassin is distributed under the Apache License, Version 2.0, as
133       described in the file "LICENSE" included with the distribution.
134
135
136
137perl v5.10.1                      2013-12-05                     SA-COMPILE(1)
Impressum