From: pcs Date: Fri, 20 Nov 1998 16:39:03 +0000 (+0000) Subject: Make documentation clearer for Windows users: state when descriptions X-Git-Tag: 1.3.4~25 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=ffa0b686b48804766633cb8dddcaaf01430192ca;p=apache Make documentation clearer for Windows users: state when descriptions apply only to Unix; add links to Windows and TPF instructions. Where defaults are different in OS/2 or Windows, show them. Add the -k command line option (Windows only). git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@82409 13f79535-47bb-0310-9956-ffa450edef68 --- diff --git a/docs/manual/install.html b/docs/manual/install.html index 97c30285d6..40cad3178b 100644 --- a/docs/manual/install.html +++ b/docs/manual/install.html @@ -16,6 +16,14 @@

Compiling and Installing Apache 1.3

+This document covers compilation and installation of Apache on Unix +systems only. For compiling and installation on Windows, see Using Apache with Microsoft Windows and for +TPF see Installing the Apache 1.3 HTTP +Server on TPF. + +

+ UnixWare users will want to consult build notes for various UnixWare versions before compiling. diff --git a/docs/manual/install.html.en b/docs/manual/install.html.en index 97c30285d6..40cad3178b 100644 --- a/docs/manual/install.html.en +++ b/docs/manual/install.html.en @@ -16,6 +16,14 @@

Compiling and Installing Apache 1.3

+This document covers compilation and installation of Apache on Unix +systems only. For compiling and installation on Windows, see Using Apache with Microsoft Windows and for +TPF see Installing the Apache 1.3 HTTP +Server on TPF. + +

+ UnixWare users will want to consult build notes for various UnixWare versions before compiling. diff --git a/docs/manual/invoking.html b/docs/manual/invoking.html index 957d4d1c8f..3c699d74e4 100644 --- a/docs/manual/invoking.html +++ b/docs/manual/invoking.html @@ -16,12 +16,19 @@

Starting Apache

Invoking Apache

-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 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

The following options are recognized on the httpd command line: @@ -29,8 +36,10 @@ The following options are recognized on the httpd command line:
-d serverroot
Set the initial value for the ServerRoot variable to -serverroot. This can be overridden by the ServerRoot command in the -configuration file. The default is /usr/local/apache. +serverroot. 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.
-D name
Define a name for use in in @@ -86,16 +95,21 @@ 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. +
-k option +
Windows only: signal Apache to restart or shutdown. option +is one of "shutdown" or "restart". (New in Apache 1.3.3). +
-?
Print a list of the httpd options, and then exit.

Configuration files

-The server will read three files for configuration directives. Any directive -may appear in any of these files. The the names of these files are taken -to be relative to the server root; this is set by the -ServerRoot directive, or the --d command line flag. +The server will read three files for configuration directives. Any +directive may appear in any of these files. The the names of these +files are taken to be relative to the server root; this is set by the +ServerRoot directive, the +-d command line flag, or (on Windows only) the registry +(see Running Apache for Windows). Conventionally, the files are:
@@ -129,30 +143,40 @@ access to the directory the logs are stored in without being aware of the consequences; see the security tips document for details.

pid file

-On daemon startup, it saves the process id of the parent httpd process to -the file logs/httpd.pid. This filename can be changed with the -PidFile directive. The process-id is for -use by the administrator in restarting and terminating the daemon; -A HUP or USR1 signal causes the daemon to re-read its configuration files and -a TERM signal causes it to die gracefully. For more information -see the Stopping and Restarting page. + +On startup, Apache saves the process id of the parent httpd process to +the file logs/httpd.pid. This filename can be changed +with the PidFile directive. The +process-id is for use by the administrator in restarting and +terminating the daemon: on Unix, a HUP or USR1 signal causes the +daemon to re-read its configuration files and a TERM signal causes it +to die gracefully; on Windows, use the -k command line option instead. +For more information see the Stopping and +Restarting page. +

If the process dies (or is killed) abnormally, then it will be necessary to kill the children httpd processes.

Error log

-The server will log error messages to a log file, logs/error_log -by default. The filename can be set using the -ErrorLog directive; different error logs -can -be set for different virtual hosts. + +The server will log error messages to a log file, by default +logs/error_log on Unix or logs/error.log on +OS/2. The filename can be set using the ErrorLog directive; different error +logs can be set for different virtual hosts.

Transfer log

-The server will typically log each request to a transfer file, -logs/access_log by default. The filename can be set using a -TransferLog directive; -different transfer logs can be set for different -virtual hosts. + +The server will typically log each request to a transfer file, by +default logs/access_log on Unix or +logs/access.log on OS/2. The filename can be set using a +TransferLog +directive or additional log files created with the CustomLog directive; +different transfer logs can be set for different virtual hosts. diff --git a/docs/manual/invoking.html.en b/docs/manual/invoking.html.en index 957d4d1c8f..3c699d74e4 100644 --- a/docs/manual/invoking.html.en +++ b/docs/manual/invoking.html.en @@ -16,12 +16,19 @@

Starting Apache

Invoking Apache

-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 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

The following options are recognized on the httpd command line: @@ -29,8 +36,10 @@ The following options are recognized on the httpd command line:
-d serverroot
Set the initial value for the ServerRoot variable to -serverroot. This can be overridden by the ServerRoot command in the -configuration file. The default is /usr/local/apache. +serverroot. 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.
-D name
Define a name for use in in @@ -86,16 +95,21 @@ 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. +
-k option +
Windows only: signal Apache to restart or shutdown. option +is one of "shutdown" or "restart". (New in Apache 1.3.3). +
-?
Print a list of the httpd options, and then exit.

Configuration files

-The server will read three files for configuration directives. Any directive -may appear in any of these files. The the names of these files are taken -to be relative to the server root; this is set by the -ServerRoot directive, or the --d command line flag. +The server will read three files for configuration directives. Any +directive may appear in any of these files. The the names of these +files are taken to be relative to the server root; this is set by the +ServerRoot directive, the +-d command line flag, or (on Windows only) the registry +(see Running Apache for Windows). Conventionally, the files are:
@@ -129,30 +143,40 @@ access to the directory the logs are stored in without being aware of the consequences; see the security tips document for details.

pid file

-On daemon startup, it saves the process id of the parent httpd process to -the file logs/httpd.pid. This filename can be changed with the -PidFile directive. The process-id is for -use by the administrator in restarting and terminating the daemon; -A HUP or USR1 signal causes the daemon to re-read its configuration files and -a TERM signal causes it to die gracefully. For more information -see the Stopping and Restarting page. + +On startup, Apache saves the process id of the parent httpd process to +the file logs/httpd.pid. This filename can be changed +with the PidFile directive. The +process-id is for use by the administrator in restarting and +terminating the daemon: on Unix, a HUP or USR1 signal causes the +daemon to re-read its configuration files and a TERM signal causes it +to die gracefully; on Windows, use the -k command line option instead. +For more information see the Stopping and +Restarting page. +

If the process dies (or is killed) abnormally, then it will be necessary to kill the children httpd processes.

Error log

-The server will log error messages to a log file, logs/error_log -by default. The filename can be set using the -ErrorLog directive; different error logs -can -be set for different virtual hosts. + +The server will log error messages to a log file, by default +logs/error_log on Unix or logs/error.log on +OS/2. The filename can be set using the ErrorLog directive; different error +logs can be set for different virtual hosts.

Transfer log

-The server will typically log each request to a transfer file, -logs/access_log by default. The filename can be set using a -TransferLog directive; -different transfer logs can be set for different -virtual hosts. + +The server will typically log each request to a transfer file, by +default logs/access_log on Unix or +logs/access.log on OS/2. The filename can be set using a +TransferLog +directive or additional log files created with the CustomLog directive; +different transfer logs can be set for different virtual hosts. diff --git a/docs/manual/stopping.html b/docs/manual/stopping.html index 3d03d4df97..73690ea913 100644 --- a/docs/manual/stopping.html +++ b/docs/manual/stopping.html @@ -15,6 +15,11 @@

Stopping and Restarting Apache

+

This document covers stopping and restarting Apache on Windows +only. Windows uses should see Signalling +Apache when running.

+ +

You will notice many httpd executables running on your system, but you should not send signals to any of them except the parent, whose pid is in the PidFile. That is to diff --git a/docs/manual/stopping.html.en b/docs/manual/stopping.html.en index 3d03d4df97..73690ea913 100644 --- a/docs/manual/stopping.html.en +++ b/docs/manual/stopping.html.en @@ -15,6 +15,11 @@

Stopping and Restarting Apache

+

This document covers stopping and restarting Apache on Windows +only. Windows uses should see Signalling +Apache when running.

+ +

You will notice many httpd executables running on your system, but you should not send signals to any of them except the parent, whose pid is in the PidFile. That is to