1ASY(1) General Commands Manual ASY(1)
2
3
4
6 asy - Asymptote: a script-based vector graphics language
7
9 asy [options] [file ...]
10
12 Asymptote is a powerful descriptive vector graphics language for tech‐
13 nical drawings, inspired by MetaPost but with an improved C++-like syn‐
14 tax. Asymptote provides for figures the same high-quality level of
15 typesetting that LaTeX does for scientific text.
16
18 If no arguments are given, Asymptote runs in interactive mode.
19
20 If "-" is given as the file argument, Asymptote reads from standard in‐
21 put.
22
23 A summary of options is included below. The effect of most options can
24 be negated by prepending no to the option name. Default values for
25 most options may also be entered in the file .asy/config.asy in the
26 user's home directory using the long form:
27
28 import settings;
29 batchView=true;
30
31 For a complete description, see the Info files.
32
33 -GPUcompress
34 Compress GPU transparent fragment counts [false].
35
36 -GPUindexing
37 Compute indexing partial sums on GPU [true].
38
39 -GPUinterlock
40 Use fragment shader interlock [true].
41
42 -GPUlocalSize n
43 Compute shader local size [16].
44
45 -V,-View
46 View output; command-line only.
47
48 -absolute
49 Use absolute WebGL dimensions [false].
50
51 -a,-align C|B|T|Z
52 Center, Bottom, Top, or Zero page alignment [C].
53
54 -aligndir pair
55 Directional page alignment (overrides align) [(0,0)].
56
57 -antialias n
58 Antialiasing width for rasterized output [2].
59
60 -auto3D
61 Automatically activate 3D scene [true].
62
63 -autobillboard
64 3D labels always face viewer by default [true].
65
66 -autoimport string
67 Module to automatically import.
68
69 -autoplain
70 Enable automatic importing of plain [true].
71
72 -autoplay
73 Autoplay 3D animations [false].
74
75 -autorotate
76 Enable automatic PDF page rotation [false].
77
78 -axes3 Show 3D axes in PDF output [true].
79
80 -batchMask
81 Mask fpu exceptions in batch mode [false].
82
83 -batchView
84 View output in batch mode [false].
85
86 -bw Convert all colors to black and white [false].
87
88 -cd directory
89 Set current directory; command-line only.
90
91 -cmyk Convert rgb colors to cmyk [false].
92
93 -c,-command string
94 Command to autoexecute.
95
96 -compact
97 Conserve memory at the expense of speed [false].
98
99 -compress
100 Compress images in PDF output [true].
101
102 -d,-debug
103 Enable debugging messages [false].
104
105 -devicepixelratio n
106 Ratio of physical to logical pixels [1].
107
108 -digits n
109 Default output file precision [7].
110
111 -divisor n
112 Garbage collect using purge(divisor=n) [2].
113
114 -dvisvgmMultipleFiles
115 dvisvgm supports multiple files [false].
116
117 -embed Embed rendered preview image [true].
118
119 -exitonEOF
120 Exit interactive mode on EOF [true].
121
122 -fitscreen
123 Fit rendered image to screen [true].
124
125 -framedelay ms
126 Additional frame delay [0].
127
128 -framerate frames/s
129 Animation speed [30].
130
131 -globalread
132 Allow read from other directory [true].
133
134 -globalwrite
135 Allow write to other directory [false].
136
137 -gray Convert all colors to grayscale [false].
138
139 -h,-help
140 Show summary of options; command-line only.
141
142 -historylines n
143 Retain n lines of history [1000].
144
145 -ibl Enable environment map image-based lighting [false].
146
147 -iconify
148 Iconify rendering window [false].
149
150 -image string
151 Environment image name [snowyField].
152
153 -imageDir string
154 Environment image library directory [ibl].
155
156 -inlineimage
157 Generate inline embedded image [false].
158
159 -inlinetex
160 Generate inline TeX code [false].
161
162 -interactiveMask
163 Mask fpu exceptions in interactive mode [true].
164
165 -interactiveView
166 View output in interactive mode [true].
167
168 -interactiveWrite
169 Write expressions entered at the prompt to stdout [true].
170
171 -k,-keep
172 Keep intermediate files [false].
173
174 -keepaux
175 Keep intermediate LaTeX .aux files [false].
176
177 -level n
178 Postscript level [3].
179
180 -l,-listvariables
181 List available global functions and variables [false].
182
183 -localhistory
184 Use a local interactive history file [false].
185
186 -loop Loop 3D animations [false].
187
188 -lossy Use single precision for V3D reals [false].
189
190 -lsp Interactive mode for the Language Server Protocol [false].
191
192 -m,-mask
193 Mask fpu exceptions; command-line only.
194
195 -maxtile pair
196 Maximum rendering tile size [(1024,768)].
197
198 -maxviewport pair
199 Maximum viewport size [(0,0)].
200
201 -multiline
202 Input code over multiple lines at the prompt [false].
203
204 -multipleView
205 View output from multiple batch-mode files [false].
206
207 -multisample n
208 Multisampling width for screen images [4].
209
210 -offline
211 Produce offline html files [false].
212
213 -O,-offset pair
214 PostScript offset [(0,0)].
215
216 -f,-outformat format
217 Convert each output file to specified format.
218
219 -o,-outname name
220 Alternative output directory/filename.
221
222 -p,-parseonly
223 Parse file [false].
224
225 -pdfreload
226 Automatically reload document in pdfviewer [false].
227
228 -pdfreloaddelay usec
229 Delay before attempting initial pdf reload [750000].
230
231 -position pair
232 Initial 3D rendering screen position [(0,0)].
233
234 -prc Embed 3D PRC graphics in PDF output [false].
235
236 -prerender resolution
237 Prerender V3D objects (0 implies vector output) [0].
238
239 -prompt string
240 Prompt [> ].
241
242 -prompt2 string
243 Continuation prompt for multiline input [..].
244
245 -q,-quiet
246 Suppress welcome text and noninteractive stdout [false].
247
248 -render n
249 Render 3D graphics using n pixels per bp (-1=auto) [-1].
250
251 -resizestep step
252 Resize step [1.2].
253
254 -reverse
255 reverse 3D animations [false].
256
257 -rgb Convert cmyk colors to rgb [false].
258
259 -safe Disable system call [true].
260
261 -scroll n
262 Scroll standard output n lines at a time [0].
263
264 -shiftHoldDistance n
265 WebGL touch screen distance limit for shift mode [20].
266
267 -shiftWaitTime ms
268 WebGL touch screen shift mode delay [200].
269
270 -spinstep deg/s
271 Spin speed [60].
272
273 -svgemulation
274 Emulate unimplemented SVG shading [true].
275
276 -tabcompletion
277 Interactive prompt auto-completion [true].
278
279 -tex engine
280 latex|pdflatex|xelatex|lualatex|tex|pdftex|luatex|context|none
281 [latex].
282
283 -thick Render thick 3D lines [true].
284
285 -thin Render thin 3D lines [true].
286
287 -threads
288 Use POSIX threads for 3D rendering [true].
289
290 -toolbar
291 Show 3D toolbar in PDF output [true].
292
293 -s,-translate
294 Show translated virtual machine code [false].
295
296 -twice Run LaTeX twice (to resolve references) [false].
297
298 -twosided
299 Use two-sided 3D lighting model for rendering [true].
300
301 -u,-user string
302 General purpose user string.
303
304 -v,-verbose
305 Increase verbosity level (can specify multiple times) [0].
306
307 -version
308 Show version; command-line only.
309
310 -vibrateTime ms
311 WebGL shift mode vibrate duration [25].
312
313 -viewportmargin pair
314 Horizontal and vertical 3D viewport margin [(0.5,0.5)].
315
316 -wait Wait for child processes to finish before exiting [false].
317
318 -warn string
319 Enable warning; command-line only.
320
321 -webgl2
322 Use webgl2 if available [false].
323
324 -where Show where listed variables are declared [false].
325
326 -wsl Run asy under the Windows Subsystem for Linux. [false].
327
328 -xasy Interactive mode for xasy [false].
329
330 -zoomPinchCap limit
331 WebGL maximum zoom pinch [100].
332
333 -zoomPinchFactor n
334 WebGL zoom pinch sensitivity [10].
335
336 -zoomfactor factor
337 Zoom step factor [1.05].
338
339 -zoomstep step
340 Mouse motion zoom step [0.1].
341
342
344 Asymptote is documented fully in the asymptote Info page. The manual
345 can also be accessed in interactive mode with the "help" command.
346
347
349 Asymptote was written by Andy Hammerlindl, John Bowman, and Tom Prince.
350
351 This manual page was written by Hubert Chan for the Debian project (but
352 may be used by others).
353
354
355
356 1 Dec 2004 ASY(1)