1PUBLICAN(1) User Contributed Perl Documentation PUBLICAN(1)
2
6 publican - a DocBook XML publishing tool.
7
9 This document describes publican version 1.0
10
12 publican <command options>
13 publican <action> <action options>
15 Command Options
17 --help Display help message
19 --man Display the man page
20 --help_actions Display a list of valid actions
21 -v Display the version of Publican
22 Run: 'publican <action> --help' for details on action usage
24 Valid actions are:
26 build Transform XML to other formats (pdf, html, html-single, etc)
28 clean Remove all temporary files and directories
29 clean_ids Run clean ids for source XML
30 clean_set Remove local copies of remote set books
31 create Create a new book, set, or article
32 create_brand Create a new brand
33 create_site Create a new WebSite in the supplied location.
34 help_config Display help text for the configuration file
35 install_book Install a book in to a WebSite.
36 install_brand Install a brand to the supplied location
37 lang_stats report PO statistics
38 old2new Create a publican.cfg file from the Makefile of an old book, set, or article
39 package Package a language for shipping
40 print_banned Print a list of banned DocBook tags
41 print_known Print a list of QA'd DocBook tags
42 print_unused Print a list of unused XML files
43 print_tree Print a tree of the xi:includes
44 remove_book Remove a book from a WebSite.
45 site_stats Report on the contents of a WebSite
46 update_po Update the PO files
47 update_pot Update the POT files
48 update_site Update an existing sites templates.
49
51 Publican is a DocBook publication system, not just a DocBook processing
52 tool. As well as ensuring your DocBook XML is valid, publican works to
53 ensure your XML is up to publishable standard.
54
56 build
57 Transform XML to other formats (pdf, html, html-single, etc)
58 Options:
60 --help Display help message
61 --config=s Use a nonstandard config file
62 --common_config=s Override path to Common_Config directory
63 --common_content=s Override path to Common_Content directory
64 --nocolours Disable ANSI colourisation of logging.
65 --quiet Disable all logging.
66 --formats=<FORMATS> Comma-separated list of formats, for example: html,pdf,html-single,html-desktop,txt,epub
67 --langs=<LANGS> Comma-separated list of languages, for example: en-US,de-DE,all
68 --publish Set up built content for publishing
69 --embedtoc Embed the web site TOC object in the generated HTML
70 --distributed_set This flag tells publican the data being processed is a distributed set. Note: do not use distributed_set on the command line. Publican uses this flag when calling itself to process distributed sets. This is the only safe way this flag can be used.
71 clean
73 Remove all temporary files and directories
74 Options:
76 --help Display help message
77 --config=s Use a nonstandard config file
78 --common_config=s Override path to Common_Config directory
79 --common_content=s Override path to Common_Content directory
80 --nocolours Disable ANSI colourisation of logging.
81 --quiet Disable all logging.
82 clean_ids
84 Run clean ids for source XML
85 Options:
87 --help Display help message
88 --config=s Use a nonstandard config file
89 --common_config=s Override path to Common_Config directory
90 --common_content=s Override path to Common_Content directory
91 --nocolours Disable ANSI colourisation of logging.
92 --quiet Disable all logging.
93 clean_set
95 Remove local copies of remote set books
96 Options:
98 --help Display help message
99 --config=s Use a nonstandard config file
100 --common_config=s Override path to Common_Config directory
101 --common_content=s Override path to Common_Content directory
102 --nocolours Disable ANSI colourisation of logging.
103 --quiet Disable all logging.
104 create
106 Create a new book, set, or article
107 Options:
109 --help Display help message
110 --config=s Use a nonstandard config file
111 --common_config=s Override path to Common_Config directory
112 --common_content=s Override path to Common_Content directory
113 --nocolours Disable ANSI colourisation of logging.
114 --quiet Disable all logging.
115 --name=<NAME> The name of the book, article, set, or brand
116 --version=<VERSION> The version of the product
117 --edition=<EDITION> The edition of the book, article, or set
118 --product=<PRODUCT> The name of the product
119 --brand=<BRAND> The brand to use
120 --lang=<LANG> The language the XML will be written in
121 --type=<TYPE> The type (book, article, or set)
122 create_brand
124 Create a new brand
125 Options:
127 --help Display help message
128 --config=s Use a nonstandard config file
129 --common_config=s Override path to Common_Config directory
130 --common_content=s Override path to Common_Content directory
131 --nocolours Disable ANSI colourisation of logging.
132 --quiet Disable all logging.
133 --name=<NAME> The name of the book, article, set, or brand
134 --lang=<LANG> The language the XML will be written in
135 create_site
137 Create a new WebSite in the supplied location.
138 Options:
140 --site_config=<SITE_CONFIG> WebSite configuration file to use or create.
141 --db_file=<DB_FILE> Override default database file.
142 --toc_path=<TOC_PATH> Override the default TOC path.
143 --tmpl_path=<TMPL_PATH> Override the default template path.
144 help_config
146 Display help text for the configuration file
147 Options:
149 --help Display help message
150 --config=s Use a nonstandard config file
151 --common_config=s Override path to Common_Config directory
152 --common_content=s Override path to Common_Content directory
153 --nocolours Disable ANSI colourisation of logging.
154 --quiet Disable all logging.
155 install_book
157 Install a book in to a WebSite.
158 Options:
160 --site_config=<SITE_CONFIG> WebSite configuration file to use or create.
161 --lang=<LANG> The language the XML will be written in
162 install_brand
164 Install a brand to the supplied location
165 Options:
167 --help Display help message
168 --config=s Use a nonstandard config file
169 --common_config=s Override path to Common_Config directory
170 --common_content=s Override path to Common_Content directory
171 --nocolours Disable ANSI colourisation of logging.
172 --quiet Disable all logging.
173 --path=<PATH> /path/to/install/to
174 lang_stats
176 report PO statistics
177 Options:
179 --help Display help message
180 --config=s Use a nonstandard config file
181 --common_config=s Override path to Common_Config directory
182 --common_content=s Override path to Common_Content directory
183 --nocolours Disable ANSI colourisation of logging.
184 --quiet Disable all logging.
185 --lang=<LANG> The language the XML will be written in
186 old2new
188 Create a publican.cfg file from the Makefile of an old book, set,
189 or article
190 Options:
192 --help Display help message
193 --config=s Use a nonstandard config file
194 --common_config=s Override path to Common_Config directory
195 --common_content=s Override path to Common_Content directory
196 --nocolours Disable ANSI colourisation of logging.
197 --quiet Disable all logging.
198 package
200 Package a language for shipping
201 Options:
203 --help Display help message
204 --config=s Use a nonstandard config file
205 --common_config=s Override path to Common_Config directory
206 --common_content=s Override path to Common_Content directory
207 --nocolours Disable ANSI colourisation of logging.
208 --quiet Disable all logging.
209 --lang=<LANG> The language the XML will be written in
210 --desktop Create desktop instead of web package
211 --brew Push SRPM to brew
212 --scratch Use scratch instead of tag build
213 --short_sighted Create package without using version in package name
214 --binary Build binary rpm when running package
215 --wait Wait for brew to finish building
216 --cvs Import the SRPM in to CVS, the run make tag and make build.
217 print_banned
219 Print a list of banned DocBook tags
220 Options:
222 --help Display help message
223 --config=s Use a nonstandard config file
224 --common_config=s Override path to Common_Config directory
225 --common_content=s Override path to Common_Content directory
226 --nocolours Disable ANSI colourisation of logging.
227 --quiet Disable all logging.
228 print_known
230 Print a list of QA'd DocBook tags
231 Options:
233 --help Display help message
234 --config=s Use a nonstandard config file
235 --common_config=s Override path to Common_Config directory
236 --common_content=s Override path to Common_Content directory
237 --nocolours Disable ANSI colourisation of logging.
238 --quiet Disable all logging.
239 print_unused
241 Print a list of unused XML files
242 Options:
244 --help Display help message
245 --config=s Use a nonstandard config file
246 --common_config=s Override path to Common_Config directory
247 --common_content=s Override path to Common_Content directory
248 --nocolours Disable ANSI colourisation of logging.
249 --quiet Disable all logging.
250 print_tree
252 Print a tree of the xi:includes
253 Options:
255 --help Display help message
256 --config=s Use a nonstandard config file
257 --common_config=s Override path to Common_Config directory
258 --common_content=s Override path to Common_Content directory
259 --nocolours Disable ANSI colourisation of logging.
260 --quiet Disable all logging.
261 remove_book
263 Remove a book from a WebSite.
264 Options:
266 --site_config=<SITE_CONFIG> WebSite configuration file to use or create.
267 --lang=<LANG> The language the XML will be written in
268 site_stats
270 Report on the contents of a WebSite
271 Options:
273 --site_config=<SITE_CONFIG> WebSite configuration file to use or create.
274 update_po
276 Update the PO files
277 Options:
279 --help Display help message
280 --config=s Use a nonstandard config file
281 --common_config=s Override path to Common_Config directory
282 --common_content=s Override path to Common_Content directory
283 --nocolours Disable ANSI colourisation of logging.
284 --quiet Disable all logging.
285 --langs=<LANGS> Comma-separated list of languages, for example: en-US,de-DE,all
286 update_pot
288 Update the POT files
289 Options:
291 --help Display help message
292 --config=s Use a nonstandard config file
293 --common_config=s Override path to Common_Config directory
294 --common_content=s Override path to Common_Content directory
295 --nocolours Disable ANSI colourisation of logging.
296 --quiet Disable all logging.
297 update_site
299 Update an existing sites templates.
300 Options:
302 --site_config=<SITE_CONFIG> WebSite configuration file to use or create.
303
305 Publican requires access to GetText msgmerge for merging updated POT
306 files with PO files.
307 Publican requires access to Apache FOP for creating PDF files.
309
311 Archive::Tar Carp Config::Simple Cwd DateTime
312 DateTime::Format::DateParse Encode File::Copy::Recursive File::Find
313 File::Find::Rule File::Path File::pushd File::Spec Getopt::Long
314 HTML::FormatText HTML::TreeBuilder I18N::LangTags::List Image::Magick
315 Image::Size Locale::PO Makefile::Parser Module::Build Pod::Usage
316 Publican Publican::Builder Publican::CreateBook Publican::CreateBrand
317 Publican::Localise Publican::Translate Publican::TreeView
318 Publican::XmlClean Syntax::Highlight::Engine::Kate Term::ANSIColor
319 Test::More Text::Wrap XML::LibXML XML::LibXSLT XML::TreeBuilder
320
322 None reported.
323
325 No bugs have been reported.
326 Please report any bugs or feature requests to
328 "publican-list@redhat.com", or through the web interface at
329 <https://bugzilla.redhat.com/bugzilla/enter_bug.cgi?product=Fedora&version=rawhide&component=publican>.
330
332 Jeff Fearn "<jfearn@redhat.com>"
333perl v5.10.1 2010-11-12 PUBLICAN(1)