Debian Codegraph @

upstream/debian-unstable/man1/eqn2graph.1

raw
1 .TH eqn2graph 1 "2026-04-22" "groff 1.24.1"
2 .SH Name
3 eqn2graph \- convert an
4 .I eqn \" generic
5 equation into a cropped image
6 .
7 .
8 .\" ====================================================================
9 .\" Legal Terms
10 .\" ====================================================================
11 .\"
12 .\" This documentation is released to the public domain.
13 .
14 .
15 .\" Save and disable compatibility mode (for, e.g., Solaris 10/11).
16 .do nr *groff_eqn2graph_1_man_C \n[.cp]
17 .cp 0
18 .
19 .\" Define fallback for groff 1.23's MR macro if the system lacks it.
20 .nr do-fallback 0
21 .if !\n(.f .nr do-fallback 1 \" mandoc
22 .if \n(.g .if !d MR .nr do-fallback 1 \" older groff
23 .if !\n(.g .nr do-fallback 1 \" non-groff *roff
24 .if \n[do-fallback] \{\
25 . de MR
26 . ie \\n(.$=1 \
27 . I \%\\$1
28 . el \
29 . IR \%\\$1 (\\$2)\\$3
30 . .
31 .\}
32 .rr do-fallback
33 .
34 .
35 .\" ====================================================================
36 .SH Synopsis
37 .\" ====================================================================
38 .
39 .SY eqn2graph
40 .RB [ \-format\~\c
41 .IR output-format ]
42 .RI [ convert-argument \~.\|.\|.]
43 .YS
44 .
45 .
46 .P
47 .SY eqn2graph
48 .B \-\-help
49 .YS
50 .
51 .
52 .P
53 .SY eqn2graph
54 .B \-v
55 .YS
56 .
57 .SY eqn2graph
58 .B \%\-\-version
59 .YS
60 .
61 .
62 .\" ====================================================================
63 .SH Description
64 .\" ====================================================================
65 .
66 .I eqn2graph
67 reads a one-line
68 .MR \%eqn 1
69 equation from the standard input and writes an image file,
70 by default in Portable Network Graphics (PNG) format,
71 to the standard output.
72 .
73 .
74 .PP
75 The input EQN code should
76 .I not
77 be preceded by the
78 .B .EQ
79 macro that normally precedes it within
80 .MR groff 1
81 macros;
82 nor do you need to have dollar-sign or other delimiters around the
83 equation.
84 .
85 .
86 .\" FIXME: How old? This text hasn't been touched since 2008 at latest.
87 .\" Older versions of
88 .\" .I \%convert
89 .\" will produce a black-on-white graphic; newer ones may produce a
90 .\" black-on-transparent graphic.
91 .
92 .PP
93 Arguments not recognized by
94 .I eqn2graph
95 are passed to the ImageMagick or GraphicsMagick program
96 .MR convert 1 .
97 .
98 .
99 By specifying these, you can give your image a border,
100 .\" Transparent backgrounds are the default in 2018.
101 .\" force the background transparent,
102 set the image's pixel density,
103 or perform other useful transformations.
104 .
105 .
106 .PP
107 The output image is clipped using
108 .IR \%convert 's
109 .B \-trim
110 option to the smallest possible bounding box that contains all the black
111 pixels.
112 .
113 .
114 .\" ====================================================================
115 .SH Options
116 .\" ====================================================================
117 .
118 .B \-\-help
119 displays a usage message,
120 while
121 .B \-v
122 and
123 .B \%\-\-version
124 show version information;
125 all exit afterward.
126 .
127 .
128 .TP
129 .BI \-format\~ output-format
130 Write the image in
131 .IR output-format ,
132 which must be understood by
133 .IR \%convert ;
134 the default is PNG.
135 .
136 .
137 .\" ====================================================================
138 .SH Environment
139 .\" ====================================================================
140 .
141 .TP
142 .I \%GROFF_TMPDIR
143 .TQ
144 .I \%TMPDIR
145 .TQ
146 .I TMP
147 .TQ
148 .I TEMP
149 These environment variables are searched in the order shown to determine
150 the directory where temporary files will be created.
151 .
152 If none are set,
153 .I /tmp
154 is used.
155 .
156 .
157 .\" ====================================================================
158 .SH Authors
159 .\" ====================================================================
160 .
161 .I eqn2graph
162 was written by
163 .MT esr@\:thyrsus\:.com
164 Eric S.\& Raymond
165 .ME ,
166 based on a recipe for
167 .MR pic2graph 1 ,
168 by W.\& Richard Stevens.
169 .
170 .
171 .\" ====================================================================
172 .SH "See also"
173 .\" ====================================================================
174 .
175 .MR pic2graph 1 ,
176 .MR grap2graph 1 ,
177 .MR \%eqn 1 ,
178 .MR groff 1 ,
179 .MR convert 1
180 .
181 .
182 .\" Restore compatibility mode (for, e.g., Solaris 10/11).
183 .cp \n[*groff_eqn2graph_1_man_C]
184 .do rr *groff_eqn2graph_1_man_C
185 .
186 .
187 .\" Local Variables:
188 .\" fill-column: 72
189 .\" mode: nroff
190 .\" End:
191 .\" vim: set filetype=groff textwidth=72: