.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "RMLINKMAIL 1"
.TH RMLINKMAIL 1 "2022-08-29" "perl v5.30.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
rmLinkMail.pl \- remove netmail, echomail and files of a link
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
perl rmLinkMail.pl [options]
.PP
.Vb 10
\&  Options:
\&    \-\-config path         path to fidoconfig
\&    \-\-bindir directory    the directory holding hpt if it is not in the PATH
\&    \-\-address ftnAddress  the link address
\&    \-\-netmail             exclude netmail from the files to be deleted
\&    \-\-echomail            exclude echomail from the files to be deleted
\&    \-\-fileecho            exclude fileechomail from the files to be deleted
\&    \-\-other\-files         exclude other files in the link\*(Aqs filebox
\&    \-\-box                 do not delete an empty filebox
\&    \-\-report              send a report to the echo or netmail area
\&    \-\-nolog               do not log anything in the rmLinkMail.log file
\&    \-\-quiet               do not print to terminal window
\&    \-\-version             print version and exit
\&    \-\-help                print help and exit
\&
\&  To print full documentation run \`perldoc rmLinkMail.pl\`.
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
rmLinkMail.pl removes netmail, echomail and files of the specified link taking
all the necessary information from fidoconfig.
.SH "OPTIONS"
.IX Header "OPTIONS"
All options are case insensitive and their names may be abbreviated to
uniqueness. One may also use single-character option names with one dash
instead of long option names with two dashes.
.IP "\fB\-c\fR path" 4
.IX Item "-c path"
.PD 0
.IP "\fB\-\-config\fR path" 4
.IX Item "--config path"
.PD
You have to supply full path to fidoconfig here if \s-1FIDOCONFIG\s0 environment
variable is not defined. Otherwise you may omit the option.
.IP "\fB\-\-bindir\fR directory" 4
.IX Item "--bindir directory"
You have to specify the directory where hpt resides if it is not in the \s-1PATH.\s0
.IP "\fB\-a\fR ftnAddress" 4
.IX Item "-a ftnAddress"
.PD 0
.IP "\fB\-\-address\fR ftnAddress" 4
.IX Item "--address ftnAddress"
.PD
The link address, the files of which will be deleted.
.IP "\fB\-\-netmail\fR" 4
.IX Item "--netmail"
Exclude netmail from the files to be deleted.
.IP "\fB\-e\fR" 4
.IX Item "-e"
.PD 0
.IP "\fB\-\-echomail\fR" 4
.IX Item "--echomail"
.PD
Exclude echomail from the files to be deleted.
.IP "\fB\-f\fR" 4
.IX Item "-f"
.PD 0
.IP "\fB\-\-fileecho\fR" 4
.IX Item "--fileecho"
.PD
Exclude fileechomail from the files to be deleted.
.IP "\fB\-o\fR" 4
.IX Item "-o"
.PD 0
.IP "\fB\-\-other\-files\fR" 4
.IX Item "--other-files"
.PD
Exclude files in the link's filebox not belonging to netmail, echomail or
fileechomail from the files to be deleted.
.IP "\fB\-b\fR" 4
.IX Item "-b"
.PD 0
.IP "\fB\-\-box\fR" 4
.IX Item "--box"
.PD
Do not delete an empty filebox. On default the empty filebox is deleted.
.IP "\fB\-r\fR [area]" 4
.IX Item "-r [area]"
.PD 0
.IP "\fB\-\-report\fR [area]" 4
.IX Item "--report [area]"
.PD
Send a report about the deleted files to the echo or netmail area.
.Sp
If the name of the area is omitted, then  \fBReportTo\fR statement
in fidoconfig is used.
.Sp
If the whole option is omitted, a report will not be sent.
.IP "\fB\-l\fR" 4
.IX Item "-l"
.PD 0
.IP "\fB\-\-log\fR" 4
.IX Item "--log"
.PD
Log all actions to rmLinkMail.log file if \fBLogFileDir\fR is defined in
fidoconfig. It is not necessary to use it since on default logging is switched
on.
.IP "\fB\-\-nolog\fR" 4
.IX Item "--nolog"
Do not print anything to rmLinkMail.log file. This option does not influence
printing to terminal window.
.IP "\fB\-q\fR" 4
.IX Item "-q"
.PD 0
.IP "\fB\-\-quiet\fR" 4
.IX Item "--quiet"
.IP "\fB\-\-noquiet\fR" 4
.IX Item "--noquiet"
.PD
On default (or when \-\-noquiet option is used), printing to terminal window is
switched on. If the \-\-quiet option is used, the script does not print to the
terminal window. This option does not influence printing
to a log file.
.IP "\fB\-\-dry\-run\fR" 4
.IX Item "--dry-run"
.PD 0
.IP "\fB\-\-nodry\-run\fR" 4
.IX Item "--nodry-run"
.PD
If \f(CW\*(C`\-\-dry\-run\*(C'\fR is used, perform a trial run with no changes made. Nothing is
deleted, but the same output is produced as in a real run except the error
messages that may appear during the actual run.
.IP "\fB\-v\fR" 4
.IX Item "-v"
.PD 0
.IP "\fB\-\-version\fR" 4
.IX Item "--version"
.PD
Print the program version and exit
.IP "\fB\-h\fR" 4
.IX Item "-h"
.PD 0
.IP "\fB\-\-help\fR" 4
.IX Item "--help"
.PD
Print a brief help and exit
.SH "EXIT CODE"
.IX Header "EXIT CODE"
If required operation is successfully done, the exit code is 0. If help or
version is printed, the exit code is 1, otherwise it is more than 1.
.SH "RESTRICTION"
.IX Header "RESTRICTION"
SeparateBundles keyword in fidoconfig is not supported.
.SH "AUTHOR"
.IX Header "AUTHOR"
Michael Dukelsky 2:5020/1042
