The current FIDOGATE distribution includes the following programs and scripts:
ffx
ffxbatch
ffxmail
ffx
frontend for sending mail
ffxqt
ffx
requests
ffxrmail
rmail
command for ffxqt
ffxrun
ffxqt
ftn2ftn
ftn2rfc
ftnaf
ftnafmail
ftnbounce
ftnbsy
ftnconfig
ftnhatch
ftnin
ftn2rfc
ftninpost
ftninrecomb
ftnlock
ftnlog
ftnpack
ftnroute
ftnseq
ftntick
ftntoss
ftnfattach
pktdebug
rfc2ftn
rundf
runin
runout
runtoss
rununpack
sumcrc
ffx
frontend for sending mail
ffx
requests
rmail
command for ffxqt
ffxqt
ftn2rfc
Almost all FIDOGATE programs support standard options, which aren't listed in the following sections describing the individual programs:
-v --verbose
-h --help
-c --config name
""
means none. name may
start with %L/
, indicating a file relative to LIBDIR.
-L --lib-dir name
-S --spool-dir name
-a --addr Z:N/F.P
-u --uplink-addr Z:N/F.P
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:
%L
LibDir
%S
SpoolDir
%G
LogDir
%O
Outbound
%I
Inbound
%P
PInbound
%U
UUInbound
Usage:
ffx [-options] Z:N/F.P command
Options:
-b --batch-dir dir
-n
.
-B --binkley name
-F --flavor flavor
Hold
, Normal
,
Direct
, or Crash
.
-g --grade grade
-n --nocompression
The compression program (gzip
) and other are hardcoded in the
ffx.c
source code.
Usage:
ffxbatch [-options] Z:N/F.P command
Options:
-b --batch-dir dir
ffx -b
dir. The files in this
directory will be archived and transfered as a single ffx
command.
-B --binkley name
-F --flavor flavor
Hold
, Normal
,
Direct
, or Crash
.
-g --grade grade
-w --wait-bsy
ffx
-Jobs.
The name of the archiving program (zip
) is hardcoded in the
ffxbatch.c
source.
Usage:
ffxmail Z:N/F.P address ...
No options.
ffxmail
calls ffx
in batch mode (-b
), selecting the
batch directory from the node address. Modify the script
(src/ffxmail.sh
) for other addresses/batch directories.
Usage:
ffxqt [-options]
Options:
-g --grade grade
-I --inbound name
f???????.ffx
control files
are read from. Default: INBOUND
-t --insecure
ffxqt
searches the input directory for control files and executes
the requested commands. Commands are executed by running
LIBDIR/ffxqt-dir/command, so every allowed command must reside as a
script or symbolic link there.
Some program/paths are hard coded in the ffxqt.c
code.
rmail
CommandsUsage:
ffxrun [-v]
Perl script to be called as rmail
by ffxqt
. This replaces
/bin/rmail
(UUCP), calling /usr/lib/sendmail
directly with
appropiate options.
Installed as LIBDIR/ffxqt-dir/rmail
.
Usage:
ffxrun [ffxqt options]
This script runs ffxqt
twice (the second run for processing batch
archives unpacked by the first one). All command line arguments are passed
to ffxqt
.
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.
Usage:
ftn2rfc [-options] [packet ... ]
Options:
-1 --single-articles
tmpnews
), not news
batches containing several articles (batch is default).
-t --insecure
-I --inbound-dir NAME
-l --lock-file
-x --exec-program SCRIPT
%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 files and news batches to the directories
SPOOLDIR/in/mail and SPOOLDIR/in/news, respectively.
Usage:
ftnaf [-options] [Z:N/F.P command ]
Options:
-m --mail
-r --no-reply
-n --no-rewrite
-b --areas-bbs NAME
-F --filefix
Commands:
listall
list
query
unlinked
passwd Z:N/F.P PASSWORD
password Z:N/F.P PASSWORD
pass Z:N/F.P PASSWORD
add AREA
+AREA
AREA
remove AREA
delete AREA
del AREA
-AREA
help
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
(see config.h
configuration).
Usage:
ftnafmail [-options]
Options:
-F --filefix
ftnaf
as Filefix program.
This is the setuid mail frontend for ftnaf
to be run from the
sendmail aliases:
# Areafix/Filefix - FIDOGATE ftnaf areafix: "|/usr/local/lib/fidogate/ftnafmail" areamgr: areafix filefix: "|/usr/local/lib/fidogate/ftnafmail -F" filemgr: filefix
Usage:
ftnbounce [-options] [packet ... ]
Options:
NOT YET IMPLEMENTED. (Only program skeleton is there.)
Usage:
ftnbsy [-options] Z:N/F.P ...
Options:
-t --test
-l --lock
-u --unlock
-w --wait
-l
option is given).
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.
Usage:
ftnhatch [-options] area file "description"
Options:
-b --fareas-bbs NAME
ftn2rfc
Usage:
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
statements in config
) and calls ftn2rfc
for each packet.
Usage:
ftninpost [-options]
This script is run by ftn2rfc
or ftnin
, feeding the output
in SPOOLDIR/in/mail and SPOOLDIR/in/news to sendmail
and
rnews
, respectively.
Usage:
ftninrecomb [-options]
If FTNInRecombine
is enabled in config.gate
, this script
wil be run by ftninpost
to recombine split messages.
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 SPOOLDIR/locks/NAME.
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 LOGFILE
environment variable.
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: LIBDIR/packing
-P --pkt
ftnroute
.
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: LIBDIR/routing
-M --maxopen n
MAXOPENFILES
from config.h
)
Usage:
ftnseq [-options] sequencer
This utilitity increments the named sequencer file outputs the resulting value to standard output. Useful for accessing FIDOGATE sequencer files from perl and shell scripts.
Usage:
ftntick [-options]
Options:
-b --fareas-bbs file
-I --inbound dir
-t --insecure
Usage:
ftntoss [-options] [packet ... ]
Options:
-g --grade grade
-I --in-dir name
-O --out-dir name
-l --lock-file
-t --insecure
-n --toss-all
-n --passthru
#
in areas.bbs).
-r --routing-file name
routing
config file. Default: LIBDIR/routing
-s --strip-attribute
-m --maxmsg n
-x --maxmsg-exit n
-M --maxopen n
MAXOPENFILES
from config.h
)
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.
Usage:
pktdebug [-options] file ...
Options (standard options not supported):
-m --msg-header
-t --msg-text
-m
.
-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
.
Usage:
rfc2ftn [-options] [address ...]
Options:
-b --news-batch
-n
).
-B --binkley name
-i --ignore-registration
HOSTS_RESTRICTED
in config.h
is enabled).
-n --news-mode
-o --out-packet-file name
-O --out-packet-dir name
-t --to
-w --write-outbound flav
-W --write-crash
Usage:
rundf dir
No options.
This shell script returns the free disk space (kB) of the file system
containing dir. It is called by runtoss
for the directories
OUTBOUND
and SPOOLDIR
.
As distributed with FIDOGATE this script requires df
from the GNU
file utilities. If you don't have this one, you must adapt
src/rundf.sh
to the output of your df
.
Usage:
runin
No options.
Runs the tosser for the inbound directories:
rununpack
)
runtoss
)
rununpack
)
runtoss
)
All log messages are written to LIBDIR/log-in.
Edit this script (src/runin.sh
) to meet your local
requirements.
Usage:
runout
No options.
Runs the tosser for the gateway output directory, all log messages are written to LIBDIR/log-out.
Edit this script (src/runout.sh
) to meet your local
requirements.
Usage:
runtoss type
No options.
Types:
normal
out
rfc2ftn
(input SPOOLDIR/out).
pin
in
Edit the script (src/runtoss.sh
) for configuration options:
maximum number of open files, maximum number of messages, maximum
archive size, minimum free disk space.
Usage:
rununpack type
No options.
Types:
pin
in
It requires the file
command and the following definitions in
LIBDIR/magic
to work properly (done by make install):
# ----- Archiver ---------------------------------- 0 string PK ZIP Archive 0 byte 0x1a ARC Archive 2 string -lh LHA Archive 0 string ZOO ZOO Archive 0 short 0xea60 ARJ Archive 0 short 0x60ea ARJ Archive
Edit the script (src/rununpack.sh
) if necessary, changing
unpacker names. The required programs are unzip
, unarj
,
lha
(rc
), zoo
, arc
.
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.
Go to the first, previous, next, last section, table of contents.