Manual Pages for UNIX Darwin command on man pdfroff

PDFROFF(1) PDFROFF(1)

NAME

pdfroff - create PDF documents using groff

SYNOPSIS

ppddffrrooffff [-aabbcceeggiillppssttzzCCEEGGNNRRSSUUVVXXZZ] [-dd cs] [-ff fam] [-FF dir]

[-II dir] [-LL arg] [-mm name] [-MM dir] [-nn num] [-oo list]

[-PP arg] [-rr cn] [-TT dev] [-ww name] [-WW name]

[--nnoo-ttoocc-rreellooccaattiioonn] [--ssttyylleesshheeeett=name]

[--nnoo-ppddff-oouuttppuutt | --ppddff-oouuttppuutt=name]

[--nnoo-rreeffeerreennccee-ddiiccttiioonnaarryy | --rreeffeerreennccee-ddiiccttiioonnaarryy=name]

[--rreeppoorrtt-pprrooggrreessss] ffiillee ...

ppddffrrooffff -hh | --hheellpp

ppddffrrooffff -vv | --vveerrssiioonn [option ...]

The command line is parsed in accordance with normal GNU conventions,

but with one exception - when specifying any short form option (i.e.,

a single character option introduced by a single hyphen), and if that option expects an argument, then it must be specified independently (i.e., it may not be appended to any group of other single character short form options). Long form option names (i.e., those introduced by a double hyphen) may be abbreviated to their minimum length unambigous initial substring.

DESCRIPTION

ppddffrrooffff is a wrapper program for the GNU text processing system, ggrrooffff.

It transparently handles the mechanics of multiple pass ggrrooffff process-

ing, when applied to suitably marked up ggrrooffff source files, such that

tables of contents and body text are formatted separately, and are sub-

sequently combined in the correct order, for final publication as a single PDF document. A further optional "style sheet" capability is provided; this allows for the definition of content which is required to preceed the table of contents, in the published document. For each invocation of ppddffrrooffff, the ultimate ggrrooffff output stream is

post-processed by the GhostScript interpreter, to produce a finished

PDF document. ppddffrrooffff makes no assumptions about, and imposes no restrictions on, the use of any ggrrooffff macro packages which the user may choose to employ, in order to achieve a desired document format; however, it does include

specific built in support for the ppddffmmaarrkk macro package, should the us-

er choose to employ it. Specifically, if the pdfhref macro, defined in the ppddffmmaarrkk..ttmmaacc package, is used to define public reference marks, or dynamic links to such reference marks, then ppddffrrooffff will perform as many preformatting ggrrooffff passes as required, up to a maximum limit of four, in order to compile a document reference dictionary, to resolve references, and to expand the dynamically defined content of links. UUSSAAGGEE ppddffrrooffff usage closely mirrors that of ggrrooffff itself. Indeed, with the

exception of the -hh, -vv, and -TT dev short form options, and all long

form options, which are parsed internally by ppddffrrooffff, all options and file name arguments specified on the command line are passed on to ggrrooffff, to control the formatting of the PDF document. Consequently, ppddffrrooffff accepts all options and arguments, as specified in ggrrooffff(1),

which may also be considered as the definitive reference for all stan-

dard ppddffrrooffff options and argument usage. OOPPTTIIOONNSS ppddffrrooffff accepts all of the short form options (i.e., those introduced by a single hyphen), which are available with ggrrooffff itself. In most cases, these are simply passed transparently to ggrrooffff; the following, however, are handled specially by ppddffrrooffff.

-hh Same as --hheellpp; see below.

-ii Process standard input, after all other specified input files.

This is passed transparently to ggrrooffff, but, if grouped with oth-

er options, it must be the first in the group. Hiding it within a group will break standard input processing, in the multiple pass ggrrooffff processing context of ppddffrrooffff.

-TT dev Only -TT ps is supported by ppddffrrooffff. Attempting to specify any

other device will cause ppddffrrooffff to abort.

-vv Same as --vveerrssiioonn; see below.

See ggrrooffff(1) for a description of all other short form options, which are transparently passed through ppddffrrooffff to ggrrooffff. All long form options (i.e., those introduced by a double hyphen) are interpreted locally by ppddffrrooffff; they are nnoott passed on to ggrrooffff, unless otherwise stated below.

--hheellpp Causes ppddffrrooffff to display a summary of the its usage syntax, and

supported options, and then exit.

--nnoo-ppddff-oouuttppuutt

May be used with the --rreeffeerreennccee-ddiiccttiioonnaarryy==name option (de-

scribed below) to eliminate the overhead of PDF formatting, when running ppddffrrooffff to create a reference dictionary, for use in a different document.

--nnoo-rreeffeerreennccee-ddiiccttiioonnaarryy

May be used to eliminate the overhead of creating a reference dictionary, when it is known that the target PDF document will contain no public references, created by the pdfhref macro.

--nnoo-ttoocc-rreellooccaattiioonn

May be used to eliminate the extra ggrrooffff processing pass, which is required to generate a table of contents, and relocate it to the start of the PDF document, when processing any document which lacks an automatically generated table of contents.

--ppddff-oouuttppuutt==name

Specifies the name to be used for the resultant PDF document; if unspecified, the PDF output is written to standard output. A future version of ppddffrrooffff may use this option, to encode the document name in a generated reference dictionary.

--rreeffeerreennccee-ddiiccttiioonnaarryy==name

Specifies the name to be used for the generated reference dic-

tionary file; if unspecified, the reference dictionary is creat-

ed in a temporary file, which is deleted when ppddffrrooffff completes

processing of the current document. This option must be speci-

fied, if it is desired to save the reference dictionary, for use in references placed in other PDF documents.

--rreeppoorrtt-pprrooggrreessss

Causes ppddffrrooffff to display an informational message on standard error, at the start of each ggrrooffff processing pass.

--ssttyylleesshheeeett==name

Specifies the name of an input file, to be used as a style sheet

for formatting of content, which is to be placed before the ta-

ble of contents, in the formatted PDF document.

--vveerrssiioonn

Causes ppddffrrooffff to display a version identification message. The entire command line is then passed transparently to ggrrooffff, in a one pass operation only, in order to display the associated ggrrooffff version information, before exiting. ENVIRONMENT The following environment variables may be set, and exported, to modify the behaviour of ppddffrrooffff. GGRROOFFFFTTMMPPDDIIRR

Identifies the directory in which ppddffrrooffff should create tempo-

rary files. If GGRROOFFFFTTMMPPDDIIRR is not specified, then the vari-

ables TTMMPPDDIIRR, TTMMPP and TTEEMMPP are considered in turn, as possible temporary file repositories. If none of these are set, then temporary files will be created in the current directory. GGRROOFFFFGGHHOOSSTTSSCCRRIIPPTTIINNTTEERRPPRREETTEERR Specifies the program to be invoked, when ppddffrrooffff converts ggrrooffff PostScript output to PDF. If GGRROOFFFFGGHHOOSSTTSSCCRRIIPPTTIINNTTEERRPPRREETTEERR is

not specified, then ppddffrrooffff will search the process PPAATTHH, look-

ing for a program with any of the well known names for the GhostScript interpreter; if no GhostScript interpreter can be found, ppddffrrooffff will abort. GGRROOFFFFAAWWKKIINNTTEERRPPRREETTEERR Specifies the program to be invoked, when ppddffrrooffff is extracting reference dictionary entries from a ggrrooffff intermediate message stream. If GGRROOFFFFAAWWKKIINNTTEERRPPRREETTEERR is not specified, then ppddffrrooffff will search the process PPAATTHH, looking for any of the preferred programs, `gawk', `mawk', `nawk' and `awk', in this order; if none of these are found, ppddffrrooffff will issue a warning message, and continue processing; however, in this case, no reference dictionary will be created. OOSSTTYYPPEE Typically defined automatically by the operating system, OOSSTTYYPPEE

is used on Microsoft Win32/MS-DOS platforms only, to infer the

default PPAATTHHSSEEPPAARRAATTOORR character, which is used when parsing the process PPAATTHH to search for external helper programs. PPAATTHHSSEEPPAARRAATTOORR

If set, PPAATTHHSSEEPPAARRAATTOORR overrides the default separator charac-

ter, (':' on POSIX/UNIX systems, inferred from OOSSTTYYPPEE on Mi-

crosoft Win32/MS-DOS), which is used when parsing the process

PPAATTHH to search for external helper programs. SSHHOOWWPPRROOGGRREESSSS

If this is set to a non-empty value, then ppddffrrooffff will always

behave as if the --rreeppoorrtt-pprrooggrreessss option is specified, on the

command line. FILES

Input and output files for ppddffrrooffff may be named according to any con-

vention of the user's choice. Typically, input files may be named ac-

cording to the choice of the principal formatting macro package, e.g., file..mmss might be an input file for formatting using the mmss macros (ss..ttmmaacc); normally, the final output file should be named file..ppddff.

Temporary files, created by ppddffrrooffff, are placed in the directory speci-

id y niomn vrals se eto ENVIRONMENT) ad ae a-

cording to the convention ppddff$$..**, where $$ is the standard shell vari-

able representing the process ID of the ppddffrrooffff process itself, and * represents any of a number of extensions used by ppddffrrooffff for temporary and intermediate files.

the pdfroff program, to which it relates.

You should have received a copy of the FDL as part of the GNU troff

distribution; it is also available on-line, at the GNU "copyleft" site,

. Groff Version 1.19.2 17 May 2005 PDFROFF(1)