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 build Transform XML to other formats (pdf, html, html-single, etc)
26 bump TECH PREVIEW: bump the pubsnumber [revision]. This feature is intended to have an additional argument to add a revision history entry and message. This feature is UNTESTED
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 old2new Create a publican.cfg file from the Makefile of an old book, set, or article
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 remove_book Remove a book from a WebSite.
44 rename Rename a publican book
45 site_stats Report on the contents of a WebSite
46 update_db Add or remove database entries. Used for processing pre-build books, such as when building packages.
47 update_po Update the PO files
48 update_pot Update the POT files
49 update_site Update an existing sites templates.
50 Run: 'publican <action> --help' for details on action usage
52
54 Publican is a DocBook publication system, not just a DocBook processing
55 tool. As well as ensuring your DocBook XML is valid, publican works to
56 ensure your XML is up to publishable standard.
57
59 build
60 Transform XML to other formats (pdf, html, html-single, etc)
61 Options:
63 --help Display help message
64 --config=s Use a nonstandard config file
65 --common_config=s Override path to Common_Config directory
66 --common_content=s Override path to Common_Content directory
67 --nocolours Disable ANSI colourisation of logging.
68 --quiet Disable all logging.
69 --formats=<FORMATS> Comma-separated list of formats, for example: html,pdf,html-single,html-desktop,txt,epub
70 --langs=<LANGS> Comma-separated list of languages, for example: en-US,de-DE,all
71 --publish Set up built content for publishing
72 --embedtoc Embed the web site TOC object in the generated HTML
73 --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.
74 --novalid Do not run the DTD validation
75 bump
77 TECH PREVIEW: bump the pubsnumber [revision]. This feature is
78 intended to have an additional argument to add a revision history entry
79 and message. This feature is UNTESTED
80 Options:
82 --help Display help message
83 --config=s Use a nonstandard config file
84 --common_config=s Override path to Common_Config directory
85 --common_content=s Override path to Common_Content directory
86 --nocolours Disable ANSI colourisation of logging.
87 --quiet Disable all logging.
88 --lang=<LANG> The language the XML will be written in
89 clean
91 Remove all temporary files and directories
92 Options:
94 --help Display help message
95 --config=s Use a nonstandard config file
96 --common_config=s Override path to Common_Config directory
97 --common_content=s Override path to Common_Content directory
98 --nocolours Disable ANSI colourisation of logging.
99 --quiet Disable all logging.
100 clean_ids
102 Run clean ids for source XML
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 clean_set
113 Remove local copies of remote set books
114 Options:
116 --help Display help message
117 --config=s Use a nonstandard config file
118 --common_config=s Override path to Common_Config directory
119 --common_content=s Override path to Common_Content directory
120 --nocolours Disable ANSI colourisation of logging.
121 --quiet Disable all logging.
122 create
124 Create a new book, set, or article
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 --version=<VERSION> The version of the product
135 --edition=<EDITION> The edition of the book, article, or set
136 --product=<PRODUCT> The name of the product
137 --brand=<BRAND> The brand to use
138 --lang=<LANG> The language the XML will be written in
139 --type=<TYPE> The type (book, article, or set)
140 create_brand
142 Create a new brand
143 Options:
145 --help Display help message
146 --config=s Use a nonstandard config file
147 --common_config=s Override path to Common_Config directory
148 --common_content=s Override path to Common_Content directory
149 --nocolours Disable ANSI colourisation of logging.
150 --quiet Disable all logging.
151 --name=<NAME> The name of the book, article, set, or brand
152 --lang=<LANG> The language the XML will be written in
153 create_site
155 Create a new WebSite in the supplied location.
156 Options:
158 --help Display help message
159 --config=s Use a nonstandard config file
160 --common_config=s Override path to Common_Config directory
161 --common_content=s Override path to Common_Content directory
162 --nocolours Disable ANSI colourisation of logging.
163 --quiet Disable all logging.
164 --site_config=<SITE_CONFIG> WebSite configuration file to use or create.
165 --db_file=<DB_FILE> Override default database file.
166 --toc_path=<TOC_PATH> Override the default TOC path.
167 --tmpl_path=<TMPL_PATH> Override the default template path.
168 --lang=<LANG> The language the XML will be written in
169 help_config
171 Display help text for the configuration file
172 Options:
174 --help Display help message
175 --config=s Use a nonstandard config file
176 --common_config=s Override path to Common_Config directory
177 --common_content=s Override path to Common_Content directory
178 --nocolours Disable ANSI colourisation of logging.
179 --quiet Disable all logging.
180 install_book
182 Install a book in to a WebSite.
183 Options:
185 --help Display help message
186 --config=s Use a nonstandard config file
187 --common_config=s Override path to Common_Config directory
188 --common_content=s Override path to Common_Content directory
189 --nocolours Disable ANSI colourisation of logging.
190 --quiet Disable all logging.
191 --site_config=<SITE_CONFIG> WebSite configuration file to use or create.
192 --lang=<LANG> The language the XML will be written in
193 install_brand
195 Install a brand to the supplied location
196 Options:
198 --help Display help message
199 --config=s Use a nonstandard config file
200 --common_config=s Override path to Common_Config directory
201 --common_content=s Override path to Common_Content directory
202 --nocolours Disable ANSI colourisation of logging.
203 --quiet Disable all logging.
204 --path=<PATH> /path/to/install/to
205 lang_stats
207 report PO statistics
208 Options:
210 --help Display help message
211 --config=s Use a nonstandard config file
212 --common_config=s Override path to Common_Config directory
213 --common_content=s Override path to Common_Content directory
214 --nocolours Disable ANSI colourisation of logging.
215 --quiet Disable all logging.
216 --lang=<LANG> The language the XML will be written in
217 old2new
219 Create a publican.cfg file from the Makefile of an old book, set,
220 or article
221 Options:
223 --help Display help message
224 --config=s Use a nonstandard config file
225 --common_config=s Override path to Common_Config directory
226 --common_content=s Override path to Common_Content directory
227 --nocolours Disable ANSI colourisation of logging.
228 --quiet Disable all logging.
229 package
231 Package a language for shipping
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 --lang=<LANG> The language the XML will be written in
241 --desktop Create desktop instead of web package
242 --brew Push SRPM to brew
243 --scratch Use scratch instead of tag build
244 --short_sighted Create package without using version in package name
245 --binary Build binary rpm when running package
246 --wait Wait for brew to finish building
247 --cvs Import the SRPM in to CVS, the run make tag and make build.
248 print_banned
250 Print a list of banned DocBook tags
251 Options:
253 --help Display help message
254 --config=s Use a nonstandard config file
255 --common_config=s Override path to Common_Config directory
256 --common_content=s Override path to Common_Content directory
257 --nocolours Disable ANSI colourisation of logging.
258 --quiet Disable all logging.
259 print_known
261 Print a list of QA'd DocBook tags
262 Options:
264 --help Display help message
265 --config=s Use a nonstandard config file
266 --common_config=s Override path to Common_Config directory
267 --common_content=s Override path to Common_Content directory
268 --nocolours Disable ANSI colourisation of logging.
269 --quiet Disable all logging.
270 print_tree
272 Print a tree of the xi:includes
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 print_unused
283 Print a list of unused XML files
284 Options:
286 --help Display help message
287 --config=s Use a nonstandard config file
288 --common_config=s Override path to Common_Config directory
289 --common_content=s Override path to Common_Content directory
290 --nocolours Disable ANSI colourisation of logging.
291 --quiet Disable all logging.
292 remove_book
294 Remove a book from a WebSite.
295 Options:
297 --help Display help message
298 --config=s Use a nonstandard config file
299 --common_config=s Override path to Common_Config directory
300 --common_content=s Override path to Common_Content directory
301 --nocolours Disable ANSI colourisation of logging.
302 --quiet Disable all logging.
303 --site_config=<SITE_CONFIG> WebSite configuration file to use or create.
304 --lang=<LANG> The language the XML will be written in
305 rename
307 Rename a publican book
308 Options:
310 --help Display help message
311 --config=s Use a nonstandard config file
312 --common_config=s Override path to Common_Config directory
313 --common_content=s Override path to Common_Content directory
314 --nocolours Disable ANSI colourisation of logging.
315 --quiet Disable all logging.
316 --name=<NAME> The name of the book, article, set, or brand
317 --product=<PRODUCT> The name of the product
318 --version=<VERSION> The version of the product
319 site_stats
321 Report on the contents of a WebSite
322 Options:
324 --help Display help message
325 --config=s Use a nonstandard config file
326 --common_config=s Override path to Common_Config directory
327 --common_content=s Override path to Common_Content directory
328 --nocolours Disable ANSI colourisation of logging.
329 --quiet Disable all logging.
330 --site_config=<SITE_CONFIG> WebSite configuration file to use or create.
331 update_db
333 Add or remove database entries. Used for processing pre-build
334 books, such as when building packages.
335 Options:
337 --help Display help message
338 --config=s Use a nonstandard config file
339 --common_config=s Override path to Common_Config directory
340 --common_content=s Override path to Common_Content directory
341 --nocolours Disable ANSI colourisation of logging.
342 --quiet Disable all logging.
343 --site_config=<SITE_CONFIG> WebSite configuration file to use or create.
344 --add Add a database entry
345 --del Delete a database entry
346 --lang=<LANG> The language the XML will be written in
347 --product=<PRODUCT> The name of the product
348 --version=<VERSION> The version of the product
349 --name=<NAME> The name of the book, article, set, or brand
350 --formats=<FORMATS> Comma-separated list of formats, for example: html,pdf,html-single,html-desktop,txt,epub
351 --subtitle=<SUBTITLE> Sub title for a book
352 --abstract=<ABSTRACT> Abstract for a book
353 --product_label=<PRODUCT_LABEL> product label for a book
354 --version_label=<VERSION_LABEL> version label for a book
355 --name_label=<NAME_LABEL> name label for a book
356 update_po
358 Update the PO files
359 Options:
361 --help Display help message
362 --config=s Use a nonstandard config file
363 --common_config=s Override path to Common_Config directory
364 --common_content=s Override path to Common_Content directory
365 --nocolours Disable ANSI colourisation of logging.
366 --quiet Disable all logging.
367 --langs=<LANGS> Comma-separated list of languages, for example: en-US,de-DE,all
368 update_pot
370 Update the POT files
371 Options:
373 --help Display help message
374 --config=s Use a nonstandard config file
375 --common_config=s Override path to Common_Config directory
376 --common_content=s Override path to Common_Content directory
377 --nocolours Disable ANSI colourisation of logging.
378 --quiet Disable all logging.
379 update_site
381 Update an existing sites templates.
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 --site_config=<SITE_CONFIG> WebSite configuration file to use or create.
391
393 Publican requires access to GetText msgmerge for merging updated POT
394 files with PO files.
395 Publican requires access to Apache FOP for creating PDF files.
397
399 Archive::Tar Carp Config::Simple Cwd DateTime
400 DateTime::Format::DateParse Encode File::Copy::Recursive File::Find
401 File::Find::Rule File::Path File::pushd File::Spec Getopt::Long
402 HTML::FormatText HTML::TreeBuilder I18N::LangTags::List Image::Magick
403 Image::Size Locale::PO Makefile::Parser Module::Build Pod::Usage
404 Publican Publican::Builder Publican::CreateBook Publican::CreateBrand
405 Publican::Localise Publican::Translate Publican::TreeView
406 Publican::XmlClean Syntax::Highlight::Engine::Kate Term::ANSIColor
407 Test::More Text::Wrap XML::LibXML XML::LibXSLT XML::TreeBuilder
408
410 None reported.
411
413 No bugs have been reported.
414 Please report any bugs or feature requests to
416 "publican-list@redhat.com", or through the web interface at
417 <https://bugzilla.redhat.com/bugzilla/enter_bug.cgi?product=Publican&component=publican>.
418
420 Jeff Fearn "<jfearn@redhat.com>"
421perl v5.12.4 2011-09-22 PUBLICAN(1)