Fix license info ( BSD-3-Clause -> BSD-2.0 )
[platform/upstream/bzip2.git] / README.XML.STUFF
1   ----------------------------------------------------------------
2   This file is part of bzip2/libbzip2, a program and library for
3   lossless, block-sorting data compression.
4
5   bzip2/libbzip2 version 1.0.6 of 6 September 2010
6   Copyright (C) 1996-2010 Julian Seward <jseward@bzip.org>
7
8   Please read the WARNING, DISCLAIMER and PATENTS sections in the 
9   README file.
10
11   This program is released under the terms of the license contained
12   in the file LICENSE.
13   ----------------------------------------------------------------
14
15 The script xmlproc.sh takes an xml file as input,
16 and processes it to create .pdf, .html or .ps output.
17 It uses format.pl, a perl script to format <pre> blocks nicely,
18  and add CDATA tags so writers do not have to use eg. &lt; 
19
20 The file "entities.xml" must be edited to reflect current
21 version, year, etc.
22
23
24 Usage:
25
26   ./xmlproc.sh -v manual.xml
27   Validates an xml file to ensure no dtd-compliance errors
28
29   ./xmlproc.sh -html manual.xml
30   Output: manual.html
31
32   ./xmlproc.sh -pdf manual.xml
33   Output: manual.pdf
34
35   ./xmlproc.sh -ps manual.xml
36   Output: manual.ps
37
38
39 Notum bene: 
40 - pdfxmltex barfs if given a filename with an underscore in it
41
42 - xmltex won't work yet - there's a bug in passivetex
43     which we are all waiting for Sebastian to fix.
44   So we are going the xml -> pdf -> ps route for the time being,
45     using pdfxmltex.