]> git.ipfire.org Git - thirdparty/mlmmj.git/commitdiff
Improve documentation for mlmmj-make-ml.
authorBen Schmidt <none@none>
Tue, 21 Feb 2012 13:11:07 +0000 (00:11 +1100)
committerBen Schmidt <none@none>
Tue, 21 Feb 2012 13:11:07 +0000 (00:11 +1100)
man/mlmmj-make-ml.1
src/mlmmj-make-ml.in

index d333f2a20f1617493c55e2b5458d9bc7a9fec155..937eb9ab7d8067b3384fb3958e2fa94cbaf9cbd3 100644 (file)
@@ -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
index f90c01470a0282456828849915ddb6611d198f45..a6e10a30d5e806541cfbd274270fefc45860f067 100755 (executable)
@@ -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