From: Joshua Slive Date: Tue, 28 Nov 2000 21:33:02 +0000 (+0000) Subject: Update command line options docs to match what is currently X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=0b93d714b8cce15188787ca6c782d021cccd3d6b;p=apache Update command line options docs to match what is currently in http_main.c. Also, add documentation on apachectl options. git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@87108 13f79535-47bb-0310-9956-ffa450edef68 --- diff --git a/docs/manual/STATUS b/docs/manual/STATUS index 4ed36c7042..a64e9297dc 100644 --- a/docs/manual/STATUS +++ b/docs/manual/STATUS @@ -11,6 +11,8 @@ apache-docs-subscribe@apache.org about its operation. Status: Initial outlines done. Much more details need to be filled in. + - Non unix/windows MPMs still need to be completed. + - perchild MPM needs some docs. - Merging of changes in 1.3. - There have been many changes in the 1.3 docs which haven't @@ -18,12 +20,6 @@ apache-docs-subscribe@apache.org Things which need to be merged: manual/howto/* -- Reorganizing. - - Joshua thinks this is a good opportunity to think about directory - structure. - Proposal: - Create manual/FAQ which contains all the manual/misc/FAQ* docs - - Cleaning. - We could use a list of all the docs that can be axed out of 2.0 because they are redundant or irrelevant. @@ -35,10 +31,9 @@ apache-docs-subscribe@apache.org manual/process-model.html (documented in MPMs, eventually) manual/mod/index-bytype.html - - Individual docs will need some cleanup. For example, - manual/invoking.html could use a big cleanup with lots of the - "this changed in 1.3.10" stuff removed. - + - Individual docs will need some cleanup. + Status: What docs still need to be touched here? + - invoking.html has had a first-pass cleaning done. - New build process. - The new build process is autoconf based, so manual/install.html @@ -55,6 +50,9 @@ apache-docs-subscribe@apache.org enough to know what is going on. Status: Ryan has two ApacheToday articles which may be useful for this. + New features which need documentation: + - filters !!! + - Translations Status: ??? diff --git a/docs/manual/invoking.html b/docs/manual/invoking.html index 9299ff9aad..56ce67bf81 100644 --- a/docs/manual/invoking.html +++ b/docs/manual/invoking.html @@ -15,28 +15,83 @@

Starting Apache

-

Invoking Apache

- -On Unix, the httpd program is usually run as a daemon -which executes continuously, handling requests. It is possible to -invoke Apache by the Internet daemon inetd each time a -connection to the HTTP service is made (use the ServerType directive) but this is -not recommended. - -

- -On Windows, Apache is normally run as a service on Windows NT, or as a -console application on Windows 95. See also running Apache for Windows. - -

Command line options

+

Starting Apache On Windows

+ +

On Windows, Apache is normally run as a service on Windows NT, or +as a console application on Windows 95. For details, see running Apache for Windows.

+ +

Starting Apache on Unix

+ +

On Unix, the httpd program is run as a daemon +which executes continuously in the background to handle requests. +A shell script called apachectl is provided which +can be used to control the daemon process. This shell script +can often be used as an init script to start httpd +on system boot, or it can be called directly with the following +options.

+ +

apachectl Command Line Options

+ +
+ +
start
Start httpd. If +additional command line options need to be passed to +httpd (see below), then the HTTPD variable +at the top of the apachectl script should be edited to +include them.
+ +
stop
+
Stop httpd by issuing the kill signal to the +parent httpd process, whose process ID is contained +in the file pointed to by the +PidFile directive.
+ +
restart
+
Restart httpd if it is running by sending a +SIGHUP +signal to the parent process. If the server is not running, then +it will be started. apachectl will refuse to +restart the server if there is a syntax error in the configuration +files (see configtest below).
+ +
graceful
Restart httpd if it is +running by sending a SIGWINCH signal to the parent +process. This type of restart is less disruptive to current clients. +If the server is not running, then it will be +started. apachectl will refuse to restart the server if +there is a syntax error in the configuration files.
+ +
fullstatus
+
Show a screen indicating the status of the Apache processes. +This option requires the presence of lynx, and +for mod_status to be enabled.
+ +
status
+
A shorter form of the fullstatus display. +This option requires the presence of lynx, and +for mod_status to be enabled.
+ +
configtest
+
Do a syntax test of the Apache configuration files. See +the httpd -t command line option below.
+
help
+
Show a help screen.
+ +
+ +

For additional information on the effects of the various +apachectl options, see the documentation on stopping and restarting Apache.

+ +

httpd Command Line Options

The following options are recognized on the httpd command line:
-
-d serverroot + +
-d directory
Set the initial value for the ServerRoot variable to -serverroot. This can be overridden by the ServerRoot command +directory. This can be overridden by the ServerRoot command in the configuration file. The default is /usr/local/apache on Unix, /apache on Windows and /os2httpd on OS/2. @@ -49,25 +104,21 @@ configuration file, or to use a common configuration for several independent hosts, where host specific information is enclosed in <IfDefine> sections. -
-f config -
Execute the commands in the file config on startup. If +
-f file +
Execute the commands in the file 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. -
-C "directive" -
Process the given apache "directive" (just as if it had been part of a -configuration file) before actually reading the regular configuration files. +
-C "directive" +
Process the given apache "directive" (just as if it had been part +of a configuration file) before actually reading the +regular configuration files.
-c "directive"
Process the given apache "directive" after reading all the regular configuration files. -
-X -
Run in single-process mode, for internal debugging purposes only; the -daemon does not detach from the terminal or fork any children. Do NOT -use this mode to provide ordinary web service. -
-v
Print the version of httpd and its build date, and then exit. @@ -79,48 +130,27 @@ behavior and performance of the apache server (e.g., then exit.
-L -
- -Give a list of directives together with expected arguments and places -where the directive is valid, then exit. (Apache 1.3.4 and -later. Earlier versions used -l instead). - +
Give a list of directives together with expected arguments and places +where the directive is valid, then exit.
-l -
- -Give a list of all modules compiled into the server, then exit. -(Apache 1.3.4 and later. Earlier versions used -h instead).
- -Give a list of directives together with expected arguments and places -where the directive is valid, then exit. (Apache 1.2 to 1.3.3. Later -versions use -L instead). - - +
Give a list of all modules compiled into the server, then exit.
-h -
+
Print a list of the httpd command line options, then exit. -Print a list of the httpd options, then exit. (Apache 1.3.4 and -later. Earlier versions used -? instead).
+
-t +
Test the configuration file syntax +(i.e., read all configuration files and interpret them) but +do not start the server. If the configuration contains errors, display +an error message and exit with a non-zero exit status, otherwise +display "Syntax OK" and terminate with a zero exit status. This +command checks to see if all DocumentRoot entries exist and are +directories. For sites with many vhosts, this is expensive; consider +the -T command instead.
-Give a list of all modules compiled into the server, then exit. (Up to -Apache 1.3.3. Later versions use -l instead).
- - -
-S -
Show the settings as parsed from the config file (currently only -shows a breakdown of the vhost settings) but do not start the -server. (Up to Apache 1.3.3, this option also started the server). - -
-t -
Test the configuration file syntax (i.e., read all configuration files -and interpret them) but do not start the server. If the configuration contains -errors, display an error message and exit with a non-zero exit status, -otherwise display "Syntax OK" and terminate with a zero exit status. This -command checks to see if all DocumentRoot entries exist and are directories. -For sites with many vhosts, this is expensive; consider the -T -command instead. +To check and print a summary of the current virtual host settings, +use -t -D DUMP_VHOSTS.
-T
Test the configuration file syntax (i.e., read all configuration files @@ -129,15 +159,34 @@ errors, display an error message and exit with a non-zero exit status, otherwise display "Syntax OK" and terminate with a zero exit status. This command does not perform any checking of the DocumentRoot entries. +
-R directory
+
If Apache is compiled with SHARED_CORE, then this +directive can be used to specify an alternate location for shared +object files.
+ +
+ +

When Apache is used under Windows, the following additional +command line options are available.

+ +
+ +
-n name
+
Set service name and use its ServerConfigFile.
+
-k option -
Windows only: signal Apache to restart or shutdown. option -is one of "shutdown" or "restart". (Apache 1.3.3 and later). +
Signal Apache to restart or shutdown. option +is one of "shutdown" or "restart". + +
-i
+
Install an Apache service
+ +
-u
+
Uninstall an Apache Service
+ +
-
-? -
Print a list of the httpd options, and then exit (up to Apache -1.3.3. Later version use -h instead). - diff --git a/docs/manual/invoking.html.en b/docs/manual/invoking.html.en index 9299ff9aad..56ce67bf81 100644 --- a/docs/manual/invoking.html.en +++ b/docs/manual/invoking.html.en @@ -15,28 +15,83 @@

Starting Apache

-

Invoking Apache

- -On Unix, the httpd program is usually run as a daemon -which executes continuously, handling requests. It is possible to -invoke Apache by the Internet daemon inetd each time a -connection to the HTTP service is made (use the ServerType directive) but this is -not recommended. - -

- -On Windows, Apache is normally run as a service on Windows NT, or as a -console application on Windows 95. See also running Apache for Windows. - -

Command line options

+

Starting Apache On Windows

+ +

On Windows, Apache is normally run as a service on Windows NT, or +as a console application on Windows 95. For details, see running Apache for Windows.

+ +

Starting Apache on Unix

+ +

On Unix, the httpd program is run as a daemon +which executes continuously in the background to handle requests. +A shell script called apachectl is provided which +can be used to control the daemon process. This shell script +can often be used as an init script to start httpd +on system boot, or it can be called directly with the following +options.

+ +

apachectl Command Line Options

+ +
+ +
start
Start httpd. If +additional command line options need to be passed to +httpd (see below), then the HTTPD variable +at the top of the apachectl script should be edited to +include them.
+ +
stop
+
Stop httpd by issuing the kill signal to the +parent httpd process, whose process ID is contained +in the file pointed to by the +PidFile directive.
+ +
restart
+
Restart httpd if it is running by sending a +SIGHUP +signal to the parent process. If the server is not running, then +it will be started. apachectl will refuse to +restart the server if there is a syntax error in the configuration +files (see configtest below).
+ +
graceful
Restart httpd if it is +running by sending a SIGWINCH signal to the parent +process. This type of restart is less disruptive to current clients. +If the server is not running, then it will be +started. apachectl will refuse to restart the server if +there is a syntax error in the configuration files.
+ +
fullstatus
+
Show a screen indicating the status of the Apache processes. +This option requires the presence of lynx, and +for mod_status to be enabled.
+ +
status
+
A shorter form of the fullstatus display. +This option requires the presence of lynx, and +for mod_status to be enabled.
+ +
configtest
+
Do a syntax test of the Apache configuration files. See +the httpd -t command line option below.
+
help
+
Show a help screen.
+ +
+ +

For additional information on the effects of the various +apachectl options, see the documentation on stopping and restarting Apache.

+ +

httpd Command Line Options

The following options are recognized on the httpd command line:
-
-d serverroot + +
-d directory
Set the initial value for the ServerRoot variable to -serverroot. This can be overridden by the ServerRoot command +directory. This can be overridden by the ServerRoot command in the configuration file. The default is /usr/local/apache on Unix, /apache on Windows and /os2httpd on OS/2. @@ -49,25 +104,21 @@ configuration file, or to use a common configuration for several independent hosts, where host specific information is enclosed in <IfDefine> sections. -
-f config -
Execute the commands in the file config on startup. If +
-f file +
Execute the commands in the file 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. -
-C "directive" -
Process the given apache "directive" (just as if it had been part of a -configuration file) before actually reading the regular configuration files. +
-C "directive" +
Process the given apache "directive" (just as if it had been part +of a configuration file) before actually reading the +regular configuration files.
-c "directive"
Process the given apache "directive" after reading all the regular configuration files. -
-X -
Run in single-process mode, for internal debugging purposes only; the -daemon does not detach from the terminal or fork any children. Do NOT -use this mode to provide ordinary web service. -
-v
Print the version of httpd and its build date, and then exit. @@ -79,48 +130,27 @@ behavior and performance of the apache server (e.g., then exit.
-L -
- -Give a list of directives together with expected arguments and places -where the directive is valid, then exit. (Apache 1.3.4 and -later. Earlier versions used -l instead). - +
Give a list of directives together with expected arguments and places +where the directive is valid, then exit.
-l -
- -Give a list of all modules compiled into the server, then exit. -(Apache 1.3.4 and later. Earlier versions used -h instead).
- -Give a list of directives together with expected arguments and places -where the directive is valid, then exit. (Apache 1.2 to 1.3.3. Later -versions use -L instead). - - +
Give a list of all modules compiled into the server, then exit.
-h -
+
Print a list of the httpd command line options, then exit. -Print a list of the httpd options, then exit. (Apache 1.3.4 and -later. Earlier versions used -? instead).
+
-t +
Test the configuration file syntax +(i.e., read all configuration files and interpret them) but +do not start the server. If the configuration contains errors, display +an error message and exit with a non-zero exit status, otherwise +display "Syntax OK" and terminate with a zero exit status. This +command checks to see if all DocumentRoot entries exist and are +directories. For sites with many vhosts, this is expensive; consider +the -T command instead.
-Give a list of all modules compiled into the server, then exit. (Up to -Apache 1.3.3. Later versions use -l instead).
- - -
-S -
Show the settings as parsed from the config file (currently only -shows a breakdown of the vhost settings) but do not start the -server. (Up to Apache 1.3.3, this option also started the server). - -
-t -
Test the configuration file syntax (i.e., read all configuration files -and interpret them) but do not start the server. If the configuration contains -errors, display an error message and exit with a non-zero exit status, -otherwise display "Syntax OK" and terminate with a zero exit status. This -command checks to see if all DocumentRoot entries exist and are directories. -For sites with many vhosts, this is expensive; consider the -T -command instead. +To check and print a summary of the current virtual host settings, +use -t -D DUMP_VHOSTS.
-T
Test the configuration file syntax (i.e., read all configuration files @@ -129,15 +159,34 @@ errors, display an error message and exit with a non-zero exit status, otherwise display "Syntax OK" and terminate with a zero exit status. This command does not perform any checking of the DocumentRoot entries. +
-R directory
+
If Apache is compiled with SHARED_CORE, then this +directive can be used to specify an alternate location for shared +object files.
+ +
+ +

When Apache is used under Windows, the following additional +command line options are available.

+ +
+ +
-n name
+
Set service name and use its ServerConfigFile.
+
-k option -
Windows only: signal Apache to restart or shutdown. option -is one of "shutdown" or "restart". (Apache 1.3.3 and later). +
Signal Apache to restart or shutdown. option +is one of "shutdown" or "restart". + +
-i
+
Install an Apache service
+ +
-u
+
Uninstall an Apache Service
+ +
-
-? -
Print a list of the httpd options, and then exit (up to Apache -1.3.3. Later version use -h instead). -