GROPS

NAME

SYNOPSIS

DESCRIPTION

OPTIONS

-cn

Print n copies of each page.

-l

Print the document in landscape format.

-Fdir

Search the directory dir/devname for font and device description files; name is the name of the device, usually ps.

-wn

Lines should be drawn using a thickness of n thousandths of an em.

-v

Print the version number.

USAGE

AR

AvantGarde-Book

AI

AvantGarde-BookOblique

AB

AvantGarde-Demi

ABI

AvantGarde-DemiOblique

BMR

Bookman-Light

BMI

Bookman-LightItalic

BMB

Bookman-Demi

BMBI

Bookman-DemiItalic

CR

Courier

CI

Courier-Oblique

CB

Courier-Bold

CBI

Courier-BoldOblique

HR

Helvetica

HI

Helvetica-Oblique

HB

Helvetica-Bold

HBI

Helvetica-BoldOblique

HNR

Helvetica-Narrow

HNI

Helvetica-Narrow-Oblique

HNB

Helvetica-Narrow-Bold

HNBI

Helvetica-Narrow-BoldOblique

NR

NewCenturySchlbk-Roman

NI

NewCenturySchlbk-Italic

NB

NewCenturySchlbk-Bold

NBI

NewCenturySchlbk-BoldItalic

PR

Palatino-Roman

PI

Palatino-Italic

PB

Palatino-Bold

PBI

Palatino-BoldItalic

TR

Times-Roman

TI

Times-Italic

TB

Times-Bold

TBI

Times-BoldItalic

There is also the following font which is not a member of a family:

ZCMI

ZapfChancery-MediumItalic

There are also some special fonts called SS and S. Zapf Dingbats is avilable as ZD and a reversed version of ZapfDingbats (with symbols pointing in the opposite direction) is available as ZDR; most characters in these fonts are unnamed and must be accessed using \N.

grops understands various X commands produced using the \X escape sequence; grops will only interpret commands that begin with a ps: tag.

\X'ps: exec code'

This executes the arbitrary PostScript commands in code. The PostScript currentpoint will be set to the position of the \X 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 u will be defined that converts groff units to the coordinate system in effect. For example,

.nr x 1i
\X'ps: exec \nx u 0 rlineto stroke'

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. Any definitions will also persist only until the end of the page. If you use the \Y escape sequence with an argument that names a macro, code can extend over multiple lines. For example,

.nr x 1i
.de y
ps: exec
\nx u 0 rlineto
stroke
..
\Yy

is another way to draw a horizontal line one inch long.

\X'ps: file name'

This is the same as the exec command except that the PostScript code is read from file name.

\X'ps: def code'

Place a PostScript definition contained in code in the prologue. There should be at most one definition per \X command. Long definitions can be split over several \X 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 exec command is executed. If you use the \Y escape sequence with an argument that names a macro, code can extend over multiple lines.

\X'ps: mdef n code'

Like def, except that code may contain up to n definitions. grops needs to know how many definitions code contains so that it can create an apppropriately sized PostScript dictionary to contain them.

\X'ps: import 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 \X 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 \X command are not interpreted by gtroff; 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 complies with the Adobe Document Structuring Conventions and contains a %%BoundingBox comment, then the bounding box can be automatically extracted from within groff by using the sy request to run the psbb command.

The -mps macros (which are automatically loaded when grops is run by the groff command) include a PSPIC macro which allows a picture to be easily imported. This has the format

.PSPIC file [width [height]]

file is the name of the file containing the illustration; width and height give the desired width and height of the graphic. The width and height arguments may have scaling indicators attached; the default scaling indicator is i. This macro will scale the graphic uniformly in the x and y directions so that it is no more than width wide and height high.

The input to grops must be in the format output by gtroff(@MAN1EXT@). This is described in groff_out(@MAN1EXT@). In addition the device and font description files for the device used must meet certain requirements. The device and font description files supplied for ps device meet all these requirements. afmtodit(@MAN1EXT@) can be used to create font files from AFM files. The resolution must be an integer multiple of 72 times the sizescale. The ps device uses a resolution of 72000 and a sizescale of 1000. The device description file should contain a command

paperlength n

which says that output should be generated which is suitable for printing on a page whose length is n machine units. Each font description file must contain a command

internalname psname

which says that the PostScript name of the font is psname. It may also contain a command

encoding enc_file

which says that the PostScript font should be reencoded using the encoding described in enc_file; 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. The code for each character given in the font file must correspond 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 \N escape sequence in gtroff to select the character, even if the character does not have a groff name. Every character in the font file must exist in the PostScript font, and the widths given in the font file must match the widths used in the PostScript font. grops will assume that a character with a groff name of space is blank (makes no marks on the page); it can make use of such a character to generate more efficient and compact PostScript output.

grops can automatically include the downloadable fonts necessary to print the document. Any downloadable fonts which should, when required, be included by grops must be listed in the file @FONTDIR@/devps/download; 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 download file itself will also be searched for using this mechanism.

If a file imported with the \X import command complies with the Adobe Document Structuring Conventions, then grops will include any fonts that are needed by the imported file and are listed in the download file.

grops is also able to handle inter-font dependencies. Any downloadable font that depends on another font must indicate this by following the Structuring Conventions and listing the fonts on which it depends in the %%DocumentFonts comment. For example, suppose that you have a downloadable font called Garamond, and also a downloadable font called Garamond-Outline which depends on Garamond (typically it would be defined to copy Garamond's font dictionary, and change the PaintType), then the downloadable font file for Garamond-Outline should start like this

%!PS-Adobe-2.1
%%DocumentFonts: Garamond

grops will then ensure that whenever Garamond-Outline is included, Garamond is included before it. In this case both Garamond and Garamond-Outline would need to be listed in the download file. A downloadable font should list every font that it depends on even if that font is resident in the printer (like, for example, Symbol); this will enable grops to generate a correct %%DocumentFonts comment for its output; the font should not include its own name in the %%DocumentFonts comment.  

FILES

@FONTDIR@/devps/DESC

Device desciption file.

@FONTDIR@/devps/F

Font description file for font F.

@FONTDIR@/devps/download

List of downloadable fonts.

@FONTDIR@/devps/text.enc

Encoding used for text fonts.

@MACRODIR@/tmac.ps

Macros for use with grops.

/tmp/gropsXXXXXX

Temporary file.

SEE ALSO

Index

NAME

SYNOPSIS

DESCRIPTION

OPTIONS

USAGE

FILES

SEE ALSO