Current INN Documentation
This documentation is from the current Git head of INN development, not
for the latest INN release. It is therefore intended primarily for INN
developers and users who are tracking CURRENT snapshots, and to test the
HTML conversion of the documentation. Be warned that it may be incorrect
for STABLE snapshots or a released version and be careful about relying on
it.
Basic documentation:
Documentation for developers:
Filtering and authentication hook documentation:
Configuration files:
Primary daemons and utilities to start them:
- ctlinnd — Control the main INN daemon
- innd — Core daemon for accepting and storing articles
- nnrpd — NNTP reader server
- rc.news — Start or stop INN daemons
- tinyleaf — Very simple IHAVE-only NNTP server
- Sample files:
Data files:
- active — List of newsgroups carried by the server (example)
- active.times — List of local creation times of newsgroups
- history — Record of current and recently expired Usenet articles
- newsgroups — List of newsgroups and their short descriptions (example)
- newslog — Description of INN log files
Outgoing feeds:
Article posting utilities:
- gencancel — Generate cancel control messages
- inews — Post an article to the local news server
- mailpost — Feed an e-mail message into a newsgroup
- pullnews — Pull news from news servers and feed it to another
- rnews — Inject individual articles and UUCP batches
Overview method documentation:
User utilities:
- convdate — Convert time and date strings and numbers
- getlist — Get a list from an NNTP server
- grephistory — Query the INN history database
- inncheck — Check INN configuration and database files
- innconfval — Get configuration parameters from inn.conf
- inndf — Report free disk, inodes, and overview space
- innstat — Print snapshot of INN system
- innupgrade — Upgrade INN configuration files
- mod-active — Batch processing of newsgroup changes
- nntpget — Get Usenet articles from a remote NNTP server
- sm — Command-line interface to the INN storage manager
Expiration and maintenance utilities:
- expire — Article and history expiration program
- expireover — Perform all overview-driven expiration
- expirerm — Remove articles that have been expired
- fastrm — Quickly remove a list of files
- innreport — Summarize INN log files
- makedbz — Rebuild dbz files
- makehistory — Rebuild the history and overview databases
- news.daily — Perform daily Usenet maintenance tasks
- prunehistory — Remove tokens from Usenet history file
- scanlogs — Summarize and rotate INN log files
- tally.control — Keep track of newsgroup creations and deletions
Special article processing:
Support utilities:
- actsync — Synchronize the active file with an external source
(sample actsync.cfg,
actsync.ign)
- cvtbatch — Convert Usenet batch files to INN format
- innbind — Helper program to bind sockets to privileged ports
- innmail — Simple mail sending program
- innwatch — Monitor the state of INN and the system
- perl-nocem — NoCeM-on-spool implementation
(sample nocem.ctl)
- pgpverify — Cryptographically verify Usenet control messages
- procbatch — Process an INN funnel file or innfeed-dropped file
- sendinpaths — Send Usenet Path: statistics via e-mail
- shlock — Create lock files for use in shell scripts
- shrinkfile — Shrink files on line boundaries
- simpleftp — Rudimentary FTP client
- writelog — Write or mail a log entry
Authentication programs:
- auth_krb5 — nnrpd Kerberos v5 authenticator
- ckpasswd — nnrpd password authenticator
- domain — nnrpd domain resolver
- ident — nnrpd ident resolver
- radius — nnrpd RADIUS password authenticator
CNFS storage support utilities:
OVDB overview support utilities:
ovsqlite overview support utilities:
Tradindexed overview support utilities:
- tdx-util — Tradindexed overview manipulation utility
Tradspool storage support utilities:
- scanspool — Perform a sanity check over all articles in news spool
Support library documentation:
Perl support:
Contributed software:
- thdexpire — Dynamic expire daemon for timehash and timecaf storage
- tunefeed — Build a newsgroups pattern for a remote feed
Last modified and
spun 2024-03-05