summaryrefslogtreecommitdiffstats
path: root/upstream/opensuse-leap-15-6/man1/pic.1
blob: 7c15815b88cc34b411ac98c05f20a25766d04f8d (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
.TH PIC 1 "7 February 2022" "groff 1.22.4"
.SH NAME
pic \- compile pictures for troff or TeX
.
.
.\" Save and disable compatibility mode (for, e.g., Solaris 10/11).
.do nr pic_C \n[.C]
.cp 0
.
.
.\" ====================================================================
.\" Legal Terms
.\" ====================================================================
.\"
.\" Copyright (C) 1989-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.
.
.
.\" ====================================================================
.\" Definitions
.\" ====================================================================
.
.ie t \{\
.  ds tx T\h'-.1667m'\v'.224m'E\v'-.224m'\h'-.125m'X
.  ds lx L\h'-0.36m'\v'-0.22v'\s-2A\s0\h'-0.15m'\v'0.22v'\*(tx
.\}
.el \{\
.  ds tx TeX
.  ds lx LaTeX
.\}
.
.ie \n(.g .ds ic \/
.el       .ds ic \^
.
.\" The BSD man macros can't handle " in arguments to font change macros,
.\" so use \(ts instead of ".
.tr \(ts"\""
.
.
.\" ====================================================================
.SH SYNOPSIS
.\" ====================================================================
.
.SY pic
.OP \-nvCSU
.RI [ file
\&.\|.\|.\&]
.YS
.
.SY pic
.B \-t
.OP \-cvzCSU
.RI [ file
\&.\|.\|.\&]
.YS
.
.
.\" ====================================================================
.SH DESCRIPTION
.\" ====================================================================
.
This manual page describes the GNU version of
.BR pic ,
which is part of the groff document formatting system.
.
.B pic
compiles descriptions of pictures embedded within
.B troff
or \*(tx input files into commands that are understood by \*(tx or
.BR troff .
.
Each picture starts with a line beginning with
.B .PS
and ends with a line beginning with
.BR .PE .
.
Anything outside of
.B .PS
and
.B .PE
is passed through without change.
.
.
.LP
It is the user's responsibility to provide appropriate definitions
of the
.B PS
and
.B PE
macros.
.
When the macro package being used does not supply such definitions
(for example, old versions of \-ms), appropriate definitions can be
obtained with
.BR \-mpic :
.
These will center each picture.
.
.
.\" ====================================================================
.SH OPTIONS
.\" ====================================================================
.
Options that do not take arguments may be grouped behind a single
.BR \- .
.
The special option
.B \-\^\-
can be used to mark the end of the options.
.
A filename of
.B \-
refers to the standard input.
.
.TP
.B \-C
Recognize
.B .PS
and
.B .PE
even when followed by a character other than space or newline.
.
.TP
.B \-S
Safer mode; do not execute
.B sh
commands.
.
This can be useful when operating on untrustworthy input (enabled by
default).
.
.TP
.B \-U
Unsafe mode; revert the default option
.BR \-S .
.
.TP
.B \-n
Don't use the groff extensions to the troff drawing commands.
.
You should use this if you are using a postprocessor that doesn't
support these extensions.
.
The extensions are described in
.BR groff_out (5).
.
The
.B \-n
option also causes
.B pic
not to use zero-length lines to draw dots in troff mode.
.
.TP
.B \-t
\*(tx mode.
.
.TP
.B \-c
Be more compatible with
.BR tpic .
.
Implies
.BR \-t .
Lines beginning with
.B \e
are not passed through transparently.
.
Lines beginning with
.B .
are passed through with the initial
.B .
changed to
.BR \e .
.
A line beginning with
.B .ps
is given special treatment:
it takes an optional integer argument specifying
the line thickness (pen size) in milliinches;
a missing argument restores the previous line thickness;
the default line thickness is 8 milliinches.
.
The line thickness thus specified takes effect only when a
non-negative line thickness has not been specified by use of the
.B thickness
attribute or by setting the
.B linethick
variable.
.
.TP
.B \-v
Print the version number.
.
.TP
.B \-z
In \*(tx mode draw dots using zero-length lines.
.
.
.LP
The following options supported by other versions of
.B pic
are ignored:
.
.TP
.B \-D
Draw all lines using the \eD escape sequence.
.B pic
always does this.
.
.TP
.BI \-T \ dev
Generate output for the
.B troff
device
.IR dev .
.
This is unnecessary because the
.B troff
output generated by
.B pic
is device-independent.
.
.
.\" ====================================================================
.SH USAGE
.\" ====================================================================
.
This section describes only the differences between GNU
.B pic
and the original version of
.BR pic .
.
Many of these differences also apply to newer versions of Unix
.BR pic .
.
A complete documentation is available in the file
.
.
.LP
.RS
.I /usr/\:share/\:doc/\:packages/\:groff/pic.ms
.RE
.
.
.\" ====================================================================
.SS \*(tx mode
.\" ====================================================================
.
\*(tx mode is enabled by the
.B \-t
option.
.
In \*(tx mode,
.B pic
will define a vbox called
.B \egraph
for each picture.
.
Use the
.B figname
command to change the name of the vbox.
.
You must yourself print that vbox using, for example, the command
.
.
.RS
.LP
.B
\ecenterline{\ebox\egraph}
.RE
.
.
.LP
Actually, since the vbox has a height of zero (it is defined with
\evtop) this will produce slightly more vertical space above the
picture than below it;
.RS
.LP
.B
\ecenterline{\eraise 1em\ebox\egraph}
.RE
.LP
would avoid this.
.
.
.LP
To make the vbox having a positive height and a depth of zero
(as used e.g.\& by \*[lx]'s
.BR \%graphics.sty ),
define the following macro in your document:
.RS
.LP
.B \edef\egpicbox#1{%
.br
.B "   \evbox{\eunvbox\ecsname #1\eendcsname\ekern 0pt}}"
.RE
.LP
Now you can simply say
.B \egpicbox{graph}
instead of \ebox\egraph.
.
.
.LP
You must use a \*(tx driver that supports the
.B tpic
specials, version 2.
.
.
.LP
Lines beginning with
.B \e
are passed through transparently; a
.B %
is added to the end of the line to avoid unwanted spaces.
.
You can safely use this feature to change fonts or to
change the value of
.BR \ebaselineskip .
.
Anything else may well produce undesirable results; use at your own risk.
.
Lines beginning with a period are not given any special treatment.
.
.
.\" ====================================================================
.SS Commands
.\" ====================================================================
.
.TP
\fBfor\fR \fIvariable\fR \fB=\fR \fIexpr1\fR \fBto\fR \fIexpr2\fR \
[\fBby\fR [\fB*\fR]\,\fIexpr3\/\fR] \fBdo\fR \fIX\fR \fIbody\fR \fIX\fR
Set
.I variable
to
.IR expr1 .
.
While the value of
.I variable
is less than or equal to
.IR expr2 ,
do
.I body
and increment
.I variable
by
.IR expr3 ;
if
.B by
is not given, increment
.I variable
by 1.
.
If
.I expr3
is prefixed by
.B *
then
.I variable
will instead be multiplied by
.IR expr3 .
.
The value of
.I expr3
can be negative for the additive case;
.I variable
is then tested whether it is greater than or equal to
.IR expr2 .
.
For the multiplicative case,
.I expr3
must be greater than zero.
.
If the constraints aren't met, the loop isn't executed.
.
.I X
can be any character not occurring in
.IR body .
.
.TP
\fBif\fR \fIexpr\fR \fBthen\fR \fIX\fR \fIif-true\fR \fIX\fR \
[\fBelse\fR \fIY\fR \fIif-false\fR \fIY\fR]
Evaluate
.IR expr ;
if it is non-zero then do
.IR if-true ,
otherwise do
.IR if-false .
.
.I X
can be any character not occurring in
.IR if-true .
.
.I Y
can be any character not occurring in
.IR if-false .
.
.TP
\fBprint\fR \fIarg\fR\|.\|.\|.
Concatenate the arguments and print as a line on stderr.
.
Each
.I arg
must be an expression, a position, or text.
.
This is useful for debugging.
.
.TP
\fBcommand\fR \fIarg\fR\|.\|.\|.
Concatenate the arguments
and pass them through as a line to troff or \*(tx.
.
Each
.I arg
must be an expression, a position, or text.
.
This has a similar effect to a line beginning with
.B .\&
or
.BR \e ,
but allows the values of variables to be passed through.
.
For example,
.RS
.IP
.ft B
.nf
\&.PS
x = 14
command ".ds string x is " x "."
\&.PE
\e*[string]
.ft
.fi
.RE
.IP
prints
.RS
.IP
.B x is 14.
.RE
.
.TP
\fBsh\fR \fIX\fR \fIcommand\fR \fIX\fR
Pass
.I command
to a shell.
.
.I X
can be any character not occurring in
.IR command .
.
.TP
\fBcopy\fR \fB"\,\fIfilename\/\fB"\fR
Include
.I filename
at this point in the file.
.
.TP
\fBcopy\fR [\fB"\,\fIfilename\/\fB"\fR] \fBthru\fR \fIX\fR \fIbody\fR \fIX\fR \
[\fBuntil\fR \fB"\,\fIword\*(ic\fB"\fR]
.ns
.TP
\fBcopy\fR [\fB"\,\fIfilename\/\fB"\fR] \fBthru\fR \fImacro\fR \
[\fBuntil\fR \fB"\,\fIword\*(ic\fB"\fR]
This construct does
.I body
once for each line of
.IR filename ;
the line is split into blank-delimited words,
and occurrences of
.BI $ i
in
.IR body ,
for
.I i
between 1 and 9,
are replaced by the
.IR i -th
word of the line.
.
If
.I filename
is not given, lines are taken from the current input up to
.BR .PE .
.
If an
.B until
clause is specified,
lines will be read only until a line the first word of which is
.IR word ;
that line will then be discarded.
.
.I X
can be any character not occurring in
.IR body .
.
For example,
.RS
.IP
.ft B
.nf
\&.PS
copy thru % circle at ($1,$2) % until "END"
1 2
3 4
5 6
END
box
\&.PE
.ft
.fi
.RE
.IP
is equivalent to
.RS
.IP
.ft B
.nf
\&.PS
circle at (1,2)
circle at (3,4)
circle at (5,6)
box
\&.PE
.ft
.fi
.RE
.
.IP
The commands to be performed for each line can also be taken
from a macro defined earlier by giving the name of the macro
as the argument to
.BR thru .
.
.
.LP
.B reset
.br
.ns
.TP
\fBreset\fI variable1\/\fR[\fB,\fR]\fI variable2 .\^.\^.
Reset pre-defined variables
.IR variable1 ,
.I variable2
\&.\^.\^.\& to their default values.
.
If no arguments are given, reset all pre-defined variables to their
default values.
.
Note that assigning a value to
.B scale
also causes all pre-defined variables that control dimensions to be
reset to their default values times the new value of scale.
.
.TP
\fBplot\fR \fIexpr\fR [\fB"\,\fItext\*(ic\fB"\fR]
This is a text object which is constructed by using
.I text
as a format string for sprintf
with an argument of
.IR expr .
.
If
.I text
is omitted a format string of
.B "\(ts%g\(ts"
is used.
.
Attributes can be specified in the same way as for a normal text
object.
Be very careful that you specify an appropriate format string;
.B pic
does only very limited checking of the string.
This is deprecated in favour of
.BR sprintf .
.
.TP
.IB variable\  := \ expr
This is similar to
.B =
except
.I variable
must already be defined,
and
.I expr
will be assigned to
.I variable
without creating a variable local to the current block.
.
(By contrast,
.B =
defines the variable in the current block if it is not already defined
there, and then changes the value in the current block only.)
.
For example, the following:
.RS
.IP
.ft B
.nf
\&.PS
x = 3
y = 3
[
  x := 5
  y = 5
]
print x " " y
\&.PE
.ft
.fi
.RE
.IP
prints
.RS
.IP
.B 5 3
.RE
.
.
.LP
Arguments of the form
.IP
.I X anything X
.LP
are also allowed to be of the form
.IP
.BI {\  anything\  }
.
.
.LP
In this case
.I anything
can contain balanced occurrences of
.B {
and
.BR } .
Strings may contain
.I X
or imbalanced occurrences of
.B {
and
.BR } .
.
.
.\" ====================================================================
.SS Expressions
.\" ====================================================================
.
The syntax for expressions has been significantly extended:
.
.
.LP
.IB  x\  ^\  y
(exponentiation)
.br
.BI sin( x )
.br
.BI cos( x )
.br
.BI atan2( y , \ x )
.br
.BI log( x )
(base 10)
.br
.BI exp( x )
(base 10, i.e.\&
.ie t 10\v'-.4m'\fIx\*(ic\fR\v'.4m')
.el   10^\fIx\fR)
.br
.BI sqrt( x )
.br
.BI int( x )
.br
.B rand()
(return a random number between 0 and 1)
.br
.BI rand( x )
(return a random number between 1 and
.IR x ;
deprecated)
.br
.BI srand( x )
(set the random number seed)
.br
.BI max( e1 , \ e2 )
.br
.BI min( e1 , \ e2 )
.br
.BI ! e
.br
\fIe1\fB && \fIe2\fR
.br
\fIe1\fB || \fIe2\fR
.br
\fIe1\fB == \fIe2\fR
.br
\fIe1\fB != \fIe2\fR
.br
\fIe1\fB >= \fIe2\fR
.br
\fIe1\fB > \fIe2\fR
.br
\fIe1\fB <= \fIe2\fR
.br
\fIe1\fB < \fIe2\fR
.br
\fB"\,\fIstr1\*(ic\fB" == "\,\fIstr2\*(ic\fB"\fR
.br
\fB"\,\fIstr1\*(ic\fB" != "\,\fIstr2\*(ic\fB"\fR
.br
.
.
.LP
String comparison expressions must be parenthesised in some contexts
to avoid ambiguity.
.
.
.\" ====================================================================
.SS Other Changes
.\" ====================================================================
.
A bare expression,
.IR expr ,
is acceptable as an attribute;
it is equivalent to
.IR dir\ expr ,
where
.I dir
is the current direction.
.
For example
.LP
.RS
.B line 2i
.RE
.LP
means draw a line 2\ inches long in the current direction.
.
The \[oq]i\[cq] (or \[oq]I\[cq]) character is ignored; to use another
measurement unit, set the
.I scale
variable to an appropriate value.
.
.
.LP
The maximum width and height of the picture are taken from the variables
.B maxpswid
and
.BR maxpsht .
.
Initially these have values 8.5 and 11.
.
.
.LP
Scientific notation is allowed for numbers.
For example
.RS
.LP
.B
x = 5e\-2
.RE
.
.
.LP
Text attributes can be compounded.
.
For example,
.RS
.LP
.B
"foo" above ljust
.RE
.LP
is valid.
.
.
.LP
There is no limit to the depth to which blocks can be examined.
.
For example,
.RS
.LP
.B
[A: [B: [C: box ]]] with .A.B.C.sw at 1,2
.br
.B
circle at last [\^].A.B.C
.RE
.LP
is acceptable.
.
.
.LP
Arcs now have compass points determined by the circle of which the arc
is a part.
.
.
.LP
Circles, ellipses, and arcs can be dotted or dashed.
.
In \*(tx mode splines can be dotted or dashed also.
.
.
.LP
Boxes can have rounded corners.
.
The
.B rad
attribute specifies the radius of the quarter-circles at each corner.
If no
.B rad
or
.B diam
attribute is given, a radius of
.B boxrad
is used.
.
Initially,
.B boxrad
has a value of\ 0.
.
A box with rounded corners can be dotted or dashed.
.
.
.LP
Boxes can have slanted sides.
.
This effectively changes the shape of a box from a rectangle to an
arbitrary parallelogram.
.
The
.B xslanted
and
.B yslanted
attributes specify the x and y\~offset of the box's upper right
corner from its default position.
.
.
.LP
The
.B .PS
line can have a second argument specifying a maximum height for
the picture.
.
If the width of zero is specified the width will be ignored in computing
the scaling factor for the picture.
.
Note that GNU
.B pic
will always scale a picture by the same amount vertically as well as
horizontally.
.
This is different from the DWB
2.0
.B pic
which may scale a picture by a different amount vertically than
horizontally if a height is specified.
.
.
.LP
Each text object has an invisible box associated with it.
.
The compass points of a text object are determined by this box.
.
The implicit motion associated with the object is also determined
by this box.
.
The dimensions of this box are taken from the width and height attributes;
if the width attribute is not supplied then the width will be taken to be
.BR textwid ;
if the height attribute is not supplied then the height will be taken to be
the number of text strings associated with the object
times
.BR textht .
.
Initially
.B textwid
and
.B textht
have a value of 0.
.
.
.LP
In (almost all) places where a quoted text string can be used,
an expression of the form
.IP
.BI sprintf(\(ts format \(ts,\  arg ,\fR.\|.\|.\fB)
.LP
can also be used;
this will produce the arguments formatted according to
.IR format ,
which should be a string as described in
.BR printf (3)
appropriate for the number of arguments supplied.
.
.
.LP
The thickness of the lines used to draw objects is controlled by the
.B linethick
variable.
.
This gives the thickness of lines in points.
.
A negative value means use the default thickness:
in \*(tx output mode, this means use a thickness of 8 milliinches;
in \*(tx output mode with the
.B \-c
option, this means use the line thickness specified by
.B .ps
lines;
in troff output mode, this means use a thickness proportional
to the pointsize.
.
A zero value means draw the thinnest possible line supported by
the output device.
.
Initially it has a value of \-1.
.
There is also a
.BR thick [ ness ]
attribute.
.
For example,
.RS
.LP
.B circle thickness 1.5
.RE
.LP
would draw a circle using a line with a thickness of 1.5 points.
.
The thickness of lines is not affected by the
value of the
.B scale
variable, nor by the width or height given in the
.B .PS
line.
.
.
.LP
Boxes (including boxes with rounded corners or slanted sides),
circles and ellipses can be filled by giving them an attribute of
.BR fill [ ed ].
.
This takes an optional argument of an expression with a value between
0 and 1; 0 will fill it with white, 1 with black, values in between
with a proportionally gray shade.
.
A value greater than 1 can also be used:
this means fill with the
shade of gray that is currently being used for text and lines.
.
Normally this will be black, but output devices may provide
a mechanism for changing this.
.
Without an argument, then the value of the variable
.B fillval
will be used.
.
Initially this has a value of 0.5.
.
The invisible attribute does not affect the filling of objects.
.
Any text associated with a filled object will be added after the
object has been filled, so that the text will not be obscured
by the filling.
.
.
.LP
Three additional modifiers are available to specify colored objects:
.BR outline [ d ]
sets the color of the outline,
.B shaded
the fill color, and
.B colo\fR[\fPu\fR]\fPr\fR[\fPed\fR]
sets both.
.
All three keywords expect a suffix specifying the color, for example
.RS
.LP
.B circle shaded """green""" outline """black"""
.RE
.
.
.LP
Currently, color support isn't available in \*(tx mode.
.
Predefined color names for
.B groff
are in the device macro files, for example
.BR ps.tmac ;
additional colors can be defined with the
.B .defcolor
request (see the manual page of
.BR troff (1)
for more details).
.
.
.LP
To change the name of the vbox in \*(tx mode, set the pseudo-variable
.B figname
(which is actually a specially parsed command) within a picture.
.
Example:
.RS
.LP
.B .PS
.br
.B figname = foobar;
.br
.B ...
.br
.B .PE
.RE
.
.
.LP
The picture is then available in the box
.BR \efoobar .
.
.
.LP
.B pic
assumes that at the beginning of a picture both glyph and fill color are
set to the default value.
.
.
.LP
Arrow heads will be drawn as solid triangles if the variable
.B arrowhead
is non-zero and either \*(tx mode is enabled or the
.B \-n
option has not been given.
.
Initially
.B arrowhead
has a value of\ 1.
.
Note that solid arrow heads are always filled with the current outline
color.
.
.
.LP
The troff output of
.B pic
is device-independent.
.
The
.B \-T
option is therefore redundant.
.
All numbers are taken to be in inches; numbers are never interpreted
to be in troff machine units.
.
.
.LP
Objects can have an
.B aligned
attribute.
.
This will only work if the postprocessor is
.BR grops ,
or
.BR gropdf .
.
Any text associated with an object having the
.B aligned
attribute will be rotated about the center of the object
so that it is aligned in the direction from the start point
to the end point of the object.
.
Note that this attribute will have no effect for objects whose start
and end points are coincident.
.
.
.LP
In places where
.IB n th
is allowed
.BI \[oq] expr \[cq]th
is also allowed.
.
Note that
.B \[cq]th
is a single token: no space is allowed between the
.B \[cq]
and the
.BR th .
.
For example,
.IP
.ft B
.nf
for i = 1 to 4 do {
   line from \[oq]i\[cq]th box.nw to \[oq]i+1\[cq]th box.se
}
.ft
.fi
.
.
.\" ====================================================================
.SH CONVERSION
.\" ====================================================================
.
To obtain a stand-alone picture from a
.B pic
file, enclose your
.B pic
code with
.B .PS
and
.B .PE
requests;
.B roff
configuration commands may be added at the beginning of the file, but no
.B roff
text.
.
.
.LP
It is necessary to feed this file into
.B groff
without adding any page information, so you must check which
.B .PS
and
.B .PE
requests are actually called.
.
For example, the mm macro package adds a page number, which is very
annoying.
.
At the moment, calling standard
.B groff
without any macro package works.
.
Alternatively, you can define your own requests, e.g.\& to do nothing:
.LP
.RS
.nf
.ft B
\&.de PS
\&..
\&.de PE
\&..
.ft
.fi
.RE
.
.
.LP
.B groff
itself does not provide direct conversion into other graphics file
formats.
.
But there are lots of possibilities if you first transform your
picture into PostScript\*R format using the
.B groff
option
.BR \-Tps .
.
Since this
.IR ps -file
lacks BoundingBox information it is not very useful by itself, but it
may be fed into other conversion programs, usually named
.BI ps2 other
or
.BI psto other
or the like.
.
Moreover, the PostScript interpreter
.B ghostscript
.RB ( gs )
has built-in graphics conversion devices that are called with the option
.LP
.RS
.BI "gs \-sDEVICE=" <devname>
.RE
.LP
Call
.LP
.RS
.B gs \-\-help
.RE
.LP
for a list of the available devices.
.
.
.LP
An alternative may be to use the
.B \-Tpdf
option to convert your picture directly into
.B PDF
format.
.
The MediaBox of the file produced can be controlled by passing a
.B \-P\-p
papersize to groff.
.
.
.LP
As the Encapsulated PostScript File Format
.B EPS
is getting more and more important, and the conversion wasn't
regarded trivial in the past you might be interested to know that
there is a conversion tool named
.B ps2eps
which does the right job.
.
It is much better than the tool
.B ps2epsi
packaged with
.BR gs .
.
.
.LP
For bitmapped graphic formats, you should use
.BR pstopnm ;
the resulting (intermediate)
.B PNM
file can be then converted to virtually any graphics format using the
tools of the
.B netpbm
package.
.
.
.\" ====================================================================
.SH FILES
.\" ====================================================================
.
.TP
.I /usr/\:share/\:groff/\:1.22.4/\:tmac/pic.tmac
Example definitions of the
.B PS
and
.B PE
macros.
.
.
.\" ====================================================================
.SH "SEE ALSO"
.\" ====================================================================
.
.BR troff (1),
.BR groff_out (5),
.BR tex (1),
.BR gs (1),
.BR ps2eps (1),
.BR pstopnm (1),
.BR ps2epsi (1),
.BR pnm (5)
.
.
.LP
Eric S.\& Raymond,
.I Making Pictures With GNU PIC.
.br
.I /usr/\:share/\:doc/\:packages/\:groff/pic.ps
(this file, together with its source file, pic.ms, is part
of the groff documentation)
.
.
.LP
Tpic: Pic for \*(tx
.LP
Brian W.\& Kernighan,
.UR http://\:cm.bell\-labs.com/\:cm/\:cs/\:cstr/\:116.ps.gz
.I PIC \(em A Graphics Language for Typesetting (User Manual)
.UE .
AT&T Bell Laboratories, Computing Science Technical Report No.\ 116
(revised May, 1991).
.
.
.LP
.B ps2eps
is available from CTAN mirrors, e.g.\&
.UR ftp://\:ftp.dante.de/\:tex\-archive/\:support/\:ps2eps/
.UE
.
.
.LP
W.\& Richard Stevens,
.UR http://\:www.kohala.com/\:start/\:troff/\:pic2html.html
.I Turning PIC into HTML
.UE
.
.
.LP
W.\& Richard Stevens,
.UR http://\:www.kohala.com/\:start/\:troff/\:pic.examples.ps
.IR "Examples of " pic " Macros"
.UE
.
.
.\" ====================================================================
.SH BUGS
.\" ====================================================================
.
Input characters that are invalid for
.B groff
(i.e., those with ASCII code 0,
or 013 octal, or between 015 and 037 octal, or between 0200 and 0237
octal) are rejected even in \*(tx mode.
.
.
.LP
The interpretation of
.B fillval
is incompatible with the pic in 10th edition Unix,
which interprets 0 as black and 1 as white.
.
.
.LP
PostScript\*R is a registered trademark of Adobe Systems Incorporation.
.
.
.\" Restore compatibility mode (for, e.g., Solaris 10/11).
.cp \n[pic_C]
.
.
.\" Local Variables:
.\" mode: nroff
.\" End:
.\" vim: set filetype=groff: