1PUBLICAN(1) User Contributed Perl Documentation PUBLICAN(1)
2
6 publican - a DocBook XML publishing tool.
7
9 This document describes publican version 4.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 copy_web_brand Copy a brand's installed web content to another site
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 migrate_site Migrate a website DataBase from Publican < 3 to Publican 3.
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_tree Print a tree of the xi:includes
43 print_unused Print a list of unused XML files
44 print_unused_images Print a list of unused Image files
45 remove_book Remove a book from a WebSite.
46 rename Rename a publican book
47 report Print a readability report for the source text.
48 site_stats Report on the contents of a WebSite
49 trans_drop Snapshot the source language for use in translation.
50 update_db Add or remove database entries. Used for processing pre-build books, such as when building packages.
51 update_po Update the PO files
52 update_pot Update the POT files
53 update_site Update an existing sites templates.
54 zt_pull Pull translations from Zanata.
55 zt_push Push translations to Zanata.
56 Run: 'bin/publican <action> --help' for details on action usage
58
60 add_revision
61 Add an entry to the revision history
62 Options:
64 --help Display help message
65 --config=s Use a nonstandard config file
66 --common_config=s Override path to Common_Config directory
67 --common_content=s Override path to Common_Content directory
68 --nocolours Disable ANSI colourisation of logging.
69 --quiet Disable all logging.
70 --brand_dir=s Directory to source brand files from.
71 --lang=<LANG> The language the XML will be written in
72 --revnumber=<REVNUMBER> Revision number to use for a revision.
73 --date=<DATE> Date to use for a revision.
74 --member=<MEMBER> An entry to be added to the revision. Can be specified multiple times.
75 --firstname=<FIRSTNAME> firstname to use for a revision.
76 --surname=<SURNAME> surname to use for a revision.
77 --email=<EMAIL> email to use for a revision.
78 build
80 Transform XML to other formats (pdf, html, html-single, drupal-
81 book, etc)
82 Options:
84 --help Display help message
85 --config=s Use a nonstandard config file
86 --common_config=s Override path to Common_Config directory
87 --common_content=s Override path to Common_Content directory
88 --nocolours Disable ANSI colourisation of logging.
89 --quiet Disable all logging.
90 --brand_dir=s Directory to source brand files from.
91 --formats=<FORMATS> Comma-separated list of formats, for example: html,pdf,html-single,html-desktop,txt,epub
92 --langs=<LANGS> Comma-separated list of languages, for example: en-US,de-DE,all
93 --publish Set up built content for publishing
94 --embedtoc Embed the web site TOC object in the generated HTML
95 --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.
96 --novalid Do not run the DTD validation
97 --src_dir=<SRC_DIR> Directory to source publican files from.
98 --pdftool=<PDFTOOL> Override the tool to use when creating PDFs. Valid options are wkhtmltopdf and fop.
99 --pub_dir=<PUB_DIR> Directory to publish files to. Defaults to publish.
100 clean
102 Remove all temporary files and directories
103 Options:
105 --help Display help message
106 --config=s Use a nonstandard config file
107 --common_config=s Override path to Common_Config directory
108 --common_content=s Override path to Common_Content directory
109 --nocolours Disable ANSI colourisation of logging.
110 --quiet Disable all logging.
111 --brand_dir=s Directory to source brand files from.
112 --pub_dir=<PUB_DIR> Directory to publish files to. Defaults to publish.
113 clean_ids
115 Run clean ids for source XML
116 Options:
118 --help Display help message
119 --config=s Use a nonstandard config file
120 --common_config=s Override path to Common_Config directory
121 --common_content=s Override path to Common_Content directory
122 --nocolours Disable ANSI colourisation of logging.
123 --quiet Disable all logging.
124 --brand_dir=s Directory to source brand files from.
125 clean_set
127 Remove local copies of remote set books
128 Options:
130 --help Display help message
131 --config=s Use a nonstandard config file
132 --common_config=s Override path to Common_Config directory
133 --common_content=s Override path to Common_Content directory
134 --nocolours Disable ANSI colourisation of logging.
135 --quiet Disable all logging.
136 --brand_dir=s Directory to source brand files from.
137 copy_web_brand
139 Copy a brand's installed web content to another site
140 Options:
142 --help Display help message
143 --config=s Use a nonstandard config file
144 --common_config=s Override path to Common_Config directory
145 --common_content=s Override path to Common_Content directory
146 --nocolours Disable ANSI colourisation of logging.
147 --quiet Disable all logging.
148 --brand_dir=s Directory to source brand files from.
149 --brand=<BRAND> The brand to use
150 --site_config=<SITE_CONFIG> WebSite configuration file to use or create.
151 --old_site_config=<OLD_SITE_CONFIG> WebSite configuration file to use when copying content between sites.
152 create
154 Create a new book, set, or article
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 --version=<VERSION> The version of the product
166 --edition=<EDITION> The edition of the book, article, or set
167 --product=<PRODUCT> The name of the product
168 --brand=<BRAND> The brand to use
169 --lang=<LANG> The language the XML will be written in
170 --type=<TYPE> The type (book, article, or set)
171 --dtdver=<DTDVER> The version of the DocBook DTD to use
172 create_brand
174 Create a new brand
175 Options:
177 --help Display help message
178 --config=s Use a nonstandard config file
179 --common_config=s Override path to Common_Config directory
180 --common_content=s Override path to Common_Content directory
181 --nocolours Disable ANSI colourisation of logging.
182 --quiet Disable all logging.
183 --brand_dir=s Directory to source brand files from.
184 --name=<NAME> The name of the book, article, set, or brand
185 --lang=<LANG> The language the XML will be written in
186 create_site
188 Create a new WebSite in the supplied location.
189 Options:
191 --help Display help message
192 --config=s Use a nonstandard config file
193 --common_config=s Override path to Common_Config directory
194 --common_content=s Override path to Common_Content directory
195 --nocolours Disable ANSI colourisation of logging.
196 --quiet Disable all logging.
197 --brand_dir=s Directory to source brand files from.
198 --site_config=<SITE_CONFIG> WebSite configuration file to use or create.
199 --db_file=<DB_FILE> Override default database file.
200 --toc_path=<TOC_PATH> Override the default TOC path.
201 --tmpl_path=<TMPL_PATH> Override the default template path.
202 --lang=<LANG> The language the XML will be written in
203 help_config
205 Display help text for the configuration file
206 Options:
208 --help Display help message
209 --config=s Use a nonstandard config file
210 --common_config=s Override path to Common_Config directory
211 --common_content=s Override path to Common_Content directory
212 --nocolours Disable ANSI colourisation of logging.
213 --quiet Disable all logging.
214 --brand_dir=s Directory to source brand files from.
215 install_book
217 Install a book in to a WebSite.
218 Options:
220 --help Display help message
221 --config=s Use a nonstandard config file
222 --common_config=s Override path to Common_Config directory
223 --common_content=s Override path to Common_Content directory
224 --nocolours Disable ANSI colourisation of logging.
225 --quiet Disable all logging.
226 --brand_dir=s Directory to source brand files from.
227 --site_config=<SITE_CONFIG> WebSite configuration file to use or create.
228 --lang=<LANG> The language the XML will be written in
229 install_brand
231 Install a brand to the supplied location
232 Options:
234 --help Display help message
235 --config=s Use a nonstandard config file
236 --common_config=s Override path to Common_Config directory
237 --common_content=s Override path to Common_Content directory
238 --nocolours Disable ANSI colourisation of logging.
239 --quiet Disable all logging.
240 --brand_dir=s Directory to source brand files from.
241 --path=<PATH> /path/to/install/to
242 --web Install the web content for a brand.
243 --pub_dir=<PUB_DIR> Directory to publish files to. Defaults to publish.
244 lang_stats
246 report PO statistics
247 Options:
249 --help Display help message
250 --config=s Use a nonstandard config file
251 --common_config=s Override path to Common_Config directory
252 --common_content=s Override path to Common_Content directory
253 --nocolours Disable ANSI colourisation of logging.
254 --quiet Disable all logging.
255 --brand_dir=s Directory to source brand files from.
256 --lang=<LANG> The language the XML will be written in
257 migrate_site
259 Migrate a website DataBase from Publican < 3 to Publican 3.
260 Options:
262 --help Display help message
263 --config=s Use a nonstandard config file
264 --common_config=s Override path to Common_Config directory
265 --common_content=s Override path to Common_Content directory
266 --nocolours Disable ANSI colourisation of logging.
267 --quiet Disable all logging.
268 --brand_dir=s Directory to source brand files from.
269 --site_config=<SITE_CONFIG> WebSite configuration file to use or create.
270 package
272 Package a language for shipping
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 --lang=<LANG> The language the XML will be written in
283 --desktop Create desktop instead of web package
284 --brew Push SRPM to brew
285 --scratch Use scratch instead of tag build
286 --short_sighted Create package without using version in package name
287 --binary Build binary rpm when running package
288 --wait Wait for brew to finish building
289 --pub_dir=<PUB_DIR> Directory to publish files to. Defaults to publish.
290 print_banned
292 Print a list of banned DocBook tags
293 Options:
295 --help Display help message
296 --config=s Use a nonstandard config file
297 --common_config=s Override path to Common_Config directory
298 --common_content=s Override path to Common_Content directory
299 --nocolours Disable ANSI colourisation of logging.
300 --quiet Disable all logging.
301 --brand_dir=s Directory to source brand files from.
302 print_known
304 Print a list of QA'd DocBook tags
305 Options:
307 --help Display help message
308 --config=s Use a nonstandard config file
309 --common_config=s Override path to Common_Config directory
310 --common_content=s Override path to Common_Content directory
311 --nocolours Disable ANSI colourisation of logging.
312 --quiet Disable all logging.
313 --brand_dir=s Directory to source brand files from.
314 print_tree
316 Print a tree of the xi:includes
317 Options:
319 --help Display help message
320 --config=s Use a nonstandard config file
321 --common_config=s Override path to Common_Config directory
322 --common_content=s Override path to Common_Content directory
323 --nocolours Disable ANSI colourisation of logging.
324 --quiet Disable all logging.
325 --brand_dir=s Directory to source brand files from.
326 print_unused
328 Print a list of unused XML files
329 Options:
331 --help Display help message
332 --config=s Use a nonstandard config file
333 --common_config=s Override path to Common_Config directory
334 --common_content=s Override path to Common_Content directory
335 --nocolours Disable ANSI colourisation of logging.
336 --quiet Disable all logging.
337 --brand_dir=s Directory to source brand files from.
338 print_unused_images
340 Print a list of unused Image files
341 Options:
343 --help Display help message
344 --config=s Use a nonstandard config file
345 --common_config=s Override path to Common_Config directory
346 --common_content=s Override path to Common_Content directory
347 --nocolours Disable ANSI colourisation of logging.
348 --quiet Disable all logging.
349 --brand_dir=s Directory to source brand files from.
350 remove_book
352 Remove a book from a WebSite.
353 Options:
355 --help Display help message
356 --config=s Use a nonstandard config file
357 --common_config=s Override path to Common_Config directory
358 --common_content=s Override path to Common_Content directory
359 --nocolours Disable ANSI colourisation of logging.
360 --quiet Disable all logging.
361 --brand_dir=s Directory to source brand files from.
362 --site_config=<SITE_CONFIG> WebSite configuration file to use or create.
363 --lang=<LANG> The language the XML will be written in
364 rename
366 Rename a publican book
367 Options:
369 --help Display help message
370 --config=s Use a nonstandard config file
371 --common_config=s Override path to Common_Config directory
372 --common_content=s Override path to Common_Content directory
373 --nocolours Disable ANSI colourisation of logging.
374 --quiet Disable all logging.
375 --brand_dir=s Directory to source brand files from.
376 --name=<NAME> The name of the book, article, set, or brand
377 --product=<PRODUCT> The name of the product
378 --version=<VERSION> The version of the product
379 report
381 Print a readability report for the source text.
382 Options:
384 --help Display help message
385 --config=s Use a nonstandard config file
386 --common_config=s Override path to Common_Config directory
387 --common_content=s Override path to Common_Content directory
388 --nocolours Disable ANSI colourisation of logging.
389 --quiet Disable all logging.
390 --brand_dir=s Directory to source brand files from.
391 site_stats
393 Report on the contents of a WebSite
394 Options:
396 --help Display help message
397 --config=s Use a nonstandard config file
398 --common_config=s Override path to Common_Config directory
399 --common_content=s Override path to Common_Content directory
400 --nocolours Disable ANSI colourisation of logging.
401 --quiet Disable all logging.
402 --brand_dir=s Directory to source brand files from.
403 --site_config=<SITE_CONFIG> WebSite configuration file to use or create.
404 trans_drop
406 Snapshot the source language for use in translation.
407 Options:
409 --help Display help message
410 --config=s Use a nonstandard config file
411 --common_config=s Override path to Common_Config directory
412 --common_content=s Override path to Common_Content directory
413 --nocolours Disable ANSI colourisation of logging.
414 --quiet Disable all logging.
415 --brand_dir=s Directory to source brand files from.
416 update_db
418 Add or remove database entries. Used for processing pre-build
419 books, such as when building packages.
420 Options:
422 --help Display help message
423 --config=s Use a nonstandard config file
424 --common_config=s Override path to Common_Config directory
425 --common_content=s Override path to Common_Content directory
426 --nocolours Disable ANSI colourisation of logging.
427 --quiet Disable all logging.
428 --brand_dir=s Directory to source brand files from.
429 --site_config=<SITE_CONFIG> WebSite configuration file to use or create.
430 --add Add a database entry
431 --del Delete a database entry
432 --lang=<LANG> The language the XML will be written in
433 --product=<PRODUCT> The name of the product
434 --version=<VERSION> The version of the product
435 --name=<NAME> The name of the book, article, set, or brand
436 --formats=<FORMATS> Comma-separated list of formats, for example: html,pdf,html-single,html-desktop,txt,epub
437 --subtitle=<SUBTITLE> Sub title for a book
438 --abstract=<ABSTRACT> Abstract for a book
439 --product_label=<PRODUCT_LABEL> product label for a book
440 --version_label=<VERSION_LABEL> version label for a book
441 --name_label=<NAME_LABEL> name label for a book
442 --sort_order=<SORT_ORDER> Order to sort a book
443 --book_version=<BOOK_VERSION> The version number of the book being installed.
444 --book_src_lang=<BOOK_SRC_LANG> The language this translation is based on.
445 update_po
447 Update the PO files
448 Options:
450 --help Display help message
451 --config=s Use a nonstandard config file
452 --common_config=s Override path to Common_Config directory
453 --common_content=s Override path to Common_Content directory
454 --nocolours Disable ANSI colourisation of logging.
455 --quiet Disable all logging.
456 --brand_dir=s Directory to source brand files from.
457 --langs=<LANGS> Comma-separated list of languages, for example: en-US,de-DE,all
458 --msgmerge Use gettext's msgmerge for POT/PO merging.
459 --firstname=<FIRSTNAME> firstname to use for a revision.
460 --surname=<SURNAME> surname to use for a revision.
461 --email=<EMAIL> email to use for a revision.
462 --previous Keep previous msgid when fuzzy matches are detected in PO updates.
463 update_pot
465 Update the POT files
466 Options:
468 --help Display help message
469 --config=s Use a nonstandard config file
470 --common_config=s Override path to Common_Config directory
471 --common_content=s Override path to Common_Content directory
472 --nocolours Disable ANSI colourisation of logging.
473 --quiet Disable all logging.
474 --brand_dir=s Directory to source brand files from.
475 update_site
477 Update an existing sites templates.
478 Options:
480 --help Display help message
481 --config=s Use a nonstandard config file
482 --common_config=s Override path to Common_Config directory
483 --common_content=s Override path to Common_Content directory
484 --nocolours Disable ANSI colourisation of logging.
485 --quiet Disable all logging.
486 --brand_dir=s Directory to source brand files from.
487 --site_config=<SITE_CONFIG> WebSite configuration file to use or create.
488 zt_pull
490 Pull translations from Zanata.
491 Options:
493 --help Display help message
494 --config=s Use a nonstandard config file
495 --common_config=s Override path to Common_Config directory
496 --common_content=s Override path to Common_Content directory
497 --nocolours Disable ANSI colourisation of logging.
498 --quiet Disable all logging.
499 --brand_dir=s Directory to source brand files from.
500 zt_push
502 Push translations to Zanata.
503 Options:
505 --help Display help message
506 --config=s Use a nonstandard config file
507 --common_config=s Override path to Common_Config directory
508 --common_content=s Override path to Common_Content directory
509 --nocolours Disable ANSI colourisation of logging.
510 --quiet Disable all logging.
511 --brand_dir=s Directory to source brand files from.
512
514 Publican requires access to wkhtmltopdf or Apache FOP for creating PDF
515 files.
516
518 Archive::Tar Archive::Zip Carp Config::Simple Cwd DBI DateTime
519 DateTime::Format::DateParse Devel::Cover Encode File::Basename
520 File::Copy::Recursive File::Find File::Find::Rule File::HomeDir
521 File::Inplace File::Path File::Spec File::Which File::pushd
522 Getopt::Long HTML::FormatText HTML::FormatText::WithLinks
523 HTML::FormatText::WithLinks::AndTables HTML::TreeBuilder
524 I18N::LangTags::List IO::String Lingua::EN::Fathom List::MoreUtils
525 List::Util Locale::Language Locale::Maketext::Gettext
526 Locale::Maketext::Lexicon Locale::Msgfmt Locale::PO Module::Build
527 Pod::Usage Sort::Versions String::Similarity
528 Syntax::Highlight::Engine::Kate Template Template::Constants
529 Term::ANSIColor Test::More Test::Pod Test::Pod::Coverage Text::CSV_XS
530 Text::Wrap Time::localtime XML::LibXML XML::LibXSLT XML::Simple
531 XML::TreeBuilder version
532
534 None reported.
535
537 Bug list at
538 <https://bugzilla.redhat.com/buglist.cgi?product=Publican&query_format=advanced&resolution=--->.
539 Please report any bugs or feature requests to
541 "publican-list@redhat.com", or through the web interface at
542 <https://bugzilla.redhat.com/bugzilla/enter_bug.cgi?product=Publican&component=publican&version=$version>.
543
545 Jeff Fearn "<jfearn@redhat.com>"
546perl v5.34.0 2022-01-21 PUBLICAN(1)