.\" 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 "RMLINK 1"
.TH RMLINK 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"
rmLink.pl \- remove a link
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
perl rmLink.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
\&    \-\-delete              delete the link definition lines instead of
\&                          commenting them out
\&    \-\-backup              backup configuration file before changing
\&    \-\-report [area]       send a report to the echo or netmail area
\&    \-\-nolog               do not log the actions in the rmLink.log file
\&    \-\-quiet               do not print to terminal window
\&    \-\-report\-list         include the listing of deleted files in the report
\&    \-\-nolog\-list          do not include the list of deleted files
\&                          in the log file
\&    \-\-noterm\-list         do not print the list of deleted files to the
\&                          terminal
\&    \-\-dry\-run             perform a trial run with no changes made
\&    \-\-version             print version and exit
\&    \-\-help                print help and exit
\&
\&  To print full documentation run \`perldoc rmLink.pl\`.
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
rmLink.pl unsubscribes the specified link from all echos and file echos,
removes netmail, echomail and files intended for the link taking all the
necessary information from fidoconfig and comments out or deletes the lines of
the link definition.
.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 for some options.
.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 address of the link which will be deleted.
.IP "\fB\-d\fR" 4
.IX Item "-d"
.PD 0
.IP "\fB\-\-delete\fR" 4
.IX Item "--delete"
.IP "\fB\-\-nodelete\fR" 4
.IX Item "--nodelete"
.PD
On default (or when \-\-nodelete is used), the link definition is commented out.
If \-\-delete option is used, the link definition is deleted.
.IP "\fB\-b\fR" 4
.IX Item "-b"
.PD 0
.IP "\fB\-\-backup\fR" 4
.IX Item "--backup"
.IP "\fB\-\-nobackup\fR" 4
.IX Item "--nobackup"
.PD
On default (or when \-\-nobackup is used), the configuration file is not backed
up before deleting link definition from it.  If the \-\-backup option is used, a
backup of the configuration file with the link definition is made with the .bak
filename extension.
.IP "\fB\-\-report\fR [area]" 4
.IX Item "--report [area]"
Send a report about deleting the link to the echo or netmail area.
.Sp
If the name of the area is omitted, then  \fBReportTo\fR statement
in fidoconfig is used to define the area to send report to.
.Sp
If the whole option is omitted, a report will not be sent. This option does not
influence printing to the log file or to the terminal.
.IP "\fB\-\-log\fR" 4
.IX Item "--log"
.PD 0
.IP "\fB\-\-nolog\fR" 4
.IX Item "--nolog"
.PD
On default (or when \-\-log option is used), logging to rmLink.log is switched
on. If the \-\-nolog option is used, the script does not print anything to the
log file. This option does not influence sending a report or printing to
terminal window. The rmLink.log file is created in the directory defined by
\&\fBlogFileDir\fR statement in fidoconfig. If the statement is absent, there is no
logging even when \-\-log option is used.
.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 sending a report or printing
to a log file.
.IP "\fB\-\-report\-list\fR" 4
.IX Item "--report-list"
.PD 0
.IP "\fB\-\-noreport\-list\fR" 4
.IX Item "--noreport-list"
.PD
On default (or when \-\-noreport\-list is used), the list of deleted files is
excluded from the report. Please use \-\-report\-list if you want to include
the list of deleted files in the report.
.IP "\fB\-\-log\-list\fR" 4
.IX Item "--log-list"
.PD 0
.IP "\fB\-\-nolog\-list\fR" 4
.IX Item "--nolog-list"
.PD
On default (or when \-\-log\-list is used), the list of deleted files is included
in the log file. Please use \-\-nolog\-list if you want to exclude the list of
deleted files from the log file.
.IP "\fB\-\-term\-list\fR" 4
.IX Item "--term-list"
.PD 0
.IP "\fB\-\-noterm\-list\fR" 4
.IX Item "--noterm-list"
.PD
On default (or when \-\-term\-list is used), the list of deleted files is printed
to the terminal window. Please use \-\-nolog\-list if you do not want to print the
list of deleted files to the terminal window.
.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 the required operation is successfully done, the exit code is 0. If help 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