FIDOGATE: Programs

[ < ] | [ > ] |  | [ << ] | [ Up ] | [ >> ] |  |  |  |  | [Top] | [Contents] | [Index] | [ ? ]

# 3. FIDOGATE Programs

> Areafix programs and scripts:

> 3.1 ftnaf -- Areafix |  | Areafix mail processor
> 3.2 ftnafmail -- Areafix Mail Frontend |  | Areafix mail setuid frontend
> 3.3 ftnafpkt -- Areafix packet processor |  | Areafix packet processor
> 3.4 ftnafutil -- Areafix utility |  | Areafix utility

> Character set translation table compiler:

> 3.5 charsetc -- Character set translation table compiler |  | Character set translation table compiler

> FFX programs and scripts:

> 3.6 ffx -- Remote Execution via Fido Mailer |  | Remote execution via Fido mailer
> 3.7 ffxmail -- ffx Frontend for Sending Mail |  | `ffx` frontend for sending mail
> 3.8 ffxnews -- ffx Frontend for Sending News |  | `ffx` frontend for sending news
> 3.9 ffxqt -- Execute ffx Requests |  | Execute `ffx` requests
> 3.10 ffxrmail -- Rmail Command for FFX |  | `rmail` command for `ffxqt`
> 3.11 runffx -- Script for Running FFX Programs |  | Script for running FFX programs
> 3.12 send-ffx -- Script for Processing News via FFX |  | Script for processing news via FFX

> Gateway programs and scripts:

> 3.13 ftn2rfc -- FTN-Internet Gateway Program |  | Fido-Internet gateway program
> 3.14 ftnin -- Frontend for `ftn2rfc` |  | Frontend for `ftn2rfc`
> 3.15 ftninpost -- `ftnin` Post-processing Script |  | `ftnin` post-processing script
> 3.16 ftninrecomb -- `ftnin` Recombining Script |  | `ftnin` recombining script
> 3.17 ftnmail -- `rfc2ftn` Setuid Frontend |  | `rfc2ftn` setuid frontend
> 3.18 rfc2ftn -- Internet-Fido Gateway Program |  | Internet-Fido gateway program
> 3.19 rungate -- Script for Running Gateway Programs |  | Script for running gateway programs
> 3.20 send-fidogate -- Script for Processing News via FIDOGATE |  | Script for processing news via FIDOGATE

> Ticker programs:

> 3.21 ftnhatch -- Hatch new file into file area |  | Hatch new file into file area
> 3.22 ftntick -- Process incoming TIC files |  | Process incoming TIC files
> 3.23 ftntickpost -- ftntick Post-processing Script |  | `ftntick` post-processing script

> Tosser programs and scripts:

> 3.24 ftn2ftn -- FTN-FTN NetMail Gateway Program |  | FTN-FTN NetMail gateway
> 3.25 ftnexpire -- Utility for expiring MSGID history database |  | Utility to expire MSGID history database
> 3.26 ftnpack -- Pack Fido ArcMail Packets |  | Pack (ArcMail) Fido mail packets
> 3.27 ftnroute -- Route Fido Mail Packets |  | Route Fido mail packets
> 3.28 ftntoss -- Toss Fido Mail Packets |  | Toss/remap/rewrite Fido mail packets
> 3.29 runin -- Script for Processing Inbound Packets |  | Script for processing inbound packets
> 3.30 runmail -- Script for Processing Gateway Mail Output Packets |  | Script for processing gateway mail output packets
> 3.31 runnews -- Script for Processing Gateway News Output Packets |  | Script for processing gateway news output packets
> 3.32 runout -- Script for Processing Miscellaneous Output Packets |  | Script for processing miscellaneous output packets
> 3.33 runtoss -- Script for Running the Tosser Programs |  | Script for running the tosser programs
> 3.34 rununpack -- Script for Unpacking Inbound ArcMail Archives |  | Script for unpacking inbound arcmail archives

> Utilties:

> 3.35 ftnbsy -- Create/delete Binkley Busy Filess |  | Create/delete Binkley busy files
> 3.36 ftnconfig -- Retrieve information from FIDOGATE config files |  | Retrieve information from FIDOGATE config files
> 3.37 ftnfattach -- Outbound file attaches |  | Binkley outbound file attach utility
> 3.38 ftnflo -- Process Binkley Outbound FLO Files and Attachments |  | Process Binkley outbound FLO files and attachments
> 3.39 ftnlock -- Create/Remove Lock Files |  | Create/delete lock files
> 3.40 ftnlog -- Write Message to Log File |  | Write message to log file
> 3.41 ftnoutpkt -- Create Fido Message Packets |  | Create output Fido message packets
> 3.42 ftnseq -- Command Line Interface to Sequencer Files |  | Access sequencer file
> 3.43 pktdebug -- FTN mail packet debugger |  | FTN mail packet debugger
> 3.44 pktmore -- Pager frontend for `pktdebug` |  | Pager frontend for `pktdebug`
> 3.45 sumcrc -- CRC Checksum Utility |  | CRC checksum utility

Almost all FIDOGATE programs support the following standard options, which therefore aren't listed in the sections describing the individual programs:

`-v --verbose`
  Increase the verbosity/debug level.

`-h --help`
  Help on usage and options.

`-c --config name`
  Read an alternate config file. `""` means none. name may start with %X/, see below.

`-a --addr Z:N/F.P`
  Set the main address of this program.

`-u --uplink-addr Z:N/F.P`
  Set the uplink address (boss node) of this program (only useful for gateway programs).

The option `-a` and `-u` also support Internet-style FTN addresses, e.g. `p10.f110.n2452.z2`. If any of these options is specified, all addresses from the config file are disabled.

All options and config statements which take file or directory names accept the following `%` abbreviations:

`%C`
  CONFIGDIR
`%L`
  LIBDIR
`%N`
  BINDIR
`%G`
  LOGDIR
`%V`
  VARDIR
`%K`
  LOCKDIR
`%S`
  SPOOLDIR
`%B`
  BTBASEDIR
`%I`
  INBOUND
`%P`
  PINBOUND
`%U`
  UUINBOUND

[ < ] | [ > ] |  | [ << ] | [ Up ] | [ >> ] |  |  |  |  | [Top] | [Contents] | [Index] | [ ? ]

## 3.1 ftnaf -- Areafix

Usage:

    ftnaf  [-options]  [Z:N/F.P  command ]

Options:

`-m --mail`
  Process Areafix mail message (RFC) on stdin.

`-r --no-reply`
  Don't send reply via mail, write to stdout.

`-n --no-rewrite`
  Don't rewrite AREAS.BBS.

`-b --areas-bbs NAME`
  Use alternate AREAS.BBS.

`-F --filefix`
  Run as Filefix program, using FAREAS.BBS.

Commands:

listall list all available areas list list areas available to node query list subscribed areas unlinked list unsubscribed areas from Z:N/F.P PASSWORD set address and password passwd Z:N/F.P PASSWORD password Z:N/F.P PASSWORD +AREA subscribe to AREA AREA subscribe AREA sub AREA -AREA unsubscribe from AREA unsubscribe AREA unsub AREA vacation AREA set vacation flag for AREA &AREA [-options] create new AREA new AREA [-options] create AREA [-options] ~AREA delete AREA delete AREA comment TEXT arbitrary comment (ignored) help this help AREA names are not case-sensitive and support shell-style wildcards * ? [a-z] [abc], e.g. COMP.OS.*, [A-D]*.GER
`listall`
  List all areas.

`list`
  List areas available to node.

`query`
  List subscribed areas.

`unlinked`
  List unsubscribed areas available to node.

`from Z:N/F.P PASSWORD`
`passwd Z:N/F.P PASSWORD`
`password Z:N/F.P PASSWORD`
  Set address and password.

`+AREA`
`AREA`
`subscribe AREA`
`sub AREA`
  Subscribe to AREA.

`-AREA`
`unsubscribe AREA`
`unsub AREA`
  Unsubscribe from AREA.

`vacation AREA`
  Set vacation flag for AREA. NOT YET IMPLEMENTED!!!

`&AREA [-options ]`
`new AREA [-options ]`
`create AREA [-options ]`
  Create new area. Nodes allowed to create an area must have the `&` key in their `passwd` entry. Allowed `areas.bbs` options: `-#`, `-p`, `-r`, `-l` lvl, `-k` key, `-d` desc, and `-z` zone.

`~AREA`
`delete AREA`
  Delete AREA. Nodes allowed to deleted an area must have the `~` key in their `passwd` entry.

`comment text`
  Arbitrary comment, completely ignored.

`help`
  Help on Areafix commands.

All command keywords may be prefixed by `%`. `ftnaf` also recognizes the `-q` (= query) and `-l` (= list) options following the password in the subject header.

For proper operation `ftnaf` requires the `X-FTN-From` header generated by `ftn2rfc`, thus the `X-FTN` configuration must include the `f` flag.

[ < ] | [ > ] |  | [ << ] | [ Up ] | [ >> ] |  |  |  |  | [Top] | [Contents] | [Index] | [ ? ]

## 3.2 ftnafmail -- Areafix Mail Frontend

Usage:

    ftnafmail  [-options]

Options:

`-F --filefix`
  Run `ftnaf` as Filefix program.

This is the setuid mail frontend for `ftnaf` to be run from the sendmail aliases. DO NOT use `ftnaf` directly, as this will result in security problems.

    # Areafix/Filefix - FIDOGATE ftnaf
    areafix: "|/usr/lib/fidogate/ftnafmail"
    areamgr: areafix
    filefix: "|/usr/lib/fidogate/ftnafmail -F"
    filemgr: filefix

[ < ] | [ > ] |  | [ << ] | [ Up ] | [ >> ] |  |  |  |  | [Top] | [Contents] | [Index] | [ ? ]

## 3.3 ftnafpkt -- Areafix packet processor

Usage:

    ftnafpkt  [-options]  [packet ... ]

Options:

`-I --in-dir name`
  Set input directory. Default: PINBOUND

`-O --out-dir name`
  Set output directory. Default: SPOOLDIR/outpkt

`-l --lock-file`
  Create lock file while processing.

`-r --no-reply`
  Don't send reply via NetMail.

`-n --no-rewrite`
  Don't rewrite AREAS.BBS.

`-b --areas-bbs NAME`
  Use alternate AREAS.BBS.

`-F --filefix`
  Run as Filefix program, using FAREAS.BBS.

This is the packet processor frontend for the FIDOGATE Areafix, which doesn't require the Unix mail system for Areafix operation. The best way to use `ftnafpkt` is via the tosser.

`routing` example:

    Remap  2:2499/999.*  2:2499/999.101  "Area*"
    #      ^^^^^^^^^^^^  ^^^^^^^^^^^^^^
    #      node addr     pseudo point
    #                    for Areafix

    NetMail
    Send  hold  2:2499/999.*

`packing` example:

    progn  areafix  "/usr/lib/fidogate/ftnafpkt %s"
    pack   areaifx  2:2499/999.101

`runout` must be run regularly to process messages generated by `ftnafpkt`.

[ < ] | [ > ] |  | [ << ] | [ Up ] | [ >> ] |  |  |  |  | [Top] | [Contents] | [Index] | [ ? ]

## 3.4 ftnafutil -- Areafix utility

Usage:

    ftnafutil  [-options]  [command ... ]

Options:

`-n --no-rewrite`
  Don't rewrite AREAS.BBS.

`-b --areas-bbs NAME`
  Use alternate AREAS.BBS.

`-F --filefix`
  Run as Filefix program, using FAREAS.BBS.

`-O --out-dir name`
  Set output directory. Default: SPOOLDIR/outpkt

Commands:

`delete`
  Delete dead areas from `areas.bbs` (no uplink and no downlinks).

`subscribe`
  Subscribe to area at uplink, if at least one downlink has subscribed to this area (uses the `-s S/U` option in `areas.bbs`).

`unsubscribe`
  Unsubscribe from area at uplink, if no more downlinks are subscribed to this area (uses the `-s S/U` option in `areas.bbs`).

Auto-subscribe/unsubscribe will only be used for areas marked with the state option. State `-s U` means that the area is not currently subscribed at the uplink, `-s S` means that the are is subscribed at the uplink.

[ < ] | [ > ] |  | [ << ] | [ Up ] | [ >> ] |  |  |  |  | [Top] | [Contents] | [Index] | [ ? ]

## 3.5 charsetc -- Character set translation table compiler

Usage:

    charsetc  [-options]  charset.map  charset.bin

[ < ] | [ > ] |  | [ << ] | [ Up ] | [ >> ] |  |  |  |  | [Top] | [Contents] | [Index] | [ ? ]

## 3.6 ffx -- Remote Execution via Fido Mailer

Usage:

    ffx  [-options]  Z:N/F.P  command

Options:

`-b --batch-dir dir`
  Operate in batch mode, using dir. Control and data files are not immediately appended to the node's FLO file, but rather written to a separate batch directory SPOOLDIR/out.ZZZ/dir. Implies `-n`.

`-B --binkley name`
  Set Binkley outbound directory.

`-F --flavor flavor`
  Set flavor of outbound FLO file: `Hold`, `Normal`, `Direct`, or `Crash`.

`-g --grade grade`
  Set grade of control and data files to grade (single letter [a-z0-9]).

`-n --nocompression`
  Don't compress data files.

[ < ] | [ > ] |  | [ << ] | [ Up ] | [ >> ] |  |  |  |  | [Top] | [Contents] | [Index] | [ ? ]

## 3.7 ffxmail -- ffx Frontend for Sending Mail

Usage:

    ffxmail  Z:N/F.P  address ...

No options.

`ffxmail` calls `ffx` in batch mode (`-b`), selecting the batch directory for the node address. Modify the script (`src/ffx/ffxmail.sh`) for other addresses/batch directories.

[ < ] | [ > ] |  | [ << ] | [ Up ] | [ >> ] |  |  |  |  | [Top] | [Contents] | [Index] | [ ? ]

## 3.8 ffxnews -- ffx Frontend for Sending News

Usage:

    ffxnews  Z:N/F.P

No options.

`ffxnews` calls `ffx` in batch mode (`-b`), selecting the batch directory for the node address. Modify the script (`src/ffx/ffxnews.sh`) for other addresses/batch directories.

[ < ] | [ > ] |  | [ << ] | [ Up ] | [ >> ] |  |  |  |  | [Top] | [Contents] | [Index] | [ ? ]

## 3.9 ffxqt -- Execute ffx Requests

Usage:

    ffxqt  [-options]

Options:

`-g --grade grade`
  Process ffx jobs with grade only. grade must be a single letter.

`-I --inbound name`
  Select the input directory where the `f???????.ffx` control files are read from. Default: PINBOUND

`-t --insecure`
  Process ffx files without password. Default: ffx file must contain a password.

[ < ] | [ > ] |  | [ << ] | [ Up ] | [ >> ] |  |  |  |  | [Top] | [Contents] | [Index] | [ ? ]

## 3.10 ffxrmail -- Rmail Command for FFX

Usage:

    ffxrmail  address ...

Perl script to be called by `ffxqt` for `rmail` commands to receive Internet mail. This replaces `/bin/rmail` (UUCP), calling `/usr/lib/sendmail` directly with appropiate options.

[ < ] | [ > ] |  | [ << ] | [ Up ] | [ >> ] |  |  |  |  | [Top] | [Contents] | [Index] | [ ? ]

## 3.11 runffx -- Script for Running FFX Programs

Usage:

    runffx

[ < ] | [ > ] |  | [ << ] | [ Up ] | [ >> ] |  |  |  |  | [Top] | [Contents] | [Index] | [ ? ]

## 3.12 send-ffx -- Script for Processing News via FFX

Usage:

    ffxqt  [hostname]

Processes INN news batch file `/var/spool/news/out.going/`hostname.

[ < ] | [ > ] |  | [ << ] | [ Up ] | [ >> ] |  |  |  |  | [Top] | [Contents] | [Index] | [ ? ]

## 3.13 ftn2rfc -- FTN-Internet Gateway Program

Usage:

    ftn2rfc  [-options]  [packet ... ]

Options:

`-1 --single-articles`
  Write single articles to output files (in `tmpnews`), not news batches containing several articles (batch is default).

`-I --inbound-dir NAME`
  Set the input directory for FTN packets. Default: PINBOUND

`-i --ignore-hosts`
  Don't bounce unknown hosts (unknown = not registered in `hosts`)

`-l --lock-file`
  Create lock file while processing.

`-n --no-remove`
  Don't remove or rename input packet files, return exit code 1 if processing fails.

`-t --insecure`
  Operate in insecure mode. All messages containing a To line for gateway addressing will be bounced.

`-x --exec-program SCRIPT`
  Run SCRIPT after processing all FTN packets. Typically this is `%L/ftninpost`.

`ftn2rfc` reads packet files from the input directory or the command line and converts the FTN packets to Internet RFC mail and news, written as mail and news RFC message files to the directories SPOOLDIR/outrfc/mail and SPOOLDIR/outrfc/news, respectively.

[ < ] | [ > ] |  | [ << ] | [ Up ] | [ >> ] |  |  |  |  | [Top] | [Contents] | [Index] | [ ? ]

## 3.14 ftnin -- Frontend for `ftn2rfc`

Usage:

    ftnin  [-options]

Options:

`-n --no-toss`
  Don't call `ftn2rfc` for processing.

`-x --exec-program SCRIPT`
  Execute SCRIPT after `ftn2rfc` processing, typically `%L/ftninpost`.

All standard options are passed to the called `ftn2rfc`.

`ftnin` looks for mail packets addressed to the gateway addresses (all `Address`/`GateAddress` statements in `fidogate.conf`) and calls `ftn2rfc` for each packet.

[ < ] | [ > ] |  | [ << ] | [ Up ] | [ >> ] |  |  |  |  | [Top] | [Contents] | [Index] | [ ? ]

## 3.15 ftninpost -- `ftnin` Post-processing Script

Usage:

    ftninpost  [-options]

This script is run by `ftn2rfc` or `ftnin`, feeding the output in SPOOLDIR/outrfc/mail and SPOOLDIR/outrfc/news to `sendmail` and `rnews`, respectively.

[ < ] | [ > ] |  | [ << ] | [ Up ] | [ >> ] |  |  |  |  | [Top] | [Contents] | [Index] | [ ? ]

## 3.16 ftninrecomb -- `ftnin` Recombining Script

Usage:

    ftninrecomb  [-options]

If `FTNInRecombine` is enabled in `fidogate.conf`, this script wil be run by `ftninpost` to recombine split messages. NOT TESTED FOR RELEASE 4.4!!!

[ < ] | [ > ] |  | [ << ] | [ Up ] | [ >> ] |  |  |  |  | [Top] | [Contents] | [Index] | [ ? ]

## 3.17 ftnmail -- `rfc2ftn` Setuid Frontend

Usage:

    ftnmail  [-options]  [address ...]

Setuid frontend for `rfc2ftn`, passes the options

`-a --addr ADDR`
  Passed to `rfc2ftn` as `-a ADDR -u ADDR`.

`-i --ignore-hosts`
  Passed to `rfc2ftn` as `-i`.

`-O --out-dir DIR`
  Passed to `rfc2ftn` as `-O %S/DIR`.

`ftnmail` should be used for sendmail mailers. DO NOT use `rfc2ftn` directly to avoid security problems.

[ < ] | [ > ] |  | [ << ] | [ Up ] | [ >> ] |  |  |  |  | [Top] | [Contents] | [Index] | [ ? ]

## 3.18 rfc2ftn -- Internet-Fido Gateway Program

Usage:

    rfc2ftn  [-options]  [address ...]

Options:

`-b --news-batch`
  Process news batch (implies `-n`).

`-B --binkley name`
  Set Binkley outbound directory.

`-i --ignore-registration`
  Do not bounce mail to nodes not registered in HOSTS (if `HostsRestricted` in `fidogate.conf` is enabled).

`-m --max-msg n`
  Create new output packet after n messages.

`-n --news-mode`
  Process news message in stdin. Default: mail

`-o --out-packet-file name`
  Write output to FTN packet file name.

`-O --out-packet-dir name`
  Set output directory for FTN packets. Default: SPOOLDIR/outpkt/mail or .../news

`-t --to`
  Get recipient addresses from To, Cc, Bcc headers instead of command line.

`-w --write-outbound flav`
  Write output directly to Binkley .?UT packets in outbound.

`-W --write-crash`
  Write only crash mail directly to Binkley .CUT file.

[ < ] | [ > ] |  | [ << ] | [ Up ] | [ >> ] |  |  |  |  | [Top] | [Contents] | [Index] | [ ? ]

## 3.19 rungate -- Script for Running Gateway Programs

Usage:

    rungate

[ < ] | [ > ] |  | [ << ] | [ Up ] | [ >> ] |  |  |  |  | [Top] | [Contents] | [Index] | [ ? ]

## 3.20 send-fidogate -- Script for Processing News via FIDOGATE

Usage:

    send-fidogate  [hostname]

Processes INN news batch file `/var/spool/news/out.going/`hostname. If hostname is omitted the default `fidogate` is used.

[ < ] | [ > ] |  | [ << ] | [ Up ] | [ >> ] |  |  |  |  | [Top] | [Contents] | [Index] | [ ? ]

## 3.21 ftnhatch -- Hatch new file into file area

Usage:

    ftnhatch  [-options]  area  file  "description"

Options:

`-b --fareas-bbs NAME`
  Use alternate FAREAS.BBS.

`-r --replaces FILE`
  Adds `Replaces` FILE header to generated tic file.

Please note that the file must already reside in the directory for the file area. Copying and hatching a new file to a file area is not yet implemented.

[ < ] | [ > ] |  | [ << ] | [ Up ] | [ >> ] |  |  |  |  | [Top] | [Contents] | [Index] | [ ? ]

## 3.22 ftntick -- Process incoming TIC files

Usage:

    ftntick  [-options]

Options:

`-b --fareas-bbs file`
  Use alternate FAREAS.BBS.

`-I --inbound dir`
  Use alternate inbound directory.

`-t --insecure`
  Insecure processing, allow TIC files without password.

`-x --exec script`
  Run script after sucessfully processing the TIC file. The one and only argument to script is the full path name of the TIC file.

[ < ] | [ > ] |  | [ << ] | [ Up ] | [ >> ] |  |  |  |  | [Top] | [Contents] | [Index] | [ ? ]

## 3.23 ftntickpost -- ftntick Post-processing Script

Usage:

    ftntickpost  [-options]  file.tic

Options:

NOT YET COMPLETELY IMPLEMENTED! Currently the script is only a skeleton with features such as announcement postings and mails to be added in the future.

[ < ] | [ > ] |  | [ << ] | [ Up ] | [ >> ] |  |  |  |  | [Top] | [Contents] | [Index] | [ ? ]

## 3.24 ftn2ftn -- FTN-FTN NetMail Gateway Program

Usage:

    ftn2ftn  [-options]  [packet ... ]

Options:

`-A --address-a Z:N/F.P`
  Set FTN address in network A.

`-B --address-b Z:N/F.P`
  Set FTN address in network B.

`-o --out-packet-file NAME`
  Set output packet file name.

`-O --out-packet-dir NAME`
  Set output packet directory.

This program provides a NetMail gateway between different FTNs, using the (somewhat) standard "User Name%Z:N/F.P" addressing in the FTN from and to fields.

If no packet is given on the command line, `ftn2ftn` looks for packets addressed to the gateway addresses (A and B) in the Binkley outbound. Both gateway addresses must be specified with the `-A` and `-B` options.

If a packet name is passed on the command line, `ftn2ftn` will gate this to the other network A. The gateway address (sender of the mails in network A) is set with `-A` option.

[ < ] | [ > ] |  | [ << ] | [ Up ] | [ >> ] |  |  |  |  | [Top] | [Contents] | [Index] | [ ? ]

## 3.25 ftnexpire -- Utility for expiring MSGID history database

Usage:

    ftnexpire  [-options]

Options:

`-m --maxhistory days`
  Set the maximum number of days for entries in the history database. The days argument supports decimal fractions.

`-w --wait`
  Wait for history database lock file to be released. Default: exit, if history database is locked.

This utility expires and rebuilds the MSGID history database, similar to expire for the INN news system.

If the MSGID history database dupe check is used, `ftnexpire` must be run regularly to keep the history database optimized (if not, accessing the history database will become very slow!). A daily cron job is just the right thing.

[ < ] | [ > ] |  | [ << ] | [ Up ] | [ >> ] |  |  |  |  | [Top] | [Contents] | [Index] | [ ? ]

## 3.26 ftnpack -- Pack Fido ArcMail Packets

Usage:

    ftnpack  [-options]  [packet ... ]

Options:

`-B --binkley dir`
  Set Binkley outbound directory.

`-f --ffx Z:N/F.P`
  Pack ffx control and data files for FTN address Z:N/F.P. You must also set the appropiate input directory with the `-I` option.

`-F --file-dir dir`
  Set directory where `ftnpack` looks for file attachments. Should be the appropiate inbound directory, see also the `runtoss` script. If this option is not specified, no file attachments are processed.

  If `-F /` is specified, `ftnpack` accepts a complete path name in the subject and doesn't search the directory. Warning: this option compromises security to some degree, because it allows any user to send any file readable by the user id running the tosser and mailer!!!

`-g --grade grade`
  Only process packets with grade (single letter).

`-I --in-dir dir`
  Set input directory. Default: %S/toss/route

`-O --out-dir dir`
  Set directory for temporary packets. Default: %S/toss/pack. This is the directory, where packets to be put into arcmail archives will be created.

`-l --lock-file`
  Create lock file while processing.

`-m --maxarc size`
  Set maximum size of an archive to size KByte. If an existing ArcMail archive exceeds this size, `ftnpack` creates a new one.

`-p --packing-file name`
  Read alternate `packing` config file. Default: %C/packing

`-P --pkt`
  Process *.pkt files in the input directory. Default: output files of `ftnroute`.

[ < ] | [ > ] |  | [ << ] | [ Up ] | [ >> ] |  |  |  |  | [Top] | [Contents] | [Index] | [ ? ]

## 3.27 ftnroute -- Route Fido Mail Packets

Usage:

    ftnroute  [-options]  [packet ... ]

Options:

`-g --grade grade`
  Only process packets with grade (single letter).

`-I --in-dir name`
  Set input directory. Default: %S/toss/toss

`-O --out-dir name`
  Set output directory. Default: %S/toss/route

`-l --lock-file`
  Create lock file while processing.

`-r --routing-file name`
  Read alternate `routing` config file. Default: %C/routing

`-M --maxopen n`
  Set maximum number of concurrently open packet filess to n. Default: `MaxOpenFiles` config

[ < ] | [ > ] |  | [ << ] | [ Up ] | [ >> ] |  |  |  |  | [Top] | [Contents] | [Index] | [ ? ]

## 3.28 ftntoss -- Toss Fido Mail Packets

Usage:

    ftntoss  [-options]  [packet ... ]

Options:

`-d --no-dupecheck`
  Disabled dupe check (if `DupeCheck` is enabled in `config.main`).

`-g --grade grade`
  Only process packets with grade (single letter).

`-I --in-dir name`
  Set input directory. Default: PINBOUND

`-O --out-dir name`
  Set output directory. Default: %S/toss/toss

`-l --lock-file`
  Create lock file while processing.

`-t --insecure`
  Insecure EchoMail tossing, don't check sender against nodes listed in AREAS.BBS.

`-n --toss-all`
  Toss all EchoMail, even messages not addressed to one of our own AKAs (most probably routed EchoMail).

`-p --passthru`
  Make all areas passthru (see also `#` in areas.bbs).

`-r --routing-file name`
  Read alternate `routing` config file. Default: %C/routing

`-s --strip-attribute`
  Strip Hold and Crash attribute from incoming NetMails.

`-m --maxmsg n`
  Flush/close all output packet files after reading n messages.

`-x --maxmsg-exit n`
  Flush/close all output packet files after reading n messages and processing the current input packet, then exit.

`-M --maxopen n`
  Set maximum number of concurrently open packet filess to n. Default: `MaxOpenFiles` config

`-b --fareas-bbs file`
  Use alternate areas.bbs.

[ < ] | [ > ] |  | [ << ] | [ Up ] | [ >> ] |  |  |  |  | [Top] | [Contents] | [Index] | [ ? ]

## 3.29 runin -- Script for Processing Inbound Packets

Usage:

    runin

No options.

Runs the tosser (unpack, toss, tick) for the inbound directories:

- Insecure inbound
- Secure inbound
- UUEncoded mail inbound
- FTP inbound

All log messages are written to %G/log-in.

Edit the script `src/toss/runin.sh` to meet your local requirements.

[ < ] | [ > ] |  | [ << ] | [ Up ] | [ >> ] |  |  |  |  | [Top] | [Contents] | [Index] | [ ? ]

## 3.30 runmail -- Script for Processing Gateway Mail Output Packets

Usage:

    runmail

No options.

Runs the tosser for the gateway mail output directory %S/outpkt/mail, all log messages are written to %G/log-out.

Edit the script `src/toss/runmail.sh` to meet your local requirements.

[ < ] | [ > ] |  | [ << ] | [ Up ] | [ >> ] |  |  |  |  | [Top] | [Contents] | [Index] | [ ? ]

## 3.31 runnews -- Script for Processing Gateway News Output Packets

Usage:

    runnews

No options.

Runs the tosser for the gateway news output directory %S/outpkt/news, all log messages are written to %G/log-out.

Edit the script `src/toss/runout.sh` to meet your local requirements.

[ < ] | [ > ] |  | [ << ] | [ Up ] | [ >> ] |  |  |  |  | [Top] | [Contents] | [Index] | [ ? ]

## 3.32 runout -- Script for Processing Miscellaneous Output Packets

Usage:

    runout

No options.

Runs the tosser for the miscellaneous (ftnafpkt, ftnafutil, ftnoutpkt) output directory %S/outpkt, all log messages are written to %G/log-out.

Edit the script `src/toss/runout.sh` to meet your local requirements.

[ < ] | [ > ] |  | [ << ] | [ Up ] | [ >> ] |  |  |  |  | [Top] | [Contents] | [Index] | [ ? ]

## 3.33 runtoss -- Script for Running the Tosser Programs

Usage:

    runtoss  type

No options.

Types:

Please the the script source code `src/toss/runtoss.sh` for available type parameters and feel free to adapt it to your requirements.

[ < ] | [ > ] |  | [ << ] | [ Up ] | [ >> ] |  |  |  |  | [Top] | [Contents] | [Index] | [ ? ]

## 3.34 rununpack -- Script for Unpacking Inbound ArcMail Archives

Usage:

    rununpack  type

No options.

Types:

Please see the script source code `src/toss/rununpack.sh` for available type parameters and feel free to adapt it to your requirements.

Edit the script if necessary to change unpacker program names. The required programs are `unzip`, `unarj`, `lha`, `zoo`, `arc`, `rar`.

[ < ] | [ > ] |  | [ << ] | [ Up ] | [ >> ] |  |  |  |  | [Top] | [Contents] | [Index] | [ ? ]

## 3.35 ftnbsy -- Create/delete Binkley Busy Filess

Usage:

    ftnbsy  [-options]  Z:N/F.P ...

Options:

`-t --test`
  Test for existing busy file.

`-l --lock`
  Create busy file, fail if it already exists.

`-u --unlock`
  Remove busy file.

`-w --wait`
  Wait for busy file to be released (when `-l` option is given).

[ < ] | [ > ] |  | [ << ] | [ Up ] | [ >> ] |  |  |  |  | [Top] | [Contents] | [Index] | [ ? ]

## 3.36 ftnconfig -- Retrieve information from FIDOGATE config files

Usage:

    ftnconfig  [-options]  parameter

Options:

`-l --no-newline`
  No output of newline after the parameter value.

`-n --no-output`
  No output, exit code only.

`-t --test-only`
  Output `1` if the parameter is present, `0` if not.

Special parameters:

`=fqdn`
  Fully qualified domain name.

`=hostname`
  Hostname.

`=domainname`
  Domainname.

`=hostsdomain`
  Domain for entries in `hosts` config files.

[ < ] | [ > ] |  | [ << ] | [ Up ] | [ >> ] |  |  |  |  | [Top] | [Contents] | [Index] | [ ? ]

## 3.37 ftnfattach -- Outbound file attaches

Usage:

    ftnfattach  [-options]  Z:N/F.P  file ...

Options:

`-B --binkley name`
  Set Binkley outbound directory.

`-F --flavor name`
  Set flavor of outbound FLO file to name: `Hold`, `Normal`, `Direct`, or `Crash`.

The file name may start with `^` or `#`, indicating that the file should be deleted or truncated, respectively, after sending.

[ < ] | [ > ] |  | [ << ] | [ Up ] | [ >> ] |  |  |  |  | [Top] | [Contents] | [Index] | [ ? ]

## 3.38 ftnflo -- Process Binkley Outbound FLO Files and Attachments

Usage:

    ftnflo  [-options]  Z:N/F.P  ...

Options:

`-B --binkley name`
  Set Binkley outbound directory.

`-l --list`
  List entries in FLO file.

`-n --no-delete`
  Don't delete FLO entries after processing.

`-x --exec command`
  Execute command for every FLO entry, delete entry after successful processing. `%s` in command is replaced with the filename of the FLO entry.

The file name may start with `^` or `#`, indicating that the file should be deleted or truncated, respectively, after sending.

[ < ] | [ > ] |  | [ << ] | [ Up ] | [ >> ] |  |  |  |  | [Top] | [Contents] | [Index] | [ ? ]

## 3.39 ftnlock -- Create/Remove Lock Files

Usage:

    ftnlock  [-options]  [NAME]  [ID]

Options:

`-l --lock`
  Create lock file NAME, fail if it already exists (exit code=2). If NAME is not specified, the default `ftnlock` is used. The optional parameter ID specifies the contents of the lock file, the default is `-none-`.

`-u --unlock`
  Remove lock file NAME.

`-w --wait`
  Wait while creating lock file. Default: immediately return, if the lock file can't be created because it already exists.

Lock files are created as %K/NAME.

[ < ] | [ > ] |  | [ << ] | [ Up ] | [ >> ] |  |  |  |  | [Top] | [Contents] | [Index] | [ ? ]

## 3.40 ftnlog -- Write Message to Log File

Usage:

    ftnlog  [-options]  message text

Options:

`-p --program NAME`
  Set program name for logging.

This program is used to write a log message from a shell script. The log file name may be specified with the `FIDOGATE_LOGFILE` environment variable.

[ < ] | [ > ] |  | [ << ] | [ Up ] | [ >> ] |  |  |  |  | [Top] | [Contents] | [Index] | [ ? ]

## 3.41 ftnoutpkt -- Create Fido Message Packets

Usage:

    ftnoutpkt  [-options]  "user name @ z:n/f.p"  "..."

Options:

`-f --from "user name @ z:n/f.p"`
  Set sender Fido address.

`-s --subject "subject"`
  Set message subject.

`-O --out-dir dir`
  Set output directory. Default: %S/outpkt

This utility can be used to create native Fido messages. The message body text is read from stdin.

[ < ] | [ > ] |  | [ << ] | [ Up ] | [ >> ] |  |  |  |  | [Top] | [Contents] | [Index] | [ ? ]

## 3.42 ftnseq -- Command Line Interface to Sequencer Files

Usage:

    ftnseq  [-options]  sequencer

This utilitity increments the named sequencer file and prints the resulting value to stdout. Useful for accessing FIDOGATE sequencer files from perl and shell scripts.

[ < ] | [ > ] |  | [ << ] | [ Up ] | [ >> ] |  |  |  |  | [Top] | [Contents] | [Index] | [ ? ]

## 3.43 pktdebug -- FTN mail packet debugger

Usage:

    pktdebug  [-options]  file ...

Options (standard options not supported):

`-m --msg-header`
  Print message header.

`-t --msg-text`
  Print message text. Implies `-m`.

`-s --short`
  Print contents in short format: packet from/to address and number of NetMail and EchoMail messages.

`-v --verbose`
  Increase verbose/debug level.

`-h --help`
  Help on `pktdebug` usage.

This utility displays the packet header and optionally the message header and message body contents.

See also the `util/pktmore` utitility, which pipes the output of `pktdebug` to `$PAGER`.

[ < ] | [ > ] |  | [ << ] | [ Up ] | [ >> ] |  |  |  |  | [Top] | [Contents] | [Index] | [ ? ]

## 3.44 pktmore -- Pager frontend for `pktdebug`

Usage:

    pktmore  file ...

`pktmore` uses the environment variable `PAGER` for the pager program. Default: `more`

[ < ] | [ > ] |  | [ << ] | [ Up ] | [ >> ] |  |  |  |  | [Top] | [Contents] | [Index] | [ ? ]

## 3.45 sumcrc -- CRC Checksum Utility

Usage:

    sumcrc  [-options]  file ...

Options (standard options not supported):

`-1 --skip-first-line`
  Skip first line in file. Useful for computing nodelist CRC.

`-3 --crc32`
  Compute 32 bit CRC checksum, using the standard 32 bit polynomial (same as in ZModem, ZIP). Default: 16 bit CRC CCITT polynomial.

`-6 --crc16`
  Use alternate 16 bit CRC16 polynomial.

`-x --hex`
  Output CRC value in hex. Default: decimal

`-z --eof-at-ctrl-z`
  The Ctrl-Z character (`^Z`) indicates end-of-file (MSDOS kludge).

`-v --verbose`
  Increase verbose/debug level.

`-h --help`
  Help on `sumcrc` usage.

Use `sumcrc -1z` to compute the checksum for a standard Fido nodelist. See also the nodelist processing scripts in `scripts/nodelist/nl-*`.

[ << ] | [ >> ] |  |  |  |  |  | [Top] | [Contents] | [Index] | [ ? ]

This document was generated by Martin Junius on August, 26 2004 using texi2html