|
|
1.1 root 1: .ds dT /usr/lib/tmac
2: .TH MPICTURES 5
3: .SH NAME
4: mpictures \- picture inclusion macros
5: .SH SYNOPSIS
6: .B troff -mpictures
7: [
8: .I options
9: ]
10: .I file ...
11: .SH DESCRIPTION
12: A macro package used to include PostScript pictures in
13: .I troff
14: documents.
15: The package is compatible with many existing
16: .I troff
17: macro packages and includes the following three macros:
18: .TP
19: \&\f5.BP\fP \|\fIfile \^height \^width \^position \^offset \|flags \^label\fP
20: Places the picture
21: .I file
22: in the space set aside by
23: .IR height ,
24: .IR width ,
25: .IR position ,
26: and
27: .IR offset ,
28: which together define and position the picture frame.
29: The macro arguments are:
30: .RS
31: .TP
32: .I file
33: Pathname of a PostScript picture
34: .IR file .
35: Appending \&\f5(n)\fP to
36: .I file
37: selects page number \&\f5n\fP from a multipage picture
38: .I file.
39: By default the first page in
40: .I file
41: is selected.
42: .TP
43: .I height
44: Vertical extent of the frame.
45: The default is 3.0i.
46: .TP
47: .I width
48: Horizontal extent of the frame.
49: The default is the current length of a line of text.
50: .TP
51: .I position
52: One of \&\f5l\fP, \&\f5c\fP, or \&\f5r\fP
53: used to align the left, center, or
54: right of the frame with the corresponding position
55: on the current line of text.
56: The default is \&\f5l\fP.
57: .TP
58: .I offset
59: Moves the frame right (positive) or left (negative)
60: from the selected
61: .IR position .
62: The default is 0i.
63: .TP
64: .I flags
65: A string built from one or more of the following:
66: .RS 1.0i
67: .PD 0v
68: .TP
69: \f5a[d]\fP
70: rotate the picture clockwise \&\f5d\fP degrees.
71: If \&\f5d\fP is omitted 90 degrees is added to the
72: current angle, which starts at zero.
73: .TP
74: \f5o\fP
75: outline the picture with a box
76: .TP
77: \f5s\fP
78: freely scale both picture dimensions
79: .TP
80: \f5w\fP
81: white out the area to be occupied by the picture
82: .TP
83: \f5l\fP
84: attach picture to the left
85: .TP
86: \f5r\fP
87: right
88: .TP
89: \f5t\fP
90: top
91: .TP
92: \f5b\fP
93: or bottom of the frame
94: .PD
95: .RE
96: .TP
97: .I label
98: Place
99: .I label
100: 1.5 vertical units below the frame.
101: .PP
102: If there's room \&\f5.BP\fP fills text around the frame.
103: Everything destined for either side of the frame first
104: goes into a diversion and only reappears when the accumulated
105: text sweeps past the trap set by \&\f5.BP\fP
106: or when the diversion is explicitly closed
107: by the \&\f5.EP\fP macro (below).
108: .PP
109: Null arguments, represented by "", are replaced by the defaults
110: as noted above.
111: .RE
112: .TP
113: \&\f5.PI\fP \|\fIfile \^height,width,yoffset,xoffset \|flags\fP
114: A low level macro used by \&\f5.BP\fP.
115: It can help if you're trying to do things that \&\f5.BP\fP
116: won't allow or doesn't do well.
117: The two arguments not already described are:
118: .RS
119: .TP
120: .I xoffset
121: Moves the frame right (positive) or left (negative) from the
122: left margin.
123: The default is 0i.
124: .TP
125: .I yoffset
126: Moves the frame down (positive) or up (negative) from
127: the current baseline.
128: The default is 0i.
129: .PP
130: The second argument is a comma separated list of four numbers,
131: and although defaults are available, supplying values for all
132: four numbers is recommended.
133: .RE
134: .TP
135: \&\f5.EP\fP
136: Ends a picture started by \&\f5.BP\fP.
137: An explicit \&\f5.EP\fP call is not often required.
138: Instead \&\f5.EP\fP is usually called by springing
139: the trap set by \&\f5.BP\fP at the bottom of each frame.
140: .PP
141: Much of what's done depends on file structuring comments
142: commonly found in PostScript files.
143: If the comments needed to isolate a particular page are missing
144: the entire
145: .I file
146: is included.
147: If a \&\f5%%BoundingBox\fP comment is missing the picture is
148: assumed to fill an 8.5x11 inch page.
149: A picture
150: .I file
151: that can't be read when the
152: .I troff
153: postprocessor runs is replaced by white space.
154: Nothing done in \&\f5.BP\fP or \&\f5.PI\fP guarantees the
155: picture hasn't been placed off the page.
156: All dimensions should be explicitly given in inches.
157: .SH FILES
158: \*(dT/tmac.pictures
159: .SH SEE ALSO
160: .IR troff (1),
161: .IR dpost (1),
162: .IR picpack (1)
163: .SH BUGS
164: .PP
165: A picture and associated text can silently disappear if
166: the diversion trap set by \&\f5.BP\fP isn't reached.
167: Including a call to \&\f5.EP\fP at the end of the paper
168: should recover whatever appears to be missing.
169: .PP
170: Macros in other packages occasionally break the adjustments
171: made to the line length and indent when text is being placed
172: around a picture.
173: .PP
174: A missing or improper \&\f5%%BoundingBox\fP comment often
175: explains why a picture doesn't properly fill the space
176: that's been set aside.
This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.