Chapter 18. Highwinds Software Command Line Options

Table of Contents

Cyclone Start Options
Typhoon Start Options
Twister Start Options
Tornado Back End Start Options
Tornado Front End Start Options
Hurricane Start Options

Cyclone Start Options

    
  Usage: cycloned [options]  
  Cyclone v2.1.5.394  
    
                       Cyclone Daemon [Apr  1 2007 20:17:04]  
       Copyright (c) 1997-2006 Highwinds-Software LLC.  
    
 -active   <file_name>   Filename of optional active file.  
 -alias   <name>         Name to add to Path: if not already present.  
 -allreverse             Always use reverse DNS to resolve incoming connections.  
 -bighistory             Doubles history capacity.  
 -body                   Use entire article as input to the article filter.  
 -cache                  Enables the cacheing of history in RAM.  
 -config   <file_name>   Location of system configuration file.   
                         Default = "../cyclone.conf"  
 -detailed               Turn on detailed syslog features.  
 -dirdensity             Sets the number of files per backlog directory.  
                         Default = 200  
 -dnsexpire   <seconds>  Interval to expire resolved DNS names.   
                         Default = 21600 (6 hours)  
 -fastfilter   <shm_key> Use the shared memory article filter interface.   
 -feeds   <file_name>    Location of feed configuration file.   
                         Default = "../feeds.conf"  
 -fifo                   Changes History to FIFO-style expiration.  
 -filedensity            Sets the number of articles per backlog file.   
                         Default = 200  
 -help                   Prints this message.  
 -history   <file_name>  Location of the history database.   
                         Default = "history"  
 -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  
 -logxrefs               Augment "-log" file with xrefs  
 -masquerade   <name>    Name to use instead of the actual local hostname.  
 -multifilter   <number> Number of filter programs to start.                       Default = 1, Max = 16  
 -nfs                    Optimize I/O for NFS mounted spools.  
 -nocreate               Prevents the creation of new spools.  
 -noreverse              Never use reverse DNS to resolve incoming connections.  
 -paths   <file_name>    Filename for "Path:" header line output. This can  
                         be used for USENET Top 1000 processing.  
 -pidfile   <file_name>  File to store PID.   
                         Default = "../log/cycloned.pid"  
 -port   <port_number>   Port to bind to. Default is the NNTP port.  
 -program   <program>    Specifies a program to use as an article filter.  
 -queue   <###>          Millions of articles for "-fifo" style history.   
                         Minimum = 2, Default = 8, Millions == 2^20  
 -resolvers   <###>      Number of parallel DNS resolvers to use.   
                         Default = 6  
 -securereversedns       Force secure reverse lookups of incoming hosts.  
 -stats   <file_name>    Filename or "local0" -> "local7", "localnews"   
                         for syslog facility to write statistics data  
 -update   <seconds>     Number of seconds between updates of statistics.   
                         Default = 3600 (1 hour)  
 -user   <user_name>     User to become after binding port.  
 -veritas                Indicates veritas FS in use (used with directio).  
-active

Filename of optional active file.

Required if running in XrefAction Generate, for more details see Cyclone Active File.

-alias

Name to add to Path: if not already present.

Used carefully, this option can greatly affect the way articles are routed throughout your network.

See Also -masquerade.

-allreverse

Always use reverse DNS to resolve incoming connections.

Enabling this option will provide DNS security but at the cost of connection servicing speed. If you experience performance problems and slow connections, turn this option off.

See Also -noreverse.

-bighistory

Doubles history capacity.

Still uses the older style history which can be prone to misses, but is faster than -fifo.

See Also -history, -fifo, -queue.

-body

Use entire article as input to the article filter.

Cyclone binds the STDIN and STDOUT of a filtering program and passes article information via those filehandles. Using this option will allow the filter to filter based on the contents of the article body instead of just the headers. Using the newer -fastfilter, Cyclone uses shared memory instead of STDIN and STDOUT to communicate with the external filtering program.

See Also -fastfilter, -program.

-cache

Enables the cacheing of history in RAM.

With the history cached in RAM, NNTP responses to IHAVE and CHECK commands are faster.

-config

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

-detailed

Turn on detailed syslog features.

With this option enabled, NEWS.INFO level syslog data is logged and is valuable for debugging purposes.

-dirdensity

Sets the number of files per backlog directory. Default = 200

See Also -filedensity.

-dnsexpire

Interval to expire resolved DNS names. Default = 21600 (6 hours)

-fastfilter

Use the shared memory article filter interface.

Use of this option is discussed further in the Fastfilter API Document.

See Also -body, -program.

-feeds

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

-fifo

Changes History to FIFO-style expiration.

Use with -queue to specify a First In First Out history. The FIFO style history is not prone to lookup misses like the older history style, but isn't as fast.

See Also -bighistory, -history, -queue.

-filedensity

Sets the number of articles per backlog file. Default = 200

See Also -dirdensity.

-help

Prints this message.

-history

Location of the history database. Default = "history"

See Also -bighistory, -fifo, -queue.

-interface

Local Interface to use for network access.

Useful for multi-homed machines where you don't want to bind all interfaces. Cyclone Multihoming

-key

File that contains the license key.

See Highwinds Software for information on obtaining a license.

-log

File to use as a log for article ids.

The fields logged are described in etc/README.stats. See Monitoring your system.

-loggroups

Augment "-log" file with Newsgroups

Logs the Newsgroups header to the file specified by -log. Mutally exclusive to -logxrefs See also Monitoring the System.

-logxrefs

Augment "-log" file with xrefs

Logs the Xref header to the file specified by -log. Mutually exclusive to -loggroups. See also Monitoring the System.

-masquerade

Name to use instead of the actual local hostname.

Valuable to use if you don't want the hostname to be viewable in the Path: header.

See Also -alias.

-multifilter

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

Multiple processes will be launched, each running a copy of the -program.

See Also -fastfilter, -program.

-nfs

Optimize I/O for NFS mounted spools.

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.

-nocreate

Prevents the creation of new spools.

Useful once a Cyclone is already in production and accidental spool creation by mis-configuration should be avoided.

-noreverse

Never use reverse DNS to resolve incoming connections.

All incoming connections will be determined by IP address only.

See Also -allreverse.

-paths

Filename for "Path:" header line output. This can be used for USENET Top 1000 processing.

See Top 1000

-pidfile

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

-port

Port to bind to. Default is the NNTP port.

Typically, the NNTP port (119) is desired. Use -port when running multiple Cyclone instances on the same server and/or on a non-standard port.

-program

Specifies a program to use as an article filter.

See Custom Filtering.

See Also -body, -fastfilter, -multifilter.

-queue

Millions of articles for "-fifo" style history. Minimum = 2, Default = 8, Millions == 2^20

-resolvers

Number of parallel DNS resolvers to use. Default = 6

-securereversedns

Force secure reverse lookups of incoming hosts.

-stats

Filename or "local0" -> "local7", "localnews" for syslog facility to write statistics data

Monitoring your system

-update

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

Set to 0 if you are collecting stats by using cron and bin/statsnow.

-user

User to become after binding port.

-veritas

Indicates veritas FS in use (used with directio).

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