aboutsummaryrefslogtreecommitdiffstats
path: root/INSTALL
diff options
context:
space:
mode:
authorJames Robertson <jwrober@linuxfromscratch.org>2003-09-10 01:13:03 +0000
committerJames Robertson <jwrober@linuxfromscratch.org>2003-09-10 01:13:03 +0000
commite8a0469d8bfbf4d242b777de12e454c3cba33f3f (patch)
tree7b71c049ca20e49557f390cb9ac7347f625df0ac /INSTALL
parentfbb00ac78a28a5aa57bc48467308bd34d36732ff (diff)
Updated the INSTALL and README files with instructions from BLFS.
git-svn-id: http://svn.linuxfromscratch.org/LFS/trunk/BOOK@2761 4aa44e1e-78dd-0310-a6d2-fbcd4c07a689
Diffstat (limited to 'INSTALL')
-rw-r--r--INSTALL130
1 files changed, 46 insertions, 84 deletions
diff --git a/INSTALL b/INSTALL
index af830dc10..5a5c392f4 100644
--- a/INSTALL
+++ b/INSTALL
@@ -1,110 +1,72 @@
-Ok, so you have downloaded the XML source. Now what? You are probably
-wanting to convert these XML files to easier to read HTML, PS, PDF, TXT
-or other formatted files. All that can be read below.
+LFS Book Conversion Tools Installation Instructions
-Let's start by downloading some software.
+After downloading the CVS source, there are some things that need to be setup
+on your computer if you want to convert the XML source into something easier to
+read (e.g. HTML, TXT, PS or PDF). If you are interested in this, then keep
+reading. If you are only interested in editing the XML source for re-
+submission to the lfs-book or lfs-dev mailing lists, then you do not need this
+document. Instead, you need to read the LFS Editor's Manual. See the LFS
+website at http://linuxfromscratch.org for more information.
-If all you want to do is being able to convert XML to HTML download the
-following:
+-------------------------------------------------------------------------------
+If all you want to do is convert XML to HTML perform the following:
-OpenJade - http://openjade.sourceforge.net/
-DocBook-XML DTD - http://www.docbook.org/xml/4.1.2/
-Modified DocBook Entities -
- http://linuxfromscratch.org/~gerard/docbook-4.1.2-newent.tar.bz2
-DSSSL DocBook Stylesheets - http://www.nwalsh.com/docbook/dsssl/
+First, let's handle some dependancies:
-As the DocBook DTD and Stylesheets are made available as zip archives you
-may need to download the unzip package as well if your Linux system doesn't
-have one:
+* Unzip
+ - http://www.linuxfromscratch.org/blfs/view/cvs/general/unzip.html
-Unzip - ftp://ftp.uu.net/pub/archiving/zip/src/
+* SGML Common
+ - http://www.linuxfromscratch.org/blfs/view/cvs/pst/sgml-common.html
-If you want to be able to convert the book into PS and PDF as well I
-recommend using the Htmldoc program. This takes a html file (created
-with openjade which you already downloaded) and converts it to PS or
-PDF:
+* libxml2
+ - http://www.linuxfromscratch.org/blfs/view/cvs/general/libxml2.html
-HTMLDOC - http://www.easysw.com/htmldoc/
-FLTK (X front-end) - http://sourceforge.net/projects/fltk
+Now install the following:
-If you want to be able to convert the book into TXT as well I recommend
-using lynx to convert HTML to TXT using the -dump option to lynx.
+* DocBook DTD
+ - http://www.linuxfromscratch.org/blfs/view/cvs/pst/DocBook.html
+
+* DSSSL DocBook Stylesheets
+ - http://www.linuxfromscratch.org/blfs/view/cvs/pst/docbook-dsssl.html
-Lynx - http://lynx.browser.org
+* OpenSP
+ - http://www.linuxfromscratch.org/blfs/view/cvs/pst/opensp.html
+* OpenJade
+ - http://www.linuxfromscratch.org/blfs/view/cvs/pst/openjade.html
-You have everything you need now. Let's install this stuff.
+Once you have followed the installation instructions for all these packages
+from the BLFS Book, then you have a basic DocBook setup. Below are some
+alternate packages that you can use to convert to other formats.
-Create the /usr/share/docbook directory, cd into it and unpack the
-docbook-xml dtd archive there. Move all the files and directories from
-the newly created subdirectory to the current directory
-(/usr/share/docbook). We don't really need a
-/usr/share/docbook/docbook-<version> subdir for our purposes.
+-------------------------------------------------------------------------------
+If you want to be able to convert the book into PS and PDF as well, then you
+will need the Htmldoc package. This takes a HTML file (created with openjade
+which you already installed) and converts it to PS or PDF:
-Remove the ent directory and unpack the docbook-4.1.2-newent.tar.bz2 file.
-This will create a new ent directory with entity files that work better
-with XML.
-
-Create the /usr/share/dsssl directory, cd into it and unpack the dsssl
-stylesheet archive in there. Rename the directory that's created by tar
-into 'docbook'. Now copy the lfs.dsl file you will find in
-the LFS-BOOK XML archive into /usr/share/dsssl/docbook/html
-
-The last step is installing OpenJade.
-
-In order for openjade to be able to convert the DocBook based documents
-into other formats, it needs to know where the DocBook DTD related
-files are located. This is sort of the DocBook equivalent for the $PATH
-variable. You have two ways of doing this:
-
-1) You can set the $SGML_CATALOG_FILES variable and include the full
-paths to the catalog files in it
- or
-2) You can hard-code the paths into the openjade binary.
-
-If you choose option 1, add the following to your bash configuration
-file, system wide profile or wherever you wish to include it:
-
-export SGML_CATALOG_FILES=/usr/share/docbook/docbook.cat:/usr/share/dsssl/docbook/catalog:/usr/share/dsssl/openjade/catalog
-
-Followed by installing openjade by running:
+ - http://www.easysw.com/htmldoc/
+
+ Install HTMLDOC by running:
./configure --prefix=/usr
make
make install
- cp -av dsssl /usr/share/dsssl/openjade
-
-If you choose option 2, install OpenJade as follows:
- ./configure --prefix=/usr \
- > --enable-default-catalog=/usr/share/docbook/docbook.cat:/usr/share/dsssl/docbook/catalog:/usr/share/dsssl/openjade/catalog
- make
- make install
- cp -av dsssl /usr/share/dsssl/openjade
-
-And you don't have to worry about the $SGML_CATALOG_FILES variable in
-this case.
+An excellent X front-end for HTMLDOC is FLTK. If you will be doing rendering
+in X, then you will probably want this package.
-You're all set to convert XML to HTML (among a few other formats
-supported by openjade) now. If you want to convert to PS and PDF as
-well, install the following two packages.
+ - http://sourceforge.net/projects/fltk
-FLTK (you can skip this one if you don't want the X front-end):
+ Install FLTK bt running:
./configure --prefix=/usr
make
make install
-Install HTMLDOC by running:
- ./configure --prefix=/usr
- make
- make install
+If you want to be able to convert the book into TXT as well, then you need the
+lynx browser. Conversion is handled via the -dump option.
+ - http://www.linuxfromscratch.org/blfs/view/cvs/basicnet/lynx.html
-The last package is Lynx which will be used for the HTML to TXT
-conversion. Install it by running:
- ./configure --prefix=/usr
- make
- make install
-
-There, all set now. Go back to the README file for some examples how to
-convert this XML to the various other formats.
+You are finished installing everything. Read the README file for some examples
+how to convert this XML to the various other formats.