Debian Codegraph @

INSTALL

raw
1 $Id: INSTALL,v 1.2 2005/04/27 14:29:51 xmldoc Exp $
2
3 INSTALL file for the DocBook Slides distribution
4
5 ----------------------------------------------------------------------
6 Case #1: Installation using a package management system
7 ----------------------------------------------------------------------
8 If you have installed the Slides distribution using "apt-get",
9 "yum", "urpmi", or some similar package-management front-end,
10 then, as part of the package installation, the Slides DTDs, Relax
11 NG schemas, and XSL stylesheets have already been automatically
12 installed in the appropriate locations for your system, and your
13 XML catalog environment was updated to use those locations.
14
15 However, note that this release also includes a locatingrules.xml
16 file to simplify authoring of Slides documents in Emacs/nXML.
17 There are not yet any cross-distro standards for handling
18 installation of locating-rules files. So, for specific
19 instructions about how to make use of the locatingrules.xml file
20 with your distro, see the distro-specific documentation installed
21 along with the package. For example, on a Debian system, check the
22 /usr/share/doc/docbook-slides/README.Debian.gz file.
23
24 ----------------------------------------------------------------------
25 Case #2: Installing manually
26 ----------------------------------------------------------------------
27 If you have downloaded a docbook-slides zip, tar.gz, or tar.bz2
28 file, use the following steps to install it.
29
30 1. Move the zip, tar.gz, or tar.bz2 file to the directory where
31 you'd like to install it (not to a temporary directory).
32
33 2. unzip or untar/uncompress the file
34
35 That will create a docbook-slides-$VERSION directory (where
36 $VERSION is the version number for the release).
37
38 The remaining steps are all OPTIONAL. They are intended to
39 automatically update your user environment with XML Catalog
40 information about the Slides distribution. You are NOT REQUIRED
41 to complete these remaining steps. However, if you do not, and you
42 want to use XML catalogs with Slides, you will need to manually
43 update your XML catalog environment
44
45 3. Change to the docbook-slides-$VERSION directory and execute
46 the install.sh script:
47
48 ./install.sh
49
50 That will launch an interactive installer, which will emit a
51 series of prompts for you to respond to. After the process is
52 complete, the installer will emit a message with a command
53 you need to run in order to source your environment for use
54 with Slides.
55
56 4. To test that he installation has updated your environment
57 correctly, execute the test.sh script:
58
59 ./test.sh
60
61 That will test your XML catalog environment, using both the
62 xmlcatalog application and the Apache XML Commons Resolver.
63
64 NOTE: The test.sh file is not created until the install.sh
65 file is run for the first time. So you need to run the
66 install.sh script before running the test.sh script.
67
68 5. (UNINSTALLING) If/when you want to uninstall the release,
69 execute the uninstall.sh script.
70
71 ./uninstall.sh
72
73 That will revert all changes made by the install.sh script.
74
75 NOTE: The uninstall.sh file is not created until the install.sh
76 file is run for the first time. So you need to run the
77 install.sh script before running the uninstall.sh script.
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 Slides manually.
86
87 The catalog, catalog.xml, and locatingrules.xml file should be
88 packaged, and your package installation should automatically
89 update your system configuration to make use of them.
90
91 If your package doesn't automatically update your system Emacs
92 configuration to make use of the locatingrules.xml file, the
93 distro-specific documentation for your package should include
94 instructions explaining to users how to make use of the
95 locatingrules.xml file -- and/or the package installation should
96 emit a message with similar instructions during installation.