From: Joshua Slive Date: Thu, 14 Nov 2002 16:24:53 +0000 (+0000) Subject: Remove the nroff httpd man page and put in an xml one in the manual. X-Git-Tag: 2.0.44~56 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=4c089d54551267c60d048a552e2382bbde4ef179;p=apache Remove the nroff httpd man page and put in an xml one in the manual. At the same time, update with some new args. More review of this would be good. Reviewed by: Astrid Kessler, Erik Abele, Andr� Malo, Rich Bowen git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@97517 13f79535-47bb-0310-9956-ffa450edef68 --- diff --git a/docs/man/httpd.8 b/docs/man/httpd.8 deleted file mode 100644 index a13162d1d2..0000000000 --- a/docs/man/httpd.8 +++ /dev/null @@ -1,179 +0,0 @@ -.TH httpd 8 "February 1997" -.\" The Apache Software License, Version 1.1 -.\" -.\" Copyright (c) 2000-2002 The Apache Software Foundation. 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. The end-user documentation included with the redistribution, -.\" if any, must include the following acknowledgment: -.\" "This product includes software developed by the -.\" Apache Software Foundation (http://www.apache.org/)." -.\" Alternately, this acknowledgment may appear in the software itself, -.\" if and wherever such third-party acknowledgments normally appear. -.\" -.\" 4. The names "Apache" and "Apache Software Foundation" must -.\" not be used to endorse or promote products derived from this -.\" software without prior written permission. For written -.\" permission, please contact apache@apache.org. -.\" -.\" 5. Products derived from this software may not be called "Apache", -.\" nor may "Apache" appear in their name, without prior written -.\" permission of the Apache Software Foundation. -.\" -.\" THIS SOFTWARE IS PROVIDED ``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 SOFTWARE FOUNDATION 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 Software Foundation. For more -.\" information on the Apache Software Foundation, please see -.\" . -.\" -.SH NAME -httpd \- Apache hypertext transfer protocol server -.SH SYNOPSIS -.B httpd -[ -.BI \-d " serverroot" -] [ -.BI \-f " config" -] [ -.BI \-C " directive" -] [ -.BI \-c " directive" -] [ -.BI \-D " parameter" -] - -.B httpd -[ -.B \-h -] -[ -.B \-l -] -[ -.B \-L -] -[ -.B \-v -] -[ -.B \-V -] -[ -.B \-t -] -[ -.B \-X -] - -.SH DESCRIPTION -.B 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 to handle requests. To stop -it, send a TERM signal to the initial (parent) process. The PID of -this process is written to a file as given in the configuration file. -.PP -This manual page only lists the command line arguments. For details -of the directives necessary to configure -.B httpd -see the Apache manual, -which is part of the Apache distribution or can be found at -http://httpd.apache.org/. Paths in this manual may not reflect those -compiled into -.B httpd. -.SH OPTIONS -.TP 12 -.BI \-d " serverroot" -Set the initial value for the ServerRoot directive to \fIserverroot\fP. This -can be overridden by the ServerRoot command in the configuration file. The -default is \fB/usr/local/apache2\fP. -.TP -.BI \-f " config" -Execute the commands in the file \fIconfig\fP on startup. If \fIconfig\fP -does not begin with a /, then it is taken to be a path relative to -the ServerRoot. The default is \fBconf/httpd.conf\fP. -.TP -.BI \-C " directive" -Process the configuration \fIdirective\fP before reading config files. -.TP -.BI \-c " directive" -Process the configuration \fIdirective\fP after reading config files. -.TP -.BI \-D " parameter" -Sets a configuration \fIparameter\fP which can be used with -... sections in the configuration files -to conditionally skip or process commands. -.TP -.B \-h -Output a short summary of available command line options. -.TP -.B \-l -Output a list of modules compiled into the server. -.TP -.B \-L -Output a list of directives together with expected arguments and -places where the directive is valid. -.TP -.B \-S -Show the settings as parsed from the config file (currently only shows the -virtualhost settings). -.TP -.B \-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 -.BI \-D " DUMP_VHOSTS" -is also set, details of the virtual host configuration will be printed. -.TP -.B \-v -Print the version of -.B httpd -, and then exit. -.TP -.B \-V -Print the version and build parameters of -.B httpd -, and then exit. -.TP -.B \-X -Run -.B httpd -in debug mode. Only one worker will be started and the server will not detach -from the console. -.SH FILES -.PD 0 -.B /usr/local/apache2/conf/httpd.conf -.br -.B /usr/local/apache2/conf/mime.types -.br -.B /usr/local/apache2/conf/magic -.br -.B /usr/local/apache2/logs/error_log -.br -.B /usr/local/apache2/logs/access_log -.br -.B /usr/local/apache2/logs/httpd.pid diff --git a/docs/manual/programs/httpd.html b/docs/manual/programs/httpd.html deleted file mode 100644 index 6ecd536643..0000000000 --- a/docs/manual/programs/httpd.html +++ /dev/null @@ -1,102 +0,0 @@ - - - -Manual Page: httpd - Apache HTTP Server - - -

Manual Page: httpd

- -
-NAME
-     httpd - Apache hypertext transfer protocol server
-
-SYNOPSIS
-     httpd [ -d serverroot ] [ -f config ] [ -C directive ] [  -c
-     directive ] [ -D parameter ]
-
-     httpd [ -h ] [ -l ] [ -L ] [ -v ] [ -V ] [ -t ] [ -X ]
-
-DESCRIPTION
-     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 to handle requests. To stop it, send a TERM
-     signal to the initial (parent) process. The PID of this pro-
-     cess  is  written  to  a  file as given in the configuration
-     file.
-
-     This manual page only lists the command line arguments.  For
-     details  of  the directives necessary to configure httpd see
-     the Apache manual, which is part of the Apache  distribution
-     or  can  be found at http://httpd.apache.org/. Paths in this
-     manual may not reflect those compiled into httpd.
-
-OPTIONS
-     -d serverroot
-                 Set the initial value for the ServerRoot  direc-
-                 tive  to  serverroot.  This can be overridden by
-                 the  ServerRoot  command  in  the  configuration
-                 file. The default is /usr/local/apache2.
-
-     -f config   Execute the  commands  in  the  file  config  on
-                 startup. If config does not begin with a /, then
-                 it is taken to be a path relative to the Server-
-                 Root. The default is conf/httpd.conf.
-
-     -C directive
-                 Process the configuration directive before read-
-                 ing config files.
-
-     -c directive
-                 Process the configuration directive after  read-
-                 ing config files.
-
-     -D parameter
-                 Sets a configuration parameter which can be used
-                 with  <IfDefine>...</IfDefine>  sections  in the
-                 configuration files  to  conditionally  skip  or
-                 process commands.
-
-     -h          Output a short summary of available command line
-                 options.
-
-     -l          Output a  list  of  modules  compiled  into  the
-                 server.
-
-     -L          Output  a  list  of  directives  together   with
-                 expected  arguments  and places where the direc-
-                 tive is valid.
-
-     -S          Show the settings as parsed from the config file
-                 (currently only shows the virtualhost settings).
-
-     -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 DUMP_VHOSTS is also set,  details
-                 of   the  virtual  host  configuration  will  be
-                 printed.
-
-     -v          Print the version of httpd , and then exit.
-
-     -V          Print the version and build parameters of  httpd
-                 , and then exit.
-
-     -X          Run httpd in debug mode.  Only one  worker  will
-                 be  started  and the server will not detach from
-                 the console.
-
-FILES
-     /usr/local/apache2/conf/httpd.conf
-     /usr/local/apache2/conf/mime.types
-     /usr/local/apache2/conf/magic
-     /usr/local/apache2/logs/error_log
-     /usr/local/apache2/logs/access_log
-     /usr/local/apache2/logs/httpd.pid
-
-
- - diff --git a/docs/manual/programs/httpd.html.en b/docs/manual/programs/httpd.html.en new file mode 100644 index 0000000000..477306546f --- /dev/null +++ b/docs/manual/programs/httpd.html.en @@ -0,0 +1,157 @@ + + +httpd - Apache Hypertext Transfer Protocol Server - Apache HTTP Server

Modules | Directives | FAQ | Glossary | Sitemap

Apache HTTP Server Version 2.0

<-

httpd - Apache Hypertext Transfer Protocol Server

+

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.

+ +

In general, httpd should not be invoked directly, + but rather should be invoked via apachectl on unix systems or as an NT + service under win32.

+
top

Synopsis

+ +

httpd [ -d serverroot + ] [ -f config ] [ -C + directive ] [ -c + directive] [ -D parameter + ] [ -e level ] [ -E + file ] [ -k + start|restart|graceful|stop ] [ -R + directory ] [ -h ] [ -l + ] [ -L ] [-S] [ + -t ] [ -v ] [ -V + ] [ -X ]

+ +

On Win32 systems, the + following additional arguments are available:

+ +

httpd [ -k + install|config|uninstall ] [ -n + name ] [ -w ]

+ +
top

Options

+ +
+
-d serverroot
+ +
Set the initial value for the ServerRoot directive to +serverroot. This can be overridden by the ServerRoot +directive in the configuration file. The default is +/usr/local/apache2.
+ +
-f config
+ +
Uses the directives in the file config on startup. If +config does not begin with a /, then it is taken to be a +path relative to the ServerRoot. The default is +conf/httpd.conf.
+ +
-k start|restart|graceful|stop
+ +
Signals httpd to start, restart, or stop. See Stopping Apache for more information.
+ +
-C directive
+ +
Process the configuration directive before reading +config files.
+ +
-c directive
+ +
Process the configuration directive after reading config +files.
+ + +
-D parameter
+ +
Sets a configuration parameter which can be used with +<IfDefine> sections +in the configuration files to conditionally skip or process +commands at server startup and restart.
+ +
-e level
+ +
Sets the LogLevel to +level during server startup. This is useful for +temporarily increasing the verbosity of the error messages to find +problems during startup.
+ +
-E file
+ +
Send error messages during server startup to file.
+ +
-R directory
+ +
When the server is compiled using the SHARED_CORE +rule, this specifies the directory for the shared +object files.
+ +
-h
+ +
Output a short summary of available command line options.
+ +
-l
+ +
Output a list of modules compiled into the server. This will +not list dynamically loaded modules included using +the LoadModule directive.
+ +
-L
+ +
Output a list of directives together with expected arguments and +places where the directive is valid.
+ +
-S
+ +
Show the settings as parsed from the config file (currently only +shows the virtualhost settings).
+ +
-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 +DUMP_VHOSTS is also set, details of the virtual host +configuration will be printed.
+ +
-v
+ +
Print the version of httpd, and then exit.
+ +
-V
+ +
Print the version and build parameters of httpd, and +then exit.
+ +
-X
+ +
Run httpd in debug mode. Only one worker will be started and the +server will not detach from the console.
+ +
+ +

The following arguments are available only on the win32 platform:

+ +
+ +
-k install|config|uninstall
+ +
Install Apache as a Windows NT service; change startup options for +the Apache service; and uninstall the Apache service.
+ +
-n name
+ +
The name of the Apache service to signal.
+ +
-w
+ +
Hold the console window open on error so that the error message can +be read.
+ +
+ +
\ No newline at end of file diff --git a/docs/manual/programs/httpd.xml b/docs/manual/programs/httpd.xml new file mode 100644 index 0000000000..13d0fc8d9a --- /dev/null +++ b/docs/manual/programs/httpd.xml @@ -0,0 +1,177 @@ + + + + + +Programs + + httpd - Apache Hypertext Transfer Protocol Server + + +

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.

+ +

In general, httpd should not be invoked directly, + but rather should be invoked via apachectl on unix systems or as an NT + service under win32.

+ + +Starting Apache +Stopping Apache +Configuration Files +Platform Docs +apachectl + +
Synopsis + +

httpd [ -d serverroot + ] [ -f config ] [ -C + directive ] [ -c + directive] [ -D parameter + ] [ -e level ] [ -E + file ] [ -k + start|restart|graceful|stop ] [ -R + directory ] [ -h ] [ -l + ] [ -L ] [-S] [ + -t ] [ -v ] [ -V + ] [ -X ]

+ +

On Win32 systems, the + following additional arguments are available:

+ +

httpd [ -k + install|config|uninstall ] [ -n + name ] [ -w ]

+ +
+ +
Options + +
+
-d serverroot
+ +
Set the initial value for the ServerRoot directive to +serverroot. This can be overridden by the ServerRoot +directive in the configuration file. The default is +/usr/local/apache2.
+ +
-f config
+ +
Uses the directives in the file config on startup. If +config does not begin with a /, then it is taken to be a +path relative to the ServerRoot. The default is +conf/httpd.conf.
+ +
-k start|restart|graceful|stop
+ +
Signals httpd to start, restart, or stop. See Stopping Apache for more information.
+ +
-C directive
+ +
Process the configuration directive before reading +config files.
+ +
-c directive
+ +
Process the configuration directive after reading config +files.
+ + +
-D parameter
+ +
Sets a configuration parameter which can be used with +IfDefine sections +in the configuration files to conditionally skip or process +commands at server startup and restart.
+ +
-e level
+ +
Sets the LogLevel to +level during server startup. This is useful for +temporarily increasing the verbosity of the error messages to find +problems during startup.
+ +
-E file
+ +
Send error messages during server startup to file.
+ +
-R directory
+ +
When the server is compiled using the SHARED_CORE +rule, this specifies the directory for the shared +object files.
+ +
-h
+ +
Output a short summary of available command line options.
+ +
-l
+ +
Output a list of modules compiled into the server. This will +not list dynamically loaded modules included using +the LoadModule directive.
+ +
-L
+ +
Output a list of directives together with expected arguments and +places where the directive is valid.
+ +
-S
+ +
Show the settings as parsed from the config file (currently only +shows the virtualhost settings).
+ +
-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 +DUMP_VHOSTS is also set, details of the virtual host +configuration will be printed.
+ +
-v
+ +
Print the version of httpd, and then exit.
+ +
-V
+ +
Print the version and build parameters of httpd, and +then exit.
+ +
-X
+ +
Run httpd in debug mode. Only one worker will be started and the +server will not detach from the console.
+ +
+ +

The following arguments are available only on the win32 platform:

+ +
+ +
-k install|config|uninstall
+ +
Install Apache as a Windows NT service; change startup options for +the Apache service; and uninstall the Apache service.
+ +
-n name
+ +
The name of the Apache service to signal.
+ +
-w
+ +
Hold the console window open on error so that the error message can +be read.
+ +
+ +
+ +