Specifies another configuration file to be loaded at this point in the file. The specified path can be absolute, or relative to the bin/ directory. (Full recursion is permitted). Use #include to simplify multiple definitions and save administration busy work.

 #include ../spools.conf

Delimiters for the beginning and end of a Chain object.

<Chain>
        HostNames chaining-master.mycompany.com
        CountRefresh 5
        Subscription *
        FilterSubscription !*
        IdleTime 0
        Interface 192.168.1.2
        ListRefresh 5
        MaxConnections 300
</Chain>

Delimiters for the beginning and end of a Overview Cache object.

# Since the "alt.binaries.pictures" hierarchy is popular, use an overview
#  cache to speed the retrieval of overview lines.
#
<OverviewCache>
        CacheNumber 2
        Path /news/cache/overview2
        Kilobytes 2000000
        Subscription alt.binaries.pictures.*
        FilterSubscription alt.binaries.pictures.erotica.*
</OverviewCache>

Delimiters for the beginning and end of a Spool object. Minimum spool size is 15,000 Kilobytes (as of .348 releases and above). Maximum spool size is 2000 Gigabytes (as of .348 releases and above)

# Spool Example 1 (Not Cyclone)
<Spool>
        SpoolNumber 2
        Kilobytes 25000000
        Path /usr/local/news/spool2
        Subscription *bina*, *mp3*, *vcd*, *sex*, *multimedia*
        FilterSubscription !*,*jobs*, *.ads.*, *.forsale.*, *.for-sale.*,*.test*
</Spool>

# Spool Example 2 (Not Cyclone)
<Spool>
        SpoolNumber 200
        Kilobytes 15000
        Path /usr/local/news/spool5/control-spool
        StoreControlMessages True
        SubjectPattern cmsg*
</Spool>

# Spool Example 3 (Cyclone)
<Spool>
        SpoolName mainSpool
        Kilobytes 15000
        Path /usr/local/news/spool/mainSpool
# Subcription/FilterSubcription supported in Cyclone builds after
# Sept '04
        Subscription *
</Spool>

Specifies how to write to the spool object

AccessMode mmap

The ActiveFile directive specifies the location of the active file. It can be specified by absolute path or a path relative to the bin/ directory. The active file contains a list of the newsgroups currently being served by this system, including high and low article numbers and moderation status of the group.

 ActiveFile ../etc/active

Simple Glob-style Expressions that get appended to the Subscription directive. Since this directive is NOT accessible via the GUI, it is particularly useful for filtering out "premium" newsgroups. For example, setting this directive to '!clari.*' will prevent articles posted to just the clari groups from being sent REGARDLESS of what the Subscription directive specifies. The DefaultAdditionalSubscription directive in the cyclone.conf file is optional and provides a default value for this directive.

AdditionalSubscription !clari.*

The Aliases directive names all of the machines that are equivalent for this outgoing feed. If the Path: field of an article indicates that it has already been to one of these sites, it won't be sent to this feed. If you decide to use this directive, don't forget to include the value of OutgoingHostname in your list of machines. Please remember that the value for this directive is a list of glob-style patterns.

Aliases hostname, *.company.com

Always use reverse DNS in resolving incoming connections.

AllReverse True

Enables users to add, change, or remove newsgroups through the Web interface. The nowildcards option enables full control but disallows wildcards.

AllowActiveControl Full

Not Used ask Josh to rip this out

AllowConsole True

Permits clients matching the IncomingHostnames field on this feed to use IHAVE, CHECK and other NNTP Feeding commands.

AllowFeeding True

If set to true, this directive allows hosts matching the IncomingHostnames field to use the NNTP FILTER extension to rapidly cancel articles to this news server. See the NNTP Filter Proposal for details.

AllowFilter True

If an Active File is present, this specifies whether or not the system should send articles that do not match the Active File to this outgoing feed. The DefaultAllowJunk directive in the cyclone.conf file provides a default value for this directive.

AllowJunk No

Indicates whether the feed object supports the NEWNEWS protocol request. If you set this directive, you must also specify the '-log' and '-loggroups' directives in the start.conf file. Caution! The NEWNEWS request is performance intensive. If you set this directive to True, make sure that the server has sufficient resources to handle the extra load.

AllowNewNews False

Permits clients matching the IncomingHostnames directive on this feed to post articles on the news server. Posts are done with NNTP POST command.

AllowPosting True

Enables the feed/virtual server object to support the specified protocol.

AllowProtocols NNTP, HTTP

Permits clients matching the IncomingHostnames directive on this feed to read articles that are saved on the news server. Reading is done with NNTP Reader commands (ARTICLE, BODY, GROUP, HEAD, etc.).

AllowReading True

Permits access to NNTP based statistics commands.

AllowStat True

Specifies whether or not the system should attempt to use efficient NNTP streaming transfers for this outgoing feed. The DefaultAllowStreaming directive in the cyclone.conf file provides a default value for this directive.

AllowStreaming True

Enables message threading on a per-feed basis. A value of True allows users to view a group with or without threading, whereas a value of False requires users to view the group without threading. Threading is not to be confused with multiple threads of execution at the server level, but message threading, where each message can have a string of replies that creats a "thread".

AllowThreading True

Specifies that a Tornado Front End will be used with this feed object.

AllowTornado True

Specifies whether or not the system should attempt to resend articles that are temporarily refused by this outgoing feed (via NNTP 431 and 436 response codes). In addition, on incoming feeds, this specifies whether or not the system will send the 431 and/or 436 response codes to remote sites. The DefaultAllowTryAgain directive in the cyclone.conf file provides a default value for this directive.

AllowTryAgain True

Specifies a warning threshold for a spool object. If you set 'ArchiveThreshold n' in a spool object, where n is a warning threshold, the spool will stop accepting articles once it is filled. When the threshold is reached, the spool object issues a LOG_CRIT log message and continues to issue a message at each 1% increase thereafter. For example, specifying the ActiveThreshold at 90 results in a log message when the spool reaches 90% of its capacity, and an additional message at each additional 1% up to 100%. Warning: Once a spool is an archive spool, it must be destroyed to turn it back to a normal spool.

ArchiveThreshold 90

Password to use for AuthInfo NNTP authentication for this outgoing feed. Do NOT use this directive unless authentication is required. No Default value can be supplied.

AuthInfoPass password

Username to use for 'AuthInfo style' NNTP authentication for this outgoing feed. Do NOT use this directive unless authentication is required. No Default value can be supplied.

AuthInfoUser username

See Also AuthInfoPass.

Specifies the path of the file to be used to authenticate users before any transactions are allowed with the server. Refer to the 'authentication-EXAMPLE' file in the etc/ directory for documentation on the file format. The path can be either an absolute path or a path relative to the bin/ directory.

AuthenticationFile ../etc/authentication

Specifies a program to authenticate users and connections before any transactions are allowed with the server. The path for the filename can be either an absolute path or a path relative to the bin/ directory. Multiple feeds that have the same value assigned for this directive share access to a single instance of the AuthenticationProgram directive. An extremely powerful directive and can be used to implement tight control over capacity, simultaneous access, and security. Refer to the Advanced Configuration section for more details.

AuthenticationProgram ../etc/sample_auth.pl

Specifies that while running in XrefAction Parse mode, groups that are not in the active file and to which numbered articles are posted should be automatically added to the active file.

AutoAddGroups False

Specifies the hostname (or IP address) and Port to monitor for this outgoing feed. If a connection can not be established to this host and port, Cyclone will begin transmitting data to the host specified by the OutgoingHostName directive. Once a connection can be established, Cyclone will stop transmitting data. A connection is attempted every BackupTimeInterval seconds. No Default value can be supplied. This feature is VERY useful when implementing fault-tolerant News systems. You can have secondary machines monitor your primary machines and only activate feeds if the primary machines become unreachable.

BackupHostName main-feeder.company.com

Port to connect to on BackupHostName

BackupPortNumber 119

See Also BackupHostName.

Number of seconds to wait between attempts to connect to BackupHostName.

BackupTimeInterval 600

See Also BackupPortNumber, BackupHostName.

Specifies the maximum bandwidth allowed, in bytes per second, for a connection in an untriggered state. If this limit is exceeded during the time span specified by BandwidthTrackingWindow, the connection transitions to a triggered state. A value of 0 indicates unlimited bandwidth.

BandwidthLimitTrigger 16384

Defines the span of time, in seconds, used to calculate average bandwidth for a connection in an untriggered state. This time span should include the initially defined time span, unless an authentication program overrides the initial state of the connection. A value of 0 indicates unlimited bandwidth.

BandwidthTrackingWindow 300

See Also BandwidthLimitTrigger.

Specifies the bandwidth, in bytes per second, that sets the maximum limit for the bandwidth available for a connection in a triggered state. If the bandwidth used is less than this limit during the time span specified by TriggeredBandwidthTrackingWindow, the connection transitions to an untriggered state. A value of 0 indicates unlimited bandwidth.

BandwidthUnlimitTrigger 7168

See Also BandwidthLimitTrigger, BandwidthTrackingWindow.

Enables the caching of history in RAM.

CacheHistory True

Specifies a unique number for each overview cache object. Note: This directive is required for all overview cache objects.

CacheNumber 5

Controls the cascade feeding and expiration as a percentage of spool space.

CascadeDepthPercent 25

Appends the MessageID to the Command.

ChainMessageIdRequests True

Logs all the commands that are sent to this feed object in the specified file. The path for this log file can be either an absolute path or a path relative to the bin/ directory. This directive is useful for debugging problems pertaining to news readers. The log file is buffered, but executing the bin/ statsnow command flushes the buffer.

CommandLog ../log/command.log

Specifies whether the system should compress new articles as the are stored in this spool. Although multiple scalable compression algorithms are provided, all compression takes CPU time and is suitable only for machines with low CPU utilization. A spool can contain a mixture of compressed and uncompressed articles, so you can change the value of this directive at any time without losing articles that have already been stored in this spool. If you set the start.conf log variable, successfully compressed articles have the compressed size listed after a slash in the size field. If you run with the '-log' option, articles in the spool which were compressed successfully ( i.e. where the article compressed favorably) have the compressed size listed after a slash in the size field.

Compressed False

Specifies the compression type that is used in a compressed spool. A value of 0 specifies a real-time high-compression algorithm that specializes in low memory usage. Values from 1 through 9 indicate a "deflate" compression scheme. The higher the compression level, the more aggressive is the compression, and the more memory and CPU power are consumed. High compression levels are recommended only for servers that use little CPU and memory. Since spool objects can contain mixtures of articles compressed with different CompressionLevels, the value of this directive can be changed at any time.

CompressionLevel 1

See Also Compressed.

I cannot find who uses this

ConnectionPercentReserve 50

Specifies the number of control messages that require external processing to be queued in the control directory. When this limit is reached, no new messages are queued. A value of 0 indicates that no control messages will be queued for external processing.

ControlDepth 400

S