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 Valid actions are:
24 add_revision Add an entry to the revision history
26 build Transform XML to other formats (pdf, html, html-single, drupal-book, etc)
27 clean Remove all temporary files and directories
28 clean_ids Run clean ids for source XML
29 clean_set Remove local copies of remote set books
30 create Create a new book, set, or article
31 create_brand Create a new brand
32 create_site Create a new WebSite in the supplied location.
33 help_config Display help text for the configuration file
34 install_book Install a book in to a WebSite.
35 install_brand Install a brand to the supplied location
36 lang_stats report PO statistics
37 migrate_site Migrate a website DataBase from Publican < 3 to Publican 3.
38 package Package a language for shipping
39 print_banned Print a list of banned DocBook tags
40 print_known Print a list of QA'd DocBook tags
41 print_tree Print a tree of the xi:includes
42 print_unused Print a list of unused XML files
43 print_unused_images Print a list of unused Image files
44 remove_book Remove a book from a WebSite.
45 rename Rename a publican book
46 site_stats Report on the contents of a WebSite
47 trans_drop Snapshot the source language for use in translation.
48 update_db Add or remove database entries. Used for processing pre-build books, such as when building packages.
49 update_po Update the PO files
50 update_pot Update the POT files
51 update_site Update an existing sites templates.
52 Run: 'bin/publican <action> --help' for details on action usage
54
56 add_revision
57 Add an entry to the revision history
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 --brand_dir=s Directory to source brand files from.
67 --lang=<LANG> The language the XML will be written in
68 --revnumber=<REVNUMBER> Revision number to use for a revision.
69 --date=<DATE> Date to use for a revision.
70 --member=<MEMBER> An entry to be added to the revision. Can be specified multiple times.
71 --firstname=<FIRSTNAME> firstname to use for a revision.
72 --surname=<SURNAME> surname to use for a revision.
73 --email=<EMAIL> email to use for a revision.
74 build
76 Transform XML to other formats (pdf, html, html-single, drupal-
77 book, etc)
78 Options:
80 --help Display help message
81 --config=s Use a nonstandard config file
82 --common_config=s Override path to Common_Config directory
83 --common_content=s Override path to Common_Content directory
84 --nocolours Disable ANSI colourisation of logging.
85 --quiet Disable all logging.
86 --brand_dir=s Directory to source brand files from.
87 --formats=<FORMATS> Comma-separated list of formats, for example: html,pdf,html-single,html-desktop,txt,epub
88 --langs=<LANGS> Comma-separated list of languages, for example: en-US,de-DE,all
89 --publish Set up built content for publishing
90 --embedtoc Embed the web site TOC object in the generated HTML
91 --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.
92 --novalid Do not run the DTD validation
93 --src_dir=<SRC_DIR> Directory to source publican files from.
94 --pdftool=<PDFTOOL> Override the tool to use when creating PDFs. Valid options are wkhtmltopdf and fop.
95 --pub_dir=<PUB_DIR> Directory to publish files to. Defaults to publish.
96 clean
98 Remove all temporary files and directories
99 Options:
101 --help Display help message
102 --config=s Use a nonstandard config file
103 --common_config=s Override path to Common_Config directory
104 --common_content=s Override path to Common_Content directory
105 --nocolours Disable ANSI colourisation of logging.
106 --quiet Disable all logging.
107 --brand_dir=s Directory to source brand files from.
108 --pub_dir=<PUB_DIR> Directory to publish files to. Defaults to publish.
109 clean_ids
111 Run clean ids for source XML
112 Options:
114 --help Display help message
115 --config=s Use a nonstandard config file
116 --common_config=s Override path to Common_Config directory
117 --common_content=s Override path to Common_Content directory
118 --nocolours Disable ANSI colourisation of logging.
119 --quiet Disable all logging.
120 --brand_dir=s Directory to source brand files from.
121 clean_set
123 Remove local copies of remote set books
124 Options:
126 --help Display help message
127 --config=s Use a nonstandard config file
128 --common_config=s Override path to Common_Config directory
129 --common_content=s Override path to Common_Content directory
130 --nocolours Disable ANSI colourisation of logging.
131 --quiet Disable all logging.
132 --brand_dir=s Directory to source brand files from.
133 create
135 Create a new book, set, or article
136 Options:
138 --help Display help message
139 --config=s Use a nonstandard config file
140 --common_config=s Override path to Common_Config directory
141 --common_content=s Override path to Common_Content directory
142 --nocolours Disable ANSI colourisation of logging.
143 --quiet Disable all logging.
144 --brand_dir=s Directory to source brand files from.
145 --name=<NAME> The name of the book, article, set, or brand
146 --version=<VERSION> The version of the product
147 --edition=<EDITION> The edition of the book, article, or set
148 --product=<PRODUCT> The name of the product
149 --brand=<BRAND> The brand to use
150 --lang=<LANG> The language the XML will be written in
151 --type=<TYPE> The type (book, article, or set)
152 create_brand
154 Create a new brand
155 Options:
157 --help Display help message
158 --config=s Use a nonstandard config file
159 --common_config=s Override path to Common_Config directory
160 --common_content=s Override path to Common_Content directory
161 --nocolours Disable ANSI colourisation of logging.
162 --quiet Disable all logging.
163 --brand_dir=s Directory to source brand files from.
164 --name=<NAME> The name of the book, article, set, or brand
165 --lang=<LANG> The language the XML will be written in
166 create_site
168 Create a new WebSite in the supplied location.
169 Options:
171 --help Display help message
172 --config=s Use a nonstandard config file
173 --common_config=s Override path to Common_Config directory
174 --common_content=s Override path to Common_Content directory
175 --nocolours Disable ANSI colourisation of logging.
176 --quiet Disable all logging.
177 --brand_dir=s Directory to source brand files from.
178 --site_config=<SITE_CONFIG> WebSite configuration file to use or create.
179 --db_file=<DB_FILE> Override default database file.
180 --toc_path=<TOC_PATH> Override the default TOC path.
181 --tmpl_path=<TMPL_PATH> Override the default template path.
182 --lang=<LANG> The language the XML will be written in
183 help_config
185 Display help text for the configuration file
186 Options:
188 --help Display help message
189 --config=s Use a nonstandard config file
190 --common_config=s Override path to Common_Config directory
191 --common_content=s Override path to Common_Content directory
192 --nocolours Disable ANSI colourisation of logging.
193 --quiet Disable all logging.
194 --brand_dir=s Directory to source brand files from.
195 install_book
197 Install a book in to a WebSite.
198 Options:
200 --help Display help message
201 --config=s Use a nonstandard config file
202 --common_config=s Override path to Common_Config directory
203 --common_content=s Override path to Common_Content directory
204 --nocolours Disable ANSI colourisation of logging.
205 --quiet Disable all logging.
206 --brand_dir=s Directory to source brand files from.
207 --site_config=<SITE_CONFIG> WebSite configuration file to use or create.
208 --lang=<LANG> The language the XML will be written in
209 install_brand
211 Install a brand to the supplied location
212 Options:
214 --help Display help message
215 --config=s Use a nonstandard config file
216 --common_config=s Override path to Common_Config directory
217 --common_content=s Override path to Common_Content directory
218 --nocolours Disable ANSI colourisation of logging.
219 --quiet Disable all logging.
220 --brand_dir=s Directory to source brand files from.
221 --path=<PATH> /path/to/install/to
222 --web Install the web content for a brand.
223 --pub_dir=<PUB_DIR> Directory to publish files to. Defaults to publish.
224 lang_stats
226 report PO statistics
227 Options:
229 --help Display help message
230 --config=s Use a nonstandard config file
231 --common_config=s Override path to Common_Config directory
232 --common_content=s Override path to Common_Content directory
233 --nocolours Disable ANSI colourisation of logging.
234 --quiet Disable all logging.
235 --brand_dir=s Directory to source brand files from.
236 --lang=<LANG> The language the XML will be written in
237 migrate_site
239 Migrate a website DataBase from Publican < 3 to Publican 3.
240 Options:
242 --help Display help message
243 --config=s Use a nonstandard config file
244 --common_config=s Override path to Common_Config directory
245 --common_content=s Override path to Common_Content directory
246 --nocolours Disable ANSI colourisation of logging.
247 --quiet Disable all logging.
248 --brand_dir=s Directory to source brand files from.
249 --site_config=<SITE_CONFIG> WebSite configuration file to use or create.
250 package
252 Package a language for shipping
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 --brand_dir=s Directory to source brand files from.
262 --lang=<LANG> The language the XML will be written in
263 --desktop Create desktop instead of web package
264 --brew Push SRPM to brew
265 --scratch Use scratch instead of tag build
266 --short_sighted Create package without using version in package name
267 --binary Build binary rpm when running package
268 --wait Wait for brew to finish building
269 --pub_dir=<PUB_DIR> Directory to publish files to. Defaults to publish.
270 print_banned
272 Print a list of banned DocBook tags
273 Options:
275 --help Display help message
276 --config=s Use a nonstandard config file
277 --common_config=s Override path to Common_Config directory
278 --common_content=s Override path to Common_Content directory
279 --nocolours Disable ANSI colourisation of logging.
280 --quiet Disable all logging.
281 --brand_dir=s Directory to source brand files from.
282 print_known
284 Print a list of QA'd DocBook tags
285 Options:
287 --help Display help message
288 --config=s Use a nonstandard config file
289 --common_config=s Override path to Common_Config directory
290 --common_content=s Override path to Common_Content directory
291 --nocolours Disable ANSI colourisation of logging.
292 --quiet Disable all logging.
293 --brand_dir=s Directory to source brand files from.
294 print_tree
296 Print a tree of the xi:includes
297 Options:
299 --help Display help message
300 --config=s Use a nonstandard config file
301 --common_config=s Override path to Common_Config directory
302 --common_content=s Override path to Common_Content directory
303 --nocolours Disable ANSI colourisation of logging.
304 --quiet Disable all logging.
305 --brand_dir=s Directory to source brand files from.
306 print_unused
308 Print a list of unused XML files
309 Options:
311 --help Display help message
312 --config=s Use a nonstandard config file
313 --common_config=s Override path to Common_Config directory
314 --common_content=s Override path to Common_Content directory
315 --nocolours Disable ANSI colourisation of logging.
316 --quiet Disable all logging.
317 --brand_dir=s Directory to source brand files from.
318 print_unused_images
320 Print a list of unused Image files
321 Options:
323 --help Display help message
324 --config=s Use a nonstandard config file
325 --common_config=s Override path to Common_Config directory
326 --common_content=s Override path to Common_Content directory
327 --nocolours Disable ANSI colourisation of logging.
328 --quiet Disable all logging.
329 --brand_dir=s Directory to source brand files from.
330 remove_book
332 Remove a book from a WebSite.
333 Options:
335 --help Display help message
336 --config=s Use a nonstandard config file
337 --common_config=s Override path to Common_Config directory
338 --common_content=s Override path to Common_Content directory
339 --nocolours Disable ANSI colourisation of logging.
340 --quiet Disable all logging.
341 --brand_dir=s Directory to source brand files from.
342 --site_config=<SITE_CONFIG> WebSite configuration file to use or create.
343 --lang=<LANG> The language the XML will be written in
344 rename
346 Rename a publican book
347 Options:
349 --help Display help message
350 --config=s Use a nonstandard config file
351 --common_config=s Override path to Common_Config directory
352 --common_content=s Override path to Common_Content directory
353 --nocolours Disable ANSI colourisation of logging.
354 --quiet Disable all logging.
355 --brand_dir=s Directory to source brand files from.
356 --name=<NAME> The name of the book, article, set, or brand
357 --product=<PRODUCT> The name of the product
358 --version=<VERSION> The version of the product
359 site_stats
361 Report on the contents of a WebSite
362 Options:
364 --help Display help message
365 --config=s Use a nonstandard config file
366 --common_config=s Override path to Common_Config directory
367 --common_content=s Override path to Common_Content directory
368 --nocolours Disable ANSI colourisation of logging.
369 --quiet Disable all logging.
370 --brand_dir=s Directory to source brand files from.
371 --site_config=<SITE_CONFIG> WebSite configuration file to use or create.
372 trans_drop
374 Snapshot the source language for use in translation.
375 Options:
377 --help Display help message
378 --config=s Use a nonstandard config file
379 --common_config=s Override path to Common_Config directory
380 --common_content=s Override path to Common_Content directory
381 --nocolours Disable ANSI colourisation of logging.
382 --quiet Disable all logging.
383 --brand_dir=s Directory to source brand files from.
384 update_db
386 Add or remove database entries. Used for processing pre-build
387 books, such as when building packages.
388 Options:
390 --help Display help message
391 --config=s Use a nonstandard config file
392 --common_config=s Override path to Common_Config directory
393 --common_content=s Override path to Common_Content directory
394 --nocolours Disable ANSI colourisation of logging.
395 --quiet Disable all logging.
396 --brand_dir=s Directory to source brand files from.
397 --site_config=<SITE_CONFIG> WebSite configuration file to use or create.
398 --add Add a database entry
399 --del Delete a database entry
400 --lang=<LANG> The language the XML will be written in
401 --product=<PRODUCT> The name of the product
402 --version=<VERSION> The version of the product
403 --name=<NAME> The name of the book, article, set, or brand
404 --formats=<FORMATS> Comma-separated list of formats, for example: html,pdf,html-single,html-desktop,txt,epub
405 --subtitle=<SUBTITLE> Sub title for a book
406 --abstract=<ABSTRACT> Abstract for a book
407 --product_label=<PRODUCT_LABEL> product label for a book
408 --version_label=<VERSION_LABEL> version label for a book
409 --name_label=<NAME_LABEL> name label for a book
410 --sort_order=<SORT_ORDER> Order to sort a book
411 update_po
413 Update the PO files
414 Options:
416 --help Display help message
417 --config=s Use a nonstandard config file
418 --common_config=s Override path to Common_Config directory
419 --common_content=s Override path to Common_Content directory
420 --nocolours Disable ANSI colourisation of logging.
421 --quiet Disable all logging.
422 --brand_dir=s Directory to source brand files from.
423 --langs=<LANGS> Comma-separated list of languages, for example: en-US,de-DE,all
424 --msgmerge Use gettext's msgmerge for POT/PO merging.
425 --firstname=<FIRSTNAME> firstname to use for a revision.
426 --surname=<SURNAME> surname to use for a revision.
427 --email=<EMAIL> email to use for a revision.
428 update_pot
430 Update the POT files
431 Options:
433 --help Display help message
434 --config=s Use a nonstandard config file
435 --common_config=s Override path to Common_Config directory
436 --common_content=s Override path to Common_Content directory
437 --nocolours Disable ANSI colourisation of logging.
438 --quiet Disable all logging.
439 --brand_dir=s Directory to source brand files from.
440 update_site
442 Update an existing sites templates.
443 Options:
445 --help Display help message
446 --config=s Use a nonstandard config file
447 --common_config=s Override path to Common_Config directory
448 --common_content=s Override path to Common_Content directory
449 --nocolours Disable ANSI colourisation of logging.
450 --quiet Disable all logging.
451 --brand_dir=s Directory to source brand files from.
452 --site_config=<SITE_CONFIG> WebSite configuration file to use or create.
453
455 Publican requires access to Apache FOP for creating PDF files.
456
458 Archive::Tar Archive::Zip Carp Config::Simple Cwd DBI DateTime
459 DateTime::Format::DateParse Devel::Cover Encode File::Basename
460 File::Copy::Recursive File::Find File::Find::Rule File::HomeDir
461 File::Inplace File::Path File::Spec File::Which File::pushd
462 Getopt::Long HTML::FormatText HTML::FormatText::WithLinks
463 HTML::FormatText::WithLinks::AndTables HTML::TreeBuilder
464 I18N::LangTags::List IO::String List::MoreUtils List::Util
465 Locale::Language Locale::Maketext::Gettext Locale::PO Module::Build
466 Pod::Usage Sort::Versions String::Similarity
467 Syntax::Highlight::Engine::Kate Template Template::Constants
468 Term::ANSIColor Test::More Test::Pod Test::Pod::Coverage Text::CSV_XS
469 Text::Wrap Time::localtime XML::LibXML XML::LibXSLT XML::Simple
470 XML::TreeBuilder
471
473 None reported.
474
476 No bugs have been reported.
477 Please report any bugs or feature requests to
479 "publican-list@redhat.com", or through the web interface at
480 <https://bugzilla.redhat.com/bugzilla/enter_bug.cgi?product=Publican&component=publican&version=v3.2.0>.
481
483 Jeff Fearn "<jfearn@redhat.com>"
484perl v5.16.3 2013-08-08 PUBLICAN(1)