INSTALL

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