![]()
|
3. FIDOGATE Programs
Almost all FIDOGATE programs support the following standard options, which therefore aren't listed in the sections describing the individual programs:
The option
All options and config statements which take file or directory names
accept the following
3.1 ftnaf -- AreafixUsage:
Options:
Commands:
All command keywords may be prefixed by
For proper operation
3.2 ftnafmail -- Areafix Mail FrontendUsage:
Options:
This is the setuid mail frontend for
3.3 ftnafpkt -- Areafix packet processorUsage:
Options:
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
3.4 ftnafutil -- Areafix utilityUsage:
Options:
Commands:
Auto-subscribe/unsubscribe will only be used for areas marked with the
state option. State
3.5 charsetc -- Character set translation table compilerUsage:
3.6 ffx -- Remote Execution via Fido MailerUsage:
Options:
3.7 ffxmail -- ffx Frontend for Sending MailUsage:
No options.
3.8 ffxnews -- ffx Frontend for Sending NewsUsage:
No options.
3.9 ffxqt -- Execute ffx RequestsUsage:
Options:
3.10 ffxrmail -- Rmail Command for FFXUsage:
Perl script to be called by
3.11 runffx -- Script for Running FFX ProgramsUsage:
3.12 send-ffx -- Script for Processing News via FFXUsage:
Processes INN news batch file
3.13 ftn2rfc -- FTN-Internet Gateway ProgramUsage:
Options:
3.14 ftnin -- Frontend for
|
ftnin [-options] |
Options:
-n --no-toss
ftn2rfc
for processing.
-x --exec-program SCRIPT
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] | [ ? ] |
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] | [ ? ] |
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] | [ ? ] |
rfc2ftn
Setuid Frontend Usage:
ftnmail [-options] [address ...] |
Setuid frontend for rfc2ftn
, passes the options
-a --addr ADDR
rfc2ftn
as -a ADDR -u ADDR
.
-i --ignore-hosts
rfc2ftn
as -i
.
-O --out-dir DIR
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] | [ ? ] |
Usage:
rfc2ftn [-options] [address ...] |
Options:
-b --news-batch
-n
).
-B --binkley name
-i --ignore-registration
HostsRestricted
in fidogate.conf
is enabled).
-m --max-msg n
-n --news-mode
-o --out-packet-file name
-O --out-packet-dir name
-t --to
-w --write-outbound flav
-W --write-crash
[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
Usage:
rungate |
[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
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] | [ ? ] |
Usage:
ftnhatch [-options] area file "description" |
Options:
-b --fareas-bbs NAME
-r --replaces FILE
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] | [ ? ] |
Usage:
ftntick [-options] |
Options:
-b --fareas-bbs file
-I --inbound dir
-t --insecure
-x --exec script
[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
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] | [ ? ] |
Usage:
ftn2ftn [-options] [packet ... ] |
Options:
-A --address-a Z:N/F.P
-B --address-b Z:N/F.P
-o --out-packet-file NAME
-O --out-packet-dir NAME
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] | [ ? ] |
Usage:
ftnexpire [-options] |
Options:
-m --maxhistory days
-w --wait
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] | [ ? ] |
Usage:
ftnpack [-options] [packet ... ] |
Options:
-B --binkley dir
-f --ffx Z:N/F.P
-I
option.
-F --file-dir dir
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
-I --in-dir dir
-O --out-dir dir
-l --lock-file
-m --maxarc size
ftnpack
creates a new one.
-p --packing-file name
packing
config file. Default: %C/packing
-P --pkt
ftnroute
.
[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
Usage:
ftnroute [-options] [packet ... ] |
Options:
-g --grade grade
-I --in-dir name
-O --out-dir name
-l --lock-file
-r --routing-file name
routing
config file. Default: %C/routing
-M --maxopen n
MaxOpenFiles
config
[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
Usage:
ftntoss [-options] [packet ... ] |
Options:
-d --no-dupecheck
DupeCheck
is enabled in
config.main
).
-g --grade grade
-I --in-dir name
-O --out-dir name
-l --lock-file
-t --insecure
-n --toss-all
-p --passthru
#
in areas.bbs).
-r --routing-file name
routing
config file. Default: %C/routing
-s --strip-attribute
-m --maxmsg n
-x --maxmsg-exit n
-M --maxopen n
MaxOpenFiles
config
-b --fareas-bbs file
[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
Usage:
runin |
No options.
Runs the tosser (unpack, toss, tick) for the inbound directories:
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] | [ ? ] |
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] | [ ? ] |
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] | [ ? ] |
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] | [ ? ] |
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] | [ ? ] |
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] | [ ? ] |
Usage:
ftnbsy [-options] Z:N/F.P ... |
Options:
-t --test
-l --lock
-u --unlock
-w --wait
-l
option is given).
[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
Usage:
ftnconfig [-options] parameter |
Options:
-l --no-newline
-n --no-output
-t --test-only
1
if the parameter is present, 0
if not.
Special parameters:
=fqdn
=hostname
=domainname
=hostsdomain
hosts
config files.
[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
Usage:
ftnfattach [-options] Z:N/F.P file ... |
Options:
-B --binkley name
-F --flavor 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] | [ ? ] |
Usage:
ftnflo [-options] Z:N/F.P ... |
Options:
-B --binkley name
-l --list
-n --no-delete
-x --exec command
%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] | [ ? ] |
Usage:
ftnlock [-options] [NAME] [ID] |
Options:
-l --lock
ftnlock
is used. The
optional parameter ID specifies the contents of the lock file, the
default is -none-
.
-u --unlock
-w --wait
Lock files are created as %K/NAME.
[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
Usage:
ftnlog [-options] message text |
Options:
-p --program NAME
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] | [ ? ] |
Usage:
ftnoutpkt [-options] "user name @ z:n/f.p" "..." |
Options:
-f --from "user name @ z:n/f.p"
-s --subject "subject"
-O --out-dir dir
This utility can be used to create native Fido messages. The message body text is read from stdin.
[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
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] | [ ? ] |
Usage:
pktdebug [-options] file ... |
Options (standard options not supported):
-m --msg-header
-t --msg-text
-m
.
-s --short
-v --verbose
-h --help
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] | [ ? ] |
pktdebug
Usage:
pktmore file ... |
pktmore
uses the environment variable PAGER
for the pager
program. Default: more
[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
Usage:
sumcrc [-options] file ... |
Options (standard options not supported):
-1 --skip-first-line
-3 --crc32
-6 --crc16
-x --hex
-z --eof-at-ctrl-z
^Z
) indicates end-of-file (MSDOS kludge).
-v --verbose
-h --help
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] | [ ? ] |