2 Copyright (C) 1989-2000, 2001, 2002, 2003 Free Software Foundation, Inc.
4 Permission is granted to make and distribute verbatim copies of
5 this manual provided the copyright notice and this permission notice
6 are preserved on all copies.
8 Permission is granted to copy and distribute modified versions of this
9 manual under the conditions for verbatim copying, provided that the
10 entire resulting derived work is distributed under the terms of a
11 permission notice identical to this one.
13 Permission is granted to copy and distribute translations of this
14 manual into another language, under the above conditions for modified
15 versions, except that this permission notice may be included in
16 translations approved by the Free Software Foundation instead of in
26 .\" Like TP, but if specified indent is more than half
27 .\" the current line-length - indent, use the default indent.
29 . ie \\n(.$=0:((0\\$1)*2u>(\\n(.lu-\\n(.iu)) .TP
40 . if '\\*(.T'ps' .ft \\$1
44 .TH GROPS @MAN1EXT@ "@MDATE@" "Groff Version @VERSION@"
48 grops \- PostScript driver for groff
60 .ie \\n(.$-1 .RI "[\ \fB\\$1\fP" "\%\\$2" "\ ]"
61 .el .RB "[\ " "\\$1" "\ ]"
72 .RI "[\ " files\|.\|.\|. "\ ]"
77 It is possible to have whitespace between a command line option and its
83 translates the output of GNU
89 should be invoked by using the groff command
94 .if '@DEVICE@'ps' (Actually, this is the default for groff.)
96 If no files are given,
98 will read the standard input.
104 to read the standard input.
106 PostScript output is written to the standard output.
112 options can be passed to
123 Provide workarounds for older printers, broken spoolers, and previewers.
127 produces output at PostScript LanguageLevel\~2 that conforms to the
128 Document Structuring Conventions version 3.0.
130 Some older printers, spoolers, and previewers can't handle such output.
136 does to make its output acceptable to such programs.
138 A value of\~0 will cause grops not to employ any workarounds.
142 .B %%Begin\%Document\%Setup
144 .B %%End\%Document\%Setup
145 comments should be generated;
146 this is needed for early versions of TranScript that get confused by
149 comment and the first
154 Add\~2 if lines in included files beginning with
156 should be stripped out; this is needed for Sun's pageview previewer.
165 stripped out of included files; this is needed for spoolers that
173 Add\~8 if the first line of the PostScript output should be
177 this is needed when using Sun's Newsprint with a printer that requires
181 Add\~16 if no media size information should be included in the document
182 (this is, neither use
188 This was the behaviour of groff version 1.18.1 and earlier; it is needed
189 for older printers which don't understand PostScript LanguageLevel\~2.
191 It is also necessary if the output is further processed to get an
192 encapsulated PS (EPS) file -- see below.
195 The default value can be specified by a
202 command in the DESC file.
204 Otherwise the default value is\~0.
217 to the search path for prologue, font, and device description files;
219 is the name of the device, usually
224 Guess the page length.
226 This generates PostScript code that guesses the page length.
228 The guess will be correct only if the imageable area is vertically
229 centered on the page.
231 This option allows you to generate documents that can be printed
232 both on letter (8.5\(mu11) paper and on A4 paper without change.
236 This option may be used to specify a directory to search for
237 files on the command line and files named in
242 The current directory is always searched first.
243 This option may be specified more than once;
244 the directories will be searched in the order specified.
245 No directory search is performed for files specified using an absolute path.
249 Print the document in landscape format.
253 Turn manual feed on for the document.
257 Set physical dimension of output medium.
266 file; it accepts the same arguments as the
271 .B groff_font (@MAN5EXT@)
275 .BI \-P prologue-file
278 (in the font path) as the prologue instead of the default prologue file
281 This option overrides the environment variable
286 Lines should be drawn using a thickness of
288 thousandths of an em.
289 If this option is not given, the line thickness defaults to 0.04\~em.
293 Print the version number.
297 There are styles called
303 mounted at font positions 1 to\~4.
305 The fonts are grouped into families
315 having members in each of these styles:
327 AvantGarde-BookOblique
339 AvantGarde-DemiOblique
411 Helvetica-BoldOblique
423 Helvetica-Narrow-Oblique
429 Helvetica-Narrow-Bold
435 Helvetica-Narrow-BoldOblique
441 NewCenturySchlbk-Roman
447 NewCenturySchlbk-Italic
453 NewCenturySchlbk-Bold
459 NewCenturySchlbk-BoldItalic
512 There is also the following font which is not a member of a family:
518 ZapfChancery-MediumItalic
523 There are also some special fonts called
525 for the PS Symbol font, and
527 containing slanted lowercase Greek letters taken from PS Symbol.
529 Zapf Dingbats is available as
531 and a reversed version of ZapfDingbats (with symbols pointing in the opposite
532 direction) is available as
534 most characters in these fonts are unnamed and must be accessed using
538 The default color for
542 is black; for colors defined in the `rgb' color space,
544 is used, for `cmy' and `cmyk'
550 is a PostScript LanguageLevel\~2 command and thus not available on some
555 understands various X\~commands produced using the
559 will only interpret commands that begin with a
564 .BI \[rs]X'ps:\ exec\ code '
565 This executes the arbitrary PostScript commands in
568 The PostScript currentpoint will be set to the position of the
570 command before executing
573 The origin will be at the top left corner of the page,
574 and y\~coordinates will increase down the page.
578 will be defined that converts groff units
579 to the coordinate system in effect.
589 \[rs]X'ps: exec \[rs]nx u 0 rlineto stroke'
594 will draw a horizontal line one inch long.
597 may make changes to the graphics state,
598 but any changes will persist only to the
601 A dictionary containing the definitions specified by the
605 will be on top of the dictionary stack.
607 If your code adds definitions to this dictionary,
608 you should allocate space for them using
609 .BI \[rs]X'ps\ mdef \ n '\fR.
611 Any definitions will persist only until the end of the page.
615 escape sequence with an argument that names a macro,
617 can extend over multiple lines.
628 \&\[rs]nx u 0 rlineto
636 is another way to draw a horizontal line one inch long.
640 .BI \[rs]X'ps:\ file\ name '
641 This is the same as the
643 command except that the PostScript code is read from file
647 .BI \[rs]X'ps:\ def\ code '
648 Place a PostScript definition contained in
652 There should be at most one definition per
656 Long definitions can be split over several
661 arguments are simply joined together separated by newlines.
663 The definitions are placed in a dictionary which is automatically
664 pushed on the dictionary stack when an
670 escape sequence with an argument that names a macro,
672 can extend over multiple lines.
675 .BI \[rs]X'ps:\ mdef\ n\ code '
685 needs to know how many definitions
688 so that it can create an appropriately sized PostScript dictionary
692 .BI \[rs]X'ps:\ import\ file\ llx\ lly\ urx\ ury\ width\ \fR[\fP\ height\ \fR]\fP '
693 Import a PostScript graphic from
702 give the bounding box of the graphic in the default PostScript
703 coordinate system; they should all be integers;
707 are the x and y\~coordinates of the lower left
708 corner of the graphic;
712 are the x and y\~coordinates of the upper right corner of the graphic;
716 are integers that give the desired width and height in groff
717 units of the graphic.
719 The graphic will be scaled so that it has this width and height
720 and translated so that the lower left corner of the graphic is
721 located at the position associated with
725 If the height argument is omitted it will be scaled uniformly in the
726 x and y\~directions so that it has the specified width.
728 Note that the contents of the
730 command are not interpreted by
732 so vertical space for the graphic is not automatically added,
737 arguments are not allowed to have attached scaling indicators.
739 If the PostScript file complies with the Adobe Document Structuring
740 Conventions and contains a
742 comment, then the bounding box can be automatically
743 extracted from within groff by using the
749 .BR groff_tmac (@MAN5EXT@)
750 for a description of the
752 macro which provides a convenient high-level interface for inclusion of
756 .B \[rs]X'ps:\ invis'
758 .B \[rs]X'ps:\ endinvis'
759 No output will be generated for text and drawing commands
760 that are bracketed with these
764 These commands are intended for use when output from
766 will be previewed before being processed with
768 if the previewer is unable to display certain characters
769 or other constructs, then other substitute characters or constructs
770 can be used for previewing by bracketing them with these
778 is not able to display a proper
780 character because the standard X11 fonts do not provide it;
781 this problem can be overcome by executing the following
787 \&.char \[rs](em \[rs]X'ps: invis'\[rs]
788 \[rs]Z'\[rs]v'-.25m'\[rs]h'.05m'\[rs]D'l .9m 0'\[rs]h'.05m''\[rs]
789 \[rs]X'ps: endinvis'\[rs](em
796 will be unable to display the
798 character and will draw the line,
804 and ignore the line (this code is already in file
806 which will be loaded if a documented intended for
815 must be in the format output by
816 .BR @g@troff (@MAN1EXT@).
819 .BR groff_out (@MAN5EXT@).
822 In addition, the device and font description files for the device used
823 must meet certain requirements.
825 The device and font description files supplied for
827 device meet all these requirements.
829 .BR afmtodit (@MAN1EXT@)
830 can be used to create font files from AFM files.
832 The resolution must be an integer multiple of\~72 times the
837 device uses a resolution of 72000 and a sizescale of 1000.
840 The device description file must contain a valid paper size; see
841 .BR groff_font (@MAN5EXT@)
842 for more information.
845 Each font description file must contain a command
847 .BI internalname\ psname
849 which says that the PostScript name of the font is
852 It may also contain a command
854 .BI encoding\ enc_file
857 the PostScript font should be reencoded using the encoding described in
859 this file should consist of a sequence of lines of the form:
866 is the PostScript name of the character,
869 is its position in the encoding expressed as a decimal integer; valid
870 values are in the range 0 to\~255.
874 and blank lines are ignored.
876 The code for each character given in the font file must correspond
877 to the code for the character in encoding file, or to the code in the default
878 encoding for the font if the PostScript font is not to be reencoded.
880 This code can be used with the
884 to select the character,
885 even if the character does not have a groff name.
887 Every character in the font file must exist in the PostScript font, and
888 the widths given in the font file must match the widths used
889 in the PostScript font.
892 will assume that a character with a groff name of
894 is blank (makes no marks on the page);
895 it can make use of such a character to generate more efficient and
896 compact PostScript output.
901 is able to display all glyphs in a PostScript font, not only 256.
903 (or the default encoding if no encoding file specified) just defines the
904 order of glyphs for the first 256 characters; all other glyphs are
905 accessed with additional encoding vectors which
911 can automatically include the downloadable fonts necessary
912 to print the document.
913 Such fonts must be in PFA format.
915 .BR pfbtops (@MAN1EXT@)
916 to convert a Type\~1 font in PFB format.
917 Any downloadable fonts which should, when required, be included by
919 must be listed in the file
920 .BR @FONTDIR@/devps/download ;
921 this should consist of lines of the form
930 is the PostScript name of the font,
933 is the name of the file containing the font;
936 and blank lines are ignored;
937 fields may be separated by tabs or spaces;
939 will be searched for using the same mechanism that is used
940 for groff font metric files.
944 file itself will also be searched for using this mechanism;
945 currently, only the first found file in the font path is used.
948 If the file containing a downloadable font or imported document
949 conforms to the Adobe Document Structuring Conventions,
952 will interpret any comments in the files sufficiently to ensure that its
953 own output is conforming.
955 It will also supply any needed font resources that are listed in the
958 as well as any needed file resources.
960 It is also able to handle inter-resource dependencies.
962 For example, suppose that you have a downloadable font called Garamond,
963 and also a downloadable font called Garamond-Outline
964 which depends on Garamond
965 (typically it would be defined to copy Garamond's font dictionary,
966 and change the PaintType),
967 then it is necessary for Garamond to appear before Garamond-Outline
968 in the PostScript document.
971 will handle this automatically
972 provided that the downloadable font file for Garamond-Outline
973 indicates its dependence on Garamond by means of
974 the Document Structuring Conventions,
975 for example by beginning with the following lines
979 %!PS-Adobe-3.0 Resource-Font
982 %%DocumentNeededResources: font Garamond
988 %%IncludeResource: font Garamond
991 In this case both Garamond and Garamond-Outline would need to be listed
996 A downloadable font should not include its own name in a
997 .B %%Document\%Supplied\%Resources
1003 .B %%Document\%Fonts
1007 .BR %%Document\%Needed\%Resources ,
1008 .BR %%Document\%Supplied\%Resources ,
1009 .BR %%Include\%Resource ,
1010 .BR %%Begin\%Resource ,
1014 (or possibly the old
1015 .BR %%Document\%Needed\%Fonts ,
1016 .BR %%Document\%Supplied\%Fonts ,
1017 .BR %%Include\%Font ,
1025 .SS Encapsulated PostScript
1027 itself doesn't emit bounding box information.
1029 With the help of GhostScript the following commands will produce an
1030 encapsulated PS file
1037 groff -P-b16 foo > foo.ps
1040 gs -dNOPAUSE -sDEVICE=bbox -- foo.ps 2> foo.bbox
1043 cat foo.ps | sed \-e '/%%Orientation/rfoo.bbx' > foo.eps
1052 TrueType fonts can be used with
1054 if converted first to
1056 format, an especial PostScript wrapper equivalent to the
1057 PFA format mentioned in
1058 .BR pfbtops (@MAN1EXT@).
1059 There are several different methods to generate a type42
1060 wrapper and most of them involve the use of a PostScript
1061 interpreter such as Ghostscript \(em see
1063 Yet, the easiest method involves the use of the application
1067 (version 1.3.1) to generate type42
1068 font wrappers and well-formed AFM files that can be fed to
1070 .BR afmtodit (@MAN1EXT@)
1071 script to create appropriate metric files.
1072 The resulting font wrappers should be added to the
1076 source code can be downloaded from
1077 .URL ftp://\:www.giga.or.at/\:pub/\:nih/\:ttftot42/ \
1078 ftp://\:www.giga.or.at/\:pub/\:nih/\:ttftot42/ .
1091 (in the font path) instead of the default prologue file
1096 overrides this environment variable.
1100 .Tp \w'\fB@FONTDIR@/devps/download'u+2n
1101 .B @FONTDIR@/devps/DESC
1102 Device description file.
1105 .BI @FONTDIR@/devps/ F
1106 Font description file for font
1110 .B @FONTDIR@/devps/download
1111 List of downloadable fonts.
1114 .B @FONTDIR@/devps/text.enc
1115 Encoding used for text fonts.
1118 .B @MACRODIR@/ps.tmac
1121 automatically loaded by
1125 .B @MACRODIR@/pspic.tmac
1129 automatically loaded by
1133 .B @MACRODIR@/psold.tmac
1134 Macros to disable use of characters not present in older
1135 PostScript printers (e.g. `eth' or `thorn').
1138 .BI /tmp/grops XXXXXX
1143 .BR afmtodit (@MAN1EXT@),
1144 .BR groff (@MAN1EXT@),
1145 .BR @g@troff (@MAN1EXT@),
1146 .BR pfbtops (@MAN1EXT@),
1147 .BR groff_out (@MAN5EXT@),
1148 .BR groff_font (@MAN5EXT@),
1149 .BR groff_char (@MAN7EXT@),
1150 .BR groff_tmac (@MAN5EXT@)
1154 .\" Local Variables: