18.4. Tornado Back End Start Options

Usage: tornadod_be [options]
Tornado Backend v1.0.4.371
    Tornado Back End [Sep 16 2004 14:52:14]
Copyright (c) 1997-2004 Highwinds-Software Inc.
 -allreverse           [D]Always use reverse DNS in resolving incoming
                        connections.
 -backfill             Read all the spools in chronological order and queue
                        up their contents to all back ends
 -body                 [D]Use entire article as input to the article filter.
 -cache                [D]Enables the cacheing of history in RAM.
 -chanprog <program>   Specifies a program to use as a channel feed.
 -commonlog <file>     File to use as a log for web requests.
 -commonlogformat <format> Specifies fields included in the common log.
 -config <file_name>   Location of system configuration file.
                        Default = "../tornado_be.conf".
 -control <directory>  Directory to use for saving control messages.
                        Default = "../control".
 -critsyslog <file>    Send CRIT level and higher syslog messages to file
                        rather than the system log.
 -debugsyslog <file>   Send DEBUG level and higher syslog messages to file 
                        rather than the system log.
 -detailed             Turn on detailed syslog features.
 -detailedstats        Turn on detailed reader statistics.
 -errsyslog <file>     Send ERR level and higher syslog messages to file 
                        rather than the system log.
 -fastfilter <shm_key> Use the shared memory article filter interface. 
 -feeds <file_name>    Location of feed configuration file.
                        Default = "../feeds.conf".
 -groupstats           Turn on VERY detailed reading statistics.
 -help                 Prints this message.
 -history <file_name>  Location of the history database. Default = "history".
 -httpport <port_number>   Port to bind to. Default = HTTP (80).
 -interface <host/ip>  Local interface to use for network access.
 -key <file_name>      File that contains the license key.
 -log <file_name>      File to use as a log for article ids.
 -loggroups            Augment "-log" file with newsgroups
                        (enables NEWNEWS command).
 -logxrefs             Augment "-log" file with xrefs
 -mailers <###>        Number of parallel mail helpers to use.
                        Default = 10.
 -masquerade <name>    Name to use instead of the actual local hostname.
 -maxpendconnect <###> How many pending auths will be allowed (default 80)
 -multifilter <number> Number of filter programs to start.
                        Default = 1, Max = 16
 -nfs                  Optimize I/O for NFS mounted spools.
 -nntpport <port_number> Port to bind to. Default = NNTP (119).
 -nocreate             Prevents the creation of new spools.
 -nokeepalive          Prevents the use of TCP KeepAlive's
 -nonagle              Prevents the use of TCP Nagle Algorithm
 -noreverse            [D]Prevents the use of reverse DNS in resolving
                        incoming connections.
 -nosyslog             Print the syslog messages to stderr
                        rather than the system log
 -nohistory            Accept all incoming articles without checking history.
 -overview <directory> Directory to store overview database
 -paths <file_name>    File to store Path: lines in (for Top 1000 entries)
 -pidfile <file_name>  File to store PID. Default = "../log/tornado.pid".
 -postlog <file_name>  File to use as a log for local POSTs.
 -postprog <program>   Specifies a program to use as a POST filter.
 -program <program>    Specifies a program to use as an article filter.
 -queue <###>          Millions of articles for history.
                        Default = 8. Millions == 2^20.
 -resolvers <###>      Number of parallel DNS resolvers to use.
                        Default = 6.
 -reverseposted        Reverses the POSTED path stamp to 'POSTED.hostname'.
 -signal <directory>   Temporary to use for signal files.
                        Default = "../log".
 -stats <file_name>    Filename for writing statistics data.
 -strict               Strictly interpret NNTP.
 -spoolstats <file_name> Time reader stats.
 -spoolstatsinterval <###> Sample time for -timer Default = 300 (5 minutes)
 -update <seconds>     Number of seconds between updates of statistics.
                        Default = 3600 (1 hour).
 -upstream <directory> Directory to use for holding posts being sent 
                        upstream.  Default = "../upstream".
 -user <user_name>     User to become after binding port.
 -veritas              Indicates veritas FS in use (used with directio).
-allreverse

[D]Always use reverse DNS in resolving incoming connections.

Forces a reverse DNS lookup on all incoming IP addresses. Normally, the system will only perform reverse DNS if it is required.

-backfill

Read all the spools in chronological order and queue up their contents to all back ends

Deprecated

-body

[D]Use entire article as input to the article filter.

Used with the -program option. When -body is specified, the entire body of each incoming and posted article is passed to the program filter, rather than just the article headers. The program filter should be configured so that it is expecting to receive article bodies.

-cache

[D]Enables the cacheing of history in RAM.

Enables extra caching of the history file, which should speed up inbound article processing and is useful in the event you have multiple inbound feeds. This option causes the server to consume an additional 16Mb of memory.

-chanprog

Specifies a program to use as a channel feed.

-commonlog

File to use as a log for web requests.

-commonlogformat

Specifies fields included in the common log.

-config

Location of system configuration file. Default = "../tornado_be.conf".

Takes as a single argument the name of the config file, normally ../<typhoon|twister|tornado_be>.conf. If you specify this argument in the line which starts <typhoond|twisterd|tornado_be> in the bin/start script, you should add it to the line which runs validate as well, so that validate checks the same file which will be used to configure the server.

-control

Directory to use for saving control messages. Default = "../control".

-critsyslog

Send CRIT level and higher syslog messages to file rather than the system log.

-debugsyslog

Send DEBUG level and higher syslog messages to file rather than the system log.

-detailed

Turn on detailed syslog features.

Enabled, informational messages about the operation of the server (connect and disconnect messages, for instance) are syslogged using news.info facility. You must have configured your syslogd to save news.info messages.

-detailedstats

Turn on detailed reader statistics.

Should be used with the -stats option. The server will keep summary statistics about article reading patterns on a per-connection basis and store them in stats.detailed, where stats is the file name provided to the -stats option.

-errsyslog

Send ERR level and higher syslog messages to file rather than the system log.

-fastfilter

Use the shared memory article filter interface.

-feeds

Location of feed configuration file. Default = "../feeds.conf".

Takes as a single argument the name of the feed definition file, normally ../feeds.conf. If you specify this argument in the line which starts <typhoond|twisterd|tornado_be> in the bin/start script, you should add it to the line which runs validate as well, so that validate checks the same file which will be used to configure the server.

-groupstats

Turn on VERY detailed reading statistics.

Should be used with the -stats option. If specified, detailed statistics about readership patterns within each group will be recorded in the file statsfile.group, where statsfile is the root statistics file name passed to the -stats option.

-help

Prints this message.

Causes the server to summarize the valid command-line arguments and exit.

-history

Location of the history database. Default = "history".

Specifies an alternate location for the history file (normally bin/history).

-httpport

Port to bind to. Default = HTTP (80).

-interface

Local interface to use for network access.

Specifies a host name or IP address of the local network interface which should be used by the server.

-key

File that contains the license key.

Specifies an alternate location for the license key file. The license key file is usually found in the bin subdirectory and named <typhoon|twister|tornado>.key.

-log

File to use as a log for article ids.

Specifies that every incoming article should be logged to the specified file, one per line.

-loggroups

Augment "-log" file with newsgroups (enables NEWNEWS command).

Should be used with the -log option. Causes the newsgroups to which an article was posted to be added at the end of the article's log file line.

-logxrefs

Augment "-log" file with xrefs

-mailers

Number of parallel mail helpers to use. Default = 10.

Specifies the number of mail helper programs to use during operation. The default value is 10.

-masquerade

Name to use instead of the actual local hostname.

Specifies an alternate name for the system to be stamped in the Path field of articles. Normally, the local hostname is used.

-maxpendconnect

How many pending auths will be allowed (default 80)

-multifilter

Number of filter programs to start. Default = 1, Max = 16

-nfs

Optimize I/O for NFS mounted spools.

Tells the system to optimize its disk I/O routines for accessing spool objects that are NFS mounted. Without this option, accessing NFS mounted spools might be slower than necessary.

Using -nfs changes the system calls that Cyclone uses to access the I/O system from mmap() to pread(). Activating -nfs should alleviate problems that may occur with mmap() under load.

-nntpport

Port to bind to. Default = NNTP (119).

-nocreate

Prevents the creation of new spools.

Prevents the server from creating or resizing spools during startup. This option can be useful after you have created your spools to prevent user error from causing accidental spool modification.

-nohistory

Accept all incoming articles without checking history.

Run without a history. Useful when you don't need or want a history db.

-nokeepalive

Prevents the use of TCP KeepAlive's

Prevents the server from setting the TCP KeepAlive option on incoming and outgoing connections.

-nonagle

Prevents the use of TCP Nagle Algorithm

Prevents the server from using the TCP Nagle algorithm on incoming and outgoing connections.

-noreverse

[D]Prevents the use of reverse DNS in resolving incoming connections.

Prevents the server from trying reverse DNS resolution on incoming feeds; only IP-based patterns are checked.

-nosyslog

Print the syslog messages to stderr rather than the system log

-overview

Directory to store overview database

Overview files will be created in the specified directory instead of in the overview directory in the installation area.

-paths

File to store Path: lines in (for Top 1000 entries)

Causes the server to record the full Path header from each received article to the specified file; this information is used when reporting statistics to the Freenix Top 1000.

-pidfile

File to store PID. Default = "../log/tornado.pid".

Specifies an alternate location for the pid file (normally log/<typhoond|twisterd|tornado_be>.pid ).

-postlog

File to use as a log for local POSTs.

Specifies that every article accepted via POST should be logged to the specified file, one per line.

-postprog

Specifies a program to use as a POST filter.

The server will start program and attempt to use it as an post filter. The filter will be fed feed information, and full articles, and is expected to return codes indicating whether the article should be saved, discarded, or modified.

-program

Specifies a program to use as an article filter.

The server will start program and attempt to use it as an article filter. The filter will be fed article headers (and article bodies if the -body option is specified as well), and is expected to return codes indicating whether the article should be saved.

-queue

Millions of articles for history. Default = 8. Millions == 2^20.

Specifies the number of millions of articles of history the server will remember in its attempt to prevent the reception of an article more than once. The provided number is multiplied by 1048675 (which is 2^20) to give the number of articles stored in the history. This number can be increased without worry, but decreasing it can cause the server to accept duplicates of old articles for a short time. The default is eight, or a history containing 8388608 articles.

-resolvers

Number of parallel DNS resolvers to use. Default = 6.

Specifies the number of DNS resolver programs to use during operation. The default value is 6.

-reverseposted

Reverses the POSTED path stamp to 'POSTED.hostname'.

Reverses the posted path stamp to be POSTED.hostname instead of the default hostname.POSTED.

-signal

Temporary to use for signal files. Default = "../log".

-spoolstats

Time reader stats.

-spoolstatsinterval

Sample time for -timer Default = 300 (5 minutes)

-stats

Filename for writing statistics data.

The server will use filename as the base filename for requested statistics. Statistics about incoming articles will be stored in filename.in. See also -groupstats and -detailedstats.

-strict

Strictly interpret NNTP.

Runs with strict NNTP RFC compliance as opposed to being more lax and allowing some borderline protocol violations. Generally not needed or desired.

-update

Number of seconds between updates of statistics. Default = 3600 (1 hour).

Should be used with the -stats option. Every seconds seconds, the server will update the requested statistics. The default is 3600, meaning hourly statistics updates.

-upstream

Directory to use for holding posts being sent upstream. Default = "../upstream".

-user

User to become after binding port.

After the server has bound its port, it will attempt to become the user username. The server will refuse to start if the provided user is the super-user.

-veritas

Indicates veritas FS in use (used with directio).

Enables direct I/O for Veritas VXFS (Veritas File System).