Warning: Attempt to read property "date" on null in /usr/local/www/websvn.planix.org/blame.php on line 247

Warning: Attempt to read property "msg" on null in /usr/local/www/websvn.planix.org/blame.php on line 247
WebSVN – planix.SVN – Blame – /os/branches/feature_fixcpp/sys/man/6/mpictures – Rev 2

Subversion Repositories planix.SVN

Rev

Go to most recent revision | Details | Last modification | View Log | RSS feed

Rev Author Line No. Line
2 - 1 
.TH MPICTURES 6
2 
.SH NAME
3 
mpictures \- picture inclusion macros
4 
.SH SYNOPSIS
5 
.B troff -mpictures
6 
[
7 
.I options
8 
]
9 
.I file ...
10 
.SH DESCRIPTION
11 
.I Mpictures
12 
macros insert PostScript pictures into
13 
.IR troff (1)
14 
documents.
15 
The macros are:
16 
.TP
17 
.BI .BP " source height width position offset flags label
18 
Define a frame and place a picture in it.
19 
Null arguments, represented by \f5""\fR,
20 
are interpreted as defaults.
21 
The arguments are:
22 
.RS
23 
.TP
24 
.I source
25 
Name of a PostScript picture file, optionally
26 
suffixed with
27 
.RI ( n )
28 
to select page number
29 
.I n
30 
from the file (first page by default).
31 
.PD0
32 
.TP
33 
.I height
34 
Vertical size of the frame, default
35 
.BR 3.0i .
36 
.TP
37 
.I width
38 
Horizontal size of the frame, current line length by default.
39 
.TP
40 
.I position
41 
.L l
42 
(default),
43 
.LR c ,
44 
or
45 
.L r
46 
to left-justify, center, or right-justify the frame.
47 
.TP
48 
.I offset
49 
Move the frame horizontally from the original
50 
.I position
51 
by this amount, default
52 
.BR 0i .
53 
.TP
54 
.I flags
55 
One or more of:
56 
.RS
57 
.PD 0v
58 
.TP
59 
.BI a d
60 
Rotate the picture clockwise
61 
.I d
62 
degrees, default
63 
.IR d =90.
64 
.TP
65 
.B o
66 
Outline the picture with a box.
67 
.TP
68 
.B s
69 
Freely scale both picture dimensions.
70 
.TP
71 
.B w
72 
White out the area to be occupied by the picture.
73 
.TP
74 
.BR l , r , t ,\fPb
75 
Attach the picture to the left right, top, or bottom of the frame.
76 
.RE
77 
.TP
78 
.I label
79 
Place
80 
.I label
81 
at distance
82 
.B 1.5v
83 
below the frame.
84 
.PD
85 
.PP
86 
If there's room,
87 
.B .BP
88 
fills text around the frame.
89 
Everything destined for either side of the frame
90 
goes into a diversion to be retrieved when the accumulated
91 
text sweeps past the trap set by
92 
.B .BP
93 
or when the diversion is explicitly closed
94 
by
95 
.BR .EP .
96 
.RE
97 
.TP
98 
.BI .PI " source height" , width , "yoffset\fB,\fPxoffset flags.
99 
This low-level macro, used by
100 
.BR .BP ,
101 
can help do more complex things.
102 
The two arguments not already described are:
103 
.RS
104 
.TP
105 
.I xoffset
106 
Offset the frame from the left margin by this amount, default
107 
.BR 0i .
108 
.PD0
109 
.TP
110 
.I yoffset
111 
Offset the frame from the current baseline,
112 
measuring positive downward, default
113 
.BR 0i .
114 
.PD
115 
.RE
116 
.TP
117 
.B .EP
118 
End a picture started by
119 
.BR .BP ;
120 
.B .EP
121 
is usually called implicitly by a trap
122 
at frame bottom.
123 
.PP
124 
If a PostScript file lacks page-delimiting comments,
125 
the entire file is included.
126 
If no
127 
.B %%BoundingBox
128 
comment is present, the picture is
129 
assumed to fill an 8.5\(mu11-inch page.
130 
Nothing prevents the picture from being placed off the page.
131 
.SH SEE ALSO
132 
.IR troff (1)
133 
.SH DIAGNOSTICS
134 
A picture file that can't be read by the PostScript
135 
postprocessor is replaced by white space.
136 
.SH BUGS
137 
A picture and associated text silently disappear if
138 
a diversion trap set by
139 
.B .BP
140 
isn't reached.
141 
Call
142 
.B .EP
143 
at the end of the document to retrieve it.
144 
.br
145 
Macros in other packages may break the adjustments
146 
made to the line length and indent when text is being placed
147 
around a picture.
148 
.br
149 
A missing or improper
150 
.B %%BoundingBox
151 
comment may cause the frame to be filled incorrectly.