diff --git a/mkapachepw.1 b/mkapachepw.1 index 43e0c83..7c9e3a6 100644 --- a/mkapachepw.1 +++ b/mkapachepw.1 @@ -42,17 +42,9 @@ .SH INSTALLATION -\'mkapachepw\' is a pure-Python module and should run anywhere a -recent Python implementation is found. However, it is Unix-specific -in that it requires the \'pwd\' and \'grp\' modules for accessing the -underlying OS user and group databases. Note that access to these -system databases requires the program be run by the root user. - -The program will not run on Win32 systems. - FreeBSD users can simply install the package using the \'mkapachepw\' port. -All other systems require the program to be installed manually: +All other Unix-like systems require the program to be installed manually: .IP \(bu 4 Get the distribution tarball from http://www.tundraware.com/Software/mkapachepw @@ -66,8 +58,48 @@ .SH OPTIONS .TP +.B -s +suppress inclusion system user and group information + +By default, \'mkapachepw\' includes the users and groups found +in the underlying operating system (starting with the specified +starting GID and UID - see the -g and -u options below). This +command line option prevents any system users or groups from +being included in the final output files. + +.TP +.B -G + +.TP +.B -U + +.TP +.B -g + +.TP +.B -u + +.TP +.B -I + +.TP +.B -i + +.TP +.B -c + +.TP +.B -q + +.TP +.B -O + +.TP +.B -o + +.TP .B -h -print this help information +print help information .TP .B -v @@ -76,8 +108,46 @@ .SH EXAMPLES +.SH EXIT CODES +.ft C \" Courier +.nf + 0 No error, normal completion + + 1 Invalid command line: + - Cannot open include file + - Invalid command line option + - Extraneous argument(s) after command line options + - Invalid argument for starting GID or UID + + 2 Invalid enumeration argument: + - Enumerated entry missing an inclusion/exclusion prefix (+/-) + - Attempt to include/exclude a non-existent GID, UID, or name + + 3 Cannot open output file + + 4 Included file attempted to redefine existing user or group +.fi +.ft \" revert + + + .SH OTHER -You must have a reasonably current version of Python installed. +\'mkapachepw\' is a pure-Python module and should run anywhere a +recent Python implementation is found. However, it is Unix-specific +in that it requires the \'pwd\' and \'grp\' modules for accessing the +underlying OS user and group databases. Note that access to these +system databases requires the program be run by the root user. + +In order for this program to produce correct access control files, +Apache and the underlying OS must agree on the hash algorithm +used to encrypt passwords. This should be the default case in +most instances. + +This program has only been tested on FreeBSD, though it should work +on other Unix-like variants. + +The program will not run on Win32 systems. + .SH BUGS AND MISFEATURES None known as of this release. @@ -104,7 +174,7 @@ .ft \" revert .SH DOCUMENT REVISION INFORMATION -$Id: mkapachepw.1,v 1.101 2005/04/12 08:03:18 toor Exp $ +$Id: mkapachepw.1,v 1.102 2005/04/12 08:28:28 toor Exp $