'\" t
.\" $Id: plucker-build.1,v 1.22 2002/10/16 01:57:57 janssen Exp $
.\"
.\" man page for plucker-build -- an HTML-to-Plucker converter
.\" Copyright 2002 (c) Bill Janssen, <bill@janssen.org>
.\" 
.\" This man page is free software; you can redistribute it and/or
.\" modify it under the terms of the GNU General Public License
.\" as published by the Free Software Foundation; either version 2
.\" of the License, or (at your option) any later version.
.\" 
.\" This man page is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
.\" GNU General Public License for more details.
.\"
.\" You should have received a copy of the GNU General Public License
.\" along with this man page; if not, write to the Free Software
.\" Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
.\"
.\" plucker-build.1
.TH PLUCKER-BUILD 1 "Plucker 1.2 - http://plkr.org/"
.SH NAME
plucker-build \- generate a document (e-book) in Plucker format
.SH SYNOPSIS
\fBplucker-build\fR
[--alt-maxheight=\fIpixel-height\fR]
[--alt-maxwidth=\fIpixel-width\fR]
[--author=\fIstring\fR]
[--backup]
[--beamable]
[--bpp=\fIimage-depth\fR]
[--category=\fIdefault-category-name\fR]
[--charset=\fIcharset-indicator\fR]
[--compression=\fIcompression-type\fR]
[--depth-first]
[--doc-file=\fIname-prefix\fR]
[--doc-name=\fIdocument-name\fR]
[--doc-compression]
[--exclusion-list=\fIfilename\fR]
[--extra-section=\fIsection-name\fR]
[--help]
[--home-url=\fIbase-URL\fR]
[--icon=\fIimage-filename\fR]
[--launchable]
[--maxdepth=\fIdepth\fR]
[--maxheight=\fIpixel-height\fR]
[--maxwidth=\fIpixel-width\fR]
[--no-backup]
[--noimages]
[--not-beamable]
[--not-launchable]
[--no-urlinfo]
[--owner-id=\fIname\fR]
[--pluckerdir=\fIoutput-directory\fR]
[--pluckerhome=\fIplucker-home-directory\fR]
[--quiet]
[--referrer=\fIstring\fR]
[--status-file=\fIfilename\fR]
[--staybelow=\fIurl-prefix\fR]
[--stayonhost]
[--title=\fIstring\fR]
[--update-cache]
[--url-pattern=\fIpattern\fR]
[--user-agent=\fIstring\fR]
[--verbosity=\fIverbosity-level\fR]
[--zlib-compression]
[HOME-URL]
.SH DESCRIPTION
.B plucker-build
creates a Plucker binary document, which is a kind of e-book, from a URL.  This document is formatted for the Plucker viewer program, which currently runs on Palm devices.  The normal mode of operation is to take a \fIhome URL\fR and 'pluck' it to produce a Plucker document, either to stdout, or to a file if \fI--doc-file\fR is specified.  Alternatively, specifying the option \fI--update-cache\fR will update a cache of Plucker records (though it's not clear what this is good for).  The Plucker document format is specified at \fChttp://www.plkr.org/index.pl/cvs/docs/DBFormat.html?rev=HEAD\fR.
.SH OPTIONS
Many options are also available as parameters in the configuration file \fC$HOME/.pluckerrc\fR, or in the default configuration file.  Where applicable, the name of the configuration file parameter is shown after the documentation on the option.  An option given on the command line will override any configuration file parameter.  For more on configuration files, see below.
.TP
\fB--alt-maxheight=\fIpixel-height\fR
Specifies the maximum height, in pixels, of the \fIalternate rendition\fR of an image.  (When inline images are too large to be included full-size, they are converted into smaller versions, with sizes governed by the MAXHEIGHT and MAXWIDTH parameters, and are linked to larger renditions of the images, called the \fIalternate rendition\fR.)  [\fCalt_maxheight\fR]
.TP
\fB--alt-maxwidth=\fIpixel-width\fR
Specifies the maximum width, in pixels, of the \fIalternate rendition\fR of an image.  (When inline images are too large to be included full-size, they are converted into smaller versions, with sizes governed by the MAXHEIGHT and MAXWIDTH parameters, and are linked to larger renditions of the images, called the \fIalternate rendition\fR.)  [\fCalt_maxwidth\fR]
.TP
\fB--author=\fIstring\fR
Sets the author of the document to \fIstring\fR, which is assumed to be in the charset of the document (see \fB--charset\fR), or ASCII if no charset is specified.  [\fCauthor_md\fR]
.TP
\fB--backup\fR
Sets the bit in the output file that causes the document to be backed up on Palm HotSync.  By default, the document is backed up.  [\fCbackup_bit\fR]
.TP
\fB--beamable\fR
Sets the bit in the output file that allows the document to be beamed.  By default, the document is beamable.  [\fCcopyprevention_bit\fR]
.TP
\fB--bpp=\fIimage-depth\fR
Specifies the number of bits-per-pixel to be used for images.  Valid values as of Plucker 1.1 are 0, 1 (the default), 2, 4, or 8.  If 0 is specified, no images will be included in the document.  See also \fB--noimages\fR.  [\fCbpp\fR]
.TP
\fB--category=\fIdefault-category-name\fR
Specifies a default Plucker category or categories to include in the document.  If more than one category is specified, the category names should be separated by semicolons.  [\fCcategory\fR]
.TP
\fB--charset=\fIcharset-indicator\fR
Specifies the default character set encoding used in the text of the documents being plucked.  \fIcharset-indicator\fR is either a charset name (from a small list; see \fCsrc/parser/python/PyPlucker/__init__.py.in\fR for a list of valid names), or a decimal integer indicating the charset's MIBenum value, as shown in the table at \fChttp://www.iana.org/assignments/character-sets\fR.  [\fCdefault_charset\fR]
.TP
\fB--compression=\fIcompression-type\fR
Specifies the type of compression to use in the document.  There are two possible values for \fIcompression-type\fR:  \fCdoc\fR or \fCzlib\fR.  The default is \fCdoc\fR, which is the same compression system used in Palm DOC-format documents.  \fCzlib\fR compression usually results in smaller documents.  See also \fB--zlib-compression\fR and \fB--doc-compression\fR.  [\fCcompression\fR]
.TP
\fB--depth-first\fR
Specifies a depth-first traversal of the web graph, rather than the default breadth-first traversal.  This often works better on bushy acyclic graph structures than the breadth-first traversal.  [\fCdepth_first\fR]
.TP
\fB--doc-file=\fIname-prefix\fR (or \fB-f \fIname-prefix\fR)
also as \fB-f \fIname-prefix\fR.  Specifies the name of the document output file, without the directory (specified with --pluckerdir) or extension (always .pdb).  If not specified, and if stdout is not a tty, the document will be written to stdout.  [\fCdoc_file\fR]
.TP
\fB--doc-name=\fIdocument-name\fR (or \fB-N \fIdocument-name\fR)
Specifies the short name by which the document will be identified in the viewer.  Defaults to value of \fI--doc-file\fR.  If \fI--doc-file\fR is not specified, the document name defaults to the home URL.  This name should be limited to 26 characters.  [\fCdoc_name\fR]
.TP
\fB--doc-compression\fR
Specifies that Doc compression, the compression scheme developed for the Palm DOC format, should be used for the parts of this document.  This is the default.  See also \fB--zlib-compression\fR and \fB--compression\fR.
.TP
\fB--exclusion-list=\fIfilename\fR (or \fB-E \fIfilename\fR)
Used to add additional files to the the \fIexclusion list\fR, a list of files containing information on URLs to exclude from the document.  See the User's Guide for more information on exclusion lists.  [\fCexclusion_lists\fR]
.TP
\fB--extra-section=\fIsection-name\fR (or \fB-s \fIsection-name\fR)
Used to add additional sections to the list to searched sections in the configuration files.  A section is a named set of configuration information.  By default, the \fBDEFAULT\fR section will be searched, then any operating-system-specific sections, then any sections specified on the command line.
.TP
\fB--help\fR (or \fB-h\fR)
Outputs help on command-line parameters.
.TP
\fB--home-url=\fIbase-url\fR (or \fB-H \fIbase-URL\fR)
Specifies the URL from which the document is to be constructed.  This may also be specified as a single argument on the command line.  If a home URL is not specified, it will default to file:/$HOME/.plucker/home.html.  This default may be changed in your .pluckerrc file.  Note that this value must be a valid absolute URL.  A special URL scheme is supported, \fBplucker:\fR.  This specifies files on the Plucker search path, which consists of \fIPluckerDir\fR (the Plucker current working directory) followed by \fIPluckerHome\fR (the Plucker home directory).  [\fChome_url\fR]
.TP
\fB--icon=\fIimage-filename\fR
If the output file is launchable, this switch can be used to specify the large icon shown in the launcher for the document.  If not specified, a default icon is used.  If the output file is not launchable, this switch has no effect.  See also \fB--launchable\fR.  [\fCbig_icon\fR]
.TP
\fB--launchable\fR
Specifies that the output document should be shown as an icon in the system launcher.  Clicking on the icon will start Plucker and select this document.  By default, documents are not launchable.  [\fClaunchable_bit\fR]
.TP
\fB--maxdepth=\fIdepth\fR (or \fB-M \fIdepth\fR)
This specifies the number of levels of links the parser will traverse when converting the input.  It is best to keep this value small, or the size of your document can get very large.  If you want just a page, but none of the pages pointed to by that page, use a value of 1.  [\fChome_maxdepth\fR]
.TP
\fB--maxheight=\fIpixel-height\fR
Specifies the maximum height, in pixels, for an inline image.  Overrides the MAXHEIGHT parameter in the configuration file, but is in turn overridden by any height specification in the image link itself.  [\fCmaxheight\fR]
.TP
\fB--maxwidth=\fIpixel-width\fR
Specifies the maximum width, in pixels, for an inline image.  Overrides the MAXWIDTH parameter in the configuration file, but is in turn overridden by any width specification in the image link itself.  [\fCmaxwidth\fR]
.TP
\fB--no-backup\fR
Clears the bit in the output file that causes the document to be backed up on Palm HotSync.  By default, the document is backed up.  [\fCbackup_bit\fR]
.TP
\fB--noimages\fR
Specifies that no images will be included.  Identical to --bpp=0.  See also \fB--bpp\fR.
.TP
\fB--not-beamable\fR
Sets the bit in the output file that prevents the document from being beamed.  By default, the document is beamable.  [\fCcopyprevention_bit\fR]
.TP
\fB--not-launchable\fR
Specifies that the output document should not be shown as an icon in the system launcher.  By default, documents are not launchable.  [\fClaunchable_bit\fR]
.TP
\fB--no-urlinfo\fR
Specifies that no URL information will be included in the document.  When links are included in documents, the information about the actual URL is included by default.  This is often handy for external references (links to documents not included in the document).  Use of this option may result in a slightly smaller document.  [\fCno_urlinfo\fR]
.TP
\fB--owner-id=\fIname\fR
Specifies an owner-id for the document.  This causes the document to be lightly encrypted in such a way that it will only open on a device with a matching owner-id.  With the PalmOS viewer, the HotSync UserName is used as the owner-id.  [\fCowner_id_build\fR]
.TP
\fB--pluckerhome=\fIplucker-home-directory\fR (or \fB-P \fIplucker-home-directory\fR)
Overrides the default value for \fIPluckerHome\fR, which is $HOME/.plucker/.  Can also be specified by setting the environment variable PLUCKERHOME.  An explicit value for \fB--pluckerhome\fR overrides any setting of PLUCKERHOME.  [\fCPLUCKERHOME\fR]
.TP
\fB--pluckerdir=\fIoutput-directory\fR (or \fB-p \fIoutput-directory\fR)
Overrides the default value for \fIPluckerDir\fR, which defaults to \fIPluckerHome\fR (see \fB--pluckerhome\fR).  \fIPluckerDir\fR is the default directory to which output documents will be written, and which will be searched for input files if the \fBplucker:\fR URL scheme is used.  [\fCpluckerdir\fR]
.TP
\fB--quiet\fR (or \fB-q\fR)
Same as --verbosity=0.
.TP
\fB--referrer=\fIstring\fR
When using HTTP to gather input, send \fIstring\fR as the value of the Referrer HTTP header.  Default is to send no referrer header.  [\fCreferrer\fR]
.TP
\fB--status-file=\fIfilename\fR
Gives the name of a file to read to get an estimate for the total number of pages that have to be processed, and to continually write with a single line giving the number of pages collected so far, the number of links still to process, and the estimated number of total pages that will be gathered (or zero if this is not known).  The three values are written as space-separated ASCII numbers.  The status line in the file is continually over-written as the pluck progresses, so the file will always contain only a single line.  [\fCstatus_file\fR]
.TP
\fB--staybelow=\fIurl-prefix\fR
Automatically excludes all URLs that do not start with \fIurl-prefix\fR.  A handy way to process a subtree.  [\fChome_staybelow\fR]
.TP
\fB--stayondomain\fR
Specifies that no web hosts other than those in the same domain as the original base URL will be visited for parts of the document.  [\fChome_stayondomain\fR]
.TP
\fB--stayonhost\fR
Specifies that no web hosts other than that named in the original base URL will be visited for parts of the document.  [\fChome_stayonhost\fR]
.TP
\fB--title=\fIstring\fR
Sets the title of the document to \fIstring\fR.  This is different from the name of the document (see \fB--doc-name=\fR) in that it may be relatively long.  The \fIstring\fR is assumed to be in the charset of the document (see \fB--charset\fR), or ASCII if no charset is specified.  [\fCtitle_md\fR]
.TP
\fB--update-cache\fR (or \fB-c\fR)
Update the Plucker cache of records, rather than build a document.  [\fCuse_cache\fR]
.TP
\fB--url-pattern=\fIpattern\fR
Automatically excludes all URLs that do not match the regular expression \fIpattern\fR.  The regular expression language used is that of the Python 're' module, as specified in \fChttp://www.python.org/doc/current/lib/re-syntax.html\fR.  [\fChome_url_pattern\fR]
.TP
\fB--user-agent=\fIstring\fR
When using HTTP to gather input, send \fIstring\fR as the value of the User-Agent HTTP header.  Default is to send "Plucker/Py-\fIXX\fR", where \fIXX\fR is the Plucker version.  [\fCuser_agent\fR]
.TP
\fB--verbosity=\fIverbosity-level\fR (or \fB-V \fIverbosity-level\fR)
Sets the level of status information output to the value specified by \fIverbosity-level\fR.  Appropriate values are 0, for total silence, 1, for standard progress status (the default value), and 2, for lots of output about gathering and parsing the input (usually reserved for debugging).  Values larger than 2 will also work, but tend to give profuse output that's only useful to developers.  See also \fB--quiet\fR.  [\fCverbosity\fR]
.TP
\fB--zlib-compression\fR
Specifies that Zlib compression should be used for the parts of this document.  This is considerably more efficient than the default compression format, Doc compression.  See also \fB--doc-compression\fR and \fB--compression\fR.
.SH EXAMPLES
To build a pocket version of the weekly cafeteria menu at the foo.com cafeteria, available on the Web at http://www.foo.com/ops/cafe/weeklymenu.html, without following any links, and without including any images, and naming the document "Cafeteria Menu", and putting the document in a file named /tmp/Menu.pdb, one would say:
.sp
\fC% plucker-build http://www.foo.com/cafe/weeklymenu.html >/tmp/Menu.pdb\fR
.sp
Or alternatively,
.sp
\fC% plucker-build --pluckerdir=/tmp \\
.br
     --doc-name="Cafeteria Menu" \\
.br
     --doc-file=Menu \\
.br
     --home-url="http://www.foo.com/cafe/weeklymenu.html" \\
.br
     --maxdepth=1 \\
.br
     --bpp=0
.br
Pluckerdir is '/tmp'...
.br
---- 0 collected, 1 to do ----
.br
Processing http://www.foo.com/cafe/weeklymenu.html...
.br
  Retrieved ok.
.br
  Parsed ok.
.br
---- all pages retrieved and parsed ----
.sp
Writing out collected data...
.br
Writing document 'Cafeteria Menu' to file /tmp/Menu.pdb
.br
Converting http://www.foo.com/cafe/weeklymenu.html...
.br
Wrote 1 <= plucker:/~special~/index
.br
Wrote 2 <= http://www.foo.com/cafe/weeklymenu.html
.br
Wrote 3 <= plucker:/~special~/pluckerlinks
.br
Wrote 5 <= plucker:/~special~/metadata
.br
Wrote 11 <= plucker:/~special~/links1
.br
Done!
.br
% ls -l /tmp/Menu.pdb
.br 
-rw-rw-r--   1 user  somegroup    2646 Nov  2 21:19 /tmp/Menu.pdb
.br
% \fR
.sp
.SH "ENVIRONMENT VARIABLES"
.TP
HOME
Used to determine the location of the user's configuration file.  If not set, the system-wide configuration file is used.
.TP
HTTP_PROXY, HTTP_PROXY_USER, HTTP_PROXY_PASS
If set, will be used to retrieve URLs with the \fChttp\fR URL scheme.
.TP
PLUCKERHOME
Specifies value for \fIPluckerHome\fR.  See the option \fI--pluckerhome\fR for more details.
.TP
PLUCKERDIR
Specifies value for \fIPluckerDir\fR.  See the option \fI--pluckerdir\fR for more details.
.SH "CONFIGURATION FILES"
Two configuration files are examined for customized settings of the various \fIplucker-build\fR parameters.  The first is a system-wide configuration file, by default \fC/usr/local/etc/pluckerrc\fR.  Any settings in this may be overridden with a personal configuration file, \fC$HOME/.pluckerrc\fR.  Both files contain any number of \fIsections\fR, each of which may contain any number of configuration parameter settings.  Each section has a name, which is enclosed in square brackets, followed by parameter settings.  Normally, only the section called "default" will be examined.  Extra sections may be specified with the \fI--extra-section\fR option to plucker-build; settings in these sections will override values in the default section.
.PP
Parameter settings have the form form \fIname = value\fR, where name is the name of a plucker-build parameter, and value is a string, integer, floating-point, or boolean value.  A colon character (:) may be used instead of the equals sign to separate name and value.  Comments may be expressed by starting any line with the characters "rem", or with the character "#", or with the character ";".  Boolean values of True may be expressed with "TRUE", "true", "True", "on", or "1".  Boolean values of False may be expressed with "FALSE", "false", "False", "off", or "0".
.PP
Configuration sections are often useful for specific often-used groups of options.  It's possible to define these options in a section of the configuration file, and then just specify the section as the argument to \fCplucker-build\fR; the other options can all be drawn from the section.
.PP
The following parameters are understood:
.TP
\fBPLUCKERHOME\fR
See option \fI--pluckerhome\fR.
.TP
\fBalt_maxheight\fR
See option \fI--alt-maxheight\fR.
.TP
\fBalt_maxwidth\fR
See option \fI--alt-maxwidth\fR.
.TP
\fBanchor_color\fR
A color to draw all links in, expressed as one of the 16 standard Web color names, or in the Web standard RGB color notation.  See the HTTP 4.0.1 specification for more details on allowed color names and RGB notation.
.TP
\fBauthor_md\fR
See option \fI--author\fR.
.TP
\fBauto_scale_images\fR
A boolean; if true, \fCplucker-build\fR will automatically attempt to convert images which are too large to include in the document, to a smaller form which will fit in the document.  Defaults to false.
.TP
\fBbackup_bit\fR
See option \fI--backup\fR.
.TP
\fBbig_icon\fR
See option \fI--icon\fR.
.TP
\fBbmp_to_tbmp\fR
Name of the bmp2tbmp program in Windows.  Defaults to \fCBmp2Tbmp.exe\fR.
.TP
\fBbmp_to_tbmp_parameter\fR
Parameter for the bmp2tbmp program in the Windows ImageMagick image parser.
.TP
\fBbpp\fR
See option \fI--bpp\fR.
.TP
\fBcache_dir_name\fR
Specify the subdirectory of \fIPluckerDir\fR to use for cache storage.  The default is \fC"cache"\fR.
.TP
\fBcategory\fR
See option \fI--category\fR.
.TP
\fBcolor_paragraphs\fR
Boolean; if set, will insert a specific foreground color at beginning of every paragraph.  Shouldn't be necessary, and defaults to off.
.TP
\fBcompression\fR
See option \fI--compression\fR.
.TP
\fBconvert_program\fR
If using the deprecated imagemagick image parser, the name of the \fCconvert\fR program.  Defaults to \fCconvert\fR (\fCconvert.exe\fR for Windows).
.TP
\fBconvert_program_parameter\fR
Parameter for the Windows ImageMagick image parser's use of \fCconvert\fR.
.TP
\fBcopyprevention_bit\fR
See option \fI--beamable\fR.
.TP
\fBdb_file\fR
Deprecated alternative to \fIdoc_file\fR.  May disappear in any release.
.TP
\fBdb_name\fR
Deprecated alternative to \fIdoc_name\fR.  May disappear in any release.
.TP
\fBdefault_charset\fR
See option \fI--charset\fR.
.TP
\fBdepth_first\fR
See option \fI--depth-first\fR.
.TP
\fBdjpeg_program\fR
Name of the \fCdjpeg\fR program.  Defaults to \fCdjpeg\fR.  Used by the netpbm2 image parser.
.TP
\fBdoc_file\fR
See option \fI--doc-file\fR.
.TP
\fBdoc_name\fR
See option \fI--doc-name\fR.
.TP
\fBexclusion_lists\fR
See option \fI--exclusion-list\fR.  If multiple files are specified here, they should be separated by the appropriate separator character for your operating system (a colon on Unix platforms, a semicolon on Windows platforms).
.TP
\fBfilename_extension\fR
Extension to use for the filename.  Defaults to \fCpdb\fR.  Another possibility is \fCplkr\fR.
.TP
\fBgiftopnm_program\fR
Name of program used to convert GIF image files to PNM image files.  Used by the netpbm and netpbm2 image parsers.  Defaults to \fCgiftopnm\fR.
.TP
\fBguess_tbmp_size\fR
Boolean, defaults to on.  Used by the Windows image parser.
.TP
\fBhome_maxdepth\fR
See option \fI--maxdepth\fR.
.TP
\fBhome_staybelow\fR
See option \fI--staybelow\fR.
.TP
\fBhome_stayondomain\fR
See option \fI--stayondomain\fR.
.TP
\fBhome_stayonhost\fR
See option \fI--stayonhost\fR.
.TP
\fBhome_url\fR
See option \fI--home-url\fR.
.TP
\fBhome_url_pattern\fR
See option \fI--url-pattern\fR.
.TP
\fBhttp_proxy\fR
String giving any HTTP proxy server to use.  Sets the environment variable HTTP_PROXY to this value.
.TP
\fBhttp_proxy_pass\fR
String giving a password for any HTTP proxy.  Sets the environment variable HTTP_PROXY_PASS to this value.
.TP
\fBhttp_proxy_user\fR
String giving a username for any HTTP proxy.  Sets the environment variable HTTP_PROXY_USER to this value.
.TP
\fBimage_compression_limit\fR
Integer giving the minimum number of image bytes to compress.  Defaults to 0.  Images smaller than this will not be compressed.
.TP
\fBimage_parser\fR
String specifying which image parser to use.  If not specified, a working default will be used.  It's suggested that you not specify this configuration parameter unless you know what you are doing.  Acceptable values are \fCnetpbm2\fR, \fCpil2\fR, \fCimagemagick2\fR, \fCnetpbm\fR (deprecated), \fCpil\fR (deprecated), \fCimagemagick\fR (deprecated), \fCwindowspil\fR, \fCwindows\fR (deprecated).  This value is ignored in the Java version of \fCplucker-build\fR.
.TP
\fBimagemagick_convert_command\fR
Identifies the ImageMagick \fCconvert\fR program in the imagemagick2 image parser.  Defaults to \fCconvert\fR.
.TP
\fBindent_paragraphs\fR
Boolean which when set will cause paragraphs to have leading indentation, but no extra leading space.  Defaults to off.
.TP
\fBlaunchable_bit\fR
See option \fI--launchable\fR.
.TP
\fBmax_tbmp_size\fR
Integer, maximum size for an image in the windows image parser.
.TP
\fBmaxheight\fR
See option \fI--maxheight\fR.
.TP
\fBmaxwidth\fR
See option \fI--maxwidth\fR.
.TP
\fBno_dithering_in_java_image_quantization\fR
Boolean, used in the Java \fCplucker-build\fR image parser to turn off dithering when an image is being quantized to the fixed set of colors used in Palm grayscale or eight-bit colormaps.  Defaults to false.
.TP
\fBno_urlinfo\fR
See option \fI--no-urlinfo\fR.
.TP
\fBowner_id_build\fR
See option \fI--owner-id\fR.
.TP
\fBpalm1bit_graymap_file\fR
String, used by the netpbm2 and netpbm image parsers to get the location of the Palm colormap file.
.TP
\fBpalm2bit_graymap_file\fR
String, used by the netpbm2 and netpbm image parsers to get the location of the Palm colormap file.
.TP
\fBpalm4bit_graymap_file\fR
String, used by the netpbm2 and netpbm image parsers to get the location of the Palm colormap file.
.TP
\fBpalm8bit_stdcolormap_file\fR
String, used by the netpbm2 and netpbm image parsers to get the location of the Palm colormap file.
.TP
\fBpalmtopnm_program\fR
String, used by the netpbm2 image parser, giving the location of the palmtopnm program.  Defaults to \fCpalmtopnm\fR.
.TP
\fBpgmtopbm_program\fR
String, used by the netpbm2 image parser, giving the location of the pgmtopbm program.  Defaults to \fCpgmtopbm\fR.
.TP
\fBpluckerdir\fR
See option \fI--pluckerdir\fR.
.TP
\fBpngtopnm_program\fR
String, used by the netpbm2 image parser, giving the location of the pngtopnm program.  Defaults to \fCpngtopnm\fR.
.TP
\fBpnmcut_program\fR
String, used by the netpbm2 image parser, giving the location of the pnmcut program.  Defaults to \fCpnmcut\fR.
.TP
\fBpnmdepth_program\fR
String, used by the netpbm2 image parser, giving the location of the pnmdepth program.  Defaults to \fCpnmdepth\fR.
.TP
\fBpnmfile_program\fR
String, used by the netpbm2 image parser, giving the location of the pnmfile program.  Defaults to \fCpnmfile\fR.
.TP
\fBpnmscale_program\fR
String, used by the netpbm2 image parser, giving the location of the pnmscale program.  Defaults to \fCpnmscale\fR.
.TP
\fBppmquant_program\fR
String, used by the netpbm2 image parser, giving the location of the pnmquant program.  Defaults to \fCpnmquant\fR.
.TP
\fBppmtoTbmp_program\fR
String, used by various image parsers, giving the location of either the ppmtoTbmp program (in various deprecated image parsers), or in netpbm2, the pnmtopalm program.  In netpbm2, defaults to \fCpnmtopalm\fR.
.TP
\fBppmtopgm_program\fR
String, used by the netpbm2 image parser, giving the location of the ppmtopgm program.  Defaults to \fCppmtopgm\fR.
.TP
\fBreferrer\fR
See option \fI--referrer\fR.
.TP
\fBretrieval_timeout\fR
Integer, used to attempt to set a timeout in seconds on all retrievals.  Will not affect timeouts on Java version of \fCplucker-build\fR.
.TP
\fBsmall_icon\fR
Filename of file containing a Palm icon to use as the small icon for the document, if the launchable bit is set.  Defaults to a built-in icon.
.TP
\fBstatus_file\fR
See option \fI--status-file\fR.
.TP
\fBstatus_line_length\fR
Integer, specifying, in characters, the length of status lines output by the distiller.  Defaults to 60.  If a line is too long, some of the characters in the center are elided.
.TP
\fBtbmp_compression\fR
Boolean, used by the windows image parser to indicate whether or not to use Palm compression on images.  Defaults to true.
.TP
\fBtbmp_compression_type\fR
Apparently also boolean, used by the windows image parser to indicate whether or not to use Palm compression on images.  Defaults to true.  The difference between this parameter and \fItbmp_compression\fR is not known.
.TP
\fBtitle_md\fR
See option \fI--title\fR.
.TP
\fBtry_reduce_bpp\fR
Boolean, controls whether the image parser will attempt to scale a large picture to fit by reducing the number of bits-per-pixel of the image.  Only valid for netpbm2, imagemagick2, pil2, java, and windows image parsers.  Defaults to off.  \fItry_reduce_bpp\fR has precedence over \fItry_reduce_dimension\fR or \fIauto_scale_image\fR.
.TP
\fBtry_reduce_dimension\fR
Boolean, controls whether the image parser will attempt to scale a large picture to fit by reducing the size of the image.  Only valid for netpbm2, imagemagick2, pil2, java, and windows parser.
.TP
\fBuse_cache\fR
See option \fI--update-cache\fR.  Misleadingly named.
.TP
\fBuser_agent\fR
See option \fI--user-agent\fR.
.TP
\fBverbosity\fR
See option \fI--verbosity\fR.
.TP
\fBzlib_compression\fR
Specifies that zlib compression should be used.  Deprecated in favor of \fIcompression\fR.
.SH "SEE ALSO"
\fBThe Plucker User's Guide\fR, at \fChttp://plkr.org/docs/\fR.
.SH "BUGS"
Report bugs to http://bugs.plkr.org/ or <plucker-bugs@rubberchicken.org>
.SH "AUTHORS"
Holger Duerer, <holly@starship.python.net>, and Bill Janssen, <bill@janssen.org>