.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .ie \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} .el \{\ . de IX .. .\} .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "PUBLICAN 1p" .TH PUBLICAN 1p "2012-06-18" "perl v5.14.2" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" publican \- a DocBook XML publishing tool. .SH "VERSION" .IX Header "VERSION" This document describes publican version 1.0 .SH "SYNOPSIS" .IX Header "SYNOPSIS" publican .PP publican .PP Command Options .PP .Vb 4 \& \-\-help Display help message \& \-\-man Display the man page \& \-\-help_actions Display a list of valid actions \& \-v Display the version of Publican .Ve .PP Valid actions are: .PP .Vb 10 \& build Transform XML to other formats (pdf, html, html\-single, etc) \& 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 \& clean Remove all temporary files and directories \& clean_ids Run clean ids for source XML \& clean_set Remove local copies of remote set books \& create Create a new book, set, or article \& create_brand Create a new brand \& create_site Create a new WebSite in the supplied location. \& help_config Display help text for the configuration file \& install_book Install a book in to a WebSite. \& install_brand Install a brand to the supplied location \& lang_stats report PO statistics \& old2new Create a publican.cfg file from the Makefile of an old book, set, or article \& package Package a language for shipping \& print_banned Print a list of banned DocBook tags \& print_known Print a list of QA\*(Aqd DocBook tags \& print_tree Print a tree of the xi:includes \& print_unused Print a list of unused XML files \& remove_book Remove a book from a WebSite. \& rename Rename a publican book \& site_stats Report on the contents of a WebSite \& update_db Add or remove database entries. Used for processing pre\-build books, such as when building packages. \& update_po Update the PO files \& update_pot Update the POT files \& update_site Update an existing sites templates. .Ve .PP Run: 'publican \-\-help' for details on action usage .SH "DESCRIPTION" .IX Header "DESCRIPTION" Publican is a DocBook publication system, not just a DocBook processing tool. As well as ensuring your DocBook \s-1XML\s0 is valid, publican works to ensure your \s-1XML\s0 is up to publishable standard. .SH "INTERFACE" .IX Header "INTERFACE" build Transform \s-1XML\s0 to other formats (pdf, html, html-single, etc) .PP .Vb 10 \& Options: \& \-\-help Display help message \& \-\-config=s Use a nonstandard config file \& \-\-common_config=s Override path to Common_Config directory \& \-\-common_content=s Override path to Common_Content directory \& \-\-nocolours Disable ANSI colourisation of logging. \& \-\-quiet Disable all logging. \& \-\-formats= Comma\-separated list of formats, for example: html,pdf,html\-single,html\-desktop,txt,epub \& \-\-langs= Comma\-separated list of languages, for example: en\-US,de\-DE,all \& \-\-publish Set up built content for publishing \& \-\-embedtoc Embed the web site TOC object in the generated HTML \& \-\-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. \& \-\-novalid Do not run the DTD validation .Ve .PP bump \s-1TECH\s0 \s-1PREVIEW:\s0 bump the pubsnumber [revision]. This feature is intended to have an additional argument to add a revision history entry and message. This feature is \s-1UNTESTED\s0 .PP .Vb 8 \& Options: \& \-\-help Display help message \& \-\-config=s Use a nonstandard config file \& \-\-common_config=s Override path to Common_Config directory \& \-\-common_content=s Override path to Common_Content directory \& \-\-nocolours Disable ANSI colourisation of logging. \& \-\-quiet Disable all logging. \& \-\-lang= The language the XML will be written in .Ve .PP clean Remove all temporary files and directories .PP .Vb 7 \& Options: \& \-\-help Display help message \& \-\-config=s Use a nonstandard config file \& \-\-common_config=s Override path to Common_Config directory \& \-\-common_content=s Override path to Common_Content directory \& \-\-nocolours Disable ANSI colourisation of logging. \& \-\-quiet Disable all logging. .Ve .PP clean_ids Run clean ids for source \s-1XML\s0 .PP .Vb 7 \& Options: \& \-\-help Display help message \& \-\-config=s Use a nonstandard config file \& \-\-common_config=s Override path to Common_Config directory \& \-\-common_content=s Override path to Common_Content directory \& \-\-nocolours Disable ANSI colourisation of logging. \& \-\-quiet Disable all logging. .Ve .PP clean_set Remove local copies of remote set books .PP .Vb 7 \& Options: \& \-\-help Display help message \& \-\-config=s Use a nonstandard config file \& \-\-common_config=s Override path to Common_Config directory \& \-\-common_content=s Override path to Common_Content directory \& \-\-nocolours Disable ANSI colourisation of logging. \& \-\-quiet Disable all logging. .Ve .PP create Create a new book, set, or article .PP .Vb 10 \& Options: \& \-\-help Display help message \& \-\-config=s Use a nonstandard config file \& \-\-common_config=s Override path to Common_Config directory \& \-\-common_content=s Override path to Common_Content directory \& \-\-nocolours Disable ANSI colourisation of logging. \& \-\-quiet Disable all logging. \& \-\-name= The name of the book, article, set, or brand \& \-\-version= The version of the product \& \-\-edition= The edition of the book, article, or set \& \-\-product= The name of the product \& \-\-brand= The brand to use \& \-\-lang= The language the XML will be written in \& \-\-type= The type (book, article, or set) .Ve .PP create_brand Create a new brand .PP .Vb 9 \& Options: \& \-\-help Display help message \& \-\-config=s Use a nonstandard config file \& \-\-common_config=s Override path to Common_Config directory \& \-\-common_content=s Override path to Common_Content directory \& \-\-nocolours Disable ANSI colourisation of logging. \& \-\-quiet Disable all logging. \& \-\-name= The name of the book, article, set, or brand \& \-\-lang= The language the XML will be written in .Ve .PP create_site Create a new WebSite in the supplied location. .PP .Vb 12 \& Options: \& \-\-help Display help message \& \-\-config=s Use a nonstandard config file \& \-\-common_config=s Override path to Common_Config directory \& \-\-common_content=s Override path to Common_Content directory \& \-\-nocolours Disable ANSI colourisation of logging. \& \-\-quiet Disable all logging. \& \-\-site_config= WebSite configuration file to use or create. \& \-\-db_file= Override default database file. \& \-\-toc_path= Override the default TOC path. \& \-\-tmpl_path= Override the default template path. \& \-\-lang= The language the XML will be written in .Ve .PP help_config Display help text for the configuration file .PP .Vb 7 \& Options: \& \-\-help Display help message \& \-\-config=s Use a nonstandard config file \& \-\-common_config=s Override path to Common_Config directory \& \-\-common_content=s Override path to Common_Content directory \& \-\-nocolours Disable ANSI colourisation of logging. \& \-\-quiet Disable all logging. .Ve .PP install_book Install a book in to a WebSite. .PP .Vb 9 \& Options: \& \-\-help Display help message \& \-\-config=s Use a nonstandard config file \& \-\-common_config=s Override path to Common_Config directory \& \-\-common_content=s Override path to Common_Content directory \& \-\-nocolours Disable ANSI colourisation of logging. \& \-\-quiet Disable all logging. \& \-\-site_config= WebSite configuration file to use or create. \& \-\-lang= The language the XML will be written in .Ve .PP install_brand Install a brand to the supplied location .PP .Vb 8 \& Options: \& \-\-help Display help message \& \-\-config=s Use a nonstandard config file \& \-\-common_config=s Override path to Common_Config directory \& \-\-common_content=s Override path to Common_Content directory \& \-\-nocolours Disable ANSI colourisation of logging. \& \-\-quiet Disable all logging. \& \-\-path= /path/to/install/to .Ve .PP lang_stats report \s-1PO\s0 statistics .PP .Vb 8 \& Options: \& \-\-help Display help message \& \-\-config=s Use a nonstandard config file \& \-\-common_config=s Override path to Common_Config directory \& \-\-common_content=s Override path to Common_Content directory \& \-\-nocolours Disable ANSI colourisation of logging. \& \-\-quiet Disable all logging. \& \-\-lang= The language the XML will be written in .Ve .PP old2new Create a publican.cfg file from the Makefile of an old book, set, or article .PP .Vb 7 \& Options: \& \-\-help Display help message \& \-\-config=s Use a nonstandard config file \& \-\-common_config=s Override path to Common_Config directory \& \-\-common_content=s Override path to Common_Content directory \& \-\-nocolours Disable ANSI colourisation of logging. \& \-\-quiet Disable all logging. .Ve .PP package Package a language for shipping .PP .Vb 10 \& Options: \& \-\-help Display help message \& \-\-config=s Use a nonstandard config file \& \-\-common_config=s Override path to Common_Config directory \& \-\-common_content=s Override path to Common_Content directory \& \-\-nocolours Disable ANSI colourisation of logging. \& \-\-quiet Disable all logging. \& \-\-lang= The language the XML will be written in \& \-\-desktop Create desktop instead of web package \& \-\-brew Push SRPM to brew \& \-\-scratch Use scratch instead of tag build \& \-\-short_sighted Create package without using version in package name \& \-\-binary Build binary rpm when running package \& \-\-wait Wait for brew to finish building \& \-\-cvs Import the SRPM in to CVS, the run make tag and make build. .Ve .PP print_banned Print a list of banned DocBook tags .PP .Vb 7 \& Options: \& \-\-help Display help message \& \-\-config=s Use a nonstandard config file \& \-\-common_config=s Override path to Common_Config directory \& \-\-common_content=s Override path to Common_Content directory \& \-\-nocolours Disable ANSI colourisation of logging. \& \-\-quiet Disable all logging. .Ve .PP print_known Print a list of \s-1QA\s0'd DocBook tags .PP .Vb 7 \& Options: \& \-\-help Display help message \& \-\-config=s Use a nonstandard config file \& \-\-common_config=s Override path to Common_Config directory \& \-\-common_content=s Override path to Common_Content directory \& \-\-nocolours Disable ANSI colourisation of logging. \& \-\-quiet Disable all logging. .Ve .PP print_tree Print a tree of the xi:includes .PP .Vb 7 \& Options: \& \-\-help Display help message \& \-\-config=s Use a nonstandard config file \& \-\-common_config=s Override path to Common_Config directory \& \-\-common_content=s Override path to Common_Content directory \& \-\-nocolours Disable ANSI colourisation of logging. \& \-\-quiet Disable all logging. .Ve .PP print_unused Print a list of unused \s-1XML\s0 files .PP .Vb 7 \& Options: \& \-\-help Display help message \& \-\-config=s Use a nonstandard config file \& \-\-common_config=s Override path to Common_Config directory \& \-\-common_content=s Override path to Common_Content directory \& \-\-nocolours Disable ANSI colourisation of logging. \& \-\-quiet Disable all logging. .Ve .PP remove_book Remove a book from a WebSite. .PP .Vb 9 \& Options: \& \-\-help Display help message \& \-\-config=s Use a nonstandard config file \& \-\-common_config=s Override path to Common_Config directory \& \-\-common_content=s Override path to Common_Content directory \& \-\-nocolours Disable ANSI colourisation of logging. \& \-\-quiet Disable all logging. \& \-\-site_config= WebSite configuration file to use or create. \& \-\-lang= The language the XML will be written in .Ve .PP rename Rename a publican book .PP .Vb 10 \& Options: \& \-\-help Display help message \& \-\-config=s Use a nonstandard config file \& \-\-common_config=s Override path to Common_Config directory \& \-\-common_content=s Override path to Common_Content directory \& \-\-nocolours Disable ANSI colourisation of logging. \& \-\-quiet Disable all logging. \& \-\-name= The name of the book, article, set, or brand \& \-\-product= The name of the product \& \-\-version= The version of the product .Ve .PP site_stats Report on the contents of a WebSite .PP .Vb 8 \& Options: \& \-\-help Display help message \& \-\-config=s Use a nonstandard config file \& \-\-common_config=s Override path to Common_Config directory \& \-\-common_content=s Override path to Common_Content directory \& \-\-nocolours Disable ANSI colourisation of logging. \& \-\-quiet Disable all logging. \& \-\-site_config= WebSite configuration file to use or create. .Ve .PP update_db Add or remove database entries. Used for processing pre-build books, such as when building packages. .PP .Vb 10 \& Options: \& \-\-help Display help message \& \-\-config=s Use a nonstandard config file \& \-\-common_config=s Override path to Common_Config directory \& \-\-common_content=s Override path to Common_Content directory \& \-\-nocolours Disable ANSI colourisation of logging. \& \-\-quiet Disable all logging. \& \-\-site_config= WebSite configuration file to use or create. \& \-\-add Add a database entry \& \-\-del Delete a database entry \& \-\-lang= The language the XML will be written in \& \-\-product= The name of the product \& \-\-version= The version of the product \& \-\-name= The name of the book, article, set, or brand \& \-\-formats= Comma\-separated list of formats, for example: html,pdf,html\-single,html\-desktop,txt,epub \& \-\-subtitle= Sub title for a book \& \-\-abstract= Abstract for a book \& \-\-product_label= product label for a book \& \-\-version_label= version label for a book \& \-\-name_label= name label for a book .Ve .PP update_po Update the \s-1PO\s0 files .PP .Vb 8 \& Options: \& \-\-help Display help message \& \-\-config=s Use a nonstandard config file \& \-\-common_config=s Override path to Common_Config directory \& \-\-common_content=s Override path to Common_Content directory \& \-\-nocolours Disable ANSI colourisation of logging. \& \-\-quiet Disable all logging. \& \-\-langs= Comma\-separated list of languages, for example: en\-US,de\-DE,all .Ve .PP update_pot Update the \s-1POT\s0 files .PP .Vb 7 \& Options: \& \-\-help Display help message \& \-\-config=s Use a nonstandard config file \& \-\-common_config=s Override path to Common_Config directory \& \-\-common_content=s Override path to Common_Content directory \& \-\-nocolours Disable ANSI colourisation of logging. \& \-\-quiet Disable all logging. .Ve .PP update_site Update an existing sites templates. .PP .Vb 8 \& Options: \& \-\-help Display help message \& \-\-config=s Use a nonstandard config file \& \-\-common_config=s Override path to Common_Config directory \& \-\-common_content=s Override path to Common_Content directory \& \-\-nocolours Disable ANSI colourisation of logging. \& \-\-quiet Disable all logging. \& \-\-site_config= WebSite configuration file to use or create. .Ve .SH "CONFIGURATION AND ENVIRONMENT" .IX Header "CONFIGURATION AND ENVIRONMENT" Publican requires access to GetText msgmerge for merging updated \s-1POT\s0 files with \s-1PO\s0 files. .PP Publican requires access to Apache \s-1FOP\s0 for creating \s-1PDF\s0 files. .SH "DEPENDENCIES" .IX Header "DEPENDENCIES" Archive::Tar Carp Config::Simple Cwd DateTime DateTime::Format::DateParse Encode File::Copy::Recursive File::Find File::Find::Rule File::Path File::pushd File::Spec Getopt::Long HTML::FormatText HTML::TreeBuilder I18N::LangTags::List Image::Magick Image::Size Locale::PO Makefile::Parser Module::Build Pod::Usage Publican Publican::Builder Publican::CreateBook Publican::CreateBrand Publican::Localise Publican::Translate Publican::TreeView Publican::XmlClean Syntax::Highlight::Engine::Kate Term::ANSIColor Test::More Text::Wrap XML::LibXML XML::LibXSLT XML::TreeBuilder .SH "INCOMPATIBILITIES" .IX Header "INCOMPATIBILITIES" None reported. .SH "BUGS AND LIMITATIONS" .IX Header "BUGS AND LIMITATIONS" No bugs have been reported. .PP Please report any bugs or feature requests to \&\f(CW\*(C`publican\-list@redhat.com\*(C'\fR, or through the web interface at . .SH "AUTHOR" .IX Header "AUTHOR" Jeff Fearn \f(CW\*(C`\*(C'\fR