PLUCKER-BUILD(1)

NAME
plucker-build - generate a document (e-book) in Plucker format

SYNOPSIS
plucker-build [--alt-maxheight=pixel-height] [--alt-maxwidth=pixel-width] [--author=string] [--backup] [--beamable] [--bpp=image-depth] [--category=default-category-name] [--charset=charset-indicator] [--compression=compression-type] [--depth-first] [--doc-file=name-prefix] [--doc-name=document-name] [--doc-compression] [--exclusion-list=filename] [--extra-section=section-name] [--help] [--home-url=base-URL] [--icon=image-filename] [--launchable] [--maxdepth=depth] [--maxheight=pixel-height] [--maxwidth=pixel-width] [--no-backup] [--noimages] [--not-beamable] [--not-launchable] [--no-urlinfo] [--owner-id=name] [--pluckerdir=output-directory] [--pluckerhome=plucker-home-directory] [--quiet] [--referrer=string] [--status-file=filename] [--staybelow=url-prefix] [--stayonhost] [--title=string] [--update-cache] [--url-pattern=pattern] [--user-agent=string] [--verbosity=verbosity-level] [--zlib-compression] [HOME-URL]

DESCRIPTION
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 home URL and 'pluck' it to produce a Plucker document, either to stdout, or to a file if --doc-file is specified. Alternatively, specifying the option --update-cache will update a cache of Plucker records. The Plucker document format is specified at http://www.plkr.org/index.pl/cvs/docs/DBFormat.html?rev=HEAD.

OPTIONS

--alt-maxheight=pixel-height
    Specifies the maximum height, in pixels, of the alternate rendition 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 alternate rendition.)

--alt-maxwidth=pixel-width
    Specifies the maximum width, in pixels, of the alternate rendition 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 alternate rendition.)

--author=string
    Sets the author of the document to string, which is assumed to be in the charset of the document (see --charset), or ASCII if no charset is specified.

--backup
    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.

--beamable
    Sets the bit in the output file that allows the document to be beamed. By default, the document is beamable.

--bpp=image-depth
    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 --noimages.

--category=default-category-name
    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.

--charset=charset-indicator
    Specifies the default character set encoding used in the text of the documents being plucked. charset-indicator is either a charset name (from a small list; see src/parser/python/PyPlucker/__init__.py.in for a list of valid names), or a decimal integer indicating the charset's MIBenum value, as shown in the table at http://www.iana.org/assignments/character-sets.

--compression=compression-type
    Specifies the type of compression to use in the document. There are two possible values for compression-type: doc or zlib. The default is doc, which is the same compression system used in Palm DOC-format documents. zlib compression usually results in smaller documents. See also --zlib-compression and --doc-compression.

--depth-first
    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.

--doc-file=name-prefix (or -f name-prefix)
    also as -f name-prefix. 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.

--doc-name=document-name (or -N document-name)
    Specifies the name by which the document will be identified in the viewer. Defaults to value of --doc-file. If --doc-file is not specified, the document name defaults to the home URL.

--doc-compression
    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 --zlib-compression and --compression.

--exclusion-list=filename (or -E filename)
    Used to add additional files to the the exclusion list, a list of files containing information on URLs to exclude from the document. See the User's Guide for more information on exclusion lists.

--extra-section=section-name (or -s section-name)
    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 DEFAULT section will be searched, then any operating-system-specific sections, then any sections specified on the command line.

--help (or -h)
    Outputs help on command-line parameters.

--home-url=base-url (or -H base-URL)
    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, plucker:. This specifies files on the Plucker search path, which consists of PluckerDir (the Plucker current working directory) followed by PluckerHome (the Plucker home directory).

--icon=image-filename
    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 --launchable.

--launchable
    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.

--maxdepth=depth (or -M depth)
    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.

--maxheight=pixel-height
    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.

--maxwidth=pixel-width
    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.

--no-backup
    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.

--noimages
    Specifies that no images will be included. Identical to --bpp=0. See also --bpp.

--not-beamable
    Sets the bit in the output file that prevents the document from being beamed. By default, the document is beamable.

--not-launchable
    Specifies that the output document should not be shown as an icon in the system launcher. By default, documents are not launchable.

--no-urlinfo
    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.

--owner-id=name
    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.

--pluckerhome=plucker-home-directory (or -P plucker-home-directory)
    Overrides the default value for PluckerHome, which is $HOME/.plucker/. Can also be specified by setting the environment variable PLUCKERHOME. An explicit value for --pluckerhome overrides any setting of PLUCKERHOME.

--pluckerdir=output-directory (or -p output-directory)
    Overrides the default value for PluckerDir, which defaults to PluckerHome (see --pluckerhome). PluckerDir is the default directory to which output documents will be written, and which will be searched for input files if the plucker: URL scheme is used.

--quiet (or -q)
    Same as --verbosity=0.

--referrer=string
    When using HTTP to gather input, send string as the value of the Referrer HTTP header. Default is to send no referrer header.

--status-file=filename
    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.

--staybelow=url-prefix
    Automatically excludes all URLs that do not start with url-prefix. A handy way to process a subtree.

--stayonhost
    Specifies that no web hosts other than that named in the original base URL will be visited for parts of the document.

--title=string
    Sets the title of the document to string. This is different from the name of the document (see --doc-name=) in that it may be relatively long. The string is assumed to be in the charset of the document (see --charset), or ASCII if no charset is specified.

--update-cache (or -c)
    Update the Plucker cache of records, rather than build a document.

--url-pattern=pattern
    Automatically excludes all URLs that do not match the regular expression pattern. The regular expression language used is that of the Python 're' module, as specified in http://www.python.org/doc/current/lib/re-syntax.html.

--user-agent=string
    When using HTTP to gather input, send string as the value of the User-Agent HTTP header. Default is to send "Plucker/Py-XX", where XX is the Plucker version.

--verbosity=verbosity-level (or -V verbosity-level)
    Sets the level of status information output to the value specified by verbosity-level. 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). See also --quiet.

--zlib-compression
    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 --doc-compression and --compression.

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:

% plucker-build http://www.foo.com/cafe/weeklymenu.html >/tmp/Menu.pdb

Or alternatively,

% plucker-build --pluckerdir=/tmp \
     --doc-name="Cafeteria Menu" \
     --doc-file=Menu \
     --home-url="http://www.foo.com/cafe/weeklymenu.html" \
     --maxdepth=1 \
     --bpp=0
Pluckerdir is '/tmp'...
---- 0 collected, 1 to do ----
Processing http://www.foo.com/cafe/weeklymenu.html...
  Retrieved ok.
  Parsed ok.
---- all pages retrieved and parsed ----

Writing out collected data...
Writing document 'Cafeteria Menu' to file /tmp/Menu.pdb
Converting http://www.foo.com/cafe/weeklymenu.html...
Wrote 1 <= plucker:/~special~/index
Wrote 2 <= http://www.foo.com/cafe/weeklymenu.html
Wrote 3 <= plucker:/~special~/pluckerlinks
Wrote 5 <= plucker:/~special~/metadata
Wrote 11 <= plucker:/~special~/links1
Done!
% ls -l /tmp/Menu.pdb
-rw-rw-r-- 1 user somegroup 2646 Nov 2 21:19 /tmp/Menu.pdb
%

ENVIRONMENT VARIABLES

PLUCKERHOME
    Specifies value for PluckerHome.

PLUCKERDIR
    Specifies value for PluckerDir.

SEE ALSO
The Plucker User's Guide, at http://plkr.org/docs/.

BUGS
Report bugs to http://bugs.plkr.org/ or <plucker-bugs@rubberchicken.org>

AUTHORS
Holger Duerer, <holly@starship.python.net>, and Bill Janssen, <bill@janssen.org>