$ sp --help
Usage: [parameter] command
-h, --help Show this help
--autoopen Open the PDF file (MacOS X and Linux only)
--data=NAME Name of the XML data file. Defaults to 'data.xml'. Use '-' for STDIN
--dummy Don't read a data file, use '<data />' as input
-c, --config=NAME Read the config file with the given NAME. Default: 'publisher.cfg'
--[no-]cutmarks Display cutmarks in the document
-x, --extra-dir=DIR Additional directory for file search
--filter=FILTER Run XPROC filter before publishing starts
--grid Display background grid. Disable with --no-grid
--[no-]local Add local directory to the search path. Default is true
--layout=NAME Name of the layout file. Defaults to 'layout.xml'
--jobname=NAME The name of the resulting PDF file (without
extension), default is 'publisher'
--mainlanguage=NAME The document's main language in locale format,
for example 'en' or 'en_US'.
--outputdir=DIR Copy PDF and protocol to this directory
--profile Run publisher with profiling on (internal use)
--runs=NUM Number of publishing runs
--startpage=NUM The first page number
--show-gridallocation Show the allocated grid cells
--systemfonts Use system fonts
--trace Show debug messages and some tracing PDF output
--timeout=SEC Exit after SEC seconds
-v, --var=VAR=VALUE Set a variable for the publishing run
--verbose Print a bit of debugging output
--version Show version information
--wd=DIR Change working directory
--xml Output as (pseudo-)XML (for list-fonts)
Commands
clean Remove publisher generated files
compare Compare files for quality assurance
doc Open documentation
list-fonts List installed fonts (use together with --xml
for copy/paste)
run Start publishing (default)
watch Start watchdog / hotfolder
Parameter | Description |
---|---|
--autoopen |
Opens the PDF file after running the publisher. Can also be set in the configuration file. |
--data=NAME |
Name of the data XML file. Default is data.xml . Can be set in theconfiguration file. If the file name is a dash(- ), the speedata publisher reads the XML data from standard input(STDIN). |
--cutmarks |
Show cut marks. Can be also configured in the Layout. |
--dummy |
Only read the layout rules. A simple data file is assumed which only contains one element: <data /> . This is for quick testing of layout files. |
-x , --extra-dir |
Puts the given directory into the search path. All assets (images,fonts, XML data and layout rules) must be found in the seach path,which will be traversed recursively. This parameter can be given multiple times and preset in the configurationfile. |
--filter=FILTER |
Run the given XPROC file. |
--grid |
Show the grid. Can be turned off with --no-grid . Can be configured in the layout XML file: Layout. |
--layout=NAME |
Name of the layout XML file. Default is layout.xml . Can beconfigured. |
--[no-]local |
The current directory is (not) added to the search path recursively.The default is --local which means that the current directory and all its subdirectories is added to the search path. This allows you to run the publisher in any directory and put your assets in a subdirectory. |
--jobname=NAME |
The name of the output file. Default is publisher . The extension(.pdf ) is added automatically. |
--mainlanguage=NAME |
Set the main language for the document (hyphenation). Allowed values are: af , as , bg , ca , cs , cy , da , de , el , en ,en_GB , en_US , eo , es , et , eu , fi , fr , ga , gl ,gu , hi , hr , hu , hy , ia , id , is , it , ku , kn ,la , lo , lt , ml , lv , ml , mn , mr , nb , nl , nn ,or , pa , pl , pt , ro , ru , sa , sk , sl , sr , sv ,ta , te , tk , tr , uk und zh . See also the language codelist. |
--outputdir=DIR |
Name of the directory of the resulting file. The directory will be created if necessary. |
--runs=NUM |
The number of passes. Normally the publisher will process a file only once, but more passes can be necessary if intermediate files are created for generating a table of contents or other document dependent data. |
--show-gridallocation |
Show the allocated grid cells in yellowish color and double allocated grid cells in red. |
--startpage=NUM |
The number of the first page. |
--systemfonts |
Also use system fonts. Does not work on Windows XP. |
--timeout=SEC |
Exit after SEC seconds with exit status 1. |
-v , --var=value |
Passes additional variables to the publisher run. The variables can be accessed as usual with select="$variable" . |
--verbose |
More information than necessary. |
--wd=DIR |
Change working directory. Exactly the same as if you’d cd into that directory before running sp . |
--xml |
The output of some commands (currently only list-fonts ) will be printed in (pseudo) XML. That way the output can be re-used in the layout XML. |
Command | Description |
---|---|
list-fonts |
Lists all fonts that are found in the search path. Together with --xml the output format can re used in the layout XML. |
compare |
Recursively check a directory for layout changes. See the topicabout quality assurance. |
clean |
Remove temporary files from the publisher run. Keeps the PDF file. |
doc |
Opens the HTML documentation. |
run |
Starts the speedata publisher (this is the default command). |
watch |
Runs in internal hotfolder mode. |
[hotfolder]
hotfolder = /home/speedata/hotfolder
events = layout\.xml:run(runpublisher);data\.xml:run(runpublisher)
Parameter | Description |
---|---|
hotfolder |
Directory to be watched. |
events |
Entries (separated by a semicolon) in the form pattern:command .The pattern is a regular expression. If this pattern matches a file, the command given in the configuration is executed. Currently only external programs can be run. These programs must be given in parentheses. The path to the file will be passed as the first argument. The hotfolder waits until the program is finished and removes the file afterwards. |