aboutsummaryrefslogtreecommitdiff
path: root/doc/gsc.texi
diff options
context:
space:
mode:
authorSergey Poznyakoff <gray@gnu.org.ua>2005-09-03 17:28:36 +0000
committerSergey Poznyakoff <gray@gnu.org.ua>2005-09-03 17:28:36 +0000
commit3230f1bf78406529af13b81479c957e52b83b2a8 (patch)
treebf61351b99cf97b831b60c417953334bdecdef55 /doc/gsc.texi
parentfd1f7e1f5cfbfa044b6b04f739bcc0e90f632ac1 (diff)
downloadgsc-3230f1bf78406529af13b81479c957e52b83b2a8.tar.gz
gsc-3230f1bf78406529af13b81479c957e52b83b2a8.tar.bz2
Document ckaliases
git-svn-id: file:///svnroot/gsc/trunk@117 d2de0444-eb31-0410-8365-af798a554d48
Diffstat (limited to 'doc/gsc.texi')
-rw-r--r--doc/gsc.texi133
1 files changed, 117 insertions, 16 deletions
diff --git a/doc/gsc.texi b/doc/gsc.texi
index a752c0c..149cdf4 100644
--- a/doc/gsc.texi
+++ b/doc/gsc.texi
@@ -737,8 +737,107 @@ cases, though not always. Such files should be inspected after
@node ckaliases
@section ckaliases
-@UNREVISED{}
+@cindex ckaliases
+ @command{Ckaliases} checks one or several
+@command{sendmail}-style alias files for consistency. Following
+checks are performed:
+
+@enumerate 1
+@item Transitivity check
+ This check discovers eventual circular dependencies.
+
+@item Use of prohibited aliases
+@end enumerate
+
+ If several alias files are supplied, @command{ckaliases} treats
+them as parts of a single alias file.
+
+ The program returns 0 if all checks pass successfully. Otherwise,
+it diagnoses encountered problems and exits with error code 1.
+
+@cindex @option{-w}, ckaliases option
+@cindex ckaliases, @option{-w} command line option
+ Before processing its input files, @command{ckaliases} reads
+definitions of Sendmail @code{w} class from file
+@file{/etc/mail/sendmail.cw}, or from a file specified using
+@option{-w} command line option. For example, running
+
+@smallexample
+ckaliases -w /etc/mail/local-domains aliases
+@end smallexample
+
+@noindent
+instructs @command{ckaliases} to use @file{/etc/mail/local-domains}.
+
+@cindex @option{-r}, ckaliases option
+@cindex ckaliases, @option{-r} command line option
+@cindex @option{-u}, ckaliases option
+@cindex ckaliases, @option{-u} command line option
+ By default, the program allows any valid Sendmail constructions
+in its input files. To restrict the input syntax to plain aliases only,
+i.e. to prohibit use of pipes and file redirections, use @option{-r}
+command line option. This option affects any file names following
+it. To cances the restriction, use @option{-u} option. For example:
+
+@smallexample
+ckaliases aliases -r local -u global
+@end smallexample
+
+@noindent
+This command restricts @file{local} to plain aliases only, while
+allowing any aliases in files @file{aliases} and @file{global}.
+
+@cindex @option{-v}, ckaliases option
+@cindex ckaliases, @option{-v} command line option
+@cindex @option{-d}, ckaliases option
+@cindex ckaliases, @option{-d} command line option
+ Two options are provided to help trace and debug program's
+actions. First, @option{-v} increases verbosity level. Secondly,
+@option{-d} enables debugging mode. This option takes a mandatory
+argument, a string specifying part or parts of the program to debug.
+Characters valid in this string are:
+
+@table @asis
+@item l or L
+ Enable lexical analyzer debugging information.
+
+@item y or Y
+ Enable debugging input grammar analyzer (parser).
+@end table
+
+ Any of these characters can be prefixed with @samp{-} (a dash),
+to disable corresponding debugging feature, e.g. @code{-d y-l}.
+
+@cindex @option{-h}, ckaliases option
+@cindex ckaliases, @option{-h} command line option
+ Finally, running @code{ckaliases -h} displays a short usage
+summary.
+
+@subheading Example of @command{ckaliases} usage
+
+@cindex @command{ckaliases}, example
+ The following @file{/etc/mail/Makefile} rule constructs
+@file{aliases} from several input files, provided that these are
+valid alias files:
+
+@smallexample
+aliases: .depend Aliases mailman/LISTS /com/mailer/aliases
+ ckaliases Aliases -f mailman/LISTS -r /com/mailer/aliases
+ @@(echo "# WARNING: DO NOT EDIT THIS FILE!!!"; \
+ cat Aliases;\
+ cat mailman/LISTS | \
+ (cd mailman; \
+ while read name; \
+ do \
+ case $$name in \
+ \#*) ;; \
+ *) cat $$name;; \
+ esac;\
+ done);\
+ cat /com/mailer/aliases) > aliases
+@end smallexample
+
@node bind replication
@section bind replication
@UNREVISED{}
@@ -754,31 +853,33 @@ cases, though not always. Such files should be inspected after
To compile them you must have @command{sendmail} source tree
installed.
- Create in @file{mc/} directory file @file{.sendmail}. This
-file should contain at least one of the following variables:
+ When configuring the package, use one of the following options:
-@cindex CFDIR, @file{.sendmail} variable
-@defvar CFDIR
- @command{Sendmail} configuration directory (@file{cf} in the
+@table @option
+@item --with-sendmail-cfdir=@var{dir}
+@cindex @option{--with-sendmail-cfdir}, @command{configure} command line option
+ Set @command{sendmail} configuration directory (@file{cf} in the
@command{sendmail} source tree).
-@end defvar
-@cindex VERSION, @file{.sendmail} variable
-@defvar VERSION
- @command{Sendmail} version number. The @command{sendmail}
+@item --with-sendmail-version=@var{version}
+@cindex @option{--with-sendmail-version}, @command{configure} command line option
+ Set @command{sendmail} version number. The @command{sendmail}
configuration @file{Makefile} will be searched in directories
-@file{/usr/src/sendmail-@var{VERSION}/cf} and
-@file{/usr/local/src/sendmail-@var{VERSION}/cf}.
-@end defvar
+@file{/usr/src/sendmail-@var{version}/cf} and
+@file{/usr/local/src/sendmail-@var{version}/cf}.
+@end table
- Once this file is created, @file{.cf} files can be generated
-using the following command:
+ Once the package is configured, you can create all @file{.cf}
+files using following command:
@smallexample
cd mc
-make @var{file}.cf
+make cf
@end smallexample
+ To create only @file{@var{file}.cf}, run @code{make
+@file{@var{file}.cf}}.
+
@node Startup Scripts, User Tools, Sendmail mc Files, Top
@chapter Startup Scripts
@UNREVISED{}

Return to:

Send suggestions and report system problems to the System administrator.