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

6 files changed, 134 insertions, 60 deletions

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 @@
 
 <H1 ALIGN="CENTER">Compiling and Installing Apache 1.3</H1>
 
+This document covers compilation and installation of Apache on Unix
+systems only. For compiling and installation on Windows, see <A
+HREF="windows.html">Using Apache with Microsoft Windows</A> and for
+TPF see <A HREF="install-tpf.html">Installing the Apache 1.3 HTTP
+Server on TPF</A>.
+
+<P>
+
 UnixWare users will want to consult <A HREF="unixware.html">build notes</A>
 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 @@
 
 <H1 ALIGN="CENTER">Compiling and Installing Apache 1.3</H1>
 
+This document covers compilation and installation of Apache on Unix
+systems only. For compiling and installation on Windows, see <A
+HREF="windows.html">Using Apache with Microsoft Windows</A> and for
+TPF see <A HREF="install-tpf.html">Installing the Apache 1.3 HTTP
+Server on TPF</A>.
+
+<P>
+
 UnixWare users will want to consult <A HREF="unixware.html">build notes</A>
 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 @@
 <H1 ALIGN="CENTER">Starting Apache</H1>
 
 <H2>Invoking Apache</H2>
-The <CODE>httpd</CODE> program is usually run as a daemon which executes
-continuously, handling requests.  It is possible to invoke Apache by
-the Internet daemon <CODE>inetd</CODE> each time a connection to the HTTP
-service is made (use the
-<A HREF="mod/core.html#servertype">ServerType</A> directive)
-but this is not recommended.
+
+On Unix, the <CODE>httpd</CODE> program is usually run as a daemon
+which executes continuously, handling requests.  It is possible to
+invoke Apache by the Internet daemon <CODE>inetd</CODE> each time a
+connection to the HTTP service is made (use the <A
+HREF="mod/core.html#servertype">ServerType</A> directive) but this is
+not recommended.
+
+<P>
+
+On Windows, Apache is normally run as a service on Windows NT, or as a
+console application on Windows 95. See also <A
+HREF="windows.html#run">running Apache for Windows</A>.
 
 <H2>Command line options</H2>
 The following options are recognized on the httpd command line:
@@ -29,8 +36,10 @@ The following options are recognized on the httpd command line:
 <DT><CODE>-d</CODE> <EM>serverroot</EM>
 <DD>Set the initial value for the
 <A HREF="mod/core.html#serverroot">ServerRoot</A> variable to
-<EM>serverroot</EM>. This can be overridden by the ServerRoot command in the
-configuration file. The default is <CODE>/usr/local/apache</CODE>.
+<EM>serverroot</EM>. This can be overridden by the ServerRoot command
+in the configuration file. The default is
+<CODE>/usr/local/apache</CODE> on Unix, <CODE>/apache</CODE> on
+Windows and <CODE>/os2httpd</CODE> on OS/2.
 
 <DT><CODE>-D</CODE> <EM>name</EM>
 <DD>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.
 
+<DT><CODE>-k</CODE> <EM>option</EM>
+<DD>Windows only: signal Apache to restart or shutdown. <EM>option</EM> 
+is one of "shutdown" or "restart". (New in Apache 1.3.3).
+
 <DT><CODE>-?</CODE>
 <DD>Print a list of the httpd options, and then exit.
 </DL>
 
 <H2>Configuration files</H2>
-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
-<A HREF="mod/core.html#serverroot">ServerRoot</A> directive, or the
-<CODE>-d</CODE> 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
+<A HREF="mod/core.html#serverroot">ServerRoot</A> directive, the
+<CODE>-d</CODE> command line flag, or (on Windows only) the registry
+(see <A HREF="windows.html#run">Running Apache for Windows</A>).
 
 Conventionally, the files are:
 <DL>
@@ -129,30 +143,40 @@ access to the directory the logs are stored in without being aware of
 the consequences; see the <A HREF="misc/security_tips.html">security tips</A>
 document for details.
 <H3>pid file</H3>
-On daemon startup, it saves the process id of the parent httpd process to
-the file <CODE>logs/httpd.pid</CODE>. This filename can be changed with the
-<A HREF="mod/core.html#pidfile">PidFile</A> 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 <A HREF="stopping.html">Stopping and Restarting</A> page.
+
+On startup, Apache saves the process id of the parent httpd process to
+the file <CODE>logs/httpd.pid</CODE>. This filename can be changed
+with the <A HREF="mod/core.html#pidfile">PidFile</A> 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 <A HREF="stopping.html">Stopping and
+Restarting</A> page.
+
 <P>
 If the process dies (or is killed) abnormally, then it will be necessary to
 kill the children httpd processes.
 
 <H3>Error log</H3>
-The server will log error messages to a log file, <CODE>logs/error_log</CODE>
-by default. The filename can be set using the
-<A HREF="mod/core.html#errorlog">ErrorLog</A> directive; different error logs
-can
-be set for different <A HREF="mod/core.html#virtualhost">virtual hosts</A>.
+
+The server will log error messages to a log file, by default
+<CODE>logs/error_log</CODE> on Unix or <CODE>logs/error.log</CODE> on
+OS/2. The filename can be set using the <A
+HREF="mod/core.html#errorlog">ErrorLog</A> directive; different error
+logs can be set for different <A
+HREF="mod/core.html#virtualhost">virtual hosts</A>.
 
 <H3>Transfer log</H3>
-The server will typically log each request to a transfer file,
-<CODE>logs/access_log</CODE> by default. The filename can be set using a
-<A HREF="mod/mod_log_config.html#transferlog">TransferLog</A> directive;
-different transfer logs can be set for different
-<A HREF="mod/core.html#virtualhost">virtual hosts</A>.
+
+The server will typically log each request to a transfer file, by
+default <CODE>logs/access_log</CODE> on Unix or
+<CODE>logs/access.log</CODE> on OS/2. The filename can be set using a
+<A HREF="mod/mod_log_config.html#transferlog">TransferLog</A>
+directive or additional log files created with the <A
+HREF="mod/mod_log_config.html#customlog">CustomLog</A> directive;
+different transfer logs can be set for different <A
+HREF="mod/core.html#virtualhost">virtual hosts</A>.
 
 <!--#include virtual="footer.html" -->
 </BODY>
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 @@
 <H1 ALIGN="CENTER">Starting Apache</H1>
 
 <H2>Invoking Apache</H2>
-The <CODE>httpd</CODE> program is usually run as a daemon which executes
-continuously, handling requests.  It is possible to invoke Apache by
-the Internet daemon <CODE>inetd</CODE> each time a connection to the HTTP
-service is made (use the
-<A HREF="mod/core.html#servertype">ServerType</A> directive)
-but this is not recommended.
+
+On Unix, the <CODE>httpd</CODE> program is usually run as a daemon
+which executes continuously, handling requests.  It is possible to
+invoke Apache by the Internet daemon <CODE>inetd</CODE> each time a
+connection to the HTTP service is made (use the <A
+HREF="mod/core.html#servertype">ServerType</A> directive) but this is
+not recommended.
+
+<P>
+
+On Windows, Apache is normally run as a service on Windows NT, or as a
+console application on Windows 95. See also <A
+HREF="windows.html#run">running Apache for Windows</A>.
 
 <H2>Command line options</H2>
 The following options are recognized on the httpd command line:
@@ -29,8 +36,10 @@ The following options are recognized on the httpd command line:
 <DT><CODE>-d</CODE> <EM>serverroot</EM>
 <DD>Set the initial value for the
 <A HREF="mod/core.html#serverroot">ServerRoot</A> variable to
-<EM>serverroot</EM>. This can be overridden by the ServerRoot command in the
-configuration file. The default is <CODE>/usr/local/apache</CODE>.
+<EM>serverroot</EM>. This can be overridden by the ServerRoot command
+in the configuration file. The default is
+<CODE>/usr/local/apache</CODE> on Unix, <CODE>/apache</CODE> on
+Windows and <CODE>/os2httpd</CODE> on OS/2.
 
 <DT><CODE>-D</CODE> <EM>name</EM>
 <DD>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.
 
+<DT><CODE>-k</CODE> <EM>option</EM>
+<DD>Windows only: signal Apache to restart or shutdown. <EM>option</EM> 
+is one of "shutdown" or "restart". (New in Apache 1.3.3).
+
 <DT><CODE>-?</CODE>
 <DD>Print a list of the httpd options, and then exit.
 </DL>
 
 <H2>Configuration files</H2>
-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
-<A HREF="mod/core.html#serverroot">ServerRoot</A> directive, or the
-<CODE>-d</CODE> 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
+<A HREF="mod/core.html#serverroot">ServerRoot</A> directive, the
+<CODE>-d</CODE> command line flag, or (on Windows only) the registry
+(see <A HREF="windows.html#run">Running Apache for Windows</A>).
 
 Conventionally, the files are:
 <DL>
@@ -129,30 +143,40 @@ access to the directory the logs are stored in without being aware of
 the consequences; see the <A HREF="misc/security_tips.html">security tips</A>
 document for details.
 <H3>pid file</H3>
-On daemon startup, it saves the process id of the parent httpd process to
-the file <CODE>logs/httpd.pid</CODE>. This filename can be changed with the
-<A HREF="mod/core.html#pidfile">PidFile</A> 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 <A HREF="stopping.html">Stopping and Restarting</A> page.
+
+On startup, Apache saves the process id of the parent httpd process to
+the file <CODE>logs/httpd.pid</CODE>. This filename can be changed
+with the <A HREF="mod/core.html#pidfile">PidFile</A> 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 <A HREF="stopping.html">Stopping and
+Restarting</A> page.
+
 <P>
 If the process dies (or is killed) abnormally, then it will be necessary to
 kill the children httpd processes.
 
 <H3>Error log</H3>
-The server will log error messages to a log file, <CODE>logs/error_log</CODE>
-by default. The filename can be set using the
-<A HREF="mod/core.html#errorlog">ErrorLog</A> directive; different error logs
-can
-be set for different <A HREF="mod/core.html#virtualhost">virtual hosts</A>.
+
+The server will log error messages to a log file, by default
+<CODE>logs/error_log</CODE> on Unix or <CODE>logs/error.log</CODE> on
+OS/2. The filename can be set using the <A
+HREF="mod/core.html#errorlog">ErrorLog</A> directive; different error
+logs can be set for different <A
+HREF="mod/core.html#virtualhost">virtual hosts</A>.
 
 <H3>Transfer log</H3>
-The server will typically log each request to a transfer file,
-<CODE>logs/access_log</CODE> by default. The filename can be set using a
-<A HREF="mod/mod_log_config.html#transferlog">TransferLog</A> directive;
-different transfer logs can be set for different
-<A HREF="mod/core.html#virtualhost">virtual hosts</A>.
+
+The server will typically log each request to a transfer file, by
+default <CODE>logs/access_log</CODE> on Unix or
+<CODE>logs/access.log</CODE> on OS/2. The filename can be set using a
+<A HREF="mod/mod_log_config.html#transferlog">TransferLog</A>
+directive or additional log files created with the <A
+HREF="mod/mod_log_config.html#customlog">CustomLog</A> directive;
+different transfer logs can be set for different <A
+HREF="mod/core.html#virtualhost">virtual hosts</A>.
 
 <!--#include virtual="footer.html" -->
 </BODY>
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 @@
 <!--#include virtual="header.html" -->
 <H1 ALIGN="CENTER">Stopping and Restarting Apache</H1>
 
+<P>This document covers stopping and restarting Apache on Windows
+only. Windows uses should see <A HREF="windows.html#signal">Signalling
+Apache when running</A>.</P>
+
+
 <P>You will notice many <CODE>httpd</CODE> executables running on your system,
 but you should not send signals to any of them except the parent, whose
 pid is in the <A HREF="mod/core.html#pidfile">PidFile</A>.  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 @@
 <!--#include virtual="header.html" -->
 <H1 ALIGN="CENTER">Stopping and Restarting Apache</H1>
 
+<P>This document covers stopping and restarting Apache on Windows
+only. Windows uses should see <A HREF="windows.html#signal">Signalling
+Apache when running</A>.</P>
+
+
 <P>You will notice many <CODE>httpd</CODE> executables running on your system,
 but you should not send signals to any of them except the parent, whose
 pid is in the <A HREF="mod/core.html#pidfile">PidFile</A>.  That is to