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
|
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter [
<!ENTITY % BOOK_ENTITIES SYSTEM "Users_Guide.ent">
%BOOK_ENTITIES;
<!ENTITY % sgml.features "IGNORE">
<!ENTITY % xml.features "INCLUDE">
<!ENTITY % DOCBOOK_ENTS PUBLIC "-//OASIS//ENTITIES DocBook Character Entities V4.5//EN" "/usr/share/xml/docbook/schema/dtd/4.5/dbcentx.mod">
%DOCBOOK_ENTS;
]>
<chapter conformance="204" version="5.0" xml:id="chap-Publican-Users_Guide-Publican_commands" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<info>
<title>Publican commands</title>
</info>
<para>
<application>Publican</application> is a command-line tool. To use <application>Publican</application> on a computer with a Linux operating system, you must either start a terminal emulator program (such as <application>GNOME Terminal</application> or <application>Konsole</application>) or switch to a virtual console. To use <application>Publican</application> on a computer with a Windows operating system, run the <command>cmd</command> command from the <guimenu>Start menu</guimenu> to open a command prompt.
</para>
<para>
<application>Publican</application> commands take one of the following formats:
<variablelist>
<varlistentry>
<term><prompt>$</prompt> <command>publican <replaceable>command_option</replaceable></command></term>
<listitem>
<para>
The <replaceable>command_option</replaceable> is any of several options for the <prompt>$</prompt> <command>publican</command> command itself. For a complete list of actions see <xref linkend="Auto_Docs-Command_actions" />
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><prompt>$</prompt> <command>publican <replaceable>action</replaceable> <replaceable>action_options</replaceable></command></term>
<listitem>
<para>
The <replaceable>action</replaceable> is an action for <application>Publican</application> to perform, such as creating the XML files for a new document or building a HTML document from a document's XML files. The <replaceable>action_options</replaceable> apply to the <replaceable>action</replaceable>, such as specifying the language of a document. For a complete list of actions see <xref linkend="Auto_Docs-Command_actions" />
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><prompt>$</prompt> <command>publican <replaceable>command_option</replaceable> <replaceable>action</replaceable> <replaceable>action_options</replaceable></command></term>
<listitem>
<para>
Some <replaceable>command_options</replaceable> affect the output of <replaceable>actions</replaceable>, for example, whether <application>Publican</application> should use ANSI colors in its output. For a complete list of actions and options see <xref linkend="Auto_Docs-Command_actions" />
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</chapter>
|
