1 3aec33fe 2005-07-18 devnull .TH MPICTURES 7
3 3aec33fe 2005-07-18 devnull mpictures \- picture inclusion macros
4 3aec33fe 2005-07-18 devnull .SH SYNOPSIS
5 3aec33fe 2005-07-18 devnull .B troff -mpictures
7 3aec33fe 2005-07-18 devnull .I options
9 3aec33fe 2005-07-18 devnull .I file ...
10 3aec33fe 2005-07-18 devnull .SH DESCRIPTION
11 3aec33fe 2005-07-18 devnull .I Mpictures
12 3aec33fe 2005-07-18 devnull macros insert PostScript pictures into
13 d32deab1 2020-08-16 rsc .MR troff (1)
14 3aec33fe 2005-07-18 devnull documents.
15 3aec33fe 2005-07-18 devnull The macros are:
17 3aec33fe 2005-07-18 devnull .BI .BP " source height width position offset flags label
18 3aec33fe 2005-07-18 devnull Define a frame and place a picture in it.
19 3aec33fe 2005-07-18 devnull Null arguments, represented by \f5""\fR,
20 3aec33fe 2005-07-18 devnull are interpreted as defaults.
21 3aec33fe 2005-07-18 devnull The arguments are:
24 3aec33fe 2005-07-18 devnull .I source
25 3aec33fe 2005-07-18 devnull Name of a PostScript picture file, optionally
26 3aec33fe 2005-07-18 devnull suffixed with
27 3aec33fe 2005-07-18 devnull .RI ( n )
28 3aec33fe 2005-07-18 devnull to select page number
30 3aec33fe 2005-07-18 devnull from the file (first page by default).
33 3aec33fe 2005-07-18 devnull .I height
34 3aec33fe 2005-07-18 devnull Vertical size of the frame, default
35 3aec33fe 2005-07-18 devnull .BR 3.0i .
38 3aec33fe 2005-07-18 devnull Horizontal size of the frame, current line length by default.
40 3aec33fe 2005-07-18 devnull .I position
42 3aec33fe 2005-07-18 devnull (default),
46 3aec33fe 2005-07-18 devnull to left-justify, center, or right-justify the frame.
48 3aec33fe 2005-07-18 devnull .I offset
49 3aec33fe 2005-07-18 devnull Move the frame horizontally from the original
50 3aec33fe 2005-07-18 devnull .I position
51 3aec33fe 2005-07-18 devnull by this amount, default
55 3aec33fe 2005-07-18 devnull One or more of:
60 3aec33fe 2005-07-18 devnull Rotate the picture clockwise
62 3aec33fe 2005-07-18 devnull degrees, default
63 3aec33fe 2005-07-18 devnull .IR d =90.
66 3aec33fe 2005-07-18 devnull Outline the picture with a box.
69 3aec33fe 2005-07-18 devnull Freely scale both picture dimensions.
72 3aec33fe 2005-07-18 devnull White out the area to be occupied by the picture.
74 3aec33fe 2005-07-18 devnull .BR l , r , t ,\fPb
75 3aec33fe 2005-07-18 devnull Attach the picture to the left right, top, or bottom of the frame.
81 3aec33fe 2005-07-18 devnull at distance
83 3aec33fe 2005-07-18 devnull below the frame.
86 3aec33fe 2005-07-18 devnull If there's room,
88 3aec33fe 2005-07-18 devnull fills text around the frame.
89 3aec33fe 2005-07-18 devnull Everything destined for either side of the frame
90 3aec33fe 2005-07-18 devnull goes into a diversion to be retrieved when the accumulated
91 3aec33fe 2005-07-18 devnull text sweeps past the trap set by
93 3aec33fe 2005-07-18 devnull or when the diversion is explicitly closed
95 3aec33fe 2005-07-18 devnull .BR .EP .
98 3aec33fe 2005-07-18 devnull .BI .PI " source height" , width , "yoffset\fB,\fPxoffset flags.
99 3aec33fe 2005-07-18 devnull This low-level macro, used by
100 3aec33fe 2005-07-18 devnull .BR .BP ,
101 3aec33fe 2005-07-18 devnull can help do more complex things.
102 3aec33fe 2005-07-18 devnull The two arguments not already described are:
105 3aec33fe 2005-07-18 devnull .I xoffset
106 3aec33fe 2005-07-18 devnull Offset the frame from the left margin by this amount, default
107 3aec33fe 2005-07-18 devnull .BR 0i .
110 3aec33fe 2005-07-18 devnull .I yoffset
111 3aec33fe 2005-07-18 devnull Offset the frame from the current baseline,
112 3aec33fe 2005-07-18 devnull measuring positive downward, default
113 3aec33fe 2005-07-18 devnull .BR 0i .
118 3aec33fe 2005-07-18 devnull End a picture started by
119 3aec33fe 2005-07-18 devnull .BR .BP ;
121 3aec33fe 2005-07-18 devnull is usually called implicitly by a trap
122 3aec33fe 2005-07-18 devnull at frame bottom.
124 3aec33fe 2005-07-18 devnull If a PostScript file lacks page-delimiting comments,
125 3aec33fe 2005-07-18 devnull the entire file is included.
127 3aec33fe 2005-07-18 devnull .B %%BoundingBox
128 3aec33fe 2005-07-18 devnull comment is present, the picture is
129 3aec33fe 2005-07-18 devnull assumed to fill an 8.5\(mu11-inch page.
130 3aec33fe 2005-07-18 devnull Nothing prevents the picture from being placed off the page.
131 3aec33fe 2005-07-18 devnull .SH SEE ALSO
132 d32deab1 2020-08-16 rsc .MR troff (1)
133 3aec33fe 2005-07-18 devnull .SH DIAGNOSTICS
134 3aec33fe 2005-07-18 devnull A picture file that can't be read by the PostScript
135 3aec33fe 2005-07-18 devnull postprocessor is replaced by white space.
136 3aec33fe 2005-07-18 devnull .SH BUGS
137 3aec33fe 2005-07-18 devnull A picture and associated text silently disappear if
138 3aec33fe 2005-07-18 devnull a diversion trap set by
140 3aec33fe 2005-07-18 devnull isn't reached.
143 3aec33fe 2005-07-18 devnull at the end of the document to retrieve it.
145 3aec33fe 2005-07-18 devnull Macros in other packages may break the adjustments
146 3aec33fe 2005-07-18 devnull made to the line length and indent when text is being placed
147 3aec33fe 2005-07-18 devnull around a picture.
149 3aec33fe 2005-07-18 devnull A missing or improper
150 3aec33fe 2005-07-18 devnull .B %%BoundingBox
151 3aec33fe 2005-07-18 devnull comment may cause the frame to be filled incorrectly.
