← Back to branch summary

~ubuntu-branches/ubuntu/trusty/dblatex/trusty

« back to all changes in this revision

Viewing changes to docs/publish.sgml

  • Committer: Bazaar Package Importer
  • Author(s): Andreas Hoenen
  • Date: 2006-11-18 09:52:18 UTC
  • mfrom: (3.1.2 feisty)
  • Revision ID: james.westby@ubuntu.com-20061118095218-zsibrzxr9w6e2lor
Tags: 0.2-2
http://bugs.debian.org/398776
Do not depend on script mktexlsr belonging to a non-essential package
in postrm purge. (Urgency set to high due to serious severity.)
Closes: #398776

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/publish.sgml
1
 
<sect1>
2
 
   <title>
3
 
   Publishing with dblatex
4
 
  </title>
5
 
  <para>
6
 
   To publish your document, you just need to use the script <filename>dblatex</filename>. 
7
 
  </para>
8
 
   <sect2>
9
 
    <title>
10
 
    Synopsis
11
 
   </title>
12
 
   <programlisting>
13
 
<![CDATA[dblatex [-t {tex|dvi|ps|pdf}] [-b {dvips|pdftex}] [-o output] [other options] file.{xml|sgml}
14
 
]]>   </programlisting>
15
 
   </sect2>
16
 
   <sect2>
17
 
    <title>
18
 
    Description
19
 
   </title>
20
 
   <para>
21
 
    The script works on an XML or SGML file and can produce LaTeX, DVI, Postscript and PDF output. By default (i.e. without option) a PDF file is produced in the same directory where the input file is, with the same base name.
22
 
   </para>
23
 
   </sect2>
24
 
   <sect2>
25
 
    <title>
26
 
    Options
27
 
   </title>
28
 
   <variablelist>
29
 
    <varlistentry>
30
 
    <term>
31
 
<option>-t <replaceable>format</replaceable></option>
32
 
</term><listitem><para>Output format. By default the format is PDF.
33
 
    </para>
34
 
   </listitem>
35
 
   </varlistentry>
36
 
    <varlistentry>
37
 
    <term>
38
 
<option>-b <replaceable>driver</replaceable></option>
39
 
</term><listitem><para>Backend driver to use. The available drivers are &ldquo;dvips&rdquo; (latex) and &ldquo;pdftex&rdquo; (pdflatex). By default the &ldquo;dvips&rdquo; driver is selected. See also <xref linkend="sec-process">.
40
 
    </para>
41
 
   </listitem>
42
 
   </varlistentry>
43
 
    <varlistentry>
44
 
    <term>
45
 
<option>-f <replaceable>fig_format</replaceable></option>
46
 
</term><listitem><para>Input figures format, specified to have on the fly conversion. See also <xref linkend="sec-figconv">.
47
 
    </para>
48
 
   </listitem>
49
 
   </varlistentry>
50
 
    <varlistentry>
51
 
    <term>
52
 
<option>-I <replaceable>fig_path</replaceable></option>
53
 
</term><listitem><para>Additional lookup paths of the figures. See <xref linkend="sec-lookup">.
54
 
    </para>
55
 
   </listitem>
56
 
   </varlistentry>
57
 
    <varlistentry>
58
 
    <term>
59
 
<option>-o <replaceable>output</replaceable></option>
60
 
</term><listitem><para>Output filename. When not used, the input file name is used, with a suffix related to the output format.
61
 
    </para>
62
 
   </listitem>
63
 
   </varlistentry>
64
 
    <varlistentry>
65
 
    <term>
66
 
<option>-d</option>
67
 
</term><listitem><para>Debug mode. It only keeps the temporary directory in which dblatex actually works. <xref linkend="sec-debug"> explains how you can use it.
68
 
    </para>
69
 
   </listitem>
70
 
   </varlistentry>
71
 
    <varlistentry>
72
 
    <term>
73
 
<option>-p <replaceable>config_file</replaceable></option>
74
 
</term><listitem><para>Specify a configuration file. See <xref linkend="sec-param">.
75
 
    </para>
76
 
   </listitem>
77
 
   </varlistentry>
78
 
    <varlistentry>
79
 
    <term>
80
 
<option>-P <replaceable>param=value</replaceable></option>
81
 
</term><listitem><para>Set an XSL parameter value from command line.
82
 
See <xref linkend="sec-param-value">.
83
 
    </para>
84
 
   </listitem>
85
 
   </varlistentry>
86
 
    <varlistentry>
87
 
    <term>
88
 
<option>-S <replaceable>spec_file</replaceable></option>
89
 
</term><listitem><para>Specification file. A specification file can be used to group all the options and customizations to apply. See <xref linkend="sec-specs">.
90
 
    </para>
91
 
   </listitem>
92
 
   </varlistentry>
93
 
   <varlistentry>
94
 
    <term>
95
 
<option>-T <replaceable>style</replaceable></option>
96
 
</term><listitem><para>Rendering style to use. Several rendering style (also called
97
 
LaTeX style) are provided by default. See <xref linkend="sec-style">.
98
 
    </para>
99
 
   </listitem>
100
 
   </varlistentry>
101
 
    <varlistentry>
102
 
    <term>
103
 
<option>-x <replaceable>xslt_options</replaceable></option>
104
 
</term><listitem><para>Options to pass to the XSLT. The example below passes the options &ldquo;--timing&rdquo; and &ldquo;--profile&rdquo; to the XSLT. Using this option supposes that you know the supported XSLT options. 
105
 
    </para>
106
 
    <programlisting>
107
 
<![CDATA[dblatex -x "--timing --profile" file.sgml]]></programlisting>
108
 
   </listitem>
109
 
   </varlistentry>
110
 
    <varlistentry>
111
 
    <term>
112
 
<option>-X</option>
113
 
</term><listitem><para>Disable the external text file support. This support is
114
 
needed for callouts on external files referenced by <sgmltag>textdata</sgmltag>
115
 
or <sgmltag>imagedata</sgmltag>, but it can be disabled if the document does not
116
 
contain such callouts. Disabling
117
 
this support can improve the processing performance for big
118
 
documents.
119
 
    </para>
120
 
   </listitem>
121
 
   </varlistentry>
122
 
   </variablelist>
123
 
   </sect2>
124
 
   <sect2>
125
 
    <title>
126
 
    Other options
127
 
   </title>
128
 
   <para>
129
 
    Other options are defined to customize the tool, but they should be used in exceptional cases, for test or debug purpose. These options are defined in section <xref linkend="sec-specs"> and should normaly be set through a specification file.
130
 
   </para>
131
 
   </sect2>
132
 
  </sect1>
133