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) (unidiff)
tree9cb03914f08dea95f1713010d94b274c6458d6ae
parentc56e18d5a97384a33941a9c0acf0872df16f2f8d (diff)
downloadalck-8f8a1c98f84669306d1489ddc5d55b6f589df9be.tar.gz
alck-8f8a1c98f84669306d1489ddc5d55b6f589df9be.tar.bz2
Add a manpage.
Diffstat (more/less context) (ignore 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 @@
1.\" This file is part of ALCK -*- nroff -*-
2.\" Copyright (C) 2013 Sergey Poznyakoff
3.\"
4.\" Alck is free software; you can redistribute it and/or modify
5.\" it under the terms of the GNU General Public License as published by
6.\" the Free Software Foundation; either version 3, or (at your option)
7.\" any later version.
8.\"
9.\" Alck is distributed in the hope that it will be useful,
10.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
11.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12.\" GNU General Public License for more details.
13.\"
14.\" You should have received a copy of the GNU General Public License
15.\" along with Alck. If not, see <http://www.gnu.org/licenses/>.
16.TH ALCK 1 "March 5, 2013" "ALCK"
17.SH NAME
18alck \- check MTA alias files
19.SH SYNOPSIS
20\fBalck\fR [\fB\-d\fR \fILEVEL\fR] [\fB\-T\fR \fIFILE\fR]\
21 [\-\fBruv\fR] [\fB\-w\fR \fIFILE\fR] \fIFILE\fR
22.sp
23\fBalck\fR \fB\-h\fR
24.sp
25\fBalck\fR \fB\-V\fR
26.SH DESCRIPTION
27.B Alck
28checks one or several
29.BR sendmail -style
30alias files for consistency. The following tests are performed:
31.TP
32.B Transitivity test
33This test discovers eventual circular dependencies.
34.TP
35.B Use of prohibited aliases
36.PP
37The program returns 0 if all tests pass successfully. Otherwise,
38it diagnoses encountered problems and exits with error code 1.
39.PP
40The program takes a list of alias files to be checked from its command
41line. Command line options can be interspersed with filename
42arguments. The command line option
43.B \-T
44can be used to read the list of file names from a plain-text file.
45Such a file must contain one file name per line. Empty lines and
46lines beginning with
47.B #
48are ignored. Any file name that does not begin with a
49.B /
50is searched in the same directory where the list file resides. For
51example, assuming that the file
52.B /etc/mailman/LIST contains:
53.sp
54.nf
55.in +2
56mailman
57mailman-test
58.in
59.fi
60.sp
61the following invocation
62.sp
63.nf
64.in +2
65$ alck /etc/mail/aliases -T/etc/mailman/LIST
66.in
67.fi
68.sp
69would instruct
70.B alck
71to process files
72.BR /etc/mail/aliases ,
73.B /etc/mailman/mailman
74and
75.BR /etc/mailman/mailman-test ,
76in that order.
77.PP
78In any case, if several alias files are supplied,
79.B alck
80treats them as parts of a single alias file.
81.SH OPTIONS
82.TP
83\fB\-d\fR \fISPEC\fR
84Set debug level. The \fISPEC\fR can contain one or more of the
85following letters:
86.RS
87.TP
88.B y
89enable parser debugging;
90.TP
91.BR l " (the letter " ell ")"
92enable lexical analizer debugging.
93.RE
94.sp
95Upper-case variants are also accepted. Prepending a letter with
96a dash (\fB\-\fR) reverts its sense.
97.TP
98\fB\-T\fR \fIFILE\fR
99Read names of alias files from \fIFILE\fR.
100.TP
101.B \-r
102By default, the program allows any valid
103.B Sendmail
104constructs in its input files. To restrict the input syntax to plain
105aliases only, i.e. to prohibit the use of pipes and file redirections, use
106the \fB\-r\fR option. This option affects all file names following
107it, until the eventual occurrence of the
108.B \-u
109option or the end of command line.
110.TP
111.B \-u
112This options cancels the effect of the previous
113.B \-r
114option.
115.TP
116.B \-v
117Verbosely report the results.
118.TP
119\fB\-w\fR \fIFILE\fR
120Read contents of the
121.BR Sendmail 's
122.B w
123class from the given
124.IR FILE .
125.PP
126The following two options instruct the program to display a certain
127kind of information and exit:
128.TP
129.B \-h
130Display a terse help summary.
131.TP
132.B \-V
133Display the program version and copyright statement.
134.SH AUTHORS
135Sergey Poznyakoff
136.SH "BUG REPORTS"
137Report bugs to <gray@gnu.org>.
138.SH COPYRIGHT
139Copyright \(co 2013 Sergey Poznyakoff
140.br
141.na
142License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
143.br
144.ad
145This is free software: you are free to change and redistribute it.
146There is NO WARRANTY, to the extent permitted by law.
147.\" Local variables:
148.\" eval: (add-hook 'write-file-hooks 'time-stamp)
149.\" time-stamp-start: ".TH [A-Z_][A-Z0-9_.-]* [0-9] \""
150.\" time-stamp-format: "%:B %:d, %:y"
151.\" time-stamp-end: "\""
152.\" time-stamp-line-limit: 20
153.\" end:
154
155

Return to:

Send suggestions and report system problems to the System administrator.