You are viewing a plain text version of this content. The canonical link for it is here.
Posted to docs@httpd.apache.org by Joshua Slive <sl...@finance.commerce.ubc.ca> on 2001/05/10 07:53:06 UTC

2.0 install.html revamp

I just trashed the old install.html in httpd-docs-2.0 and replaced it with
an html'ized version of INSTALL from the source distribution.  This is a
major change, but what was there was so innacurate that I figured nobody
could object.

I don't really see the point in having complete documentation both in the
manual and in the INSTALL file.  Instead, I propose that we trash INSTALL
and replace it with a very short summary that just references install.html
and "configure --help".  The other possibility is to make install.html the
short summary.  However, it seems that it is much easier to do a good set
of documentation in HTML then it is in plain ASCII.

Any objections or suggestions?

Joshua.


---------------------------------------------------------------------
To unsubscribe, e-mail: apache-docs-unsubscribe@apache.org
For additional commands, e-mail: apache-docs-help@apache.org


Re: 2.0 install.html revamp

Posted by Rich Bowen <rb...@rcbowen.com>.
On Wed, 9 May 2001 22:53:06 -0700 (Pacific Daylight Time), Joshua Slive said:

> I just trashed the old install.html in httpd-docs-2.0 and replaced it with
>  an html'ized version of INSTALL from the source distribution.  This is a
>  major change, but what was there was so innacurate that I figured nobody
>  could object.
>  
>  I don't really see the point in having complete documentation both in the
>  manual and in the INSTALL file.  Instead, I propose that we trash INSTALL
>  and replace it with a very short summary that just references install.html
>  and "configure --help".  The other possibility is to make install.html the
>  short summary.  However, it seems that it is much easier to do a good set
>  of documentation in HTML then it is in plain ASCII.

Having always been frustrated with the inadequacy of the HTML install docs, and
the enormous difference between what they said and what the text one said, I
think that this is a great move.

-- 
And everyone said, "If we only live, 
We too will go to sea in a Sieve -
To the hills of the Chankly Bore!"
 (The Jumblies, by Edward Lear)



---------------------------------------------------------------------
To unsubscribe, e-mail: apache-docs-unsubscribe@apache.org
For additional commands, e-mail: apache-docs-help@apache.org


Re: 2.0 install.html revamp

Posted by Chris Pepper <pe...@mail.reppep.com>.
At 1:51 PM -0700 2001/05/14, Joshua Slive wrote:
>On Mon, 14 May 2001, Rodent of Unusual Size wrote:
>
>>  Joshua Slive wrote:
>>  >
>>  > I don't really see the point in having complete documentation
>>  > both in the manual and in the INSTALL file.
>>
>>  There should be a file that can be viewed in one xterm while
>>  going through the installation process in another.  It can be
>>  terse, but having to have a browser running to get this info
>>  is a bit much.  INSTALL should be this file.
>
>I understand your point, although I think most people would
>just use "lynx docs/manual/install.html" in their xterm.

	FYI: Darwin and Solaris 8 don't include lynx, and in single 
user mode it may be difficult or impossible for the user to bring up 
X to get at the Netscape (or IE on Mac OS X).

	This is a major issue for patching Solaris, although I don't 
see it as key for installing Apache. I'd expect users to have a 
working web browser by the time they get to installing server 
software.

	I don't have any problem with expecting people to print out 
the (HTML) doc ahead of time, if for some reason they have to install 
in a nongraphical mode.


						Chris Pepper
-- 
Chris Pepper:                   <http://www.reppep.com/~pepper/>
Rockefeller U Computing Services:  <http://www.rockefeller.edu/>
Mac OS X Software:                      <http://www.mosxsw.com/>

---------------------------------------------------------------------
To unsubscribe, e-mail: apache-docs-unsubscribe@apache.org
For additional commands, e-mail: apache-docs-help@apache.org


Re: 2.0 install.html revamp

Posted by Rodent of Unusual Size <Ke...@Golux.Com>.
Joshua Slive wrote:
> 
> I understand your point, although I think most people would
> just use "lynx docs/manual/install.html" in their xterm.

For another thing, it is one of the canonical files in an open-source
package.  As has been pointed out, not every system has a browser
available.
> 
> My problem is that I'm not sure I see a middle ground for INSTALL.
> People who want the quick and terse should be running
> ./configure --help.

That is not terse, that is abstruse. :-)

> Here is what I quickly hacked INSTALL down to.  If this is
> not sufficient, can you (or anyone) suggest what you think
> should be in here.

It looks good, although I think a brief note about doing it
as superuser might be in order.  (I think the default port
selection is still different based upon the configure-time
UID.)  You might also head it with 'Quick and Dirty Installation
Instructions; for more handholding, read the full installation
docco.'  Just so no-one's expectations are mis-set. :-)

> (I don't think the stuff about FreeBSD belongs in here, but
> I'm not sure where else to put it.)

No, I think it belongs here.
-- 
#ken    P-)}

Ken Coar                    <http://Golux.Com/coar/>
Apache Software Foundation  <http://www.apache.org/>
"Apache Server for Dummies" <http://Apache-Server.Com/>
"Apache Server Unleashed"   <http://ApacheUnleashed.Com/>

---------------------------------------------------------------------
To unsubscribe, e-mail: apache-docs-unsubscribe@apache.org
For additional commands, e-mail: apache-docs-help@apache.org


Re: 2.0 install.html revamp

Posted by Joshua Slive <jo...@slive.ca>.
On Mon, 14 May 2001, Rodent of Unusual Size wrote:

> Joshua Slive wrote:
> >
> > I don't really see the point in having complete documentation
> > both in the manual and in the INSTALL file.
>
> There should be a file that can be viewed in one xterm while
> going through the installation process in another.  It can be
> terse, but having to have a browser running to get this info
> is a bit much.  INSTALL should be this file.

I understand your point, although I think most people would
just use "lynx docs/manual/install.html" in their xterm.

My problem is that I'm not sure I see a middle ground for INSTALL.
People who want the quick and terse should be running
./configure --help.

Here is what I quickly hacked INSTALL down to.  If this is not sufficient,
can you (or anyone) suggest what you think should be in here.

(I don't think the stuff about FreeBSD belongs in here, but I'm not sure
where else to put it.)


  APACHE INSTALLATION

  Overview for the impatient
  --------------------------

     $ ./configure --prefix=PREFIX
     $ make
     $ make install
     $ PREFIX/bin/apachectl start

     NOTES: * PREFIX is not the string "PREFIX". Instead use the Unix
              filesystem path under which Apache should be installed. For
              instance use "/usr/local/apache2" for PREFIX above.

            * If you are building on FreeBSD, you should add the argument
              --with-mpm=prefork to the configure line.  The Apache Group
              has discovered that threads do not work well with Apache
              on FreeBSD.  For that reason, we disable threads by default
              on FreeBSD, and you need to build the prefork MPM.  If you
              wish to try to make threads work on FreeBSD, they can be
              re-enabled by using --enable-threads

            * If you are a developer using the CVS version of Apache,
              you will need to run ./buildconf before anything else.


  For more information
  --------------------

  The easiest way to find all of the configuration flags for Apache
  2.0 is to run "./configure --help".

  Installation and configuration documentation is available in
  docs/manual/install.html or at
  http://httpd.apache.org/docs-2.0/install.html


  Thanks for using the Apache HTTP Server, Version 2.0.

                                     The Apache Software Foundation
                                     http://www.apache.org/


---------------------------------------------------------------------
To unsubscribe, e-mail: apache-docs-unsubscribe@apache.org
For additional commands, e-mail: apache-docs-help@apache.org


Re: 2.0 install.html revamp

Posted by Rodent of Unusual Size <Ke...@Golux.Com>.
Joshua Slive wrote:
> 
> I don't really see the point in having complete documentation
> both in the manual and in the INSTALL file.

There should be a file that can be viewed in one xterm while
going through the installation process in another.  It can be
terse, but having to have a browser running to get this info
is a bit much.  INSTALL should be this file.
-- 
#ken    P-)}

Ken Coar                    <http://Golux.Com/coar/>
Apache Software Foundation  <http://www.apache.org/>
"Apache Server for Dummies" <http://Apache-Server.Com/>
"Apache Server Unleashed"   <http://ApacheUnleashed.Com/>

---------------------------------------------------------------------
To unsubscribe, e-mail: apache-docs-unsubscribe@apache.org
For additional commands, e-mail: apache-docs-help@apache.org