You are viewing a plain text version of this content. The canonical link for it is here.
Posted to docs-cvs@perl.apache.org by st...@apache.org on 2002/04/27 20:45:56 UTC

cvs commit: modperl-docs/src/download docs.pod

stas        02/04/27 11:45:56

  Modified:    src/download docs.pod
  Log:
  changed the order around slightly and added Pod::POM as a prerequisite.
  Submitted by:	Per Einar Ellefsen <pe...@skynet.be>
  
  Revision  Changes    Path
  1.3       +28 -29    modperl-docs/src/download/docs.pod
  
  Index: docs.pod
  ===================================================================
  RCS file: /home/cvs/modperl-docs/src/download/docs.pod,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- docs.pod	27 Apr 2002 03:19:40 -0000	1.2
  +++ docs.pod	27 Apr 2002 18:45:56 -0000	1.3
  @@ -27,8 +27,36 @@
   working directory which contains all the sources needed to build the
   site.
   
  +Another way to download the sources, if you don't want to use CVS, is
  +to get the snapshots available from
  +http://cvs.apache.org/snapshots/modperl-docs/ . However, it will be a
  +major drag for you to keep these up to date, so you are better advised
  +to use the CVS access.
  +
   =head1 Build
   
  +The build process is very simple, as we have developed a number of
  +tools which are very helpful in this task. However, you will need a
  +number of prerequisites before starting.
  +
  +=head2 Prerequisites
  +
  +DocSet: while it is included with the CVS distribution, please
  +download and install the latest version of DocSet from
  +http://www.apache.org/~stas/. It will install the tool C<html2ps>,
  +which is used to build the PDF version, and also a number of Perl
  +modules.
  +
  +You will also need C<Pod::POM> for DocSet to work. You can get it from
  +CPAN.
  +
  +For the PDF version, you will also need a command-line tool called
  +C<ps2pdf>, which is included with the Ghostscript distribution: see
  +http://www.ghostscript.com/ . You will probably also need the
  +I<netpbm> package.
  +
  + META: we need specifics about netpbm
  +
   =head2 Normal build process
   
   The programs used to build the site are included in the directory you
  @@ -41,35 +69,6 @@
   open I<index.html> in there to start browsing the site.
   
   =head2 PDF version
  -
  -=head3 Prerequisites
  -
  -To build the PDF documents, you will need to have some extra tools
  -installed: I<ps2pdf> (which should come with the Ghostscript
  -distribution, see http://www.ghostscript.com/), and maybe the
  -I<netpbm> tools too. For Windows platforms, see the file
  -I<INSTALL.win32> for information.
  -
  -Please also note that to build the PDF version, you will have to have
  -I<html2ps> installed. This tool is distributed with DocSet, the
  -framework used to build the site. DocSet is available in the I<lib/>
  -directory of the site repository, but you will have to download the
  -DocSet distribution to get I<html2ps>: download the latest from
  -http://www.apache.org/~stas/ , and then install it with the usual:
  -
  -  % tar -zxvf DocSet-0.xx.tar.gz
  -  % cd DocSet-0.xx
  -  % perl Makefile.PL
  -  % make
  -  % make test
  -  % make install
  -
  -(replace C<make> with C<nmake> on Windows systems, this implies that
  -you have C<nmake> installed, see the ActivePerl docs for this:
  -http://aspn.activestate.com//ASPN/Reference/Products/ActivePerl/faq/Windows/ActivePerl-Winfaq9.html#Where_do_I_get_a_Win32_make
  -)
  -
  -=head3 Building
   
   Now, you can go back to your I<modperl-docs> directory. Building the
   PDF version is as easy as with the HTML version, just do a simple:
  
  
  

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