pic(1)
๐ pic(1) ๐
okay so bestie, this page comes from the General Commands Manual and itโs all about pic. Buckle up, because sheโs a whole Unix icon. ๐
๐ธ NAME ๐ธ
pic โ compile pictures for troff or TeX. Thatโs the whole name, iconic. โจ
๐ฆ SYNOPSIS ๐ฆ
pic [-CnSU] [file ...]
pic -t [-cCSUz] [file ...]
pic --help
pic -v
pic --version
๐ DESCRIPTION ๐
The GNU implementation of pic is part of the groff(1) document formatting system. pic is a troff(1) preprocessor that translates descriptions of diagrammatic pictures embedded in roff(7) or TeX input into the language understood by TeX or troff. She copies each *file*โs contents to the standard output stream, translating each picture between lines starting with .PS and any of .PE, .PF, or .PY. End a pic picture with .PE to leave the drawing position at the bottom of the picture, and with .PF or .PY to leave it at the top. No cap. ๐ซถ
Normally, pic is not executed directly by the user, but invoked by specifying the -p option to groff(1). If no file operands are present, or if file is -, pic reads the standard input stream. โจ
It is the userโs responsibility to provide appropriate definitions of the PS, PE, and one or both of the PF and PY macros. When a macro package does not supply these, obtain simple definitions with the groff option -mpic; these horizontally center each picture. ๐
GNU pic supports PY as a synonym of PF to work around a name space collision with the mm macro package, which defines PF as a page footer management macro. Use PF preferentially unless a similar problem faces your document. ๐
โจ OPTIONS โจ
--helpโ displays a usage message, and exits afterward. ๐-v,--versionโ show version information, and exit afterward. ๐-cโ Be more compatible withtpic; implies-t. Lines beginning with\are not passed through transparently. Lines beginning with.are passed through with the initial.changed to\.. GNUpicgives a line beginning with.psspecial treatment: it takes an optional integer argument specifying the line thickness (pen size) in milliinches, a missing argument restores the previous line thickness, and the default line thickness is8milliinches. The line thickness thus specified takes effect only when a non-negative line thickness has not been specified by use of thethicknessattribute or by setting thelinethickvariable. ๐-Cโ Recognize.PS,.PE,.PF, and.PYeven when followed by a character other than space or newline. ๐-nโ Donโt use groff extensions to the troff drawing commands. Specify this option if a postprocessor youโre using doesnโt support these extensions, described ingroff_out(5). This option also causespicnot to use zero-length lines to draw dots in troff mode. ๐-Sโ Enable safer mode and ignore any subsequent-Uoption. In safer mode,picignoresshcommands, which can be useful when operating on untrustworthy input.picoperates in safer mode by default. ๐ซถ-tโ Produce TeX output. ๐ธ-Uโ Operate in unsafe mode;shcommands are interpreted. ๐ฅ-zโ In TeX mode, draw dots using zero-length lines. โญ
The following options supported by other versions of pic are ignored. ๐
-Dโ Draw all lines using the\Descape sequence. GNUpicalways does this. ๐-Tdev โ Generate output for the troff device dev. This option is unnecessary in GNUpicbecause the troff it generates is device-independent. ๐ฆ
๐ USAGE ๐
This section primarily discusses the differences between GNU pic and the Eighth Edition Unix version of AT&T pic (1985). Many of these differences also apply to later versions of AT&T pic. ๐
๐ TeX mode ๐
TeX-compatible output is produced when the -t option is specified. You must use a TeX driver that supports tpic version 2 specials. (tpic was a fork of AT&T pic by Tim Morgan of the University of California at Irvine that diverged from its source around 1984. It is best known today for lending its name to a group of \special commands it produced for TeX.) โจ
Lines beginning with \ are passed through unaltered except for a % suffix to avoid unwanted spaces. Use this feature to change fonts or the value of \baselineskip. Other applications may produce undesirable results; use at your own risk. By default, lines beginning with a dot are not treated speciallyโbut see the -c option. ๐
In TeX mode, pic defines a vbox called \graph for each picture. Use GNU picโs figname command to change the name of the vbox. You must print that vbox yourself using the command
\centerline{\box\graph}
for instance. Since the vbox has a height of zeroโit is defined with \vtopโthis produces slightly more vertical space above the picture than below it;
\centerline{\raise 1em\box\graph}
would avoid this. To give the vbox a positive height and a depth of zero (as used by LaTeXโs graphics.sty, for example), define the following macro in your document.
\def\gpicbox#1{%
\vbox{\unvbox\csname #1\endcsname\kern 0pt}}
You can then simply say \gpicbox{graph} instead of \box\graph. ๐ซถ
๐ง Commands ๐ง
Several commands new to GNU pic accept delimiters, shown in their synopses as braces { }. Nesting of braces is supported. Any other characters (except a space, tab, or newline) may be used as alternative delimiters, in which case the members of a given pair must be identical. GNU pic recognizes double-quoted strings within delimiters of either kind; such strings may contain the delimiter character or unbalanced braces. ๐
for variable = expr1 to expr2 [by [*]expr3] do X body Xโ Set variable to expr1. While the value of variable is less than or equal to expr2, do body and increment variable by expr3; ifbyis not given, increment variable by1. expr3 can be negative, in which case variable is then tested whether it is greater than or equal to expr2. A*prefix on variable multiplies it by expr3 (which must be greater than zero) at each iteration rather than incrementing it. If the range constraint on expr3 isnโt met, the loop does not execute.Xcan be any character not in body. ๐if expr then X if-true X [else Y if-false Y]โ Evaluate expr; if it is non-zero then do if-true, otherwise do if-false.Xcan be any character not in if-true.Ycan be any character not in if-false. ๐ฆprint arg ...โ Catenate and write arguments to the standard error stream followed by a newline. Each arg must be an expression, a position, or text. This feature is useful for debugging. ๐ฆcommand arg ...โ Catenate arguments and pass them as a line to troff or TeX. Each arg must be an expression, a position, or text.commandallows the values ofpicvariables to be passed to the formatter. Thus,
.PS
x = 14
command ".ds string x is " x "."
.PE
\*[string]
produces
x is 14.
when formatted with troff. ๐
sh X command Xโ Pass command to a shell viasystem(3). Ignored if-Uoption not specified. ๐copy "filename"โ Include filename at this point in the file. ๐copy ["filename"] thru X body X [until "word"]/copy ["filename"] thru macro [until "word"]โ This construct does body once for each line of filename; the line is split into blank-delimited words, and occurrences of$iin body, for i between 1 and 9, are replaced by the i-th word of the line. If filename is not given, lines are taken from the current input up to.PE. If anuntilclause is specified, GNUpicreads lines only until encountering one beginning with word; which it then discards.Xcan be any character not in body. For example,
.PS
copy thru % circle at ($1,$2) % until "END"
1 2
3 4
5 6
END
box
.PE
and
.PS
circle at (1,2)
circle at (3,4)
circle at (5,6)
box
.PE
are equivalent. The commands to be performed for each line can also be taken from a macro defined earlier by giving the name of the macro as the argument to thru. The argument after thru is looked up as a macro name first; if not defined, its first character is interpreted as a delimiter. ๐ง
reset/reset pvar1[,] pvar2 ...โ Reset predefined variables pvar1, pvar2 ... to their default values; if no arguments are given, reset all predefined variables to their default values. Variable names may be separated by commas, spaces, or both. Assigning a value toscalealso causes all predefined variables that control dimensions to be reset to their default values times the new value ofscale. โจplot expr ["text"]โ Create a text object by using text as a format string forsprintf(3)with an argument of expr. If text is omitted,"%g"is implied. Attributes can be specified in the same way as for a normal text object.
Caution: be very careful that you specify an appropriate format string in text;picโs validation of it is limited.plotis deprecated in favour ofsprintf. ๐
var := exprโ Update an existing variable. var must already be defined, and expr is assigned to var without creating a variable local to the current block. (By contrast,=defines var in the current block if it is not already defined there, and then changes the value in the current block only.) For example,
.PS
x = 3
y = 3
[
x := 5
y = 5
]
print x y
.PE
writes
5 3
to the standard error stream. ๐
๐ซ Expressions ๐ซ
The syntax for expressions has been significantly extended. ๐
x ^ y(exponentiation)sin(x)cos(x)atan2(y, x)log(x)(base 10)exp(x)(base 10, i.e.10^x)sqrt(x)int(x)rand()(return a random number between 0 and 1)rand(x)(return a random number between 1 and x; deprecated)srand(x)(set the random number seed)max(e1, e2)min(e1, e2)!ee1 && e2e1 || e2e1 == e2e1 != e2e1 >= e2e1 > e2e1 <= e2e1 < e2"str1" == "str2""str1" != "str2"
String comparison expressions must be parenthesised in some contexts to avoid ambiguity. ๐
โจ Other changes โจ
A bare expression, expr, is acceptable as an attribute; it is equivalent to dir expr, where dir is the current direction. For example, line 2i draws a line 2 inches long in the current direction. The i (or I) character is ignored; to use another measurement unit, set the scale variable to an appropriate value. Slay.
The maximum width and height of the picture are taken from the variables maxpswid and maxpsht. Initially, these have values 8.5 and 11, respectively. Iconic defaults, fr fr.
Scientific notation is allowed for numbers, as with x = 5e-2. Not me doing math in the group chat.
Text attributes can be compounded. For example, "foo" above ljust is valid. Stack โem, bestie.
There is no limit to the depth to which blocks can be nested. For example,
[A: [B: [C: box ]]] with .A.B.C.sw at 1,2
circle at last [].A.B.C
is acceptable. Nested like your playlists.
Arcs have compass points determined by the circle of which the arc is a part. Cute.
Circles, ellipses, and arcs can be dotted or dashed. In TeX mode, splines can be dotted or dashed as well. Glow-up for splines.
Boxes can have rounded corners. The rad attribute specifies the radius of the quarter-circles at each corner. If no rad or diam attribute is given, a radius of boxrad is used. Initially, boxrad has a value of 0. A box with rounded corners can be dotted or dashed. Soft edges, periodt.
Boxes can have slanted sides, generalizing them from rectangles to parallelograms. The xslanted and yslanted attributes specify the x and y offsets of the boxโs upper right corner from its default position. Sheโs leaning, sheโs giving parallelogram.
The .PS line accepts a second argument specifying a maximum height for the picture. If a width of zero is specified, it is ignored when computing the scaling factor for the picture. GNU pic always scales a picture by the same amount vertically and horizontally. This differs from DWB 2.0 pic, which may change the pictureโs aspect ratio if a height is specified. Important vibe check.
Each text object has an associated invisible box that determines its compass points and implicit motion. The dimensions of the box are taken from its width and height attributes. If the width attribute is not supplied, the value of textwid is assumed. If the height attribute is not supplied, the height defaults to the number of text strings associated with the object times textht. Initially, textwid and textht have values of 0. Invisible box, main character energy.
In (almost all) places where a quoted text string can be used, an expression of the form
sprintf("format", arg, ...)
can be used instead; it transforms its arguments per format, which should be a string as described in printf(3), and appropriate to the quantity of arguments supplied. GNU pic supports only the conversion specifiers e, E, f, g, G, and %, modifiers #, -, +, and [space]), a minimum field width, and an optional precision. Thatโs the whole menu, bestie.
The thickness of the lines used to draw objects is controlled by the linethick variable, which is measured in points. A negative value indicates the default thickness. In TeX output mode when the -c option is not given, this means 8 milliinches. In troff and TeX -c output modes, the default thickness corresponds to the type size. (Thus, if the type size is 10 points, a line is 10 points thick.) A linethick value of zero draws the thinnest possible line supported by the output device. Initially, linethick has a value of -1. A thick[ness] attribute is also available. For example, circle thickness 1.5 draws a circle with a line thickness of 1.5 points. The thickness of lines is not affected by the value of the scale variable, nor by the width or height given in the .PS line. Do not come for her thickness.
Boxes (including boxes with rounded corners or slanted sides), circles, and ellipses can be filled by giving them an attribute of fill[ed], which takes an optional expression argument with a value between 0 and 1; 0 fills it with white, 1 with black, and values in between with a proportionally gray shade. A value greater than 1 is interpreted as the shade of gray that is being used for text and lines. Normally this is black, but output devices may provide a mechanism for changing this. Without an argument, the value of the variable fillval is used. Initially, fillval has a value of 0.5. The invisible attribute does not affect the filling of objects. Text associated with a filled object is added after the object is filled, so that the text is not obscured by the filling. Fill it, but donโt hide the text.
Additional modifiers are available to draw colored objects: outline[d] sets the color of the outline, shaded the fill color, and colo[u]r[ed] sets both. All expect a subsequent string argument specifying the color.
circle shaded "green" outline "black"
Color is not yet supported in TeX mode. Device macro files like ps.tmac declare color names; you can define additional ones with the defcolor request (see groff(7)). pic assumes at the beginning of each picture that the stroke and fill colors are set to the device defaults. Color theory but make it roff.
To change the name of the vbox in TeX mode, set the pseudo-variable figname (which is actually a specially parsed command) within a picture. For example,
.PS
figname = foobar;
circle "dig here";
.PE
makes the picture available in the box \foobar. Name it and claim it.
Arrow heads are drawn as solid triangles if the variable arrowhead is non-zero and either TeX mode is enabled or the -n option is not used. Initially, arrowhead has a value of 1. Solid arrow heads are always filled with the current outline (stroke) color. Sharp.
The troff output of pic is device-independent. The -T option is therefore redundant. Except where noted, all measurements and dimensions use inches implicitly; they are never interpreted as troff basic units. Redundant but cute.
Objects can have an aligned attribute, but it is supported only by the grops(1) and gropdf(1) output drivers. Any text associated with an aligned object is rotated about the objectโs center such that it is oriented along a line connecting the start and end points of the object. aligned has no effect on objects whose start and end points are coincident. Only those two drivers, no cap.
In places where nth is allowed, `expr'th is also allowed. โ'thโ is a single token: no space is allowed between the apostrophe and the th. Consider the following example.
for i = 1 to 4 do {
box
move right 0.5
}
for i = 1 to 3 do {
arrow from `i'th box.ne to `i+1'th box.sw
}
Arbitrary polygons can be drawn using the polygon keyword followed by a series of n-1 line segments, where n is the number of edges of the polygon. This allows GNU troff to interpret the line segments as a complete object such that the filled and shaded attributes may be used. The last user-specified line segment determines the polygonโs final drawing position and direction. For example, draw and fill a triangle with the following.
polygon up 1 then right 1 down 0.5 fill 0.5
Triangle slay.
Two reference point suffixes permit the positioning of drawing elements relative to a polygon. .vertex expr locates the vertices, and .midpoint expr for locating the midpoints of edges. GNU pic numbers vertices and midpoints in drawing order starting from 1 . You can abbreviate .vertex as .v or .ver, and .midpoint as .mid.
For example,
arrow down
polygon up 0.5 right 1 \
then down 0.5 right 1 \
then down 0.5 left 1 \
with .v2 at last line.end
arrow down from last polygon.v4
creates and correctly places a flowchart decision diamond. Flowchart diamond, iconic.
.center(.c) is also available, but compass points do not work as expected and should not be used with polygons. Warning received, bestie.
๐ Converting pic to other image formats ๐
To create a stand-alone graphics file from a pic file, first compose the picture. Bracket your pic code with .PS and .PE tokens. groff requests that donโt produce formatted output may precede .PS, but format no text, not even any injected by a macro package, which may include a page number even on the first page, as mm does by default. Consider writing a โrawโ roff document that uses no macro package. Raw roff, no filter.
Next, convert the roff/pic input into the desired format. groff distributes a simple utility, pic2graph(1), for this purpose. Other possibilities exist, particularly if you first transform your picture into PostScript format with groff -T ps. However, such a PostScript file lacks bounding box information; roff formatters produce page-sized output. Several tools with names beginning psto or ps2 exist that can infer the bounding box and perform a format conversion. One of these is the PostScript interpreter Ghostscript (gs(1)), which exposes format converters via its -sDEVICE= option. gs --help lists available devices. So many options, so little time.
Alternatively, produce a PDF with groff -T pdf; gropdf(1)โs -p option sets the MediaBox of the file. PDF glow-up.
The Encapsulated PostScript File (EPS) format is still sometimes seen. The aforementioned Ghostscript offers ps2epsi(1), and a standalone package and command ps2eps(1) is also available. Vintage but still out here.
For raster image formats, use pstopnm(1); the resulting pnm(5) file can be then converted to virtually any image format using the netpbm tools. Pixels, bestie.
GNU plotutils offers a pic2plot(1) utility for converting pic input to a wide variety of other image formats, including SVG. SVG era.
๐ Exit status ๐
0โ successful operation ๐2โ the program cannot interpret its command-line arguments ๐ญ1โ it encounters an error during operation ๐
๐ธ Files ๐ธ
/usr/share/groff/1.24.2/tmac/pic.tmacโ offers simple definitions of thePS,PE,PF, andPYmacros. Load it with themsorequest when eschewing a full-service macro package, or using one that doesnโt supply its own definitions for them.
๐ฆ Caveats ๐ฆ
The spacing of dots and dashes in broken lines scales with other graphics, and is configurable. For example,
line from 0,0 to 100,0 dotted 5
spaces the dots in a dotted line 5 units apart. The spacing of dashes can be set the same way. The dashwid variable sets the length of dashes. Tweak the vibe, not the facts.
๐ Bugs ๐
Characters that are invalid as input to GNU troff (see the groff Texinfo manual or groff_char(7) for a list) are rejected even in TeX mode.
Research Tenth Edition Unix picโs fillval interprets 0 as black and 1 as white, incompatibly with GNU pic. Incompatibly, fr fr.
๐ SEE ALSO ๐
okay bestie these are the sacred texts, the further-reading syllabus, the iykyk links โ go consume them ๐
/usr/share/doc/groff-1.24.2/pic.psโ โMaking Pictures with GNU picโ, by Eric S. Raymond. Like, this file, together with its source,pic.ms, is literally part of the groff distribution. Iconic. No cap. ๐- โPICโA Graphics Language for Typesetting: User Manualโ, by Brian W. Kernighan, 1984 (revised 1991), AT&T Bell Laboratories Computing Science Technical Report No. 116. the OG manual, the founding mother, the main character of pic documentation fr fr ๐
ps2epsis available from CTAN mirrors, e.g.,ftp://ftp.dante.de/tex-archive/support/ps2eps/. go grab it, it's giving helpful ๐ฆ- W. Richard Stevens, Turning PIC into HTML. yes bestie, pic-to-HTML pipeline, slay ๐ธ
- W. Richard Stevens, Examples of pic Macros. macros with actual examples, we love to see it โจ
and then the whole friend group of related man pages, all of them, in order, no skipping ๐
and that's the whole page bestie, you ate that ๐ this lil document is from groff 1.24.2, dated 2026-10-01 โ read it, love it, cite it, periodt ๐ซถ๐
๐ฆ where this page comes from
- alpine 3.24: groff-doc 1.24.2-r0 ยท GPL-3.0-or-later
- Copyright 1989-2025 Free Software Foundation, Inc
- ๐ girlified by deepseek-ai/DeepSeek-V4.1-Flash-1017 on : a language model's rewrite of the original, under its terms