Annotation of researchv10no/cmd/post.src/mpictures/mpictures.5, revision 1.1.1.1

1.1       root        1: .ds dT /usr/lib/tmac
                      2: .TH MPICTURES 5
                      3: .SH NAME
                      4: .B mpictures
                      5: \- picture inclusion macros
                      6: .SH SYNOPSIS
                      7: \*(mBtroff \-mpictures\f1
                      8: .OP "" options []
                      9: .OP "" files []
                     10: .SH DESCRIPTION
                     11: .B mpictures
                     12: is a macro package used to include PostScript pictures in
                     13: .B troff
                     14: documents.
                     15: The package is compatible with many existing
                     16: .B troff
                     17: macro packages and includes the following three macros:
                     18: .TP
                     19: .MI .BP "\0file\0height\0width\0position\0offset\0flags\0label"
                     20: .sp 0.3v
                     21: Places the picture
                     22: .I file
                     23: in the space set aside by
                     24: .IR height ,
                     25: .IR width ,
                     26: .IR position ,
                     27: and
                     28: .IR offset ,
                     29: which together define and position the picture frame.
                     30: The macro arguments are:
                     31: .in +0.75i
                     32: .de XX
                     33: .sp 3p
                     34: .ti -0.75i
                     35: \f2\\$1\fP
                     36: .sp -1v
                     37: ..
                     38: .XX file
                     39: Pathname of a PostScript picture
                     40: .IR file .
                     41: Appending
                     42: .MI ( n )
                     43: to
                     44: .I file
                     45: selects page number
                     46: .I n
                     47: from a multiple-page picture
                     48: .IR file .
                     49: By default the first page in
                     50: .I file
                     51: is selected.
                     52: .XX height
                     53: Vertical extent of the frame.
                     54: The default is
                     55: .MR 3i .
                     56: .XX width
                     57: Horizontal extent of the frame.
                     58: The default is the current length of a line of text.
                     59: .XX position
                     60: One of
                     61: .MR l ,
                     62: .MR c ,
                     63: or
                     64: .MW r
                     65: used to align the left, center, or
                     66: right of the frame with the corresponding position
                     67: on the current line of text.
                     68: The default is
                     69: .MR l .
                     70: .XX offset
                     71: Moves the frame right (positive) or left (negative)
                     72: from the selected
                     73: .IR position .
                     74: The default is
                     75: .MR 0i .
                     76: .XX flags
                     77: A string built from one or more of the following:
                     78: .in +0.5i
                     79: .sp 3p
                     80: .de YY
                     81: .br
                     82: .ti -0.5i
                     83: \*(mW\\$1\f1
                     84: .sp -1v
                     85: ..
                     86: .YY a[\f2d\*(mW]
                     87: Rotate the picture clockwise
                     88: .I d
                     89: degrees.
                     90: If
                     91: .I d
                     92: is omitted, 90 degrees is added to the
                     93: current angle, which starts at zero.
                     94: .YY o
                     95: Outline the picture with a box.
                     96: .YY s
                     97: Freely scale both picture dimensions.
                     98: .YY w
                     99: White out (erase) the area to be occupied by the picture.
                    100: .YY l
                    101: Attach the picture to the left side of the frame.
                    102: .YY r
                    103: Attach the picture to the right side of the frame.
                    104: .YY t
                    105: Attach the picture to the top of the frame.
                    106: .YY b
                    107: Attach the picture to the bottom of the frame.
                    108: .in -0.5i
                    109: .XX label
                    110: Place
                    111: .I label
                    112: 1.5 vertical lines below the frame.
                    113: .in -0.75i
                    114: .sp 0.3v
                    115: If there is room
                    116: .MW .BP
                    117: fills text around the frame.
                    118: Everything destined for either side of the frame first
                    119: goes into a diversion and only reappears when the accumulated
                    120: text sweeps past the trap set by
                    121: .MW .BP
                    122: or when the diversion is explicitly closed
                    123: by the
                    124: .MW .EP
                    125: macro (see below).
                    126: .sp 0.5v
                    127: Null arguments, represented by
                    128: .MR \&"" ,
                    129: are replaced by the defaults as noted above.
                    130: .TP
                    131: .MI .PI "\0file\0height,\|width,\|yoffset,\|xoffset\0flags"
                    132: .sp 0.3v
                    133: A low level macro used by
                    134: .MR .BP .
                    135: It can help if you are trying to do things that
                    136: .MW .BP
                    137: will not allow or does not do well.
                    138: The two arguments not already described are:
                    139: .in +0.75i
                    140: .XX xoffset
                    141: Moves the frame right (positive) or left (negative) from the
                    142: left margin.
                    143: The default is
                    144: .MR 0i .
                    145: .XX yoffset
                    146: Moves the frame down (positive) or up (negative) from
                    147: the current baseline.
                    148: The default is
                    149: .MR 0i .
                    150: .in -0.75i
                    151: .sp 0.3v
                    152: The second argument is a comma separated list of four numbers,
                    153: and although defaults are available, supplying values for all
                    154: four numbers is recommended.
                    155: .br
                    156: .ne 2v
                    157: .TP
                    158: .MW .EP
                    159: Ends a picture started by
                    160: .MW .BP .
                    161: An explicit
                    162: .MW .EP
                    163: call is not often required.
                    164: Instead
                    165: .MW .EP
                    166: is usually called by
                    167: .MW .BP
                    168: at the bottom of each frame.
                    169: .PP
                    170: Much of what is done depends on file structuring comments
                    171: commonly found in PostScript files.
                    172: If the comments needed to isolate a particular page are missing
                    173: the entire
                    174: .I file
                    175: is included.
                    176: If a
                    177: .MW %%BoundingBox
                    178: comment is missing the picture is
                    179: assumed to fill an 8.5\(mu11-inch page.
                    180: A picture
                    181: .I file
                    182: that cannot be read when the
                    183: .B troff
                    184: postprocessor runs is replaced by white space.
                    185: Nothing done in
                    186: .MW .BP
                    187: or
                    188: .MW .PI
                    189: guarantees the picture has not been placed off the page.
                    190: All dimensions should be explicitly given in inches.
                    191: .SH BUGS
                    192: A picture and associated text can silently disappear if
                    193: the diversion trap set by
                    194: .MW .BP
                    195: is not reached.
                    196: Including a call to
                    197: .MW .EP
                    198: at the end of the paper
                    199: should recover whatever appears to be missing.
                    200: .PP
                    201: Macros in other packages occasionally break the adjustments
                    202: made to the line length and indent when text is being placed
                    203: around a picture.
                    204: .PP
                    205: A missing or improper
                    206: .MW %%BoundingBox
                    207: comment often
                    208: explains why a picture does not properly fill the space
                    209: that has been set aside.
                    210: .SH FILES
                    211: .MW \*(dT/tmac.pictures
                    212: .SH SEE ALSO
                    213: .BR troff (1),
                    214: .BR dpost (1),
                    215: .BR picpack (1),
                    216: .BR mps (5)
                    217: .SH REFERENCE
                    218: R. L. Drechsler and A. R. Wilks,
                    219: .ul
                    220: PostScript Pictures in Troff Documents

unix.superglobalmegacorp.com

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.