1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238
|
.TH PIC2GRAPH 1 "7 November 2018" "Groff Version 1.22.3"
.SH NAME
pic2graph \- convert a PIC diagram into a cropped image
.
.
.\" --------------------------------------------------------------------
.\" Legalese
.\" --------------------------------------------------------------------
.
.de co
This documentation is released to the public domain.
..
.
.de au
.ME esr@thyrsus.com
Eric S.\& Raymond
.UE ,
based on a recipe by W.\& Richard Stevens.
..
.
.\" --------------------------------------------------------------------
.SH SYNOPSIS
.\" --------------------------------------------------------------------
.
.B pic2graph
[
.B \-unsafe
]
[
.BI "\-format " fmt
]
[
.BI "\-eqn " delim
]
.
.
.\" --------------------------------------------------------------------
.SH DESCRIPTION
.\" --------------------------------------------------------------------
.
Reads a PIC program as input; produces an image file (by default in
Portable Network Graphics format) suitable for the Web as output.
.
Also translates
.BR eqn (1)
constructs, so it can be used for generating images of mathematical
formulae.
.
.
.P
PIC is a rather expressive graphics minilanguage suitable for
producing box-and-arrow diagrams of the kind frequently used in
technical papers and textbooks.
.
The language is sufficiently flexible to be quite useful for state
charts, Petri-net diagrams, flow charts, simple circuit schematics,
jumper layouts, and other kinds of illustration involving repetitive
uses of simple geometric forms and splines.
.
Because PIC descriptions are procedural and object-based, they are
both compact and easy to modify.
.
.
.P
The PIC language is fully documented in
.IR "Making Pictures With GNU PIC" ,
a document which is part of the
.BR groff (1)
distribution.
.
.
.P
Your input PIC code should
.I not
be wrapped with the \&.PS and \&.PE macros that normally guard it within
.BR groff (1)
macros.
.
.
.P
The output image will be clipped to the smallest possible bounding box
that contains all the black pixels.
.
Older versions of
.BR \%convert (1)
will produce a black-on-white graphic; newer ones may produce a
black-on-transparent graphic.
.
By specifying command-line options to be passed to
.BR \%convert (1)
you can give it a border, force the background transparent, set the
image\[aq]s pixel density, or perform other useful transformations.
.
.
.P
This program uses
.BR pic (1),
.BR eqn (1),
.BR groff (1),
.BR gs (1),
and the ImageMagick
.BR \%convert (1)
program.
These programs must be installed on your system and accessible on your
$PATH for
.B pic2graph
to work.
.
.
.\" --------------------------------------------------------------------
.SH OPTIONS
.\" --------------------------------------------------------------------
.
.TP
.B \-unsafe
Run
.BR pic (1)
and
.BR groff (1)
in the \[oq]unsafe\[cq] mode enabling the PIC macro
.B sh
to execute arbitrary commands.
.
The default is to forbid this.
.
.TP
.BI "\-format " fmt
Specify an output format; the default is PNG (Portable Network Graphics).
.
Any format that
.BR \%convert (1)
can emit is supported.
.
.TP
.BI "\-eqn " delim
Change the fencepost characters that delimit
.BR eqn (1)
directives
.RB ( $
and
.BR $ ,
by default).
.
This option requires an argument, but an empty string is accepted as a
directive to disable
.BR eqn (1)
processing.
.
.
.PP
Command-line switches and arguments not listed above are passed to
.BR \%convert (1).
.
.
.\" --------------------------------------------------------------------
.SH FILES
.\" --------------------------------------------------------------------
.
.TP \w'\fB/usr/share/groff/1.22.3/tmac/eqnrc'u+2n
.B /usr/share/groff/1.22.3/tmac/eqnrc
The
.BR eqn (1)
initialization file.
.
.
.\" --------------------------------------------------------------------
.SH ENVIRONMENT
.\" --------------------------------------------------------------------
.
.TP
.B GROFF_TMPDIR
The directory in which temporary files will be created.
.
If this is not set
.B pic2graph
searches the environment variables
.BR \%TMPDIR ,
.BR TMP ,
and
.B TEMP
(in that order).
.
Otherwise, temporary files will be created in
.BR /tmp .
.
.
.\" --------------------------------------------------------------------
.SH BUGS
.\" --------------------------------------------------------------------
.
Due to changes in the behavior of ImageMagick
.BR \%convert (1)
that are both forward and backward-incompatible,
mismatches between your
.B pic2graph
and
.BR \%convert (1)
versions may produce zero-sized or untrimmed output images.
.
For this version of
.B pic2graph
you will need a version of
.BR \%convert (1)
that supports the
.B \-trim
option; older versions of
.B pic2graph
used
.BR \-crop\~0x0 ,
which no longer has trimming behavior.
.
.
.\" --------------------------------------------------------------------
.SH "SEE ALSO"
.\" --------------------------------------------------------------------
.
.BR eqn2graph (1),
.BR grap2graph (1),
.BR pic (1),
.BR eqn (1),
.BR groff (1),
.BR gs (1),
.BR \%convert (1).
.
.
.\" --------------------------------------------------------------------
.SH COPYING
.\" --------------------------------------------------------------------
.co
.\" --------------------------------------------------------------------
.SH AUTHORS
.\" --------------------------------------------------------------------
.au
.
.
.\" Local Variables:
.\" mode: nroff
.\" End:
|