stylesheets/styleguide/docbook-xsl-1.75.2/INSTALL

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