From: Ben Schmidt Date: Tue, 21 Feb 2012 13:11:07 +0000 (+1100) Subject: Improve documentation for mlmmj-make-ml. X-Git-Tag: RELEASE_1_2_18a1~16 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=b679d874ea48aa4364d2b6ed9f3866f5595cb8df;p=thirdparty%2Fmlmmj.git Improve documentation for mlmmj-make-ml. --- diff --git a/man/mlmmj-make-ml.1 b/man/mlmmj-make-ml.1 index d333f2a2..937eb9ab 100644 --- a/man/mlmmj-make-ml.1 +++ b/man/mlmmj-make-ml.1 @@ -3,22 +3,24 @@ mlmmj-make-ml \- create a mailing list for mlmmj .SH SYNOPSIS .B mlmmj-make-ml -\fI[OPTIONS] +[\fI\-h\fR] [\fI\-L listname\fR] [\fI\-s spooldir\fR] [\fI\-a\fR] [\fI\-c user\fR] [\fI\-z\fR] .HP \fB\-h\fR: Display help .HP \fB\-L\fR: The name of the mailing list .HP -\fB\-s\fR: The spool directory, if different from /var/spool/mlmmj +\fB\-s\fR: Your spool directory (default /var/spool/mlmmj) .HP -\fB\-a\fR: Create the needed entries in /etc/aliases +\fB\-a\fR: Create the needed entries in your /etc/aliases file .HP -\fB\-z\fR: Do nothing for now. +\fB\-c\fR: User to chown the spool directory to (default not to chown at all) +.HP +\fB\-z\fR: Do nothing for now .SH DESCRIPTION This is an interactive script which creates the mailing list directory and thus the list itself for being run by mlmmj. .SH BUGS -It's not possible to create a mailinglist entirely on the command line. +It's not possible to create a list entirely on the command line. .SH AUTHORS This manual page was written by the following persons: .HP diff --git a/src/mlmmj-make-ml.in b/src/mlmmj-make-ml.in index f90c0147..a6e10a30 100755 --- a/src/mlmmj-make-ml.in +++ b/src/mlmmj-make-ml.in @@ -7,15 +7,16 @@ VERSION="0.1" DEFAULTDIR="/var/spool/mlmmj" ALIASFILE=/etc/aliases -USAGE="mlmmj-make-ml "$VERSION" -"$0" [OPTIONS] - --h display this help text --L the name of the mailinglist --s your spool directory if not "$DEFAULTDIR" --a create the needed entrys in your $ALIASFILE file --z nuffn for now --c chown the spool dir" +USAGE="mlmmj-make-ml $VERSION +$0 + [-h] [-L listname] [-s spooldir] [-a] [-c user] [-z] + -h: display this help text + -L: the name of the mailing list + -s: your spool directory (default $DEFAULTDIR) + -a: create the needed entries in your $ALIASFILE file + -c: user to chown the spool directory to (default not to chown at all) + -z: do nothing for now +" while getopts ":hL:s:azc:" Option do