summaryrefslogtreecommitdiffabout
authorSergey Poznyakoff <gray@gnu.org.ua>2013-03-05 20:09:24 (GMT)
committer Sergey Poznyakoff <gray@gnu.org.ua>2013-03-05 20:09:24 (GMT)
commit8f8a1c98f84669306d1489ddc5d55b6f589df9be (patch) (side-by-side diff)
tree9cb03914f08dea95f1713010d94b274c6458d6ae
parentc56e18d5a97384a33941a9c0acf0872df16f2f8d (diff)
downloadalck-8f8a1c98f84669306d1489ddc5d55b6f589df9be.tar.gz
alck-8f8a1c98f84669306d1489ddc5d55b6f589df9be.tar.bz2
Add a manpage.
Diffstat (more/less context) (show whitespace changes)
-rw-r--r--alck.1155
1 files changed, 155 insertions, 0 deletions
diff --git a/alck.1 b/alck.1
new file mode 100644
index 0000000..6e842ae
--- a/dev/null
+++ b/alck.1
@@ -0,0 +1,155 @@
+.\" This file is part of ALCK -*- nroff -*-
+.\" Copyright (C) 2013 Sergey Poznyakoff
+.\"
+.\" Alck is free software; you can redistribute it and/or modify
+.\" it under the terms of the GNU General Public License as published by
+.\" the Free Software Foundation; either version 3, or (at your option)
+.\" any later version.
+.\"
+.\" Alck is distributed in the hope that it will be useful,
+.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
+.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+.\" GNU General Public License for more details.
+.\"
+.\" You should have received a copy of the GNU General Public License
+.\" along with Alck. If not, see <http://www.gnu.org/licenses/>.
+.TH ALCK 1 "March 5, 2013" "ALCK"
+.SH NAME
+alck \- check MTA alias files
+.SH SYNOPSIS
+\fBalck\fR [\fB\-d\fR \fILEVEL\fR] [\fB\-T\fR \fIFILE\fR]\
+ [\-\fBruv\fR] [\fB\-w\fR \fIFILE\fR] \fIFILE\fR
+.sp
+\fBalck\fR \fB\-h\fR
+.sp
+\fBalck\fR \fB\-V\fR
+.SH DESCRIPTION
+.B Alck
+checks one or several
+.BR sendmail -style
+alias files for consistency. The following tests are performed:
+.TP
+.B Transitivity test
+This test discovers eventual circular dependencies.
+.TP
+.B Use of prohibited aliases
+.PP
+The program returns 0 if all tests pass successfully. Otherwise,
+it diagnoses encountered problems and exits with error code 1.
+.PP
+The program takes a list of alias files to be checked from its command
+line. Command line options can be interspersed with filename
+arguments. The command line option
+.B \-T
+can be used to read the list of file names from a plain-text file.
+Such a file must contain one file name per line. Empty lines and
+lines beginning with
+.B #
+are ignored. Any file name that does not begin with a
+.B /
+is searched in the same directory where the list file resides. For
+example, assuming that the file
+.B /etc/mailman/LIST contains:
+.sp
+.nf
+.in +2
+mailman
+mailman-test
+.in
+.fi
+.sp
+the following invocation
+.sp
+.nf
+.in +2
+$ alck /etc/mail/aliases -T/etc/mailman/LIST
+.in
+.fi
+.sp
+would instruct
+.B alck
+to process files
+.BR /etc/mail/aliases ,
+.B /etc/mailman/mailman
+and
+.BR /etc/mailman/mailman-test ,
+in that order.
+.PP
+In any case, if several alias files are supplied,
+.B alck
+treats them as parts of a single alias file.
+.SH OPTIONS
+.TP
+\fB\-d\fR \fISPEC\fR
+Set debug level. The \fISPEC\fR can contain one or more of the
+following letters:
+.RS
+.TP
+.B y
+enable parser debugging;
+.TP
+.BR l " (the letter " ell ")"
+enable lexical analizer debugging.
+.RE
+.sp
+Upper-case variants are also accepted. Prepending a letter with
+a dash (\fB\-\fR) reverts its sense.
+.TP
+\fB\-T\fR \fIFILE\fR
+Read names of alias files from \fIFILE\fR.
+.TP
+.B \-r
+By default, the program allows any valid
+.B Sendmail
+constructs in its input files. To restrict the input syntax to plain
+aliases only, i.e. to prohibit the use of pipes and file redirections, use
+the \fB\-r\fR option. This option affects all file names following
+it, until the eventual occurrence of the
+.B \-u
+option or the end of command line.
+.TP
+.B \-u
+This options cancels the effect of the previous
+.B \-r
+option.
+.TP
+.B \-v
+Verbosely report the results.
+.TP
+\fB\-w\fR \fIFILE\fR
+Read contents of the
+.BR Sendmail 's
+.B w
+class from the given
+.IR FILE .
+.PP
+The following two options instruct the program to display a certain
+kind of information and exit:
+.TP
+.B \-h
+Display a terse help summary.
+.TP
+.B \-V
+Display the program version and copyright statement.
+.SH AUTHORS
+Sergey Poznyakoff
+.SH "BUG REPORTS"
+Report bugs to <gray@gnu.org>.
+.SH COPYRIGHT
+Copyright \(co 2013 Sergey Poznyakoff
+.br
+.na
+License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
+.br
+.ad
+This is free software: you are free to change and redistribute it.
+There is NO WARRANTY, to the extent permitted by law.
+.\" Local variables:
+.\" eval: (add-hook 'write-file-hooks 'time-stamp)
+.\" time-stamp-start: ".TH [A-Z_][A-Z0-9_.-]* [0-9] \""
+.\" time-stamp-format: "%:B %:d, %:y"
+.\" time-stamp-end: "\""
+.\" time-stamp-line-limit: 20
+.\" end:
+
+

Return to:

Send suggestions and report system problems to the System administrator.