NAME
grops - PostScript driver for groff
SYNOPSIS
ggrrooppss [ -ggllmmvv ] [ -bbn ] [ -ccn ] [ -FFdir ] [ -IIdir ] [ -pppapersize ]
[ -PPprologue ] [ -wwn ] [ files... ]
It is possible to have whitespace between a command line option and its
parameter.
DESCRIPTION
ggrrooppss translates the output of GNU ttrrooffff to PostScript. Normally ggrrooppss
should be invoked by using the groff command with a -TTppss option.
(Actually, this is the default for groff.) If no files are given,
ggrrooppss will read the standard input. A filename of - will also cause
ggrrooppss to read the standard input. PostScript output is written to the
standard output. When ggrrooppss is run by ggrrooffff options can be passed to
ggrrooppss using the ggrrooffff -PP option.
OOPPTTIIOONNSS
-bbn Provide workarounds for older printers, broken spoolers, and
previewers. Normally ggrrooppss produces output at PostScript Lan-
guageLevel 2 that conforms to the Document Structuring Conven-
tions version 3.0. Some older printers, spoolers, and preview-
ers can't handle such output. The value of n controls what
ggrrooppss does to make its output acceptable to such programs. A
value of 0 will cause grops not to employ any workarounds.
Add 1 if no %%%%BBeeggiinnDDooccuummeennttSSeettuupp and %%%%EEnnddDDooccuummeennttSSeettuupp comments
should be generated; this is needed for early versions of Tran-
Script that get confused by anything between the %%%%EEnnddPPrroolloogg
comment and the first %%%%PPaaggee comment.
Add 2 if lines in included files beginning with %%!! should be
stripped out; this is needed for Sun's pageview previewer.
Add 4 if %%%%PPaaggee, %%%%TTrraaiilleerr and %%%%EEnnddPPrroolloogg comments should be
stripped out of included files; this is needed for spoolers that
don't understand the %%%%BBeeggiinnDDooccuummeenntt and %%%%EEnnddDDooccuummeenntt comments.
Add 8 if the first line of the PostScript output should be %%!!PPSS-
AAddoobbee-22..00 rather than %%!!PPSS-AAddoobbee-33..00; this is needed when using
Sun's Newsprint with a printer that requires page reversal.
Add 16 if no media size information should be included in the
document (this is, neither use %%%%DDooccuummeennttMMeeddiiaa nor the sseett-
ppaaggeeddeevviiccee PostScript command). This was the behaviour of groff
version 1.18.1 and earlier; it is needed for older printers
which don't understand PostScript LanguageLevel 2. It is also
necessary if the output is further processed to get an encapsu-
lated PS (EPS) file - see below.
The default value can be specified by a
bbrrookkeenn n
command in the DESC file. Otherwise the default value is 0.
-ccn Print n copies of each page.
-FFdir Prepend directory dir//ddeevvname to the search path for prologue,
font, and device description files; name is the name of the
device, usually ppss.
-gg Guess the page length. This generates PostScript code that
guesses the page length. The guess will be correct only if the
imageable area is vertically centered on the page. This option
allows you to generate documents that can be printed both on
letter (8.5x11) paper and on A4 paper without change.
-IIdir This option may be used to specify a directory to search for
files on the command line and files named in \\XX''ppss:: iimmppoorrtt'' and
\\XX''ppss:: ffiillee'' escapes. The current directory is always searched
first. This option may be specified more than once; the direc-
tories will be searched in the order specified. No directory
search is performed for files specified using an absolute path.
-ll Print the document in landscape format.
-mm Turn manual feed on for the document.
-pppaper-size
Set physical dimension of output medium. This overrides the
ppaappeerrssiizzee, ppaappeerrlleennggtthh, and ppaappeerrwwiiddtthh commands in the DDEESSCC
file; it accepts the same arguments as the ppaappeerrssiizzee command.
See ggrrooffffffoonntt ((55)) for details.
-PPprologue-file
Use the file prologue-file (in the font path) as the prologue
instead of the default prologue file pprroolloogguuee. This option
overrides the environment variable GROPSPROLOGUE.
-wwn Lines should be drawn using a thickness of n thousandths of an
em. If this option is not given, the line thickness defaults to
0.04 em.
-vv Print the version number.
UUSSAAGGEE
There are styles called RR, II, BB, and BBII mounted at font positions 1
to 4. The fonts are grouped into families AA, BBMM, CC, HH, HHNN, NN, PP, and TT
having members in each of these styles:
AARR AvantGarde-Book
AAII AvantGarde-BookOblique
AABB AvantGarde-Demi
AABBII AvantGarde-DemiOblique
BBMMRR Bookman-Light
BBMMII Bookman-LightItalic
BBMMBB Bookman-Demi
BBMMBBII Bookman-DemiItalic
CCRR Courier
CCII Courier-Oblique
CCBB Courier-Bold
CCBBII Courier-BoldOblique
HHRR Helvetica
HHII Helvetica-Oblique
HHBB Helvetica-Bold
HHBBII Helvetica-BoldOblique
HHNNRR Helvetica-Narrow
HHNNII Helvetica-Narrow-Oblique
HHNNBB Helvetica-Narrow-Bold
HHNNBBII Helvetica-Narrow-BoldOblique
NNRR NewCenturySchlbk-Roman
NNII NewCenturySchlbk-Italic
NNBB NewCenturySchlbk-Bold
NNBBII NewCenturySchlbk-BoldItalic
PPRR Palatino-Roman
PPII Palatino-Italic
PPBB Palatino-Bold
PPBBII Palatino-BoldItalic
TTRR Times-Roman
TTII Times-Italic
TTBB Times-Bold
TTBBII Times-BoldItalic
There is also the following font which is not a member of a family:
ZZCCMMII ZapfChancery-MediumItalic
There are also some special fonts called SS for the PS Symbol font, and
SSSS, containing slanted lowercase Greek letters taken from PS Symbol.
Zapf Dingbats is available as ZZDD and a reversed version of ZapfDingbats
(with symbols pointing in the opposite direction) is available as ZZDDRR;
most characters in these fonts are unnamed and must be accessed using
\\NN.
The default color for \\mm and \\MM is black; for colors defined in the
`rgb' color space, sseettrrggbbccoolloorr is used, for `cmy' and `cmyk' sseettccmmyykk-
ccoolloorr, and for `gray' sseettggrraayy. Note that sseettccmmyykkccoolloorr is a PostScript
LanguageLevel 2 command and thus not available on some older printers.
ggrrooppss understands various X commands produced using the \\XX escape
sequence; ggrrooppss will only interpret commands that begin with a ppss:: tag.
\\XX''ppss:: eexxeecc code''
This executes the arbitrary PostScript commands in code. The
PostScript currentpoint will be set to the position of the \\XX
command before executing code. The origin will be at the top
left corner of the page, and y coordinates will increase down
the page. A procedure uu will be defined that converts groff
units to the coordinate system in effect. For example,
..nnrr xx 11ii
\\XX''ppss:: eexxeecc \\nnxx uu 00 rrlliinneettoo ssttrrookkee''
will draw a horizontal line one inch long. code may make
changes to the graphics state, but any changes will persist only
to the end of the page. A dictionary containing the definitions
specified by the ddeeff and mmddeeff will be on top of the dictionary
stack. If your code adds definitions to this dictionary, you
should allocate space for them using \\XX''ppss mmddeeff n''. Any defini-
tions will persist only until the end of the page. If you use
the \\YY escape sequence with an argument that names a macro, code
can extend over multiple lines. For example,
..nnrr xx 11ii
..ddee yy
ppss:: eexxeecc
\\nnxx uu 00 rrlliinneettoo
ssttrrookkee
....
\\YYyy
is another way to draw a horizontal line one inch long.
\\XX''ppss:: ffiillee name''
This is the same as the eexxeecc command except that the PostScript
code is read from file name.
\\XX''ppss:: ddeeff code''
Place a PostScript definition contained in code in the prologue.
There should be at most one definition per \\XX command. Long
definitions can be split over several \\XX commands; all the code
arguments are simply joined together separated by newlines. The
definitions are placed in a dictionary which is automatically
pushed on the dictionary stack when an eexxeecc command is executed.
If you use the \\YY escape sequence with an argument that names a
macro, code can extend over multiple lines.
\\XX''ppss:: mmddeeff n code''
Like ddeeff, except that code may contain up to n definitions.
ggrrooppss needs to know how many definitions code contains so that
it can create an appropriately sized PostScript dictionary to
contain them.
\\XX''ppss:: iimmppoorrtt file llx lly urx ury width [ height ]''
Import a PostScript graphic from file. The arguments llx, lly,
urx, and ury give the bounding box of the graphic in the default
PostScript coordinate system; they should all be integers; llx
and lly are the x and y coordinates of the lower left corner of
the graphic; urx and ury are the x and y coordinates of the
upper right corner of the graphic; width and height are integers
that give the desired width and height in groff units of the
graphic. The graphic will be scaled so that it has this width
and height and translated so that the lower left corner of the
graphic is located at the position associated with \\XX command.
If the height argument is omitted it will be scaled uniformly in
the x and y directions so that it has the specified width. Note
that the contents of the \\XX command are not interpreted by
ttrrooffff; so vertical space for the graphic is not automatically
added, and the width and height arguments are not allowed to
have attached scaling indicators. If the PostScript file com-
plies with the Adobe Document Structuring Conventions and con-
tains a %%%%BBoouunnddiinnggBBooxx comment, then the bounding box can be
automatically extracted from within groff by using the ppssbbbb
request.
See ggrrooffffttmmaacc(5) for a description of the PPSSPPIICC macro which
provides a convenient high-level interface for inclusion of
PostScript graphics.
\\XX''ppss:: iinnvviiss''
\\XX''ppss:: eennddiinnvviiss''
No output will be generated for text and drawing commands that
are bracketed with these \\XX commands. These commands are
intended for use when output from ttrrooffff will be previewed before
being processed with ggrrooppss; if the previewer is unable to dis-
play certain characters or other constructs, then other substi-
tute characters or constructs can be used for previewing by
bracketing them with these \\XX commands.
For example, ggxxddiittvviieeww is not able to display a proper \\((eemm
character because the standard X11 fonts do not provide it; this
problem can be overcome by executing the following request
..cchhaarr \\((eemm \\XX''ppss:: iinnvviiss''\\
\\ZZ''\\vv''-..2255mm''\\hh''..0055mm''\\DD''ll ..99mm 00''\\hh''..0055mm''''\\
\\XX''ppss:: eennddiinnvviiss''\\((eemm
In this case, ggxxddiittvviieeww will be unable to display the \\((eemm char-
acter and will draw the line, whereas ggrrooppss will print the \\((eemm
character and ignore the line (this code is already in file
XXppss..ttmmaacc which will be loaded if a documented intended for ggrrooppss
is previewed with ggxxddiittvviieeww).
The input to ggrrooppss must be in the format output by ttrrooffff(1). This is
described in ggrrooffffoouutt(5).
In addition, the device and font description files for the device used
must meet certain requirements. The device and font description files
supplied for ppss device meet all these requirements. aaffmmttooddiitt(1) can be
used to create font files from AFM files. The resolution must be an
integer multiple of 72 times the ssiizzeessccaallee. The ppss device uses a reso-
lution of 72000 and a sizescale of 1000.
The device description file must contain a valid paper size; see
ggrrooffffffoonntt(5) for more information.
Each font description file must contain a command
iinntteerrnnaallnnaammee psname
which says that the PostScript name of the font is psname. It may also
contain a command
eennccooddiinngg encfile
which says that the PostScript font should be reencoded using the
encoding described in encfile; this file should consist of a sequence
of lines of the form:
pschar code
where pschar is the PostScript name of the character, and code is its
position in the encoding expressed as a decimal integer; valid values
are in the range 0 to 255. Lines starting with ## and blank lines are
ignored. The code for each character given in the font file must cor-
respond to the code for the character in encoding file, or to the code
in the default encoding for the font if the PostScript font is not to
be reencoded. This code can be used with the \\NN escape sequence in
ttrrooffff to select the character, even if the character does not have a
groff name. Every character in the font file must exist in the Post-
Script font, and the widths given in the font file must match the
widths used in the PostScript font. ggrrooppss will assume that a character
with a groff name of ssppaaccee is blank (makes no marks on the page); it
can make use of such a character to generate more efficient and compact
PostScript output.
Note that ggrrooppss is able to display all glyphs in a PostScript font, not
only 256. encfile (or the default encoding if no encoding file speci-
fied) just defines the order of glyphs for the first 256 characters;
all other glyphs are accessed with additional encoding vectors which
ggrrooppss produces on the fly.
ggrrooppss can automatically include the downloadable fonts necessary to
print the document. Such fonts must be in PFA format. Use ppffbbttooppss(1)
to convert a Type 1 font in PFB format. Any downloadable fonts which
should, when required, be included by ggrrooppss must be listed in the file
//uussrr//sshhaarree//ggrrooffff//11..1199..11//ffoonntt//ddeevvppss//ddoowwnnllooaadd; this should consist of
lines of the form
font filename
where font is the PostScript name of the font, and filename is the name
of the file containing the font; lines beginning with ## and blank lines
are ignored; fields may be separated by tabs or spaces; filename will
be searched for using the same mechanism that is used for groff font
metric files. The ddoowwnnllooaadd file itself will also be searched for using
this mechanism; currently, only the first found file in the font path
is used.
If the file containing a downloadable font or imported document con-
forms to the Adobe Document Structuring Conventions, then ggrrooppss will
interpret any comments in the files sufficiently to ensure that its own
output is conforming. It will also supply any needed font resources
that are listed in the ddoowwnnllooaadd file as well as any needed file
resources. It is also able to handle inter-resource dependencies. For
example, suppose that you have a downloadable font called Garamond, and
also a downloadable font called Garamond-Outline which depends on Gara-
mond (typically it would be defined to copy Garamond's font dictionary,
and change the PaintType), then it is necessary for Garamond to appear
before Garamond-Outline in the PostScript document. ggrrooppss will handle
this automatically provided that the downloadable font file for Gara-
mond-Outline indicates its dependence on Garamond by means of the Docu-
ment Structuring Conventions, for example by beginning with the follow-
ing lines
%%!!PPSS-AAddoobbee-33..00 RReessoouurrccee-FFoonntt
%%%%DDooccuummeennttNNeeeeddeeddRReessoouurrcceess:: ffoonntt GGaarraammoonndd
%%%%EEnnddCCoommmmeennttss
%%%%IInncclluuddeeRReessoouurrccee:: ffoonntt GGaarraammoonndd
In this case both Garamond and Garamond-Outline would need to be listed
in the ddoowwnnllooaadd file. A downloadable font should not include its own
name in a %%%%DDooccuummeennttSSuupppplliieeddRReessoouurrcceess comment.
ggrrooppss will not interpret %%%%DDooccuummeennttFFoonnttss comments. The %%%%DDooccuummeenntt-
NNeeeeddeeddRReessoouurrcceess, %%%%DDooccuummeennttSSuupppplliieeddRReessoouurrcceess, %%%%IInncclluuddeeRReessoouurrccee,
%%%%BBeeggiinnRReessoouurrccee, and %%%%EEnnddRReessoouurrccee comments (or possibly the old
%%%%DDooccuummeennttNNeeeeddeeddFFoonnttss, %%%%DDooccuummeennttSSuupppplliieeddFFoonnttss, %%%%IInncclluuddeeFFoonntt, %%%%BBeeggiinn-
FFoonntt, and %%%%EEnnddFFoonntt comments) should be used.
EEnnccaappssuullaatteedd PPoossttSSccrriipptt
ggrrooppss itself doesn't emit bounding box information. With the help of
GhostScript the following commands will produce an encapsulated PS file
ffoooo..eeppss from input file ffoooo:
ggrrooffff -PP-bb1166 ffoooo >> ffoooo..ppss
ggss -ddNNOOPPAAUUSSEE -ssDDEEVVIICCEE==bbbbooxx -- ffoooo..ppss 22>> ffoooo..bbbbooxx
ccaatt ffoooo..ppss || sseedd -ee ''//%%%%OOrriieennttaattiioonn//rrffoooo..bbbbxx'' >> ffoooo..eeppss
rrmm ffoooo..bbbbxx
TTrruueeTTyyppee ffoonnttss
TrueType fonts can be used with ggrrooppss if converted first to TTyyppee 4422
format, an especial PostScript wrapper equivalent to the PFA format
mentioned in ppffbbttooppss(1). There are several different methods to gener-
ate a type42 wrapper and most of them involve the use of a PostScript
interpreter such as Ghostscript - see ggss(1). Yet, the easiest method
involves the use of the application ttttffttoott4422. This program uses
ffrreeeettyyppee(3) (version 1.3.1) to generate type42 font wrappers and well-
formed AFM files that can be fed to the aaffmmttooddiitt(1) script to create
appropriate metric files. The resulting font wrappers should be added
to the ddoowwnnllooaadd file. ttttffttoott4422 source code can be downloaded from
ffttpp::////wwwwww..ggiiggaa..oorr..aatt//ppuubb//nniihh//ttttffttoott4422// .
ENVIRONMENT GGRROOPPSSPPRROOLLOOGGUUEE
If this is set to foo, then ggrrooppss will use the file foo (in the
font path) instead of the default prologue file pprroolloogguuee. The
option -PP overrides this environment variable.
FILES //uussrr//sshhaarree//ggrrooffff//11..1199..11//ffoonntt//ddeevvppss//DDEESSCC
Device description file.
//uussrr//sshhaarree//ggrrooffff//11..1199..11//ffoonntt//ddeevvppss//F
Font description file for font F.
//uussrr//sshhaarree//ggrrooffff//11..1199..11//ffoonntt//ddeevvppss//ddoowwnnllooaadd
List of downloadable fonts.
//uussrr//sshhaarree//ggrrooffff//11..1199..11//ffoonntt//ddeevvppss//tteexxtt..eenncc
Encoding used for text fonts.
//uussrr//sshhaarree//ggrrooffff//11..1199..11//ttmmaacc//ppss..ttmmaacc
Macros for use with ggrrooppss; automatically loaded by ttrrooffffrrcc
//uussrr//sshhaarree//ggrrooffff//11..1199..11//ttmmaacc//ppssppiicc..ttmmaacc
Definition of PPSSPPIICC macro, automatically loaded by ppss..ttmmaacc.
//uussrr//sshhaarree//ggrrooffff//11..1199..11//ttmmaacc//ppssoolldd..ttmmaacc
Macros to disable use of characters not present in older Post-
Script printers (e.g. `eth' or `thorn').
//ttmmpp//ggrrooppssXXXXXX
Temporary file.
SEE ALSO
aaffmmttooddiitt(1), ggrrooffff(1), ttrrooffff(1), ppffbbttooppss(1), ggrrooffffoouutt(5),
ggrrooffffffoonntt(5), ggrrooffffcchhaarr(7), ggrrooffffttmmaacc(5)
Groff Version 1.19.1 31 October 2003 GROPS(1)