summaryrefslogtreecommitdiffstats
path: root/upstream/opensuse-leap-15-6/man1/gropdf.1
blob: eebba8a16bb02b1842d94a1a57c5024f016a3bd4 (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
.TH GROPDF 1 "7 February 2022" "groff 1.22.4"
.SH NAME
gropdf \- PDF driver for groff
.
.
.\" Save and disable compatibility mode (for, e.g., Solaris 10/11).
.do nr gropdf_C \n[.C]
.cp 0
.
.
.\" ====================================================================
.\" Legal Terms
.\" ====================================================================
.\"
.\" Copyright (C) 2011-2018 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.
.
.
.de FT
.  if '\\*(.T'ps' .ft \\$1
.  if '\\*(.T'pdf' .ft \\$1
..
.
.\" ====================================================================
.SH SYNOPSIS
.\" ====================================================================
.
.SY gropdf
.OP \-dels
.OP \-F dir
.OP \-I dir
.OP \-p paper-size
\#.OP \-w n
.RB [ \-u
.RI [ cmapfile ]]
.OP \-y foundry
.RI [ file
\&.\|.\|.\&]
.YS
.
.SY gropdf
.B \-v
.SY gropdf
.B \-\-version
.YS
.
.\" ====================================================================
.SH DESCRIPTION
.\" ====================================================================
.
.B gropdf
translates the output of GNU
.B troff
to PDF.
.
Normally
.B gropdf
should be invoked by using the groff command
with a
.B \-Tpdf
option.
.
If no files are given,
.B gropdf
reads the standard input.
.
A filename of
.B \-
also causes
.B gropdf
to read the standard input.
.
PDF output is written to the standard output.
.
When
.B gropdf
is run by
.B groff
options can be passed to
.B gropdf
using
.BR groff 's
.B \-P
option.
.
.
.LP
See section \[lq]Font Installation\[rq] below for a guide how to install
fonts for
.BR gropdf .
.
.
.\" ====================================================================
.SH OPTIONS
.\" ====================================================================
.
Whitespace is permitted between a command-line option and its argument.
.
.
.TP
.B \-d
Include debug information as comments within the PDF.
.
Also produces an uncompressed PDF.
.
.
.TP
.B \-e
Forces
.B gropdf
to embed
.I all
fonts (even the 14 base PDF fonts).
.
.
.TP
.BI \-F " dir"
Prepend directory
.IR dir /dev name
to the search path for font, and device description files;
.I name
is the name of the device, usually
.BR pdf .
.
.TP
.BI \-I " dir"
This option may be used to add a directory to the search path for
files named in
.B \[rs]X'pdf: pdfpic'
escape.
.
The current directory is always searched first.
.
This option may be specified more than once; the directories are then
searched in the order specified.
.
.IP
No directory search is performed for files with an absolute file name.
.
.TP
.B \-l
Orient the document in landscape format.
.
.TP
.BI \-p " paper-size"
Set physical dimension of output medium.
.
This overrides the
.BR papersize ,
.BR paperlength ,
and
.B paperwidth
commands in the
.I DESC
file; it accepts the same arguments as the
.B papersize
command.
.
See
.BR groff_font (5)
for details.
.
.
.TP
.B \-s
Append a comment line to end of PDF showing statistics,
i.e.\& number of pages in document.
.
Ghostscript's
.B ps2pdf
complains about this line if it is included, but works anyway.
.
.
.TP
.B \-u\c
.RI " [" cmapfile ]
.B Gropdf
normally includes a ToUnicode CMap with any font created using
.I text.enc
as the encoding file,
this makes it easier to search for words which contain ligatures.
.
You can include your own CMap by specifying a
.I cmapfile
or have no CMap at all by omitting the argument.
.
.
.TP
.B \-v
.TQ
.B \-\-version
Print the version number and exit.
.
.
.\" .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
.BI \-y " foundry"
Set the foundry to use for selecting fonts of the same name.
.
.
.\" ====================================================================
.SH USAGE
.\" ====================================================================
.
The input to
.B gropdf
must be in the format output by
.BR troff (1).
.
This is described in
.BR groff_out (5).
.
.
.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 pdf
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 (5)
for more information.
.
.B gropdf
uses the same Type\~1 Adobe PostScript fonts as the
.B grops
device driver.
.
Although the PDF Standard allows the use of other font types (like
TrueType) this implementation only accepts the Type\~1 PostScript
font.
.
Fewer Type\~1 fonts are supported natively in PDF documents than the
standard 35 fonts supported by
.B grops
and all PostScript printers, but all the fonts are available since any
which aren't supported natively are automatically embedded in the
PDF.
.
.
.LP
.B gropdf
supports the concept of foundries, that is different versions of basically
the same font.
.
During install a
.I Foundry
file controls where fonts are found and builds
.B groff
fonts from the files it discovers on your system.
.
.
.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 .
.
Lines starting with
.B #
and blank lines are ignored.
.
The code for each character given in the font file must correspond
to the code in the default encoding for the font.
.
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.
.
.
.LP
Note that
.B gropdf
is currently only able to display the first 256 glyphs in any font.
This restriction will be lifted in a later version.
.
.
.\" .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 gropdf
can automatically include the downloadable fonts necessary
to print the document.
.
Fonts may be in PFA or PFB format.
.LP
.
Any downloadable fonts which should, when required, be included by
.B gropdf
must be listed in the file
.IR /usr/\:share/\:groff/\:1.22.4/\:font/devpdf/download ;
this should consist of lines of the form
.
.IP
.I
foundry font filename
.
.LP
where
.I foundry
is the foundry name or blank for the default foundry.
.
.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 must be separated by tabs
(spaces are
.B not
allowed);
.I filename
is searched for using the same mechanism that is used
for groff font metric files.
.
The
.I download
file itself is also searched for using this mechanism;
currently, only the first found file in the font path is used.
.
Foundry names are usually a single character (such as \[oq]U\[cq] for
the URW Foundry) or blank for the default foundry.
.
This default uses the same fonts as
.B ghostscript
uses when it embeds fonts in a PDF file.
.
.
.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.
.
The lower case greek characters are automatically slanted (to match
the SymbolSlanted font (SS) available to PostScript).
.
Zapf Dingbats is available as
.BR ZD ,
the "hand pointing left" glyph (\[rs][lh]) is available since it has
been defined using the \[rs]X'pdf: xrev' extension which reverses the
direction of letters within words.
.
.
.LP
The default color for
.B \[rs]m
and
.B \[rs]M
is black.
.
.LP
.B gropdf
understands some of the X\~commands produced using the
.B \[rs]X
escape sequences supported by
.B grops.
Specifically, the following is supported.
.
.TP
.B "\[rs]X'ps: invis'"
Suppress output.
.
.TP
.B "\[rs]X'ps: endinvis'"
Stop suppressing output.
.
.TP
.B "\[rs]X'ps: exec gsave currentpoint 2 copy translate \fIn\fP rotate neg exch neg exch translate'"
where
.I n
is the angle of rotation.
This is to support the
.I align
command in
.BR gpic .
.
.TP
.B "\[rs]X'ps: exec grestore'"
Again used by
.B gpic
to restore after rotation.
.
.TP
.BI "\[rs]X'ps: exec " "n " "setlinejoin'"
where
.I n
can be one of the following values.
.IP
0 = Miter join
.br
1 = Round join
.br
2 = Bevel join
.
.TP
.BI "\[rs]X'ps: exec " "n " "setlinecap'"
where
.I n
can be one of the following values.
.IP
0 = Butt cap
.br
1 = Round cap, and
.br
2 = Projecting square cap
.
.
.LP
.TP
.B "\[rs]X'ps: ... pdfmark'"
All the
.I pdfmark
macros installed by using
.I \-m pdfmark
or
.I \-m mspdf
(see documentation in
.IR pdfmark.pdf ).
.
A subset of these macros are installed automatically when you use
.B \-Tpdf
so you should not need to use \[oq]\-m pdfmark\[cq] for using most of
the PDF functionality.
.
.LP
.B gropdf
also supports a subset of the commands introduced in present.tmac.
Specifically it supports:-
.IP
PAUSE
.br
BLOCKS
.br
BLOCKE
.
.LP
Which allows you to create presentation type PDFs.
Many of the other
commands are already available in other macro packages.
.LP
These commands are implemented with
.B groff
X commands:-
.LP
.TP
.B "\[rs]X'ps: exec %%%%PAUSE"
The section before this is treated as a block and is introduced using the
current BLOCK transition setting (see \[oq]pdf: transition\[cq] below).
This command
can be introduced using the macro
.BR .pdfpause .
.TP
.B "\[rs]X'ps: exec %%%%BEGINONCE"
Any text following this command (up to %%%%ENDONCE) is shown only once,
the next %%%%PAUSE will remove it.
If producing a non presentation pdf, i.e.\&
ignoring the pauses, see
.I \%GROPDF_NOSLIDE
below, this text is ignored.
.LP
.TP
.B "\[rs]X'ps: exec %%%%ENDONCE"
This terminates the block defined by %%%%BEGINONCE.
This pair of commands
is what implements the .BLOCKS Once/.BLOCKE commands in present.tmac.
.LP
The
.B mom
macro set already has integration with these extensions so you can build
slides with
.BR mom .
.LP
If you use present.tmac with
.B gropdf
there is no need to run the program
.BR presentps (1)
since the output will already be a presentation pdf.
.LP
All other
.B ps:
tags are silently ignored.
.
.
.LP
One
.B \[rs]X
special used by the DVI driver is also recognised:
.
.TP
.BI \[rs]X'papersize= paper-size '
where the
.I paper-size
parameter is the same as the
.B papersize
command.
.
See
.BR groff_font (5)
for details.
.
This means that you can alter the page size at will within the PDF file
being created by
.BR gropdf .
.
If you do want to change the paper size, it must be done before you start
creating the page.
.
.LP
In addition,
.B gropdf
supports its own suite of
.B pdf:
tags.
.
The following tags are supported:
.
.TP
.BI "\[rs]X'pdf: pdfpic " "file alignment width height line-length" '
Place an image of the specified
.I width
containing the PDF drawing from file
.I file
of desired
.I width
and
.I height
(if
.I height
is missing or zero then it is scaled proportionally).
.
If
.I alignment
is
.B \-L
the drawing is left aligned.
.
If it is
.B \-C
or
.B \-R
a
.I linelength
greater than the width of the drawing is required as well.
.
If
.I width
is specified as zero then the width is scaled in proportion to the height.
.
.\" .IP
.\" See
.\" .BR groff_tmac (7)
.\" for a description of the
.\" .B PSPIC
.\" macro which provides a convenient high-level interface for inclusion of
.\" PostScript graphics.
.
.TP
.B \[rs]X'pdf: xrev'
This toggles a flag which reverses the direction of printing
.IR "letter by letter" ,
i.e., each separate letter is reversed, not the entire word.
.
This is useful for reversing the direction of glyphs in the Dingbats font.
.
To return to normal printing repeat the command again.
.
.TP
.BI "\[rs]X'pdf: markstart " "/ANN definition" '
The macros which support PDF Bookmarks use this call internally to
start the definition of bookmark hotspot (user will have called
\[oq].pdfhref\~L\[cq] with the text which will become the \[oq]hot
spot\[cq] region).
.
Normally this is never used except from within the pdfmark macros.
.
.TP
.B \[rs]X'pdf: markend'
The macros which support PDF Bookmarks use this call internally to
stop the definition of bookmark hotspot (user will have called
\[oq].pdfhref\~L\[cq] with the text which will become the \[oq]hot
spot\[cq] region).
.
Normally this is never used except from within the pdfmark macros.
.
.TP
.B \[rs]X'pdf: marksuspend'
.TQ
.B \[rs]X'pdf: markrestart'
If you are using page traps to produce headings, footings, etc., you
need to use these in case a \[oq]hot spot\[cq] crosses a page
boundary, otherwise any text output by the heading or footing macro
will be marked as part of the \[oq]hot spot\[cq].
.
To stop this happening just place \[oq].pdfmarksuspend\[cq] and
\[oq].pdfmarkrestart\[cq] at the start and end of the page trap macro,
respectively.
.
(These are just convenience macros which emit the \[rs]X code.
.
These macros must only be used within page traps.)
.
.TP
.BR "\[rs]X'pdf: transition'" "feature mode duration dimension motion direction scale bool"
where
.IP
.I feature
can be either SLIDE or BLOCK.
When it is SLIDE the transition is used
when a new slide is introduced to the screen, if BLOCK then this transition
is used for the individual blocks which make up the slide.
.br
.I mode
is the transition type between slides:-
.RS
.IP
.B Split
- Two lines sweep across the screen, revealing the new page.
The lines
may be either horizontal or vertical and may move inward from the
edges of the page or outward from the center, as specified by the
.I dimension
and
.I motion
entries, respectively.
.br
.B Blinds
- Multiple lines, evenly spaced across the screen, synchronously
sweep in the same direction to reveal the new page.
The lines may be
either horizontal or vertical, as specified by the
.I dimension
 entry.
Horizontal
lines move downward; vertical lines move to the right.
.br
.B Box
- A rectangular box sweeps inward from the edges of the page or
outward from the center, as specified by the
.I motion
entry, revealing the new page.
.br
.B Wipe
- A single line sweeps across the screen from one edge to the other in
the direction specified by the
.I direction
entry, revealing the new page.
.br
.B Dissolve
- The old page dissolves gradually to reveal the new one.
.br
.B Glitter
- Similar to Dissolve, except that the effect sweeps across the page in a
wide band moving from one side of the screen to the other in the
direction specified by the
.I direction
entry.
.br
.B R
- The new page simply replaces the old one with no special transition
effect; the
.I direction
entry shall be ignored.
.br
.B Fly
- (PDF 1.5) Changes are flown out or in (as specified by
.IR motion ),
in the
direction specified by
.IR direction ,
to or from a location that is offscreen except
when
.I direction
is
.BR None .
.br
.B Push
- (PDF 1.5) The old page slides off the screen while the new page
slides in, pushing the old page out in the direction specified by
.IR direction .
.br
.B Cover
- (PDF 1.5) The new page slides on to the screen in the direction
specified by
.IR direction ,
covering the old page.
.br
.B Uncover
- (PDF 1.5) The old page slides off the screen in the direction
specified by
.IR direction ,
uncovering the new page in the direction
specified by
.IR direction .
.br
.B Fade
- (PDF 1.5) The new page gradually becomes visible through the
old one.
.LP
.RE
.IP
.I duration
is the length of the transition in seconds (default 1).
.LP
.IP
.I dimension
(Optional;
.BR Split " and " Blinds
transition styles only) The dimension in which the
specified transition effect shall occur:
.B H
Horizontal, or
.B V
Vertical.
.LP
.IP
.I motion
(Optional;
.BR Split ,
.BR Box " and " Fly
transition styles only) The direction of motion for
the specified transition effect:
.B I
Inward from the edges of the page, or
.B O
Outward from the center of the page.
.LP
.IP
.I direction
(Optional;
.BR Wipe ,
.BR Glitter ,
.BR Fly ,
.BR Cover ,
.BR Uncover " and " Push
transition styles only)
The direction in which the specified transition effect shall moves, expressed in
degrees counterclockwise starting from a left-to-right direction.
If the value is a number, it shall be one of:
.B 0
= Left to right,
.B 90
= Bottom to top (Wipe only),
.B 180
= Right to left (Wipe only),
.B 270
= Top to bottom,
.B 315
= Top-left to bottom-right (Glitter only)
The value can be
.BR None ,
which is relevant only for the
.B Fly
transition when the value of
.I scale
is not 1.0.
.LP
.IP
.I scale
(Optional; PDF 1.5;
.B Fly
transition style only) The starting or ending scale at
which the changes shall be drawn.
If
.I motion
specifies an inward transition, the scale
of the changes drawn shall progress from
.I scale
to 1.0 over the course of the
transition.
If
.I motion
specifies an outward transition, the scale of the changes drawn
shall progress from 1.0 to
.I scale
over the course of the transition
.LP
.IP
.I bool
(Optional; PDF 1.5;
.B Fly
transition style only) If
.BR true ,
the area that shall be flown
in is rectangular and opaque.
.LP
.IP
This command can be used by calling the macro
.B .pdftransition
using the parameters described above.
Any of the parameters may be
replaced with a "." which signifies the parameter retains its
previous value, also any trailing missing parameters are ignored.
.LP
.IP
.B Note:
not all PDF Readers support any or all these transitions.
.LP
.
.\" ====================================================================
.SS Importing graphics
.\" ====================================================================
.
.B gropdf
only supports importing other PDF files as graphics.
.
But that PDF file may contain any of the graphic formats supported by
the PDF standard (such as JPEG, PNG, GIF, etc.).
.
So any application which outputs PDF can be used as an embedded file
in
.BR gropdf .
.
The PDF file you wish to insert must be a single page and the drawing
must just fit inside the media size of the PDF file.
.
So, in
.BR inkscape (1)
or
.BR gimp (1)
(for example) make sure the canvas size just fits the image.
.
.
.LP
The PDF parser used in
.B gropdf
has not been rigorously tested with all possible applications which
produce PDFs.
.
If you find a single page PDF which fails to import properly, it is
worth running it through the
.
.BR pdftk (1)
program by issuing the command:
.
.
.RS
.LP
.B pdftk
.I oldfile.pdf
.B output
.I newfile.pdf
.RE
.
.
.LP
You may find that
.I newfile.pdf
will now load successfully.
.
.
.\" ====================================================================
.SS TrueType and other font formats
.\" ====================================================================
.
.B gropdf
does not support any other fonts except Adobe Type 1 (PFA or PFB).
.
.
.\" ====================================================================
.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 gropdf .
.
.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 either PFA or PFB,
together with an AFM file.
.
.IP
The very first line in a PFA/PFB file contains 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.
.
.LI
Convert the AFM file to a groff font description file with the
.BR \%afmtodit (1)
program.
.
An example call is
.
.RS
.IP
afmtodit Foo\-Bar\-Bold.afm map/textmap FBB
.RE
.
.IP
which converts the metric file \[oq]Foo\-Bar\-Bold.afm\[cq] to the groff
font \[oq]FBB\[cq].
.
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
\[oq].fam\[cq] 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
\[oq]devpdf\[cq] subdirectory of the font path which groff finds.
.
See section \[lq]Environment\[rq] in
.BR troff (1)
for 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
.I devpdf/download
file.
.
Only the first occurrence of this file in the font path is read.
.
This means that you should copy the default
.I 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 \[oq]XY\-Foo\-Bar\-Bold\[cq] (the PS font name is
stored in the
.B internalname
field in the
.I FBB
file) and belongs to foundry \[oq]F\[cq]
thus the following line should be added to
.IR download :
.
.RS
.IP
.B F XY\-Foo\-Bar\-Bold Foo\-Bar\-Bold.pfa
.
.
.LP
Use a tab character to separate the fields, and the \[oq]foundry\[cq]
field should be null for the default foundry.
.RE
.
.
.\" ====================================================================
.SH ENVIRONMENT
.\" ====================================================================
.
.TP
.I GROFF_FONT_PATH
A list of directories in which to search for the
.IR dev name
directory in addition to the default ones.
.
If, in the
.I download
file,
the font file has been specified with a full path,
no directories are searched.
.
See
.BR troff (1)
and
.BR \%groff_font (5)
for more details.
.
.
.TP
.I GROPDF_NOSLIDE
If this is set true,
.B gropdf
will ignore all commands which produce a presentation pdf,
and produce a normal pdf instead.
.TP
.I SOURCE_DATE_EPOCH
A timestamp (expressed as seconds since the Unix epoch) to use as the
creation timestamp in place of the current time.
.
.
.\" ====================================================================
.SH FILES
.\" ====================================================================
.
.TP
.I /usr/\:share/\:groff/\:1.22.4/\:font/devpdf/DESC
Device description file.
.
.TP
.IR /usr/\:share/\:groff/\:1.22.4/\:font/devpdf/ F
Font description file for font\~\c
.IR F .
.
.TP
.IR /usr/\:share/\:groff/\:1.22.4/\:font/devpdf/ U\-F
Font description file for font\~\c
.I F
(using foundry\~\c
.I U
rather than the default foundry).
.
.TP
.I /usr/\:share/\:groff/\:1.22.4/\:font/devpdf/download
List of downloadable fonts.
.
.TP
.I /usr/\:share/\:groff/\:1.22.4/\:font/devpdf/Foundry
A Perl script used during install to locate suitable fonts.
.
.TP
.I /usr/\:share/\:groff/\:1.22.4/\:font/devpdf/enc/text.enc
Encoding used for text fonts.
.
.TP
.I /usr/\:share/\:groff/\:1.22.4/\:tmac/pdf.tmac
Macros for use with
.BR gropdf ;
automatically loaded by
.BR troffrc .
.
.\" .TP
.\" .B /usr/\:share/\:groff/\:1.22.4/\:tmac/pspic.tmac
.\" Definition of
.\" .B PSPIC
.\" macro,
.\" automatically loaded by
.\" .BR ps.tmac .
.\" .
.
.
.\" ====================================================================
.SH "SEE ALSO"
.\" ====================================================================
.
.BR \%afmtodit (1),
.BR groff (1),
.BR troff (1),
.BR \%groff_font (5),
.BR \%groff_out (5)
.\" Not actually referenced in above discussion.
.\" .BR \%pfbtops (1),
.\" .BR \%groff_tmac (5),
.
.
.\" Restore compatibility mode (for, e.g., Solaris 10/11).
.cp \n[gropdf_C]
.
.
.\" Local Variables:
.\" mode: nroff
.\" End:
.\" vim: set filetype=groff: