Debian Codegraph @

upstream/debian-trixie/man1/eqn2graph.1

raw
1 .TH eqn2graph 1 "3 June 2025" "groff 1.23.0"
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 .SY eqn2graph
47 .B \-\-help
48 .YS
49 .
50 .
51 .SY eqn2graph
52 .B \-v
53 .
54 .SY eqn2graph
55 .B \-\-version
56 .YS
57 .
58 .
59 .\" ====================================================================
60 .SH Description
61 .\" ====================================================================
62 .
63 .I eqn2graph
64 reads a one-line
65 .MR \%eqn 1
66 equation from the standard input and writes an image file,
67 by default in Portable Network Graphics (PNG) format,
68 to the standard output.
69 .
70 .
71 .PP
72 The input EQN code should
73 .I not
74 be preceded by the
75 .B .EQ
76 macro that normally precedes it within
77 .MR groff 1
78 macros;
79 nor do you need to have dollar-sign or other delimiters around the
80 equation.
81 .
82 .
83 .\" FIXME: How old? This text hasn't been touched since 2008 at latest.
84 .\" Older versions of
85 .\" .I \%convert
86 .\" will produce a black-on-white graphic; newer ones may produce a
87 .\" black-on-transparent graphic.
88 .
89 .PP
90 Arguments not recognized by
91 .I eqn2graph
92 are passed to the ImageMagick or GraphicsMagick program
93 .MR convert 1 .
94 .
95 .
96 By specifying these, you can give your image a border,
97 .\" Transparent backgrounds are the default in 2018.
98 .\" force the background transparent,
99 set the image's pixel density,
100 or perform other useful transformations.
101 .
102 .
103 .PP
104 The output image is clipped using
105 .IR \%convert 's
106 .B \-trim
107 option to the smallest possible bounding box that contains all the black
108 pixels.
109 .
110 .
111 .\" ====================================================================
112 .SH Options
113 .\" ====================================================================
114 .
115 .B \-\-help
116 displays a usage message,
117 while
118 .B \-v
119 and
120 .B \-\-version
121 show version information;
122 all exit afterward.
123 .
124 .
125 .TP
126 .BI \-format\~ output-format
127 Write the image in
128 .IR output-format ,
129 which must be understood by
130 .IR \%convert ;
131 the default is PNG.
132 .
133 .
134 .\" ====================================================================
135 .SH Environment
136 .\" ====================================================================
137 .
138 .TP
139 .I \%GROFF_TMPDIR
140 .TQ
141 .I \%TMPDIR
142 .TQ
143 .I TMP
144 .TQ
145 .I TEMP
146 These environment variables are searched in the given order to determine
147 the directory where temporary files will be created.
148 .
149 If none are set,
150 .I /tmp
151 is used.
152 .
153 .
154 .\" ====================================================================
155 .SH Authors
156 .\" ====================================================================
157 .
158 .I eqn2graph
159 was written by
160 .MT esr@\:thyrsus\:.com
161 Eric S.\& Raymond
162 .ME ,
163 based on a recipe for
164 .MR pic2graph 1 ,
165 by W.\& Richard Stevens.
166 .
167 .
168 .\" ====================================================================
169 .SH "See also"
170 .\" ====================================================================
171 .
172 .MR pic2graph 1 ,
173 .MR grap2graph 1 ,
174 .MR \%eqn 1 ,
175 .MR groff 1 ,
176 .MR convert 1
177 .
178 .
179 .\" Restore compatibility mode (for, e.g., Solaris 10/11).
180 .cp \n[*groff_eqn2graph_1_man_C]
181 .do rr *groff_eqn2graph_1_man_C
182 .
183 .
184 .\" Local Variables:
185 .\" fill-column: 72
186 .\" mode: nroff
187 .\" End:
188 .\" vim: set filetype=groff textwidth=72: