I386LINUX/util/I386LINUX/man/mann/eps.n

   1 '\"
   2 '\" Copyright 1991-1997 by Bell Labs Innovations for Lucent Technologies.
   3 '\"
   4 '\" Permission to use, copy, modify, and distribute this software and its
   5 '\" documentation for any purpose and without fee is hereby granted, provided
   6 '\" that the above copyright notice appear in all copies and that both that the
   7 '\" copyright notice and warranty disclaimer appear in supporting documentation,
   8 '\" and that the names of Lucent Technologies any of their entities not be used
   9 '\" in advertising or publicity pertaining to distribution of the software
  10 '\" without specific, written prior permission.
  11 '\"
  12 '\" Lucent Technologies disclaims all warranties with regard to this software,
  13 '\" including all implied warranties of merchantability and fitness.  In no event
  14 '\" shall Lucent Technologies be liable for any special, indirect or
  15 '\" consequential damages or any damages whatsoever resulting from loss of use,
  16 '\" data or profits, whether in an action of contract, negligence or other
  17 '\" tortuous action, arising out of or in connection with the use or performance
  18 '\" of this software.
  19 '\"
  20 '\" Graph widget created by Sani Nassif and George Howlett.
  21 '\"
  22 '\" The definitions below are for supplemental macros used in Tcl/Tk
  23 '\" manual entries.
  24 '\"
  25 '\" .AP type name in/out ?indent?
  26 '\"     Start paragraph describing an argument to a library procedure.
  27 '\"     type is type of argument (int, etc.), in/out is either "in", "out",
  28 '\"     or "in/out" to describe whether procedure reads or modifies arg,
  29 '\"     and indent is equivalent to second arg of .IP (shouldn't ever be
  30 '\"     needed;  use .AS below instead)
  31 '\"
  32 '\" .AS ?type? ?name?
  33 '\"     Give maximum sizes of arguments for setting tab stops.  Type and
  34 '\"     name are examples of largest possible arguments that will be passed
  35 '\"     to .AP later.  If args are omitted, default tab stops are used.
  36 '\"
  37 '\" .BS
  38 '\"     Start box enclosure.  From here until next .BE, everything will be
  39 '\"     enclosed in one large box.
  40 '\"
  41 '\" .BE
  42 '\"     End of box enclosure.
  43 '\"
  44 '\" .CS
  45 '\"     Begin code excerpt.
  46 '\"
  47 '\" .CE
  48 '\"     End code excerpt.
  49 '\"
  50 '\" .VS ?version? ?br?
  51 '\"     Begin vertical sidebar, for use in marking newly-changed parts
  52 '\"     of man pages.  The first argument is ignored and used for recording
  53 '\"     the version when the .VS was added, so that the sidebars can be
  54 '\"     found and removed when they reach a certain age.  If another argument
  55 '\"     is present, then a line break is forced before starting the sidebar.
  56 '\"
  57 '\" .VE
  58 '\"     End of vertical sidebar.
  59 '\"
  60 '\" .DS
  61 '\"     Begin an indented unfilled display.
  62 '\"
  63 '\" .DE
  64 '\"     End of indented unfilled display.
  65 '\"
  66 '\" .SO
  67 '\"     Start of list of standard options for a Tk widget.  The
  68 '\"     options follow on successive lines, in four columns separated
  69 '\"     by tabs.
  70 '\"
  71 '\" .SE
  72 '\"     End of list of standard options for a Tk widget.
  73 '\"
  74 '\" .OP cmdName dbName dbClass
  75 '\"     Start of description of a specific option.  cmdName gives the
  76 '\"     option's name as specified in the class command, dbName gives
  77 '\"     the option's name in the option database, and dbClass gives
  78 '\"     the option's class in the option database.
  79 '\"
  80 '\" .UL arg1 arg2
  81 '\"     Print arg1 underlined, then print arg2 normally.
  82 '\"
  83 '\" RCS: @(#) $Id: man.macros,v 1.3 2001/02/17 07:46:19 ghowlett Exp $
  84 '\"
  85 '\"     # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
  86 .if t .wh -1.3i ^B
  87 .nr ^l \n(.l
  88 .ad b
  89 '\"     # Start an argument description
  90 .de AP
  91 .ie !"\\$4"" .TP \\$4
  92 .el \{\
  93 .   ie !"\\$2"" .TP \\n()Cu
  94 .   el          .TP 15
  95 .\}
  96 .ta \\n()Au \\n()Bu
  97 .ie !"\\$3"" \{\
  98 \&\\$1  \\fI\\$2\\fP    (\\$3)
  99 .\".b
 100 .\}
 101 .el \{\
 102 .br
 103 .ie !"\\$2"" \{\
 104 \&\\$1  \\fI\\$2\\fP
 105 .\}
 106 .el \{\
 107 \&\\fI\\$1\\fP
 108 .\}
 109 .\}
 110 ..
 111 '\"     # define tabbing values for .AP
 112 .de AS
 113 .nr )A 10n
 114 .if !"\\$1"" .nr )A \\w'\\$1'u+3n
 115 .nr )B \\n()Au+15n
 116 .\"
 117 .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
 118 .nr )C \\n()Bu+\\w'(in/out)'u+2n
 119 ..
 120 .AS Tcl_Interp Tcl_CreateInterp in/out
 121 '\"     # BS - start boxed text
 122 '\"     # ^y = starting y location
 123 '\"     # ^b = 1
 124 .de BS
 125 .br
 126 .mk ^y
 127 .nr ^b 1u
 128 .if n .nf
 129 .if n .ti 0
 130 .if n \l'\\n(.lu\(ul'
 131 .if n .fi
 132 ..
 133 '\"     # BE - end boxed text (draw box now)
 134 .de BE
 135 .nf
 136 .ti 0
 137 .mk ^t
 138 .ie n \l'\\n(^lu\(ul'
 139 .el \{\
 140 .\"     Draw four-sided box normally, but don't draw top of
 141 .\"     box if the box started on an earlier page.
 142 .ie !\\n(^b-1 \{\
 143 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
 144 .\}
 145 .el \}\
 146 \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
 147 .\}
 148 .\}
 149 .fi
 150 .br
 151 .nr ^b 0
 152 ..
 153 '\"     # VS - start vertical sidebar
 154 '\"     # ^Y = starting y location
 155 '\"     # ^v = 1 (for troff;  for nroff this doesn't matter)
 156 .de VS
 157 .if !"\\$2"" .br
 158 .mk ^Y
 159 .ie n 'mc \s12\(br\s0
 160 .el .nr ^v 1u
 161 ..
 162 '\"     # VE - end of vertical sidebar
 163 .de VE
 164 .ie n 'mc
 165 .el \{\
 166 .ev 2
 167 .nf
 168 .ti 0
 169 .mk ^t
 170 \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
 171 .sp -1
 172 .fi
 173 .ev
 174 .\}
 175 .nr ^v 0
 176 ..
 177 '\"     # Special macro to handle page bottom:  finish off current
 178 '\"     # box/sidebar if in box/sidebar mode, then invoked standard
 179 '\"     # page bottom macro.
 180 .de ^B
 181 .ev 2
 182 'ti 0
 183 'nf
 184 .mk ^t
 185 .if \\n(^b \{\
 186 .\"     Draw three-sided box if this is the box's first page,
 187 .\"     draw two sides but no top otherwise.
 188 .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
 189 .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
 190 .\}
 191 .if \\n(^v \{\
 192 .nr ^x \\n(^tu+1v-\\n(^Yu
 193 \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
 194 .\}
 195 .bp
 196 'fi
 197 .ev
 198 .if \\n(^b \{\
 199 .mk ^y
 200 .nr ^b 2
 201 .\}
 202 .if \\n(^v \{\
 203 .mk ^Y
 204 .\}
 205 ..
 206 '\"     # DS - begin display
 207 .de DS
 208 .RS
 209 .nf
 210 .sp
 211 ..
 212 '\"     # DE - end display
 213 .de DE
 214 .fi
 215 .RE
 216 .sp
 217 ..
 218 '\"     # SO - start of list of standard options
 219 .de SO
 220 .SH "STANDARD OPTIONS"
 221 .LP
 222 .nf
 223 .ta 4c 8c 12c
 224 .ft B
 225 ..
 226 '\"     # SE - end of list of standard options
 227 .de SE
 228 .fi
 229 .ft R
 230 .LP
 231 See the \\fBoptions\\fR manual entry for details on the standard options.
 232 ..
 233 '\"     # OP - start of full description for a single option
 234 .de OP
 235 .LP
 236 .nf
 237 .ta 4c
 238 Command-Line Name:      \\fB\\$1\\fR
 239 Database Name:  \\fB\\$2\\fR
 240 Database Class: \\fB\\$3\\fR
 241 .fi
 242 .IP
 243 ..
 244 '\"     # CS - begin code excerpt
 245 .de CS
 246 .RS
 247 .nf
 248 .ta .25i .5i .75i 1i
 249 .ft CW
 250 .sp
 251 ..
 252 '\"     # CE - end code excerpt
 253 .de CE
 254 .fi
 255 .RE
 256 .ft R
 257 .sp
 258 ..
 259 .de UL
 260 \\$1\l'|0\(ul'\\$2
 261 ..
 262 .TH eps n 2.4 BLT "BLT Built-In Commands"
 263 .BS
 264 '\" Note:  do not modify the .SH NAME line immediately below!
 265 .SH NAME
 266 eps \-  Encapsulated PostScript canvas item.
 267 .SH SYNOPSIS
 268 \fIcanvas\fB create eps \fIx y \fR?\fIoption value\fR?...
 269 .BE
 270 .SH DESCRIPTION
 271 The \fBeps\fR canvas item lets you place encapulated PostScript (EPS)
 272 on a canvas, controlling its size and placement.  The EPS item is
 273 displayed either as a solid rectangle or a preview image.  The preview
 274 image is designated in one of two ways: 1) the EPS file
 275 contains an ASCII hexidecimal preview, or 2) a Tk photo image.  When
 276 the canvas generates PostScript output, the EPS will be inserted with
 277 the proper translation and scaling to match that of the EPS item. So
 278 can use the canvas widget as a page layout tool.
 279 .SH EXAMPLE
 280 Let's say you have for PostScript files of four graphs which you
 281 want to tile two-by-two on a single page.  Maybe you'd like
 282 to annotate the graphs by putting a caption at the bottom of
 283 each graph.
 284 .PP
 285 Normally, you would have to resort to an external tool or write your
 286 own PostScript program.  The \fBeps\fR canvas item lets you do this
 287 through Tk's canvas widget.  An \fBeps\fR item displays an
 288 image (or rectangle) representing the encapsulated PostScript file.
 289 It also scales and translates the EPS file when the canvas is printed.
 290
 291 .SH SYNTAX
 292 .DS
 293 \fIcanvas \fBcreate eps \fIx y \fR?\fIoption value\fR?...
 294 .DE
 295 The \fBeps\fR item creates a new canvas item. \fICanvas\fR is the name
 296 of a \fBcanvas\fR widget.  You must supply the X-Y coordinate of
 297 the new eps item.  How the coordinate is exactly interpretered is
 298 controlled by the \fB\-anchor\fR option (see below).
 299 .PP
 300 Additional options may be specified on the command line to configure
 301 aspects of the eps item such as its color, stipple, and font.  The
 302 following \fIoption\fR and \fIvalue\fR pairs are valid.
 303 .TP
 304 \fB\-anchor \fIanchor\fR
 305 Tells how to position the EPS item relative to its X-Y coordinate.
 306 The default is \f(CWcenter\fR.
 307 .TP
 308 \fB\-background \fIcolor\fR
 309 Sets the background color of the EPS rectangle.
 310 .TP
 311 \fB\-borderwidth \fIpixels\fR
 312 Sets the width of the 3\-D border around the outside edge of the item.  The
 313 \fB\-relief\fR option determines if the border is to be drawn.  The
 314 default is \f(CW0\fR.
 315 .TP
 316 \fB\-file \fIfileName\fR
 317 Specifies the name of the EPS file.  The first line of an
 318 EPS file must start with "%!PS" and contain a "EPS" version
 319 specification.  The other requirement is that there be a "%%BoundingBox:"
 320 entry which contains four integers representing the lower-left and
 321 upper-right coordinates of the area bounding the EPS.
 322 The default is \f(CW""\fR.
 323 .TP
 324 \fB\-font \fIfontName\fR
 325 Specifies the font of the title. The default is
 326 \f(CW*-Helvetica-Bold-R-Normal-*-18-180-*\fR.
 327 .TP
 328 \fB\-foreground \fIcolor\fR
 329 Specifies the foreground color of the EPS rectangle.  The option
 330 matters only when the \fB\-stipple\fR option is set.
 331 The default is \f(CWwhite\fR.
 332 .TP
 333 \fB\-height \fIpixels\fR
 334 Specifies the height EPS item.  If \fIpixels\fR is \f(CW0\fR, then
 335 the height is determined from the PostScript "BoundingBox:" entry
 336 in the EPS file.
 337 The default is \f(CW0\fR.
 338 .TP
 339 \fB\-image \fIphoto\fR
 340 Specifies the name of a Tk photo image to be displayed as in
 341 the item as a preview image.  This option overrides any preview
 342 specification found in the EPS file.
 343 The default is \f(CW""\fR.
 344 .TP
 345 \fB\-justify \fIjustify\fR
 346 Specifies how the title should be justified.  This matters only when
 347 the title contains more than one line of text. \fIJustify\fR must be
 348 \f(CWleft\fR, \f(CWright\fR, or \f(CWcenter\fR.  The default is
 349 \f(CWcenter\fR.
 350 .TP
 351 \fB\-relief \fIrelief\fR
 352 Specifies the 3-D effect for the EPS item.  \fIRelief\fR
 353 specifies how the item should appear relative to canvas;
 354 for example, \f(CWraised\fR means the item should appear to
 355 protrude.  The default is \f(CWflat\fR.
 356 .TP
 357 \fB\-shadowcolor \fIcolor\fR
 358 Specifies the color of the drop shadow used for the title.  The
 359 option with the \fB\-shadowoffset\fR option control how the
 360 title's drop shadow appears.
 361 The default is \f(CWgrey\fR.
 362 .TP
 363 \fB\-shadowoffset \fIpixels\fR
 364 Specifies the offset of the drop shadow from the title's text.
 365 If \fIpixels\fR is \f(CW0\fR, no shadow will be seen.
 366 The default is \f(CW0\fR.
 367 .TP
 368 \fB\-showimage \fIboolean\fR
 369 Indicates whether to display the image preview (if one exists),
 370 or a simple rectangle.
 371 The default is \f(CWyes\fR.
 372 .TP
 373 \fB\-stipple \fIbitmap\fR
 374 Specifies a bitmap to used to stipple the rectangle representing
 375 the EPS item.  The default is \f(CW""\fR.
 376 .TP
 377 \fB\-title \fIstring\fR
 378 Sets the title of the EPS item.  If \fIstring\fR is \f(CW""\fR,
 379 then the title specified by the PostScript "Title:" entry
 380 is used.  You can set the string a single space to display
 381 no title.  The default is \f(CW""\fR.
 382 .TP
 383 \fB\-titleanchor \fIanchor\fR
 384 Tells how to position the title within EPS item.
 385 The default is \f(CWn\fR.
 386 .TP
 387 \fB\-titlecolor \fIcolor\fR
 388 Specifies the color of the title.
 389 The default is \f(CWwhite\fR.
 390 .TP
 391 \fB\-titlerotate \fIdegrees\fR
 392 Sets the rotation of the title.  \fIDegrees\fR is a real number
 393 representing the angle of rotation.
 394 The title is first rotated in space and then placed according to
 395 the \fB\-titleanchor\fR position.  The default rotation is \f(CW0.0\fR.
 396 .TP
 397 \fB\-width \fIpixels\fR
 398 Specifies the width EPS item.  If \fIpixels\fR is \f(CW0\fR, then
 399 the width is determined from the PostScript "BoundingBox:" entry
 400 in the EPS file.
 401 The default is \f(CW0\fR.
 402 \f(CW5i\fR.