3 INSTALL file for the DocBook XSL stylesheets distribution
5 ----------------------------------------------------------------------
6 Case #1: Installation using a package management system
7 ----------------------------------------------------------------------
8 If you have installed the DocBook XSL distribution using "apt-get",
9 "yum", "urpmi", or some similar package-management front-end,
10 then, as part of the package installation, the stylesheets have
11 already been automatically installed in the appropriate location
12 for your system, and your XML catalog environment has probably
13 been updated to use that location.
15 ----------------------------------------------------------------------
16 Case #2: Installing manually
17 ----------------------------------------------------------------------
18 If you have downloaded a docbook-xsl zip, tar.gz, or tar.bz2
19 file, use the following steps to install it.
21 1. Move the zip, tar.gz, or tar.bz2 file to the directory where
22 you'd like to install it (not to a temporary directory).
24 2. unzip or untar/uncompress the file
26 That will create a docbook-xsl-$VERSION directory (where
27 $VERSION is the version number for the release).
29 The remaining steps are all OPTIONAL. They are intended to
30 automatically update your user environment with XML Catalog
31 information about the DocBook XSL distribution. You are NOT
32 REQUIRED to complete these remaining steps. However, if you do
33 not, and you want to use XML catalogs with the DocBook XSL
34 stylesheets, you will need to manually update your XML catalog
37 3. Change to the docbook-xsl-$VERSION directory and execute the
42 That will launch an interactive installer, which will emit a
43 series of prompts for you to respond to. After the process is
44 complete, the installer will emit a message with a command
45 you need to run in order to source your environment for use
48 4. To test that he installation has updated your environment
49 correctly, execute the test.sh script:
53 That will test your XML catalog environment, using both the
54 xmlcatalog application and the Apache XML Commons Resolver.
56 NOTE: The test.sh file is not created until the install.sh
57 file is run for the first time. So you need to run the
58 install.sh script before running the test.sh script.
60 5. (UNINSTALLING) If/when you want to uninstall the release,
61 execute the uninstall.sh script.
65 That will revert all changes made by the install.sh script.
67 NOTE: The uninstall.sh file is not created until the install.sh
68 file is run for the first time. So you need to run the
71 ----------------------------------------------------------------------
73 ----------------------------------------------------------------------
74 The install.sh, .CatalogManager.properties.example, and .urilist
75 files should not be packaged. They are useful only to users who
76 are installing the stylesheets manually.
78 The catalog.xml file should be packaged.