File: debiandoc2dbxml.1.sgml

package info (click to toggle)
debiandoc2dbxml 0.2
  • links: PTS
  • area: main
  • in suites: etch, etch-m68k, lenny
  • size: 104 kB
  • ctags: 12
  • sloc: xml: 386; sh: 218; makefile: 66
file content (116 lines) | stat: -rw-r--r-- 3,234 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V3.1//EN">
<refentry>
  <refmeta>
   <refentrytitle>debiandoc2dbxml</>
   <manvolnum>1</>
 </refmeta>
 
 <!-- Man page title -->
 <refnamediv>
    <refname>debiandoc2dbxml</>
 <refpurpose>Utility to translate debiandoc-sgml files into docbookxml files</>
 </refnamediv>

 <!-- Arguments -->
 <refsynopsisdiv>
   <cmdsynopsis>
      <command>debiandoc2dbxml</>
      <arg><option>-hvabsSk</option></arg>
      <arg><option>-l <replaceable>locale string</replaceable></option></arg>
      <arg><replaceable>file</replaceable></arg>
   </cmdsynopsis>
 </refsynopsisdiv>
 
 <RefSect1><Title>Description</>
   <para>   
   <command>debiandoc2dbxml</command> will take a debiandoc-sgml file and 
convert it into a docbook xml file. The root element can be "book" or
"article". The version of docbookx.dtd is 4.0.
    </para>
<para>
Before using <command>debiandoc2dbxml</command>, you should run
<command>debiandoc-tidy</command> in order to "normalize" your sgml file.
    </para>
 </RefSect1>
 
 <RefSect1><Title>Options</>
 <para>
    
   <VariableList>
     <VarListEntry><term><option>-h</option></term>
     <ListItem><Para>
     Print a help message.</para>
	</listitem>
     </VarListEntry>
   
   
     <VarListEntry><term><option>-v</option></term>
     <ListItem><Para>
     Print the version number.</para>
        </listitem>
     </VarListEntry>

        <VarListEntry><term><option>-a</option></term>
     <ListItem><Para>
     Choose the root element "article".</para>
        </listitem>
     </VarListEntry>
   
        <VarListEntry><term><option>-b</option></term>
     <ListItem><Para>
     Choose the root element "book".</para>
        </listitem>
     </VarListEntry>

        <VarListEntry><term><option>-s</option></term>
     <ListItem><Para>
Indicate that there is a subset of the dtd in the prolog of the sgml file.</para>
        </listitem>
     </VarListEntry>

        <VarListEntry><term><option>-S</option></term>
     <ListItem><Para>
Choose to split the result in many files. The script creates "main.xml" and
xml files from each bookinfo, chapter and appendix.  This option should be
used with the -l option.</para>
        </listitem>
     </VarListEntry>

        <VarListEntry><term><option>-l</option></term>
     <ListItem><Para>
A string that indicates where you want to put the xml files when the -S option
has been chosen. The "main.xml" goes to path/to/ and the xml files go to
path/to/string/.</para>
        </listitem>
     </VarListEntry>

        <VarListEntry><term><option>-k</option></term>
     <ListItem><Para>
The script creates two files "sgml.error" and "xml.error" which you can
read when this option has been set.</para>
        </listitem>
     </VarListEntry>
   </VariableList>
    </para>
 </RefSect1>

 <RefSect1><Title>See Also</>
   <para>
/usr/share/doc/debiandoc2dbxml/dd2xml.html.
    </para>
<para>
  <CiteRefEntry>
    <RefEntryTitle><command>debiandoc-tidy</command></RefEntryTitle>
    <ManVolNum/1/
  </CiteRefEntry>
    </para>
 </RefSect1>

<RefSect1><Title>Author</>
   <para>
This page was written by Philippe Batailler 
<email>philippe.batailler@free.fr</email>.
April 2003.</para>
 </RefSect1>
 
</refentry>