doc/xslt/INSTALL

   1 $Id: INSTALL 6145 2006-08-06 13:13:03Z xmldoc $
   2
   3 INSTALL file for the DocBook XSL stylesheets distribution
   4
   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.
  14
  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.
  20
  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).
  23
  24   2. unzip or untar/uncompress the file
  25
  26      That will create a docbook-xsl-$VERSION directory (where
  27      $VERSION is the version number for the release).
  28
  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
  35 environment
  36
  37   3. Change to the docbook-xsl-$VERSION directory and execute the
  38      install.sh script:
  39
  40        ./install.sh
  41
  42      That will launch an interactive installer, which will emit a
  43      series of prompts for you to respond to.
  44
  45      To instead run it non-interactively without being prompted
  46      for confirmation of the changes it makes, invoke it with the
  47      "--batch" switch, like this:
  48
  49        ./install.sh --batch
  50
  51      After the process is complete, the installer will emit a
  52      message with a command you need to run in order to source
  53      your environment for use with the stylesheets.
  54
  55   4. To test that he installation has updated your environment
  56      correctly, execute the test.sh script:
  57
  58        ./test.sh
  59
  60      That will test your XML catalog environment, using both the
  61      xmlcatalog application and the Apache XML Commons Resolver.
  62
  63      NOTE: The test.sh file is not created until the install.sh
  64            file is run for the first time.
  65
  66   5. (UNINSTALLING) If/when you want to uninstall the release,
  67      execute the uninstall.sh script.
  68
  69        ./uninstall.sh
  70
  71      To instead run it non-interactively without being prompted
  72      for confirmation of the changes it makes, invoke it with the
  73      "--batch" switch, like this:
  74
  75        ./uninstall.sh --batch
  76
  77      NOTE: The uninstall.sh file is not created until the install.sh
  78            file is run for the first time.
  79
  80
  81 ----------------------------------------------------------------------
  82 Note to packagers
  83 ----------------------------------------------------------------------
  84 The install.sh, .CatalogManager.properties.example, and .urilist
  85 files should not be packaged. They are useful only to users who
  86 are installing the stylesheets manually.
  87
  88 The catalog.xml file should be packaged.