Added descriptions, installation, and licensing sections.
1 parent 075bf9b commit ade04ec40a55c33add4275be41949fcb75fb5101
@toor toor authored on 12 Apr 2005
Showing 1 changed file
View
128
mkapachepw.1
.ds CP 2005
.TH mkapachepw 1 "TundraWare Inc."
.SH NAME
mkapachepw \- Short Description
mkapachepw \- Apache webserver user and group file management utility for Unix-like systems.
 
.SH SYNOPSIS
mkapachepw [-hv]
mkapachepw [-sGUguIicqOohv]
 
.SH DESCRIPTION
Long description
\'mkapachepw\' is a utility program for creating and maintaining
Apache webserver user and group access control files. Its primary
value is that it allows large numbers of user and group entries to be
managed in separate files. These files are then combined into single,
production files for use by the Apache webserver. In this manner,
different departments of an organization can independently manage
their own user and group information in separate files. The webmaster
then uses \'mkapachepw\' to combine them on the production system.
 
\'mkapachepw\' has a number of useful features, including:
 
.IP \(bu 4
Automatically Create Apache Users/Groups From Underlying OS Users/Groups
 
.IP \(bu 4
Combine User & Group Data From Separately Managed Files Into Single Production Apache Access Control Files
 
.IP \(bu 4
Specify Which Particular Users/Groups Are To Be Included Or Excluded
 
.IP \(bu 4
Catch (And Prevent) Redefinition Of User/Groups In Different Files
 
.P
With \'mkapachepw\', you can easily write scripts to automate the
creation of custom Apache user and group access control files that
contain any/all of the OS users/groups plus any other custom users and
groups relevant to your Apache installation. For example, you might
have separately managed user/group files for Engineering, Sales, and
Marketing. These can then be selectively combined with the
users/groups already defined by the underlying operating system.
 
 
.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:
 
.IP \(bu 4
Get the distribution tarball from http://www.tundraware.com/Software/mkapachepw
 
.IP \(bu 4
Copy the \'mkapachepw.py\' file to a directory somewhere in your path.
 
.IP \(bu 4
Copy the \'mkapachepw.1.gz\' file to the local \'man1\' directory.
 
 
.SH OPTIONS
.TP
.B -h
 
.TP
.B -v
print detailed version information.
 
 
.SH EXAMPLES
 
.SH OTHER
You must have a reasonably current version of Python installed.
 
the mkapachepw-license.txt file in the program distribution. If you
install \'mkapachepw\' on a FreeBSD system using the 'ports' mechanism, you
will also find this file in /usr/local/share/doc/mkapachepw.
 
\'mkapachepw\' is free for individual, non-commerical, personal
use. Use in any setting where there is any remuneration,
direct or indirect, requires payment of a licensing fee.
 
Individual, multiple, and enterprise licensing is available.
Contact mkapachepw@tundraware.com for current pricing.
 
.SH AUTHOR
.ft C \" Courier
.nf
Tim Daneliuk
.fi
.ft \" revert
 
.SH DOCUMENT REVISION INFORMATION
$Id: mkapachepw.1,v 1.100 2005/03/31 23:12:16 tundra Exp $
$Id: mkapachepw.1,v 1.101 2005/04/12 08:03:18 toor Exp $