1 '\" t -- preprocess: tbl(1)
5 Copyright (c) 2014 - 2017 Steffen (Daode) Nurpmeso <steffen@sdaoden.eu>.
7 Copyright (C) 2000 - 2004, 2006
8 Free Software Foundation, Inc.
10 Permission is granted to make and distribute verbatim copies of
11 this manual provided the copyright notice and this permission notice
12 are preserved on all copies.
14 Permission is granted to copy and distribute modified versions of this
15 manual under the conditions for verbatim copying, provided that the
16 entire resulting derived work is distributed under the terms of a
17 permission notice identical to this one.
19 Permission is granted to copy and distribute translations of this
20 manual into another language, under the above conditions for modified
21 versions, except that this permission notice may be included in
22 translations approved by the Free Software Foundation instead of in
35 .\" Like TP, but if specified indent is more than half
36 .\" the current line-length - indent, use the default indent.
38 . ie \\n(.$=0:((0\\$1)*2u>(\\n(.lu-\\n(.iu)) .TP
43 .TH @U_P_GRN@ @MAN1EXT@ "@MDATE@" "@T_ROFF@ v@VERSION@"
45 @L_P_GRN@ \- preprocessor for gremlin files
67 is a preprocessor for including
73 writes to standard output, processing only input lines between two that
78 Those lines must contain
81 These commands request a
83 file, and the picture in that file is
84 converted and placed in the
89 request may be followed by a C, L, or R to center, left, or right
92 picture (default justification is center).
95 is mentioned, the standard input is read.
96 At the end of the picture, the position on the page is the bottom of the
99 If the entry is ended with
103 the position is left at the top of the picture.
105 Please note that currently only the \-me macro package has support for
111 The following command-line options are understood:
114 Prepare output for printer
116 The default device is
119 .BR @L_ROFF@ (@MAN1EXT@)
120 for acceptable devices.
125 to the default search path for
128 The default path is (in that order) the current directory, the home
130 .BR @SYSTEMMACRODIR@ ,
131 .BR @LOCALMACRODIR@ ,
141 is the name of the device) for the
143 file before the default font directories
155 even when followed by a character other than space or newline.
158 .\"This switch causes the picture to be traversed twice:
159 .\"The first time, only the interiors of filled polygons (as borderless
160 .\"polygons) are printed.
161 .\"The second time, the outline is printed as a series of line segments.
162 .\"This way, postprocessors that overwrite rather than merge picture elements
163 .\"(such as Postscript) can still have text and graphics on a shaded
167 Print the version number.
169 Each input line between
176 Commands consist of one or two strings separated by white space, the first
177 string being the command and the second its operand.
178 Commands may be upper or lower case and abbreviated down to one character.
180 Commands that affect a picture's environment (those listed before
182 see below) are only in effect for the current picture:
183 The environment is reinitialized to the defaults at the start of the next
185 The commands are as follows:
196 text size number 1 (2, 3, or 4) to
199 The default is 12 (16, 24, and 36, respectively).
208 Set the roman (italics, bold, or special) font to
212 (either a name or number).
213 The default is R (I, B, and S, respectively).
218 Set the stipple font to
225 may be abbreviated down as far as `st' (to avoid
230 default for stipples (unless one is set by the default command), and it is
233 picture with polygons without specifying a
239 Magnify the picture (in addition to any default magnification) by
241 a floating point number larger than zero.
244 may be abbreviated down to `sc'.
253 narrow (medium and thick, respectively) lines to
255 times 0.15pt (this value can be changed at compile time).
256 The default is 1.0 (3.0 and 5.0, respectively), which corresponds to 0.15pt
257 (0.45pt and 0.75pt, respectively).
258 A thickness value of zero selects the smallest available line thickness.
259 Negative values cause the line thickness to be proportional to the current
262 .BI pointscale\ <off/on>
263 Scale text to match the picture.
264 Gremlin text is usually printed in the point size specified with the
270 regardless of any scaling factors in the picture.
273 will cause the point sizes to scale with the picture (within
275 limitations, of course).
276 An operand of anything but
278 will turn text scaling on.
281 Reset the picture environment defaults to the settings in the current
283 This is meant to be used as a global parameter setting mechanism at the
286 input file, but can be used at any time to reset the
290 Forces the picture to be
293 This overrides any scaling factors present in the same picture.
301 inches high, overriding other scaling factors.
302 If both `width' and `height' are specified the tighter constraint will
303 determine the scale of the picture.
307 commands are not saved with a
310 They will, however, affect point size scaling if that option is set.
317 located the current directory (or in the library directory; see the
322 commands are given, the second one overrides the first.
325 doesn't exist, an error message is reported and processing continues from
329 .SH NOTES ABOUT @U_ROFF@
332 is a preprocessor, it doesn't know about current indents, point sizes,
333 margins, number registers, etc.
336 input can be placed between the
343 text is now processed by
345 so anything valid in a single line of troff input is valid in a line of
347 text (barring `.' directives at the beginning of a line).
348 Thus, it is possible to have equations within a
350 figure by including in the
354 expressions enclosed by previously defined delimiters (e.g.
359 along with other preprocessors, it is best to run
369 should always be run last.
371 A picture is considered an entity, but that doesn't stop
373 from trying to break it up if it falls off the end of a page.
374 Placing the picture between `keeps' in \-me macros will ensure proper
388 to the width and height of the
390 figure (in device units) before entering the
392 request (this is for those who want to rewrite these macros).
393 .SH GREMLIN FILE FORMAT
394 There exist two distinct
396 file formats, the original format from the
398 graphic terminal version, and the
405 version allowing reference points with negative coordinates is
412 file does not contain negative coordinates, either format will be read
413 correctly by either version of
417 The other difference to the
419 format is the use of names for picture objects (e.g., POLYGON, CURVE)
421 Files representing the same picture are shown in Table 1 in each format.
426 sungremlinfile@@gremlinfile
427 0 240.00 128.00@@0 240.00 128.00
429 240.00 128.00@@240.00 128.00
430 185.00 120.00@@185.00 120.00
431 240.00 120.00@@240.00 120.00
432 296.00 120.00@@296.00 120.00
435 10 A Triangle@@10 A Triangle
437 224.00 416.00@@224.00 416.00
438 96.00 160.00@@96.00 160.00
439 384.00 160.00@@384.00 160.00
447 Table 1. File examples
451 The first line of each
453 file contains either the string
460 The second line of the file contains an orientation, and
464 values for a positioning point, separated by spaces.
465 The orientation, either
475 will display things in horizontal format (drawing area wider than it is
476 tall, with menu across top).
480 will display things in vertical format (drawing area taller than it is wide,
481 with menu on left side).
485 are floating point values giving a positioning point to be used when this
486 file is read into another file.
487 The stuff on this line really isn't all that important; a value of ``1 0.00
490 The rest of the file consists of zero or more element specifications.
491 After the last element specification is a line containing the string ``-1''.
493 Lines longer than 127 characters are chopped to this limit.
494 .SH ELEMENT SPECIFICATIONS
496 The first line of each element contains a single decimal number giving the
499 version) or its ASCII name
509 \fIgremlin\fP File Format \(mi Object Type Specification
511 \fIAED\fP Number@\fISUN\fP/\fIX11\fP Name@Description
512 0@BOTLEFT@bottom-left-justified text
513 1@BOTRIGHT@bottom-right-justified text
514 2@CENTCENT@center-justified text
521 10@TOPLEFT@top-left-justified text
522 11@TOPCENT@top-center-justified text
523 12@TOPRIGHT@top-right-justified text
524 13@CENTLEFT@left-center-justified text
525 14@CENTRIGHT@right-center-justified text
526 15@BOTCENT@bottom-center-justified text
531 Type Specifications in \fIgremlin\fP Files
535 After the object type comes a variable number of lines, each specifying a
536 point used to display the element.
537 Each line contains an x-coordinate and a y-coordinate in floating point
538 format, separated by spaces.
539 The list of points is terminated by a line containing the string ``-1.0
542 version) or a single asterisk, ``*''
546 After the points comes a line containing two decimal values, giving the
547 brush and size for the element.
548 The brush determines the style in which things are drawn.
549 For vectors, arcs, and curves there are six valid brush values:
554 1 \(mi@@thin dotted lines
555 2 \(mi@@thin dot-dashed lines
556 3 \(mi@@thick solid lines
557 4 \(mi@@thin dashed lines
558 5 \(mi@@thin solid lines
559 6 \(mi@@medium solid lines
562 For polygons, one more value, 0, is valid.
563 It specifies a polygon with an invisible border.
564 For text, the brush selects a font as follows:
569 1 \(mi@@roman (R font in @L_ROFF@)
570 2 \(mi@@italics (I font in @L_ROFF@)
571 3 \(mi@@bold (B font in @L_ROFF@)
572 4 \(mi@@special (S font in @L_ROFF@)
577 to run your pictures through
579 the font is really just a starting font:
580 The text string can contain formatting sequences like
584 which may change the font (as well as do many other things).
585 For text, the size field is a decimal value between 1 and 4.
586 It selects the size of the font in which the text will be drawn.
587 For polygons, this size field is interpreted as a stipple number to fill the
589 The number is used to index into a stipple font at print time.
591 The last line of each element contains a decimal number and a string of
592 characters, separated by a single space.
593 The number is a count of the number of characters in the string.
594 This information is only used for text elements, and contains the text
596 There can be spaces inside the text.
597 For arcs, curves, and vectors, this line of the element contains the string
599 .SH NOTES ON COORDINATES
603 and its coordinates reflect the
606 For vertical pictures, x-values range 116 to 511, and y-values from 0 to
608 For horizontal pictures, x-values range from 0 to 511 and y-values range
610 Although you needn't absolutely stick to this range, you'll get best results
611 if you at least stay in this vicinity.
612 Also, point lists are terminated by a point of (-1, -1), so you shouldn't
613 ever use negative coordinates.
615 writes out coordinates using format ``%f1.2''; it's probably a good idea to
616 use the same format if you want to modify the
619 .SH NOTES ON SUN/X11 COORDINATES
620 There is no longer a restriction on the range of coordinates used to create
625 However, files with negative coordinates
627 cause problems if displayed on the
630 .Tp \w'@FONTDIR@/devname/DESC'u+3n
631 .BI @FONTDIR@/dev name /DESC
632 Device description file for device
636 .BR @L_ROFF@ (@MAN1EXT@),
637 .BR @L_P_PIC@ (@MAN1EXT@),
641 David Slattengren and Barry Roitblat wrote the original Berkeley
644 Daniel Senderowicz and Werner Lemberg modified it for