changeset 849:3168aed4b01a

Improve documentation for mlmmj-make-ml.
author Ben Schmidt
date Wed, 22 Feb 2012 00:11:07 +1100
parents 42d9ec07a958
children efd01230d20a
files man/mlmmj-make-ml.1 src/mlmmj-make-ml.in
diffstat 2 files changed, 17 insertions(+), 14 deletions(-) [+]
line wrap: on
line diff
--- a/man/mlmmj-make-ml.1	Tue Jan 31 04:13:27 2012 +1100
+++ b/man/mlmmj-make-ml.1	Wed Feb 22 00:11:07 2012 +1100
@@ -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 your /etc/aliases file
 .HP
-\fB\-a\fR: Create the needed entries in /etc/aliases
+\fB\-c\fR: User to chown the spool directory to (default not to chown at all)
 .HP
-\fB\-z\fR: Do nothing for now.
+\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
--- a/src/mlmmj-make-ml.in	Tue Jan 31 04:13:27 2012 +1100
+++ b/src/mlmmj-make-ml.in	Wed Feb 22 00:11:07 2012 +1100
@@ -7,15 +7,16 @@
 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