2 Copyright (C) 1989-2000, 2001, 2002 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
23 .\" Like TP, but if specified indent is more than half
24 .\" the current line-length - indent, use the default indent.
26 .ie \\n(.$=0:((0\\$1)*2u>(\\n(.lu-\\n(.iu)) .TP
31 .TH GROPS @MAN1EXT@ "@MDATE@" "Groff Version @VERSION@"
35 grops \- PostScript driver for groff
47 .ie \\n(.$-1 .RI "[\ \fB\\$1\fP" "\%\\$2" "\ ]"
48 .el .RB "[\ " "\\$1" "\ ]"
58 .RI "[\ " files\|.\|.\|. "\ ]"
63 It is possible to have whitespace between a command line option and its
69 translates the output of GNU
75 should be invoked by using the groff command
80 .if '@DEVICE@'ps' (Actually, this is the default for groff.)
82 If no files are given,
84 will read the standard input.
90 to read the standard input.
92 PostScript output is written to the standard output.
98 options can be passed to
109 Workaround broken spoolers and previewers.
113 produces output that conforms
114 the Document Structuring Conventions version 3.0.
116 Unfortunately some spoolers and previewers can't handle such output.
122 does to its output acceptable to such programs.
124 A value of\~0 will cause grops not to employ any workarounds.
127 .B %%BeginDocumentSetup
129 .B %%EndDocumentSetup
130 comments should be generated;
131 this is needed for early versions of TranScript that get confused by
134 comment and the first
138 Add\~2 if lines in included files beginning with
140 should be stripped out; this is needed for Sun's pageview previewer.
148 stripped out of included files; this is needed for spoolers that
155 Add\~8 if the first line of the PostScript output should be
159 this is needed when using Sun's Newsprint with a printer that requires
162 The default value can be specified by a
169 command in the DESC file.
171 Otherwise the default value is\~0.
184 to the search path for prologue, font, and device description files;
186 is the name of the device, usually
191 Guess the page length.
193 This generates PostScript code that guesses the page length.
195 The guess will be correct only if the imageable area is vertically
196 centered on the page.
198 This option allows you to generate documents that can be printed
199 both on letter (8.5\(mu11) paper and on A4 paper without change.
203 Print the document in landscape format.
207 Turn manual feed on for the document.
211 Set physical dimension of output medium.
219 file; it accepts the same arguments as the
224 .BI \-P prologue-file
227 (in the font path) as the prologue instead of the default prologue file
230 This option overrides the environment variable
235 Lines should be drawn using a thickness of
237 thousandths of an em.
238 If this option is not given, the line thickness defaults to 0.04\~em.
242 Print the version number.
246 There are styles called
252 mounted at font positions 1 to\~4.
254 The fonts are grouped into families
264 having members in each of these styles:
267 .if '\\*(.T'ps' .ft \\$1
280 AvantGarde-BookOblique
292 AvantGarde-DemiOblique
364 Helvetica-BoldOblique
376 Helvetica-Narrow-Oblique
382 Helvetica-Narrow-Bold
388 Helvetica-Narrow-BoldOblique
394 NewCenturySchlbk-Roman
400 NewCenturySchlbk-Italic
406 NewCenturySchlbk-Bold
412 NewCenturySchlbk-BoldItalic
465 There is also the following font which is not a member of a family:
471 ZapfChancery-MediumItalic
476 There are also some special fonts called
481 Zapf Dingbats is available as
483 and a reversed version of ZapfDingbats (with symbols pointing in the opposite
484 direction) is available as
486 most characters in these fonts are unnamed and must be accessed using
490 The default color for
494 is black; for colors defined in the `rgb' color space,
496 is used, for `cmy' and `cmyk'
503 understands various X\~commands produced using the
507 will only interpret commands that begin with a
512 .BI \[rs]X'ps:\ exec\ code '
513 This executes the arbitrary PostScript commands in
516 The PostScript currentpoint will be set to the position of the
518 command before executing
521 The origin will be at the top left corner of the page,
522 and y\~coordinates will increase down the page.
526 will be defined that converts groff units
527 to the coordinate system in effect.
537 \[rs]X'ps: exec \[rs]nx u 0 rlineto stroke'
542 will draw a horizontal line one inch long.
545 may make changes to the graphics state,
546 but any changes will persist only to the
549 A dictionary containing the definitions specified by the
553 will be on top of the dictionary stack.
555 If your code adds definitions to this dictionary,
556 you should allocate space for them using
557 .BI \[rs]X'ps\ mdef \ n '\fR.
559 Any definitions will persist only until the end of the page.
563 escape sequence with an argument that names a macro,
565 can extend over multiple lines.
576 \&\[rs]nx u 0 rlineto
584 is another way to draw a horizontal line one inch long.
588 .BI \[rs]X'ps:\ file\ name '
589 This is the same as the
591 command except that the PostScript code is read from file
595 .BI \[rs]X'ps:\ def\ code '
596 Place a PostScript definition contained in
600 There should be at most one definition per
604 Long definitions can be split over several
609 arguments are simply joined together separated by newlines.
611 The definitions are placed in a dictionary which is automatically
612 pushed on the dictionary stack when an
618 escape sequence with an argument that names a macro,
620 can extend over multiple lines.
623 .BI \[rs]X'ps:\ mdef\ n\ code '
633 needs to know how many definitions
636 so that it can create an appropriately sized PostScript dictionary
640 .BI \[rs]X'ps:\ import\ file\ llx\ lly\ urx\ ury\ width\ \fR[\fP\ height\ \fR]\fP '
641 Import a PostScript graphic from
650 give the bounding box of the graphic in the default PostScript
651 coordinate system; they should all be integers;
655 are the x and y\~coordinates of the lower left
656 corner of the graphic;
660 are the x and y\~coordinates of the upper right corner of the graphic;
664 are integers that give the desired width and height in groff
665 units of the graphic.
667 The graphic will be scaled so that it has this width and height
668 and translated so that the lower left corner of the graphic is
669 located at the position associated with
673 If the height argument is omitted it will be scaled uniformly in the
674 x and y\~directions so that it has the specified width.
676 Note that the contents of the
678 command are not interpreted by
680 so vertical space for the graphic is not automatically added,
685 arguments are not allowed to have attached scaling indicators.
687 If the PostScript file complies with the Adobe Document Structuring
688 Conventions and contains a
690 comment, then the bounding box can be automatically
691 extracted from within groff by using the
699 macros (which are automatically loaded when
701 is run by the groff command) include a
703 macro which allows a picture to be easily imported.
707 \&\fB.PSPIC\fP [\fB\-L\fP|\fB-R\fP|\fB\-I\fP \fIn\fP]\ \fI\|file\fP [\fIwidth\fP [\fIheight\fP]]
711 is the name of the file containing the illustration;
715 give the desired width and height of the graphic.
721 arguments may have scaling indicators attached;
722 the default scaling indicator is\~\c
725 This macro will scale the graphic uniformly
726 in the x and y\~directions so that it is no more than
733 By default, the graphic will be horizontally centered.
739 cause the graphic to be left-aligned and right-aligned
744 option causes the graphic to be indented by\~\c
749 .B \[rs]X'ps:\ invis'
753 .B \[rs]X'ps:\ endinvis'
754 No output will be generated for text and drawing commands
755 that are bracketed with these
759 These commands are intended for use when output from
761 will be previewed before being processed with
763 if the previewer is unable to display certain characters
764 or other constructs, then other substitute characters or constructs
765 can be used for previewing by bracketing them with these
773 is not able to display a proper
775 character because the standard X11 fonts do not provide it;
776 this problem can be overcome by executing the following
782 \&.char \[rs](em \[rs]X'ps: invis'\[rs]
783 \[rs]Z'\[rs]v'-.25m'\[rs]h'.05m'\[rs]D'l .9m 0'\[rs]h'.05m''\[rs]
784 \[rs]X'ps: endinvis'\[rs](em
791 will be unable to display the
793 character and will draw the line,
805 must be in the format output by
806 .BR @g@troff (@MAN1EXT@).
809 .BR groff_out (@MAN5EXT@).
811 In addition the device and font description files for the device used
812 must meet certain requirements.
814 The device and font description files supplied for
816 device meet all these requirements.
818 .BR afmtodit (@MAN1EXT@)
819 can be used to create font files from AFM files.
821 The resolution must be an integer multiple of\~72 times the
826 device uses a resolution of 72000 and a sizescale of 1000.
828 The device description file should contain a command
832 which says that output should be generated which is suitable for
833 printing on a page whose length is
837 Common values are 792000 for letter paper and 841890 for paper in A4 format.
839 Alternatively, it can contain
841 .BI papersize\ string
843 to specify a paper size; see
844 .BR groff_font (@MAN5EXT@)
845 for more information.
847 Each font description file must contain a command
849 .BI internalname\ psname
851 which says that the PostScript name of the font is
854 It may also contain a command
856 .BI encoding\ enc_file
859 the PostScript font should be reencoded using the encoding described in
861 this file should consist of a sequence of lines of the form:
868 is the PostScript name of the character,
871 is its position in the encoding expressed as a decimal integer.
875 and blank lines are ignored.
877 The code for each character given in the font file must correspond
878 to the code for the character in encoding file, or to the code in the default
879 encoding for the font if the PostScript font is not to be reencoded.
881 This code can be used with the
885 to select the character,
886 even if the character does not have a groff name.
888 Every character in the font file must exist in the PostScript font, and
889 the widths given in the font file must match the widths used
890 in the PostScript font.
893 will assume that a character with a groff name of
895 is blank (makes no marks on the page);
896 it can make use of such a character to generate more efficient and
897 compact PostScript output.
901 can automatically include the downloadable fonts necessary
902 to print the document.
904 Any downloadable fonts which should, when required, be included by
906 must be listed in the file
907 .BR @FONTDIR@/devps/download ;
908 this should consist of lines of the form
917 is the PostScript name of the font,
920 is the name of the file containing the font;
923 and blank lines are ignored;
924 fields may be separated by tabs or spaces;
926 will be searched for using the same mechanism that is used
927 for groff font metric files.
931 file itself will also be searched for using this mechanism;
932 currently, only the first found file in the font path is used.
935 If the file containing a downloadable font or imported document
936 conforms to the Adobe Document Structuring Conventions,
939 will interpret any comments in the files sufficiently to ensure that its
940 own output is conforming.
942 It will also supply any needed font resources that are listed in the
945 as well as any needed file resources.
947 It is also able to handle inter-resource dependencies.
949 For example, suppose that you have a downloadable font called Garamond,
950 and also a downloadable font called Garamond-Outline
951 which depends on Garamond
952 (typically it would be defined to copy Garamond's font dictionary,
953 and change the PaintType),
954 then it is necessary for Garamond to be appear before Garamond-Outline
955 in the PostScript document.
958 will handle this automatically
959 provided that the downloadable font file for Garamond-Outline
960 indicates its dependence on Garamond by means of
961 the Document Structuring Conventions,
962 for example by beginning with the following lines
966 %!PS-Adobe-3.0 Resource-Font
969 %%DocumentNeededResources: font Garamond
975 %%IncludeResource: font Garamond
978 In this case both Garamond and Garamond-Outline would need to be listed
983 A downloadable font should not include its own name in a
984 .B %%DocumentSuppliedResources
994 .BR %%DocumentNeededResources ,
995 .BR %%DocumentSuppliedResources ,
996 .BR %%IncludeResource ,
1001 (or possibly the old
1002 .BR %%DocumentNeededFonts ,
1003 .BR %%DocumentSuppliedFonts ,
1013 TrueType fonts can be used with
1015 if converted first to
1017 format, an especial PostScript wrapper equivalent to the
1018 PFA format mentioned in
1019 .BR pfbtops (@MAN1EXT@).
1020 There are several different methods to generate a type42
1021 wrapper and most of them involve the use of a PostScript
1022 interpreter such as Ghostscript \(em see
1024 Yet, the easiest method involves the use of the application
1028 (version 1.3.1) to generate type42
1029 font wrappers and well-formed AFM files that can be fed to
1031 .BR afmtodit (@MAN1EXT@)
1032 script to create appropriate metric files.
1033 The resulting font wrappers should be added to the
1037 source code can be downloaded from
1038 .URL ftp://\:www.giga.or.at/\:pub/\:nih/\:ttftot42/ \
1039 ftp://\:www.giga.or.at/\:pub/\:nih/\:ttftot42/ .
1052 (in the font path) instead of the default prologue file
1057 overrides this environment variable.
1061 .Tp \w'\fB@FONTDIR@/devps/download'u+2n
1062 .B @FONTDIR@/devps/DESC
1063 Device description file.
1066 .BI @FONTDIR@/devps/ F
1067 Font description file for font
1071 .B @FONTDIR@/devps/download
1072 List of downloadable fonts.
1075 .B @FONTDIR@/devps/text.enc
1076 Encoding used for text fonts.
1079 .B @MACRODIR@/ps.tmac
1082 automatically loaded by
1086 .B @MACRODIR@/pspic.tmac
1090 automatically loaded by
1094 .B @MACRODIR@/psold.tmac
1095 Macros to disable use of characters not present in older
1096 PostScript printers (e.g. `eth' or `thorn').
1099 .BI /tmp/grops XXXXXX
1104 .BR afmtodit (@MAN1EXT@),
1105 .BR groff (@MAN1EXT@),
1106 .BR @g@troff (@MAN1EXT@),
1107 .BR psbb (@MAN1EXT@),
1108 .BR groff_out (@MAN5EXT@),
1109 .BR groff_font (@MAN5EXT@),
1110 .BR groff_char (@MAN7EXT@)
1112 .\" Local Variables: