rse 98/03/19 02:05:51
Modified: . STATUS
src CHANGES
src/support htpasswd.1
Added: src/support dbmmanage.1 suexec.8 htdigest.1 rotatelogs.8
logresolve.8
Log:
Here they come, fresh out of my fingers: Manual pages for
support programs which still don't have one.
Revision Changes Path
1.197 +1 -0 apache-1.3/STATUS
Index: STATUS
===================================================================
RCS file: /export/home/cvs/apache-1.3/STATUS,v
retrieving revision 1.196
retrieving revision 1.197
diff -u -r1.196 -r1.197
--- STATUS 1998/03/17 15:47:30 1.196
+++ STATUS 1998/03/19 10:05:37 1.197
@@ -96,6 +96,7 @@
* Ralf's new ApacheBench support program (src/support/ab.c)
* Ken's change HIDE default to "yes", always include hide.h
* Ralf's major Configure cleanup
+ * Ralf's additional manual pages for the support programs
Available Patches:
1.722 +6 -0 apache-1.3/src/CHANGES
Index: CHANGES
===================================================================
RCS file: /export/home/cvs/apache-1.3/src/CHANGES,v
retrieving revision 1.721
retrieving revision 1.722
diff -u -r1.721 -r1.722
--- CHANGES 1998/03/17 15:42:22 1.721
+++ CHANGES 1998/03/19 10:05:40 1.722
@@ -1,5 +1,11 @@
Changes with Apache 1.3b6
+ *) Add five new and fresh manpages for the support programs: dbmmanage.1,
+ suexec.8, htdigest.1, rotatelogs.8 and logresolve.8. Now all up-to-date
+ and per default compiled support programs have manual pages - just to
+ document our stuff a little bit more and to be able to do really
+ Unix-like installations ;-) [Ralf S. Engelschall]
+
*) Major cleanups to the Configure script to make it and its generated
Makefiles again readable and maintainable: add SRCDIR option, removed
INCLUDES_DEPTH[0-2] kludge, cleanup of TARGET option, cleanup of
1.5 +2 -1 apache-1.3/src/support/htpasswd.1
Index: htpasswd.1
===================================================================
RCS file: /export/home/cvs/apache-1.3/src/support/htpasswd.1,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- htpasswd.1 1998/03/16 16:04:22 1.4
+++ htpasswd.1 1998/03/19 10:05:45 1.5
@@ -90,4 +90,5 @@
\fIusername\fP does not exist is this file, an entry is added. If it
does exist, the password is changed.
.SH SEE ALSO
-httpd(8)
+.BR httpd(8)
+.
1.1 apache-1.3/src/support/dbmmanage.1
Index: dbmmanage.1
===================================================================
.TH dbmmanage 1 "March 1998"
.\" Copyright (c) 1998 The Apache Group. All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\"
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\"
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in
.\" the documentation and/or other materials provided with the
.\" distribution.
.\"
.\" 3. All advertising materials mentioning features or use of this
.\" software must display the following acknowledgment:
.\" "This product includes software developed by the Apache Group
.\" for use in the Apache HTTP server project (http://www.apache.org/)."
.\"
.\" 4. The names "Apache Server" and "Apache Group" must not be used to
.\" endorse or promote products derived from this software without
.\" prior written permission.
.\"
.\" 5. Redistributions of any form whatsoever must retain the following
.\" acknowledgment:
.\" "This product includes software developed by the Apache Group
.\" for use in the Apache HTTP server project (http://www.apache.org/)."
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE APACHE GROUP ``AS IS'' AND ANY
.\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE APACHE GROUP OR
.\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
.\" OF THE POSSIBILITY OF SUCH DAMAGE.
.\" ====================================================================
.\"
.\" This software consists of voluntary contributions made by many
.\" individuals on behalf of the Apache Group and was originally based
.\" on public domain software written at the National Center for
.\" Supercomputing Applications, University of Illinois, Urbana-Champaign.
.\" For more information on the Apache Group and the Apache HTTP server
.\" project, please see <http://www.apache.org/>.
.SH NAME
dbmmanage \- Create and update user authentication files in DBM format
.SH SYNOPSIS
.B dbmmanage
.I filename
[
.I command
] [
.I username
]
.PP
.SH DESCRIPTION
.B dbmmanage
is used to create and update the DBM format files used to store
usernames and password for basic authentication of HTTP users.
Resources available from the
.B httpd
Apache web server can be restricted to just the users listed
in the files created by
.B dbmmanage.
This program can only be used
when the usernames are stored in a DBM file. To use a
flat-file database see
\fBhtpasswd\fP.
.PP
This manual page only lists the command line arguments. For details of
the directives necessary to configure user authentication in
.B httpd
see
the Apache manual, which is part of the Apache distribution or can be
found at http://www.apache.org/.
.SH OPTIONS
.IP \fB\fIfilename\fP
The filename of the DBM format file. Usually without the extension .pag or
.dir.
.IP \fB\fIcommand\fP
This selects the operation to perform:
.TP 12
.B adduser
Asks for a password and then adds an entry for \fIusername\fP to
\fIfilename\fP .
.TP 12
.B check
Asks for a password and then checks if
\fIusername\fP is in \fIfilename\fP and if it's password matches
the specified one.
.TP 12
.B delete
Deletes the \fIusername\fP entry from \fIfilename\fP.
.TP 12
.B import
Reads username:password entries (one per line) from STDIN and adds them to
\fIfilename\fP. The passwords already has to be crypted.
.TP 12
.B update
Same as the "adduser" command, except that it makes sure \fIusername\fP
already exists in \fIfilename\fP.
.TP 12
.B view
Just displays the complete contents of the DBM file.
.IP \fB\fIusername\fP
The user for which the update operation is performed.
.PD
.SH SEE ALSO
.BR httpd(8)
.
1.1 apache-1.3/src/support/suexec.8
Index: suexec.8
===================================================================
.TH suexec 8 "March 1998"
.\" Copyright (c) 1998 The Apache Group. All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\"
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\"
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in
.\" the documentation and/or other materials provided with the
.\" distribution.
.\"
.\" 3. All advertising materials mentioning features or use of this
.\" software must display the following acknowledgment:
.\" "This product includes software developed by the Apache Group
.\" for use in the Apache HTTP server project (http://www.apache.org/)."
.\"
.\" 4. The names "Apache Server" and "Apache Group" must not be used to
.\" endorse or promote products derived from this software without
.\" prior written permission.
.\"
.\" 5. Redistributions of any form whatsoever must retain the following
.\" acknowledgment:
.\" "This product includes software developed by the Apache Group
.\" for use in the Apache HTTP server project (http://www.apache.org/)."
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE APACHE GROUP ``AS IS'' AND ANY
.\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE APACHE GROUP OR
.\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
.\" OF THE POSSIBILITY OF SUCH DAMAGE.
.\" ====================================================================
.\"
.\" This software consists of voluntary contributions made by many
.\" individuals on behalf of the Apache Group and was originally based
.\" on public domain software written at the National Center for
.\" Supercomputing Applications, University of Illinois, Urbana-Champaign.
.\" For more information on the Apache Group and the Apache HTTP server
.\" project, please see <http://www.apache.org/>.
.SH NAME
suexec \- Switch User For Exec
.SH SYNOPSIS
No synopsis for usage, because this program
is used internally by Apache only.
.PP
.SH DESCRIPTION
.B suexec
is the "wrapper" support program for the suEXEC behaviour for Apache.
It is run from within Apache automatically to switch the user when
an external program has to be run under a different user. For more
information about suEXEC see the document `Apache suEXEC Support'
under http://www.apache.org/docs/suexec.html .
.PD
.SH SEE ALSO
.BR httpd(8)
.
1.1 apache-1.3/src/support/htdigest.1
Index: htdigest.1
===================================================================
.TH htdigest 1 "March 1998"
.\" Copyright (c) 1997-1998 The Apache Group. All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\"
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\"
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in
.\" the documentation and/or other materials provided with the
.\" distribution.
.\"
.\" 3. All advertising materials mentioning features or use of this
.\" software must display the following acknowledgment:
.\" "This product includes software developed by the Apache Group
.\" for use in the Apache HTTP server project (http://www.apache.org/)."
.\"
.\" 4. The names "Apache Server" and "Apache Group" must not be used to
.\" endorse or promote products derived from this software without
.\" prior written permission. For written permission, please contact
.\" [EMAIL PROTECTED]
.\"
.\" 5. Redistributions of any form whatsoever must retain the following
.\" acknowledgment:
.\" "This product includes software developed by the Apache Group
.\" for use in the Apache HTTP server project (http://www.apache.org/)."
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE APACHE GROUP ``AS IS'' AND ANY
.\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE APACHE GROUP OR
.\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
.\" OF THE POSSIBILITY OF SUCH DAMAGE.
.\" ====================================================================
.\"
.\" This software consists of voluntary contributions made by many
.\" individuals on behalf of the Apache Group and was originally based
.\" on public domain software written at the National Center for
.\" Supercomputing Applications, University of Illinois, Urbana-Champaign.
.\" For more information on the Apache Group and the Apache HTTP server
.\" project, please see <http://www.apache.org/>.
.SH NAME
htdigest \- Create and update user authentication files
.SH SYNOPSIS
.B htdigest
[
.B \-c
]
.I passwdfile
.I realm
.I username
.SH DESCRIPTION
.B htdigest
is used to create and update the flat-files used to store
usernames, realm and password for digest authentication of HTTP users.
Resources available from the
.B httpd
Apache web server can be restricted to just the users listed
in the files created by
.B htdigest.
.PP
This manual page only lists the command line arguments. For details of
the directives necessary to configure digest authentication in
.B httpd
see
the Apache manual, which is part of the Apache distribution or can be
found at http://www.apache.org/.
.SH OPTIONS
.IP \-c
Create the \fIpasswdfile\fP. If \fIpasswdfile\fP already exists, it
is deleted first.
.IP \fB\fIpasswdfile\fP
Name of the file to contain the username, realm and password. If \-c
is given, this file is created if it does not already exist,
or deleted and recreated if it does exist.
.IP \fB\fIrealm\fP
The realm name to which the user name belongs to.
.IP \fB\fIusername\fP
The user name to create or update in \fBpasswdfile\fP. If
\fIusername\fP does not exist is this file, an entry is added. If it
does exist, the password is changed.
.SH SEE ALSO
.BR httpd(8)
.
1.1 apache-1.3/src/support/rotatelogs.8
Index: rotatelogs.8
===================================================================
.TH rotatelogs 8 "March 1998"
.\" Copyright (c) 1998 The Apache Group. All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\"
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\"
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in
.\" the documentation and/or other materials provided with the
.\" distribution.
.\"
.\" 3. All advertising materials mentioning features or use of this
.\" software must display the following acknowledgment:
.\" "This product includes software developed by the Apache Group
.\" for use in the Apache HTTP server project (http://www.apache.org/)."
.\"
.\" 4. The names "Apache Server" and "Apache Group" must not be used to
.\" endorse or promote products derived from this software without
.\" prior written permission.
.\"
.\" 5. Redistributions of any form whatsoever must retain the following
.\" acknowledgment:
.\" "This product includes software developed by the Apache Group
.\" for use in the Apache HTTP server project (http://www.apache.org/)."
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE APACHE GROUP ``AS IS'' AND ANY
.\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE APACHE GROUP OR
.\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
.\" OF THE POSSIBILITY OF SUCH DAMAGE.
.\" ====================================================================
.\"
.\" This software consists of voluntary contributions made by many
.\" individuals on behalf of the Apache Group and was originally based
.\" on public domain software written at the National Center for
.\" Supercomputing Applications, University of Illinois, Urbana-Champaign.
.\" For more information on the Apache Group and the Apache HTTP server
.\" project, please see <http://www.apache.org/>.
.SH NAME
rotatelogs \- rotate Apache logs without having to kill the server
.SH SYNOPSIS
.B rotatelogs
.I logfile
.I rotationtime
.PP
.SH DESCRIPTION
.B rotatelogs
is a simple program for use in conjunction with Apache's piped logfile
feature which can be used like this:
.fi
TansferLog "|rotatelogs /path/to/logs/access_log 86400"
.mf
This creates the files /path/to/logs/access_log.nnnn where nnnn is the system
time at which the log nominally starts (this time will always be a multiple of
the rotation time, so you can synchronize cron scripts with it). At the end
of each rotation time (here after 24 hours) a new log is started.
.SH OPTIONS
.IP \fB\fIlogfile\fP
The path plus basename of the logfile. The suffix .nnnn is automatically
added.
.IP \fB\fIrotationtime\fP
The rotation time in seconds.
.PD
.SH SEE ALSO
.BR httpd(8)
.
1.1 apache-1.3/src/support/logresolve.8
Index: logresolve.8
===================================================================
.TH logresolve 8 "March 1998"
.\" Copyright (c) 1998 The Apache Group. All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\"
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\"
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in
.\" the documentation and/or other materials provided with the
.\" distribution.
.\"
.\" 3. All advertising materials mentioning features or use of this
.\" software must display the following acknowledgment:
.\" "This product includes software developed by the Apache Group
.\" for use in the Apache HTTP server project (http://www.apache.org/)."
.\"
.\" 4. The names "Apache Server" and "Apache Group" must not be used to
.\" endorse or promote products derived from this software without
.\" prior written permission.
.\"
.\" 5. Redistributions of any form whatsoever must retain the following
.\" acknowledgment:
.\" "This product includes software developed by the Apache Group
.\" for use in the Apache HTTP server project (http://www.apache.org/)."
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE APACHE GROUP ``AS IS'' AND ANY
.\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE APACHE GROUP OR
.\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
.\" OF THE POSSIBILITY OF SUCH DAMAGE.
.\" ====================================================================
.\"
.\" This software consists of voluntary contributions made by many
.\" individuals on behalf of the Apache Group and was originally based
.\" on public domain software written at the National Center for
.\" Supercomputing Applications, University of Illinois, Urbana-Champaign.
.\" For more information on the Apache Group and the Apache HTTP server
.\" project, please see <http://www.apache.org/>.
.SH NAME
logresolve \- resolve hostnames for IP-adresses in Apache logfiles
.SH SYNOPSIS
.B logresolve
[
.BI \-s " filename"
] [
.B \-c
] <
.I access_log
>
.I access_log.new
.PP
.SH DESCRIPTION
.B logresolve
is a post-processing program to resolve IP-adresses in Apache's access
logfiles. To minimize impact on your nameserver, logresolve has its very own
internal hash-table cache. This means that each IP number will only be looked
up the first time it is found in the log file.
.SH OPTIONS
.TP 12
.BI \-s " filename"
Specifies a filename to record statistics.
.TP 12
.B \-c
This causes
.B logresolve
to apply some DNS checks: after finding the hostname from the IP address, it
looks up the IP addresses for the hostname and checks that one of these
matches the original address.
.PD
.SH SEE ALSO
.BR httpd(8)
.
