You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@httpd.apache.org by sl...@apache.org on 2005/11/15 19:41:13 UTC

svn commit: r344409 - /httpd/httpd/trunk/docs/manual/install.xml

Author: slive
Date: Tue Nov 15 10:41:10 2005
New Revision: 344409

URL: http://svn.apache.org/viewcvs?rev=344409&view=rev
Log:
Remove a few obsolete historical references, clean up
some small inconsistencies, and use graceful-stop in
the upgrading example.

Modified:
    httpd/httpd/trunk/docs/manual/install.xml

Modified: httpd/httpd/trunk/docs/manual/install.xml
URL: http://svn.apache.org/viewcvs/httpd/httpd/trunk/docs/manual/install.xml?rev=344409&r1=344408&r2=344409&view=diff
==============================================================================
--- httpd/httpd/trunk/docs/manual/install.xml (original)
+++ httpd/httpd/trunk/docs/manual/install.xml Tue Nov 15 10:41:10 2005
@@ -33,15 +33,12 @@
     Windows</a>. For other platforms, see the <a
     href="platform/">platform</a> documentation.</p>
 
-    <p>Apache 2.0's configuration and installation environment has
-    changed completely from Apache 1.3. Apache 1.3 used a custom
-    set of scripts to achieve easy installation. Apache 2.0 now
-    uses <code>libtool</code> and <code>autoconf</code>
-    to create an environment that looks like many other Open Source
+    <p>Apache httpd uses <code>libtool</code> and <code>autoconf</code>
+    to create a build environment that looks like many other Open Source
     projects.</p>
 
     <p>If you are upgrading from one minor version to the next (for
-    example, 2.0.50 to 2.0.51), please skip down to the <a
+    example, 2.2.50 to 2.2.51), please skip down to the <a
     href="#upgrading">upgrading</a> section.</p>
 
 </summary>
@@ -65,8 +62,9 @@
       <tr>
         <td><a href="#extract">Extract</a></td>
 
-        <td><code>$ gzip -d httpd-2_1_<em>NN</em>.tar.gz<br />
-         $ tar xvf httpd-2_1_<em>NN</em>.tar</code> </td>
+        <td><code>$ gzip -d httpd-<em>NN</em>.tar.gz<br />
+         $ tar xvf httpd-<em>NN</em>.tar</code><br />
+         $ cd httpd-<em>NN</em></td>
       </tr>
 
       <tr>
@@ -97,12 +95,12 @@
       <tr>
         <td><a href="#test">Test</a></td>
 
-        <td><code>$ <em>PREFIX</em>/bin/apachectl start</code>
+        <td><code>$ <em>PREFIX</em>/bin/apachectl -k start</code>
         </td>
       </tr>
     </table>
 
-    <p><em>NN</em> must be replaced with the current minor version
+    <p><em>NN</em> must be replaced with the current version
     number, and <em>PREFIX</em> must be replaced with the
     filesystem path under which the server should be installed. If
     <em>PREFIX</em> is not specified, it defaults to
@@ -110,7 +108,7 @@
 
     <p>Each section of the compilation and installation process is
     described in more detail below, beginning with the requirements
-    for compiling and installing Apache HTTPD.</p>
+    for compiling and installing Apache httpd.</p>
 </section>
 
 <section id="requirements"><title>Requirements</title>
@@ -141,9 +139,7 @@
       synchronization facility on your system. Usually the
       <code>ntpdate</code> or <code>xntpd</code> programs are used for
       this purpose which are based on the Network Time Protocol (NTP).
-      See the Usenet newsgroup <a
-      href="news:comp.protocols.time.ntp">comp.protocols.time.ntp</a>
-      and the <a href="http://www.ntp.org">NTP
+      See the <a href="http://www.ntp.org">NTP
       homepage</a> for more details about NTP software and public
       time servers.</dd>
 
@@ -160,15 +156,15 @@
       If no Perl 5 interpreter is found by the 
       <program>configure</program> script, you will not be able to use 
       the affected support scripts. Of course, you will still be able to 
-      build and use Apache 2.0.</dd>
+      build and use Apache httpd.</dd>
     </dl>
 </section>
 
 <section id="download"><title>Download</title>
 
-    <p>Apache can be downloaded from the <a
+    <p>The Apache HTTP Server can be downloaded from the <a
     href="http://httpd.apache.org/download.cgi">Apache HTTP Server
-    download site</a> which lists several mirrors.  Most users of
+    download site</a>, which lists several mirrors.  Most users of
     Apache on unix-like systems will be better off downloading and
     compiling a source version.  The build process (described below) is
     easy, and it allows you to customize your server to suit your needs.
@@ -193,8 +189,8 @@
     simple matter of uncompressing, and then untarring:</p>
 
 <example>
-$ gzip -d httpd-2_1_<em>NN</em>.tar.gz<br />
-$ tar xvf httpd-2_1_<em>NN</em>.tar
+$ gzip -d httpd-<em>NN</em>.tar.gz<br />
+$ tar xvf httpd-<em>NN</em>.tar
 </example>
 
     <p>This will create a new directory under the current directory
@@ -209,7 +205,7 @@
     particular platform and personal requirements. This is done using
     the script <program>configure</program> included in
     the root directory of the distribution. (Developers downloading
-    the CVS version of the Apache source tree will need to have
+    an unreleased version of the Apache source tree will need to have
     <code>autoconf</code> and <code>libtool</code> installed and will
     need to run <code>buildconf</code> before proceeding with the next
     steps. This is not necessary for official releases.)</p>
@@ -282,9 +278,9 @@
 <example>$ make</example>
 
     <p>Please be patient here, since a base configuration takes
-    approximately 3 minutes to compile under a Pentium III/Linux
-    2.2 system, but this will vary widely depending on your
-    hardware and the number of modules which you have enabled.</p>
+    serveral minutes to compile and the time will vary widely
+    depending on your hardware and the number of modules that you
+    have enabled.</p> 
 </section>
 
 <section id="install"><title>Install</title>
@@ -320,16 +316,16 @@
     <p>Now you can <a href="invoking.html">start</a> your Apache
     HTTP server by immediately running:</p>
 
-<example>$ <em>PREFIX</em>/bin/apachectl start</example>
+<example>$ <em>PREFIX</em>/bin/apachectl -k start</example>
 
     <p>and then you should be able to request your first document
     via URL <code>http://localhost/</code>. The web page you see is located
-    under the <directive module="core">DocumentRoot</directive>
+    under the <directive module="core">DocumentRoot</directive>,
     which will usually be <code><em>PREFIX</em>/htdocs/</code>.
     Then <a href="stopping.html">stop</a> the server again by
     running:</p>
 
-<example>$ <em>PREFIX</em>/bin/apachectl stop</example>
+<example>$ <em>PREFIX</em>/bin/apachectl -k stop</example>
 </section>
 <section id="upgrading"><title>Upgrading</title>
 
@@ -343,7 +339,7 @@
     module API.</p>
 
     <p>Upgrading from one minor version to the next (for example, from
-    2.0.55 to 2.0.57) is easier.  The <code>make install</code>
+    2.2.55 to 2.2.57) is easier.  The <code>make install</code>
     process will not overwrite any of your existing documents, log
     files, or configuration files.  In addition, the developers make
     every effort to avoid incompatible changes in the
@@ -351,8 +347,7 @@
     module API between minor versions.  In most cases you should be able to
     use an identical <program>configure</program> command line, an identical
     configuration file, and all of your modules should continue to
-    work.  (This is only valid for versions after 2.0.41; earlier
-    versions have incompatible changes.)</p>
+    work.</p>
 
     <p>To upgrade across minor versions, start by finding the file
     <code>config.nice</code> in the <code>build</code> directory of
@@ -368,8 +363,8 @@
     $ ./config.nice<br />
     $ make<br />
     $ make install<br />
-    $ <em>PREFIX</em>/bin/apachectl stop<br />
-    $ <em>PREFIX</em>/bin/apachectl start<br />
+    $ <em>PREFIX</em>/bin/apachectl -k graceful-stop<br />
+    $ <em>PREFIX</em>/bin/apachectl -k start<br />
     </example>
 
     <note type="warning">You should always test any new version in your



Re: svn commit: r344409 - /httpd/httpd/trunk/docs/manual/install.xml

Posted by Joshua Slive <jo...@slive.ca>.

Justin Erenkrantz wrote:

>> -        <td><code>$ <em>PREFIX</em>/bin/apachectl start</code>
>> +        <td><code>$ <em>PREFIX</em>/bin/apachectl -k start</code>
> 
> Really?  That'd be the right syntax for httpd, but not for apachectl. 
> (Looking at apachectl, it looks like it'd just happen to work though.)

It works by design.  It doesn't matter very much, but I'm trying to be 
consistent about using httpd-style arguments and not initv-style 
arguments, because it makes it much easier if the user needs to add 
other arguments in the future.  For example, if the user discovers that 
he needs to use -D to make an <IfDefine> work, it is confusing to need 
to rethink the "start" as well.  If you always use -k, then it just works.

I think this is well-documented at
http://httpd.apache.org/docs/2.2/programs/apachectl.html

> several

Thanks.

Joshua.

Re: svn commit: r344409 - /httpd/httpd/trunk/docs/manual/install.xml

Posted by Justin Erenkrantz <ju...@erenkrantz.com>.
--On November 15, 2005 6:41:13 PM +0000 slive@apache.org wrote:

> @@ -97,12 +95,12 @@
>        <tr>
>          <td><a href="#test">Test</a></td>
>
> -        <td><code>$ <em>PREFIX</em>/bin/apachectl start</code>
> +        <td><code>$ <em>PREFIX</em>/bin/apachectl -k start</code>

Really?  That'd be the right syntax for httpd, but not for apachectl. 
(Looking at apachectl, it looks like it'd just happen to work though.)

> @@ -282,9 +278,9 @@
>  <example>$ make</example>
>
>      <p>Please be patient here, since a base configuration takes
> -    approximately 3 minutes to compile under a Pentium III/Linux
> -    2.2 system, but this will vary widely depending on your
> -    hardware and the number of modules which you have enabled.</p>
> +    serveral minutes to compile and the time will vary widely
> +    depending on your hardware and the number of modules that you
> +    have enabled.</p>

several

Thanks.  -- justin