summaryrefslogtreecommitdiff
path: root/src/devices/grops/grops.man
blob: d60c221b2ce921bc51fb0c1a39eb8045e6bf4373 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
.ig
Copyright (C) 1989-2006, 2008-2011
  Free Software Foundation, Inc.

Permission is granted to make and distribute verbatim copies of
this manual provided the copyright notice and this permission notice
are preserved on all copies.

Permission is granted to copy and distribute modified versions of this
manual under the conditions for verbatim copying, provided that the
entire resulting derived work is distributed under the terms of a
permission notice identical to this one.

Permission is granted to copy and distribute translations of this
manual into another language, under the above conditions for modified
versions, except that this permission notice may be included in
translations approved by the Free Software Foundation instead of in
the original English.
..
.
.
.\" Like TP, but if specified indent is more than half
.\" the current line-length - indent, use the default indent.
.de Tp
.  ie \\n(.$=0:((0\\$1)*2u>(\\n(.lu-\\n(.iu)) .TP
.  el .TP "\\$1"
..
.
.de FT
.  if '\\*(.T'ps' .ft \\$1
.  if '\\*(.T'pdf' .ft \\$1
..
.
.
.TH GROPS @MAN1EXT@ "@MDATE@" "Groff Version @VERSION@"
.
.
.SH NAME
.
grops \- PostScript driver for groff
.
.
.SH SYNOPSIS
.
.SY grops
.OP \-glmv
.OP \-b n
.OP \-c n
.OP \-F dir
.OP \-I dir
.OP \-p papersize
.OP \-P prologue
.OP \-w n
.RI [ files
.IR .\|.\|. ]
.YS
.
.
.SH DESCRIPTION
.
.B grops
translates the output of GNU
.B troff
to PostScript.
.
Normally
.B grops
should be invoked by using the groff command
with a
.B \-Tps
option.
.
.if '@DEVICE@'ps' (Actually, this is the default for groff.)
.
If no files are given,
.B grops
reads the standard input.
.
A filename of
.B \-
also causes
.B grops
to read the standard input.
.
PostScript output is written to the standard output.
.
When
.B grops
is run by
.B groff
options can be passed to
.B grops
using
.BR groff 's
.B \-P
option.
.
.LP
Note that
.B grops
doesn't produce a valid document structure (conforming to the Document
Structuring Convention) if called with multiple file arguments.
.
To print such concatenated output it is necessary to deactivate DSC
handling in the printing program or previewer.
.
See section
.B FONT INSTALLATION
below for a guide how to install fonts for
.BR grops .
.
.
.SH OPTIONS
.LP
It is possible to have whitespace between a command line option and its
parameter.
.
.
.TP
.BI \-b n
Provide workarounds for older printers, broken spoolers, and previewers.
.
Normally
.B grops
produces output at PostScript LanguageLevel\~2 that conforms to the
Document Structuring Conventions version 3.0.
.
Some older printers, spoolers, and previewers can't handle such output.
.
The value of\~\c
.I n
controls what
.B grops
does to make its output acceptable to such programs.
.
A value of\~0 causes grops not to employ any workarounds.
.
.IP
Add\~1 if no
.B %%Begin\%Document\%Setup
and
.B %%End\%Document\%Setup
comments should be generated;
this is needed for early versions of TranScript that get confused by
anything between the
.B %%End\%Prolog
comment and the first
.B %%Page
comment.
.
.IP
Add\~2 if lines in included files beginning with
.B %!\&
should be stripped out; this is needed for Sun's pageview previewer.
.
.IP
Add\~4 if
.BR %%Page ,
.BR %%Trailer
and
.B %%End\%Prolog
comments should be
stripped out of included files; this is needed for spoolers that
don't understand the
.B %%Begin\%Document
and
.B %%End\%Document
comments.
.
.IP
Add\~8 if the first line of the PostScript output should be
.B %!PS-Adobe-2.0
rather than
.BR %!PS-Adobe-3.0 ;
this is needed when using Sun's Newsprint with a printer that requires
page reversal.
.
.IP
Add\~16 if no media size information should be included in the document
(this is, neither use
.B %%Document\%Media
nor the
.B setpagedevice
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
encapsulated PS (EPS) file \[en] see below.
.
.IP
The default value can be specified by a
.
.RS
.IP
.BI broken\  n
.
.LP
command in the DESC file.
.
Otherwise the default value is\~0.
.RE
.
.TP
.BI \-c n
Print
.I n
copies of each page.
.
.TP
.BI \-F dir
Prepend directory
.IB dir /dev name
to the search path for prologue, font, and device description files;
.I name
is the name of the device, usually
.BR ps .
.
.TP
.BI \-g
Guess the page length.
.
This generates PostScript code that guesses the page length.
.
The guess is 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.5\[mu]11) paper and on A4 paper without change.
.
.TP
.BI \-I dir
This option may be used to add a directory to the search path for
files on the command line and files named in
.B \[rs]X'ps: import'
and
.B \[rs]X'ps: file'
escapes.
.
The search path is initialized with the current directory.
.
This option may be specified more than once; the directories are then
searched in the order specified (but before the current directory).
.
If you want to make the current directory be read before other directories,
add
.B \-I.\&
at the appropriate place.
.
.IP
No directory search is performed for files with an absolute file name.
.
.TP
.B \-l
Print the document in landscape format.
.
.TP
.B \-m
Turn manual feed on for the document.
.
.TP
.BI \-p paper-size
Set physical dimension of output medium.
.
This overrides the
.BR papersize ,
.BR paperlength ,
and
.B paperwidth
commands in the
.B DESC
file; it accepts the same arguments as the
.B papersize
command.
.
See
.B groff_font (@MAN5EXT@)
for details.
.
.TP
.BI \-P prologue-file
Use the file
.I prologue-file
(in the font path) as the prologue instead of the default prologue file
.BR prologue .
.
This option overrides the environment variable
.SM GROPS_PROLOGUE.
.
.TP
.BI \-w n
Lines should be drawn using a thickness of
.IR n \~\c
thousandths of an em.
.
If this option is not given, the line thickness defaults to 0.04\~em.
.
.TP
.B \-v
Print the version number.
.
.
.SH USAGE
.
The input to
.B grops
must be in the format output by
.BR @g@troff (@MAN1EXT@).
.
This is described in
.BR groff_out (@MAN5EXT@).
.
.LP
In addition, the device and font description files for the device used
must meet certain requirements:
.
The resolution must be an integer multiple of\~72 times the
.BR sizescale .
.
The
.B ps
device uses a resolution of 72000 and a sizescale of 1000.
.
.LP
The device description file must contain a valid paper size; see
.BR groff_font (@MAN5EXT@)
for more information.
.
.LP
Each font description file must contain a command
.IP
.BI internalname\  psname
.LP
which says that the PostScript name of the font is
.IR psname .
.
It may also contain a command
.IP
.BI encoding\  enc_file
.LP
which says that
the PostScript font should be reencoded using the encoding described in
.IR enc_file ;
this file should consist of a sequence of lines of the form:
.IP
.I
pschar code
.LP
where
.I pschar
is the PostScript name of the character,
and
.I code
is its position in the encoding expressed as a decimal integer; valid
values are in the range 0 to\~255.
.
Lines starting with
.B #
and blank lines are ignored.
.
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
.B \[rs]N
escape sequence in
.B troff
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.
.
.B grops
assumes that a character with a groff name of
.B 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.
.
.LP
Note that
.B grops
is able to display all glyphs in a PostScript font, not only 256.
.I enc_file
(or the default encoding if no encoding file specified) just defines the
order of glyphs for the first 256 characters; all other glyphs are
accessed with additional encoding vectors which
.B grops
produces on the fly.
.
.LP
.B grops
can automatically include the downloadable fonts necessary
to print the document.
.
Such fonts must be in PFA format.
.
Use
.BR \%pfbtops (@MAN1EXT@)
to convert a Type\~1 font in PFB format.
.
Any downloadable fonts which should, when required, be included by
.B grops
must be listed in the file
.BR @FONTDIR@/devps/download ;
this should consist of lines of the form
.
.IP
.I
font filename
.
.LP
where
.I font
is the PostScript name of the font,
and
.I filename
is the name of the file containing the font;
lines beginning with
.B #
and blank lines are ignored;
fields may be separated by tabs or spaces;
.I filename
is searched for using the same mechanism that is used
for groff font metric files.
.
The
.B download
file itself is also searched for using this mechanism;
currently, only the first found file in the font path is used.
.
.LP
If the file containing a downloadable font or imported document
conforms to the Adobe Document Structuring Conventions,
then
.B grops
interprets any comments in the files sufficiently to ensure that its
own output is conforming.
.
It also supplies any needed font resources that are listed in the
.B download
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 Garamond
(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.
.
.B grops
handles this automatically
provided that the downloadable font file for Garamond-Outline
indicates its dependence on Garamond by means of
the Document Structuring Conventions,
for example by beginning with the following lines
.
.IP
.B
%!PS-Adobe-3.0 Resource-Font
.br
.B
%%DocumentNeededResources: font Garamond
.br
.B
%%EndComments
.br
.B
%%IncludeResource: font Garamond
.
.LP
In this case both Garamond and Garamond-Outline would need to be listed
in the
.B download
file.
.
A downloadable font should not include its own name in a
.B %%Document\%Supplied\%Resources
comment.
.
.LP
.B grops
does not interpret
.B %%Document\%Fonts
comments.
.
The
.BR %%Document\%Needed\%Resources ,
.BR %%Document\%Supplied\%Resources ,
.BR %%Include\%Resource ,
.BR %%Begin\%Resource ,
and
.BR %%End\%Resource
comments
(or possibly the old
.BR %%Document\%Needed\%Fonts ,
.BR %%Document\%Supplied\%Fonts ,
.BR %%Include\%Font ,
.BR %%Begin\%Font ,
and
.BR %%End\%Font
comments)
should be used.
.
.LP
In the default setup
there are styles called
.BR R ,
.BR I ,
.BR B ,
and
.B BI
mounted at font positions 1 to\~4.
.
The fonts are grouped into families
.BR A ,
.BR BM ,
.BR C ,
.BR H ,
.BR HN ,
.BR N ,
.BR P ,
and\~\c
.B T
having members in each of these styles:
.
.RS
.TP
.B AR
.FT AR
AvantGarde-Book
.FT
.
.TQ
.B AI
.FT AI
AvantGarde-BookOblique
.FT
.
.TQ
.B AB
.FT AB
AvantGarde-Demi
.FT
.
.TQ
.B ABI
.FT ABI
AvantGarde-DemiOblique
.FT
.
.TQ
.B BMR
.FT BMR
Bookman-Light
.FT
.
.TQ
.B BMI
.FT BMI
Bookman-LightItalic
.FT
.
.TQ
.B BMB
.FT BMB
Bookman-Demi
.FT
.
.TQ
.B BMBI
.FT BMBI
Bookman-DemiItalic
.FT
.
.TQ
.B CR
.FT CR
Courier
.FT
.
.TQ
.B CI
.FT CI
Courier-Oblique
.FT
.
.TQ
.B CB
.FT CB
Courier-Bold
.FT
.
.TQ
.B CBI
.FT CBI
Courier-BoldOblique
.FT
.
.TQ
.B HR
.FT HR
Helvetica
.FT
.
.TQ
.B HI
.FT HI
Helvetica-Oblique
.FT
.
.TQ
.B HB
.FT HB
Helvetica-Bold
.FT
.
.TQ
.B HBI
.FT HBI
Helvetica-BoldOblique
.FT
.
.TQ
.B HNR
.FT HNR
Helvetica-Narrow
.FT
.
.TQ
.B HNI
.FT HNI
Helvetica-Narrow-Oblique
.FT
.
.TQ
.B HNB
.FT HNB
Helvetica-Narrow-Bold
.FT
.
.TQ
.B HNBI
.FT HNBI
Helvetica-Narrow-BoldOblique
.FT
.
.TQ
.B NR
.FT NR
NewCenturySchlbk-Roman
.FT
.
.TQ
.B NI
.FT NI
NewCenturySchlbk-Italic
.FT
.
.TQ
.B NB
.FT NB
NewCenturySchlbk-Bold
.FT
.
.TQ
.B NBI
.FT NBI
NewCenturySchlbk-BoldItalic
.FT
.
.TQ
.B PR
.FT PR
Palatino-Roman
.FT
.
.TQ
.B PI
.FT PI
Palatino-Italic
.FT
.
.TQ
.B PB
.FT PB
Palatino-Bold
.FT
.
.TQ
.B PBI
.FT PBI
Palatino-BoldItalic
.FT
.
.TQ
.B TR
.FT TR
Times-Roman
.FT
.
.TQ
.B TI
.FT TI
Times-Italic
.FT
.
.TQ
.B TB
.FT TB
Times-Bold
.FT
.
.TQ
.B TBI
.FT TBI
Times-BoldItalic
.FT
.RE
.
.LP
There is also the following font which is not a member of a family:
.
.RS
.TP
.B ZCMI
.FT ZCMI
ZapfChancery-MediumItalic
.FT
.RE
.
.LP
There are also some special fonts called
.B S
for the PS Symbol font, and
.BR SS ,
containing slanted lowercase Greek letters taken from PS Symbol.
.
Zapf Dingbats is available as
.BR ZD ,
and a reversed version of ZapfDingbats (with symbols pointing in the opposite
direction) is available as
.BR ZDR ;
most characters in these fonts are unnamed and must be accessed using
.BR \[rs]N .
.
.LP
The default color for
.B \[rs]m
and
.B \[rs]M
is black; for colors defined in the `rgb' color space
.B setrgbcolor
is used, for `cmy' and `cmyk'
.BR setcmykcolor ,
and for `gray'
.BR setgray .
.
Note that
.B setcmykcolor
is a PostScript LanguageLevel\~2 command and thus not available on some
older printers.
.
.LP
.B grops
understands various X\~commands produced using the
.B \[rs]X
escape sequence;
.B grops
only interprets commands that begin with a
.B ps:
tag.
.
.TP
.BI \[rs]X'ps:\ exec\  code '
This executes the arbitrary PostScript commands in
.IR code .
.
The PostScript currentpoint is set to the position of the
.B \[rs]X
command before executing
.IR code .
.
The origin is at the top left corner of the page,
and y\~coordinates increase down the page.
.
A procedure\~\c
.B u
is defined that converts groff units
to the coordinate system in effect (provided the user doesn't change the
scale).
.
For example,
.
.RS
.IP
.B
\&.nr x 1i
.br
.B
\[rs]X'ps: exec \[rs]nx u 0 rlineto stroke'
.br
.RE
.
.IP
draws a horizontal line one inch long.
.
.I code
may make changes to the graphics state,
but any changes persist only to the end of the page.
.
A dictionary containing the definitions specified by the
.B def
and
.B mdef
is on top of the dictionary stack.
.
If your code adds definitions to this dictionary,
you should allocate space for them using
.BI \[rs]X'ps\ mdef \ n '\fR.
.
Any definitions persist only until the end of the page.
.
If you use the
.B \[rs]Y
escape sequence with an argument that names a macro,
.I code
can extend over multiple lines.
.
For example,
.
.RS
.IP
.nf
.ft B
\&.nr x 1i
\&.de y
\&ps: exec
\&\[rs]nx u 0 rlineto
\&stroke
\&..
\&\[rs]Yy
.ft R
.fi
.
.LP
is another way to draw a horizontal line one inch long.
.
Note the single backslash before `nx' \[en] the only reason to use a number
register while defining the macro `y' is to convert a user-specified
dimension `1i' to internal groff units which are in turn converted to PS
units with the
.B u
procedure.
.
.LP
.B grops
wraps user-specified PostScript code into a dictionary, nothing more.
.
In particular, it doesn't start and end the inserted code with
.B save
and
.BR restore ,
respectively.
.
This must be supplied by the user, if necessary.
.
.RE
.
.TP
.BI \[rs]X'ps:\ file\  name '
This is the same as the
.B exec
command except that the PostScript code is read from file
.IR name .
.
.TP
.BI \[rs]X'ps:\ def\  code '
Place a PostScript definition contained in
.I code
in the prologue.
.
There should be at most one definition per
.B \[rs]X
command.
.
Long definitions can be split over several
.B \[rs]X
commands;
all the
.I 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
.B exec
command is executed.
.
If you use the
.B \[rs]Y
escape sequence with an argument that names a macro,
.I code
can extend over multiple lines.
.
.TP
.BI \[rs]X'ps:\ mdef\  n\ code  '
Like
.BR def ,
except that
.I code
may contain up to
.IR n \~\c
definitions.
.
.B grops
needs to know how many definitions
.I code
contains
so that it can create an appropriately sized PostScript dictionary
to contain them.
.
.TP
.BI \[rs]X'ps:\ import\  file\ llx\ lly\ urx\ ury\ width\ \fR[\fP\ height\ \fR]\fP '
Import a PostScript graphic from
.IR file .
.
The arguments
.IR llx ,
.IR lly ,
.IR urx ,
and
.I ury
give the bounding box of the graphic in the default PostScript
coordinate system; they should all be integers;
.I llx
and
.I lly
are the x and y\~coordinates of the lower left
corner of the graphic;
.I urx
and
.I ury
are the x and y\~coordinates of the upper right corner of the graphic;
.I width
and
.I height
are integers that give the desired width and height in groff
units of the graphic.
.
.IP
The graphic is 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
.B \[rs]X
command.
.
If the height argument is omitted it is scaled uniformly in the
x and y\~directions so that it has the specified width.
.
.IP
Note that the contents of the
.B \[rs]X
command are not interpreted by
.BR troff ;
so vertical space for the graphic is not automatically added,
and the
.I width
and
.I height
arguments are not allowed to have attached scaling indicators.
.
.IP
If the PostScript file complies with the Adobe Document Structuring
Conventions and contains a
.B %%Bounding\%Box
comment, then the bounding box can be automatically
extracted from within groff by using the
.B psbb
request.
.
.IP
See
.BR groff_tmac (@MAN5EXT@)
for a description of the
.B PSPIC
macro which provides a convenient high-level interface for inclusion of
PostScript graphics.
.
.TP
.B \[rs]X'ps:\ invis'
.TQ
.B \[rs]X'ps:\ endinvis'
No output is generated for text and drawing commands
that are bracketed with these
.B \[rs]X
commands.
.
These commands are intended for use when output from
.B troff
is previewed before being processed with
.BR grops ;
if the previewer is unable to display certain characters
or other constructs, then other substitute characters or constructs
can be used for previewing by bracketing them with these
.B \[rs]X
commands.
.
.RS
.LP
For example,
.B \%gxditview
is not able to display a proper
.B \[rs](em
character because the standard X11 fonts do not provide it;
this problem can be overcome by executing the following
request
.
.IP
.ft B
.nf
\&.char \[rs](em \[rs]X'ps: invis'\[rs]
\[rs]Z'\[rs]v'-.25m'\[rs]h'.05m'\[rs]D'l .9m 0'\[rs]h'.05m''\[rs]
\[rs]X'ps: endinvis'\[rs](em
.ft
.fi
.
.LP
In this case,
.B \%gxditview
is unable to display the
.B \[rs](em
character and draws the line,
whereas
.B grops
prints the
.B \[rs](em
character
and ignores the line (this code is already in file
.B Xps.tmac
which is loaded if a document intended for
.B grops
is previewed with
.BR \%gxditview ).
.RE
.
.LP
If a PostScript procedure
.B BPhook
has been defined via a
.RB ` ps:\ def '
or
.RB ` ps:\ mdef '
device command, it is executed at the beginning
of every page (before anything is drawn or written by groff).
For example, to underlay the page contents with the word
`DRAFT' in light gray, you might use
.RS
.LP
.nf
.ft B
\&.de XX
ps: def
/BPhook
{ gsave .9 setgray clippath pathbbox exch 2 copy
  .5 mul exch .5 mul translate atan rotate pop pop
  /NewCenturySchlbk-Roman findfont 200 scalefont setfont
  (DRAFT) dup stringwidth pop \-.5 mul \-70 moveto show
  grestore }
def
\&..
\&.devicem XX
.ft R
.fi
.RE
.LP
Or, to cause lines and polygons to be drawn with square linecaps
and mitered linejoins instead of the round linecaps and linejoins
normally used by
.BR grops ,
use
.RS
.LP
.nf
.ft B
\&.de XX
ps: def
/BPhook { 2 setlinecap 0 setlinejoin } def
\&..
\&.devicem XX
.ft R
.fi
.RE
.LP
(square linecaps, as opposed to butt linecaps (0 setlinecap),
give true corners in boxed tables even though the lines are
drawn unconnected).
.
.
.SS Encapsulated PostScript
.B grops
itself doesn't emit bounding box information.
.
With the help of Ghostscript the following simple script,
.BR groff2eps ,
produces an encapsulated PS file.
.
.RS
.LP
.nf
.ft B
#! /bin/sh
groff \-P\-b16 $1 >$1.ps
gs \-dNOPAUSE \-sDEVICE=bbox \-\- $1.ps 2>$1.bbox
cat $1.ps \[rs]
| sed \-e "/\[ha]%%Orientation/r$1.bbox" \[rs]
      \-e "/\[ha]%!PS-Adobe-3.0/s/$/ EPSF-3.0/" >$1.eps
rm $1.ps $1.bbox
.ft R
.fi
.RE
.
.LP
Just say
.
.IP
.B
groff2eps foo
.
.LP
to convert file
.B foo
to
.BR foo.eps .
.
.
.SS TrueType and other font formats
TrueType fonts can be used with
.B grops
if converted first to
.B "Type\~42"
format, a special PostScript wrapper equivalent to the
PFA format mentioned in
.BR \%pfbtops (@MAN1EXT@).
.
There are several different methods to generate a type42
wrapper and most of them involve the use of a PostScript
interpreter such as Ghostscript \[en] see
.BR gs (1).
.
.LP
Yet, the easiest method involves the use of the application
.BR ttftot42 (1).
.
This program uses
.BR freetype (3)
(version 1.3.1) to generate type42
font wrappers and well-formed AFM files that can be fed to
the
.BR \%afmtodit (@MAN1EXT@)
script to create appropriate metric files.
.
The resulting font wrappers should be added to the
.B download
file.
.B ttftot42
source code can be downloaded from
.UR ftp://\:www.giga.or.at/\:pub/\:nih/\:ttftot42/
ftp://\:www.giga.or.at/\:pub/\:nih/\:ttftot42/
.UE .
.
.LP
Another solution for creating type42 wrappers is to use FontForge,
available from
.UR http://\:fontforge.sf.net
http://\:fontforge.sf.net
.UE .
This font editor can convert most outline font formats.
.
.
.SH FONT INSTALLATION
.
This section gives a summary of the above explanations; it can serve
as a step-by-step font installation guide for
.BR grops .
.
.ds BU \[bu]\ \ \"
.de LI
.IP "" 4
\h'-\w'\*[BU]'u'\*[BU]\c
..
.LI
Convert your font to something groff understands.
.
This is either a PostScript Type\~1 font in PFA format or a
PostScript Type\~42 font, together with an AFM file.
.
.IP
The very first characters in a PFA file look like this:
.
.RS
.IP
.B %!PS-AdobeFont-1.0:
.RE
.
.IP
A PFB file has this also in the first line, but the string is
preceded with some binary bytes.
.
.IP
The very first characters in a Type\~42 font file look like this:
.
.RS
.IP
.B %!PS-TrueTypeFont
.RE
.
.IP
This is a wrapper format for TrueType fonts.
.
Old PS printers might not support it (this is, they don't have a
built-in TrueType font interpreter).
.
.IP
If your font is in PFB format (such fonts normally have `.pfb' as
the file extension), you might use groff's
.BR \%pfbtops (@MAN1EXT@)
program to convert it to PFA.
.
For TrueType fonts, try
.B ttftot42
or
.BR fontforge .
For all other font formats use
.B fontforge
which can convert most outline font formats.
.
.LI
Convert the AFM file to a groff font description file with the
.BR \%afmtodit (@MAN1EXT@)
program.
.
An example call is
.
.RS
.IP
afmtodit Foo-Bar-Bold.afm textmap FBB
.RE
.
.IP
which converts the metric file `Foo-Bar-Bold.afm' to the groff
font `FBB'.
.
If you have a font family which comes with normal, bold, italic,
and bold italic faces, it is recommended to use the letters
.BR R ,
.BR B ,
.BR I ,
and
.BR BI ,
respectively, as postfixes in the groff font names to make groff's
`.fam' request work.
.
An example is groff's built-in Times-Roman font: The font family name
is
.BR T ,
and the groff font names are
.BR TR ,
.BR TB ,
.BR TI ,
and
.BR TBI .
.
.LI
Install both the groff font description files and the fonts in a
`devps' subdirectory of the font path which groff finds.
.
See the
.B ENVIRONMENT
section in the
.BR troff (@MAN1EXT@)
man page which lists the actual value of the font path.
.
Note that groff doesn't use the AFM files (but it is a good idea to
store them anyway).
.
.LI
Register all fonts which must be downloaded to the printer in the
`devps/download' file.
.
Only the first occurrence of this file in the font path is read.
.
This means that you should copy the default `download' file to the
first directory in your font path and add your fonts there.
.
To continue the above example we assume that the PS font name for
Foo-Bar-Bold.pfa is `XY-Foo-Bar-Bold' (the PS font name is stored in the
.B internalname
field in the `FBB' file), thus the following line should be added to
`download'.
.
.RS
.IP
.B XY-Foo-Bar-Bold Foo-Bar-Bold.pfa
.
.RE
.
.
.SH OLD FONTS
.
groff versions 1.19.2 and earlier contain a slightly different set of
the 35 Adobe core fonts; the difference is mainly the lack of the `Euro'
glyph and a reduced set of kerning pairs.
.
For backwards compatibility, these old fonts are installed also in the
.
.IP
.BR @OLDFONTDIR@/devps
.
.LP
directory.
.
.LP
To use them, make sure that
.B grops
finds the fonts before the default system fonts (with the same names):
Either add command line option
.B \-F
to
.B grops
.
.IP
.B groff \-Tps \-P\-F \-P@OLDFONTDIR@ .\|.\|.
.
.LP
or add the directory to groff's font path environment variable
.
.IP
.B GROFF_FONT_PATH=@OLDFONTDIR@
.
.
.SH ENVIRONMENT
.
.TP
.SM
.B GROPS_PROLOGUE
If this is set to
.IR foo ,
then
.B grops
uses the file
.I foo
(in the font path) instead of the default prologue file
.BR prologue .
.
The option
.B \-P
overrides this environment variable.
.
.
.TP
.SM
.B GROFF_FONT_PATH
A list of directories in which to search for the
.BI dev name
directory in addition to the default ones.
.
See
.BR @g@troff (@MAN1EXT@)
and
.BR \%groff_font (@MAN5EXT@)
for more details.
.
.
.SH FILES
.
.Tp \w'\fB@FONTDIR@/devps/download'u+2n
.B @FONTDIR@/devps/DESC
Device description file.
.
.TP
.BI @FONTDIR@/devps/ F
Font description file for font
.IR F .
.
.TP
.B @FONTDIR@/devps/download
List of downloadable fonts.
.
.TP
.B @FONTDIR@/devps/text.enc
Encoding used for text fonts.
.
.TP
.B @MACRODIR@/ps.tmac
Macros for use with
.BR grops ;
automatically loaded by
.BR troffrc
.
.TP
.B @MACRODIR@/pspic.tmac
Definition of
.B PSPIC
macro,
automatically loaded by
.BR ps.tmac .
.
.TP
.B @MACRODIR@/psold.tmac
Macros to disable use of characters not present in older
PostScript printers (e.g., `eth' or `thorn').
.
.TP
.BI /tmp/grops XXXXXX
Temporary file.
See
.BR groff (@MAN1EXT@)
for details on the location of temporary files.
.
.
.SH "SEE ALSO"
.
.BR \%afmtodit (@MAN1EXT@),
.BR groff (@MAN1EXT@),
.BR @g@troff (@MAN1EXT@),
.BR \%pfbtops (@MAN1EXT@),
.BR \%groff_out (@MAN5EXT@),
.BR \%groff_font (@MAN5EXT@),
.BR \%groff_char (@MAN7EXT@),
.BR \%groff_tmac (@MAN5EXT@)
.
.LP
.UR http://\:partners.adobe.com/\:public/\:developer/\:en/\:ps/\:5001.DSC_Spec.pdf
PostScript Language Document Structuring Conventions Specification
.UE
.
.
.\" Local Variables:
.\" mode: nroff
.\" End: