build man-en

(re-)add the manpages. now autogenerated from accompanying xml source.


git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@99590 13f79535-47bb-0310-9956-ffa450edef68

docs/man/apachectl.8

@@ -0,0 +1,93 @@
+.\" XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+.\" DO NOT EDIT! Generated from XML source.
+.\" XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+.de Sh \" Subsection
+.br
+.if t .Sp
+.ne 5
+.PP
+\fB\\$1\fR
+.PP
+..
+.de Sp \" Vertical space (when we can't use .PP)
+.if t .sp .5v
+.if n .sp
+..
+.de Ip \" List item
+.br
+.ie \\n(.$>=3 .ne \\$3
+.el .ne 3
+.IP "\\$1" \\$2
+..
+.TH "APACHECTL" 8 "2003-04-23" "Apache HTTP Server" "apachectl"
+
+.SH "SYNOPSIS"
+
+.PP
+When acting in pass-through mode, apachectl can take all the arguments available for the httpd binary\&.
+
+.PP
+\fBapachectl\fR [ \fIhttpd-argument\fR ]
+
+.PP
+When acting in SysV init mode, apachectl takes simple, one-word commands, defined below\&.
+
+.PP
+\fBapachectl\fR\fIcommand\fR
+
+
+.SH "SUMMARY"
+
+.PP
+apachectl is a front end to the Apache HyperText Transfer Protocol (HTTP) server\&. It is designed to help the administrator control the functioning of the Apache httpd daemon\&.
+
+.PP
+The apachectl script can operate in two modes\&. First, it can act as a simple front-end to the httpd command that simply sets any necessary environment variables and then invokes httpd, passing through any command line arguments\&. Second, apachectl can act as a SysV init script, taking simple one-word arguments like start, restart, and stop, and translating them into appropriate signals to httpd\&.
+
+.PP
+If your Apache installation uses non-standard paths, you will need to edit the apachectl script to set the appropriate paths to the httpd binary\&. You can also specify any necessary httpd command line arguments\&. See the comments in the script for details\&.
+
+.PP
+The apachectl script returns a 0 exit value on success, and >0 if an error occurs\&. For more details, view the comments in the script\&.
+
+
+.SH "OPTIONS"
+
+.PP
+Only the SysV init-style options are defined here\&. Other arguments are defined on the httpd manual page\&.
+
+.RS
+
+.TP
+start
+Start the Apache httpd daemon\&. Gives an error if it is already running\&. This is equivalent to apachectl -k start\&.
+.TP
+stop
+Stops the Apache httpd daemon\&. This is equivalent to apachectl -k stop\&.
+.TP
+restart
+Restarts the Apache httpd daemon\&. If the daemon is not running, it is started\&. This command automatically checks the configuration files as in configtest before initiating the restart to make sure the daemon doesn't die\&. This is equivalent to apachectl -k restart\&.
+.TP
+fullstatus
+Displays a full status report from mod_status\&. For this to work, you need to have mod_status enabled on your server and a text-based browser such as lynx available on your system\&. The URL used to access the status report can be set by editing the STATUSURL variable in the script\&.
+.TP
+status
+Displays a brief status report\&. Similar to the fullstatus option, except that the list of requests currently being served is omitted\&.
+.TP
+graceful
+Gracefully restarts the Apache httpd daemon\&. If the daemon is not running, it is started\&. This differs from a normal restart in that currently open connections are not aborted\&. A side effect is that old log files will not be closed immediately\&. This means that if used in a log rotation script, a substantial delay may be necessary to ensure that the old log files are closed before processing them\&. This command automatically checks the configuration files as in configtest before initiating the restart to make sure Apache doesn't die\&. This is equivalent to apachectl -k graceful\&.
+.TP
+configtest
+Run a configuration file syntax test\&. It parses the configuration files and either reports Syntax Ok or detailed information about the particular syntax error\&. This is equivalent to apachectl -t\&.
+.RE
+
+.PP
+The following additional option is available, but deprecated\&.
+
+.RS
+
+.TP
+startssl
+This is equivalent to apachectl -k start -DSSL\&. We recommend that you use that command explicitly, or you adjust your httpd\&.conf to remove the <IfDefine> section so that SSL will always be available\&.
+.RE
+

docs/man/httpd.8

@@ -0,0 +1,117 @@
+.\" XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+.\" DO NOT EDIT! Generated from XML source.
+.\" XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+.de Sh \" Subsection
+.br
+.if t .Sp
+.ne 5
+.PP
+\fB\\$1\fR
+.PP
+..
+.de Sp \" Vertical space (when we can't use .PP)
+.if t .sp .5v
+.if n .sp
+..
+.de Ip \" List item
+.br
+.ie \\n(.$>=3 .ne \\$3
+.el .ne 3
+.IP "\\$1" \\$2
+..
+.TH "HTTPD" 8 "2003-04-23" "Apache HTTP Server" "httpd"
+
+.SH "SYNOPSIS"
+
+.PP
+\fBhttpd\fR [ -\fBd\fR\fIserverroot\fR ] [ -\fBf\fR\fIconfig\fR ] [ -\fBC\fR\fIdirective\fR ] [ -\fBc\fR\fIdirective\fR ] [ -\fBD\fR\fIparameter\fR ] [ -\fBe\fR\fIlevel\fR ] [ -\fBE\fR\fIfile\fR ] [ \fB-k\fR start|restart|graceful|stop ] [ -\fBR\fR\fIdirectory\fR ] [ -\fBh\fR ] [ -\fBl\fR ] [ -\fBL\fR ] [ -\fBS\fR ] [ -\fBt\fR ] [ -\fBv\fR ] [ -\fBV\fR ] [ -\fBX\fR ]
+
+.PP
+On Windows systems, the following additional arguments are available:
+
+.PP
+\fBhttpd\fR [ -\fBk\fR install|config|uninstall ] [ -\fBn\fR\fIname\fR ] [ -\fBw\fR ]
+
+
+.SH "SUMMARY"
+
+.PP
+httpd is the Apache HyperText Transfer Protocol (HTTP) server program\&. It is designed to be run as a standalone daemon process\&. When used like this it will create a pool of child processes or threads to handle requests\&.
+
+.PP
+In general, httpd should not be invoked directly, but rather should be invoked via apachectl on Unix-based systems or as a service on Windows NT, 2000 and XP and as a console application on Windows 9x and ME\&.
+
+
+.SH "OPTIONS"
+
+.RS
+
+.TP
+-d \fIserverroot\fR
+Set the initial value for the ServerRoot directive to \fIserverroot\fR\&. This can be overridden by the ServerRoot directive in the configuration file\&. The default is /usr/local/apache2\&.
+.TP
+-f \fIconfig\fR
+Uses the directives in the file \fIconfig\fR on startup\&. If \fIconfig\fR does not begin with a /, then it is taken to be a path relative to the ServerRoot\&. The default is conf/httpd\&.conf\&.
+.TP
+-k start|restart|graceful|stop
+Signals httpd to start, restart, or stop\&. See Stopping Apache for more information\&.
+.TP
+-C \fIdirective\fR
+Process the configuration \fIdirective\fR before reading config files\&.
+.TP
+-c \fIdirective\fR
+Process the configuration \fIdirective\fR after reading config files\&.
+.TP
+-D \fIparameter\fR
+Sets a configuration \fIparameter \fRwhich can be used with <IfDefine> sections in the configuration files to conditionally skip or process commands at server startup and restart\&.
+.TP
+-e \fIlevel\fR
+Sets the LogLevel to \fIlevel\fR during server startup\&. This is useful for temporarily increasing the verbosity of the error messages to find problems during startup\&.
+.TP
+-E \fIfile\fR
+Send error messages during server startup to \fIfile\fR\&.
+.TP
+-R \fIdirectory\fR
+When the server is compiled using the SHARED_CORE rule, this specifies the \fIdirectory\fR for the shared object files\&.
+.TP
+-h
+Output a short summary of available command line options\&.
+.TP
+-l
+Output a list of modules compiled into the server\&. This will \fBnot\fR list dynamically loaded modules included using the LoadModule directive\&.
+.TP
+-L
+Output a list of directives together with expected arguments and places where the directive is valid\&.
+.TP
+-S
+Show the settings as parsed from the config file (currently only shows the virtualhost settings)\&.
+.TP
+-t
+Run syntax tests for configuration files only\&. The program immediately exits after these syntax parsing with either a return code of 0 (Syntax OK) or return code not equal to 0 (Syntax Error)\&. If -D \fIDUMP\fR_\fIVHOSTS \fRis also set, details of the virtual host configuration will be printed\&.
+.TP
+-v
+Print the version of httpd, and then exit\&.
+.TP
+-V
+Print the version and build parameters of httpd, and then exit\&.
+.TP
+-X
+Run httpd in debug mode\&. Only one worker will be started and the server will not detach from the console\&.
+.RE
+
+.PP
+The following arguments are available only on the Windows platform:
+
+.RS
+
+.TP
+-k install|config|uninstall
+Install Apache as a Windows NT service; change startup options for the Apache service; and uninstall the Apache service\&.
+.TP
+-n \fIname\fR
+The \fIname\fR of the Apache service to signal\&.
+.TP
+-w
+Keep the console window open on error so that the error message can be read\&.
+.RE
+

docs/man/logresolve.8

@@ -0,0 +1,50 @@
+.\" XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+.\" DO NOT EDIT! Generated from XML source.
+.\" XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+.de Sh \" Subsection
+.br
+.if t .Sp
+.ne 5
+.PP
+\fB\\$1\fR
+.PP
+..
+.de Sp \" Vertical space (when we can't use .PP)
+.if t .sp .5v
+.if n .sp
+..
+.de Ip \" List item
+.br
+.ie \\n(.$>=3 .ne \\$3
+.el .ne 3
+.IP "\\$1" \\$2
+..
+.TH "LOGRESOLVE" 8 "2003-04-23" "Apache HTTP Server" "logresolve"
+
+.SH "SYNOPSIS"
+
+.PP
+\fBlogresolve\fR [ -\fBs\fR\fIfilename\fR ] [ -\fBc\fR ] < \fIaccess_log\fR > \fIaccess_log\&.new\fR
+
+
+.SH "SUMMARY"
+
+.PP
+logresolve is a post-processing program to resolve IP-addresses 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\&.
+
+.PP
+Takes an Apache log file on standard input\&. The IP addresses must be the first thing on each line and must be seperated from the remainder of the line by a space\&.
+
+
+.SH "OPTIONS"
+
+.RS
+
+.TP
+-s \fIfilename\fR
+Specifies a filename to record statistics\&.
+.TP
+-c
+This causes 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\&.
+.RE
+

docs/man/rotatelogs.8

@@ -0,0 +1,120 @@
+.\" XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+.\" DO NOT EDIT! Generated from XML source.
+.\" XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+.de Sh \" Subsection
+.br
+.if t .Sp
+.ne 5
+.PP
+\fB\\$1\fR
+.PP
+..
+.de Sp \" Vertical space (when we can't use .PP)
+.if t .sp .5v
+.if n .sp
+..
+.de Ip \" List item
+.br
+.ie \\n(.$>=3 .ne \\$3
+.el .ne 3
+.IP "\\$1" \\$2
+..
+.TH "ROTATELOGS" 8 "2003-04-23" "Apache HTTP Server" "rotatelogs"
+
+.SH "SYNOPSIS"
+
+.PP
+\fBrotatelogs\fR\fIlogfile\fR [ \fIrotationtime\fR [ \fIoffset\fR ]] | [ \fIfilesize\fRM ]
+
+
+.SH "SUMMARY"
+
+.PP
+rotatelogs is a simple program for use in conjunction with Apache's piped logfile feature\&. For example:
+
+.nf
+
+     CustomLog "|bin/rotatelogs /var/logs/logfile 86400" common
+
+.fi
+
+.PP
+This creates the files /var/logs/logfile\&.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 rota- tion time (here after 24 hours) a new log is started\&.
+
+.nf
+
+     CustomLog "|bin/rotatelogs /var/logs/logfile 5M" common
+
+.fi
+
+.PP
+This configuration will rotate the logfile whenever it reaches a size of 5 megabytes\&.
+
+
+.SH "OPTIONS"
+
+.RS
+
+.TP
+\fIlogfile\fR
+The path plus basename of the logfile\&. If \fIlogfile\fR includes any '%' characters, it is treated as a format string for strftime(3)\&. Otherwise, the suffix \fI\&.nnnnnnnnnn\fR is automatically added and is the time in seconds\&. Both formats compute the start time from the beginning of the current period\&.
+.TP
+\fIrotationtime\fR
+The time between log file rotations in seconds\&.
+.TP
+\fIoffset\fR
+The number of minutes offset from UTC\&. If omitted, zero is assumed and UTC is used\&. For example, to use local time in the zone UTC -5 hours, specify a value of -300 for this argument\&.
+.TP
+\fIfilesize\fRM
+The maximum file size in megabytes followed by the letter M to specify size rather than time\&. Use this parameter in place of both rotationtime and offset\&.
+.RE
+
+.SH "PORTABILITY"
+
+.PP
+The following logfile format string substitutions should be supported by all strftime(3) implementations, see the strftime(3) man page for library-specific extensions\&.
+
+.Ip "\(bu \s-1%A\s0 \- full weekday name (localized)
+
+.Ip "\(bu \s-1%a\s0 \- 3-character weekday name (localized)
+
+.Ip "\(bu \s-1%B\s0 \- full month name (localized)
+
+.Ip "\(bu \s-1%b\s0 \- 3-character month name (localized)
+
+.Ip "\(bu \s-1%c\s0 \- date and time (localized)
+
+.Ip "\(bu \s-1%d\s0 \- 2-digit day of month
+
+.Ip "\(bu \s-1%H\s0 \- 2-digit hour (24 hour clock)
+
+.Ip "\(bu \s-1%I\s0 \- 2-digit hour (12 hour clock)
+
+.Ip "\(bu \s-1%j\s0 \- 3-digit day of year
+
+.Ip "\(bu \s-1%M\s0 \- 2-digit minute
+
+.Ip "\(bu \s-1%m\s0 \- 2-digit month
+
+.Ip "\(bu \s-1%p\s0 \- am/pm of 12 hour clock (localized)
+
+.Ip "\(bu \s-1%S\s0 \- 2-digit second
+
+.Ip "\(bu \s-1%U\s0 \- 2-digit week of year (Sunday first day of week)
+
+.Ip "\(bu \s-1%W\s0 \- 2-digit week of year (Monday first day of week)
+
+.Ip "\(bu \s-1%w\s0 \- 1-digit weekday (Sunday first day of week)
+
+.Ip "\(bu \s-1%X\s0 \- time (localized)
+
+.Ip "\(bu \s-1%x\s0 \- date (localized)
+
+.Ip "\(bu \s-1%Y\s0 \- 4-digit year
+
+.Ip "\(bu \s-1%y\s0 \- 2-digit year
+
+.Ip "\(bu \s-1%Z\s0 \- time zone name
+
+.Ip "\(bu \s-1%%\s0 \- literal `%'
+