1ASY(1) General Commands Manual ASY(1)
2
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 If "-" is given as the file argument, Asymptote reads from standard in‐
21 put.
22 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 import settings;
29 batchView=true;
30 For a complete description, see the Info files.
32 -GPUblockSize n
34 Compute shader block size [8].
35 -GPUcompress
37 Compress GPU transparent fragment counts [false].
38 -GPUindexing
40 Compute indexing partial sums on GPU [true].
41 -GPUinterlock
43 Use fragment shader interlock [true].
44 -GPUlocalSize n
46 Compute shader local size [256].
47 -V,-View
49 View output; command-line only.
50 -absolute
52 Use absolute WebGL dimensions [false].
53 -a,-align C|B|T|Z
55 Center, Bottom, Top, or Zero page alignment [C].
56 -aligndir pair
58 Directional page alignment (overrides align) [(0,0)]. -animat‐
59 ing [false]
60 -antialias n
62 Antialiasing width for rasterized output [2].
63 -auto3D
65 Automatically activate 3D scene [true].
66 -autobillboard
68 3D labels always face viewer by default [true].
69 -autoimport str
71 Module to automatically import.
72 -autoplain
74 Enable automatic importing of plain [true].
75 -autoplay
77 Autoplay 3D animations [false].
78 -autorotate
80 Enable automatic PDF page rotation [false].
81 -axes3 Show 3D axes in PDF output [true].
83 -batchMask
85 Mask fpu exceptions in batch mode [false].
86 -batchView
88 View output in batch mode [false].
89 -bw Convert all colors to black and white false.
91 -cd directory
93 Set current directory; command-line only.
94 -cmyk Convert rgb colors to cmyk false.
96 -c,-command str
98 Command to autoexecute.
99 -compact
101 Conserve memory at the expense of speed false.
102 -compress
104 Compress images in PDF output [true]. -convertOptions str []
105 -d,-debug
107 Enable debugging messages [false].
108 -devicepixelratio n
110 Ratio of physical to logical pixels [1].
111 -digits n
113 Default output file precision [7].
114 -divisor n
116 Garbage collect using purge(divisor=n) [2]. -dvipsOptions str
117 []
118 -dvisvgmMultipleFiles
120 dvisvgm supports multiple files [true]. -dvisvgmOptions str
121 []
122 -embed Embed rendered preview image [true].
124 -e,-environment
126 Show summary of environment settings; command-line only.
127 -exitonEOF
129 Exit interactive mode on EOF [true].
130 -fitscreen
132 Fit rendered image to screen [true].
133 -framerate frames/s
135 Animation speed [30]. -glOptions str []
136 -globalread
138 Allow read from other directory true.
139 -globalwrite
141 Allow write to other directory false.
142 -gray Convert all colors to grayscale false. -gsOptions str
144 []
145 -h,-help
147 Show summary of options; command-line only.
148 -historylines n
150 Retain n lines of history [1000]. -htmlviewerOptions str -hy‐
151 perrefOptions str [setpagesize=false,unicode,pdfborder=0 0 0]
152 -ibl Enable environment map image-based lighting [false].
154 -iconify
156 Iconify rendering window [false].
157 -image str
159 Environment image name [snowyField].
160 -imageDir str
162 Environment image library directory [ibl].
163 -inlineimage
165 Generate inline embedded image [false].
166 -inlinetex
168 Generate inline TeX code [false].
169 -inpipe n
171 Input pipe [-1].
172 -interactiveMask
174 Mask fpu exceptions in interactive mode [true].
175 -interactiveView
177 View output in interactive mode [true].
178 -interactiveWrite
180 Write expressions entered at the prompt to stdout [true]. -in‐
181 terrupt [false]
182 -k,-keep
184 Keep intermediate files [false].
185 -keepaux
187 Keep intermediate LaTeX .aux files [false].
188 -level n
190 Postscript level [3].
191 -l,-listvariables
193 List available global functions and variables [false].
194 -localhistory
196 Use a local interactive history file [false].
197 -loop Loop 3D animations [false].
199 -lossy Use single precision for V3D reals [false].
201 -lsp Interactive mode for the Language Server Protocol [false].
203 -m,-mask
205 Mask fpu exceptions; command-line only.
206 -maxtile pair
208 Maximum rendering tile size [(1024,768)].
209 -maxviewport pair
211 Maximum viewport size [(0,0)].
212 -multiline
214 Input code over multiple lines at the prompt [false].
215 -multipleView
217 View output from multiple batch-mode files [false].
218 -multisample n
220 Multisampling width for screen images [4].
221 -offline
223 Produce offline html files [false].
224 -O,-offset pair
226 PostScript offset [(0,0)].
227 -f,-outformat format
229 Convert each output file to specified format.
230 -o,-outname name
232 Alternative output directory/filename.
233 -outpipe n
235 Output pipe [-1].
236 -paperheight bp
238 Default page height [0].
239 -paperwidth bp
241 Default page width [0].
242 -p,-parseonly
244 Parse file [false].
245 -pdfreload
247 Automatically reload document in pdfviewer [false]. -pdfreload‐
248 Options str []
249 -pdfreloaddelay usec
251 Delay before attempting initial pdf reload [750000].
252 -pdfviewerOptions str []
253 -position pair
255 Initial 3D rendering screen position [(0,0)].
256 -prc Embed 3D PRC graphics in PDF output [false].
258 -prerender resolution
260 Prerender V3D objects (0 implies vector output) [0].
261 -prompt str
263 Prompt [> ].
264 -prompt2 str
266 Continuation prompt for multiline input [..]. -psviewerOptions
267 str []
268 -q,-quiet
270 Suppress welcome text and noninteractive stdout [false].
271 -render n
273 Render 3D graphics using n pixels per bp (-1=auto) [-1].
274 -resizestep step
276 Resize step [1.2].
277 -reverse
279 reverse 3D animations [false].
280 -rgb Convert cmyk colors to rgb false.
282 -safe Disable system call true.
284 -scroll n
286 Scroll standard output n lines at a time [0].
287 -shiftHoldDistance n
289 WebGL touch screen distance limit for shift mode [20].
290 -shiftWaitTime ms
292 WebGL touch screen shift mode delay [200].
293 -spinstep deg/s
295 Spin speed [60].
296 -svgemulation
298 Emulate unimplemented SVG shading [true].
299 -tabcompletion
301 Interactive prompt auto-completion [true].
302 -tex engine
304 latex|pdflatex|xelatex|lualatex|tex|pdftex|luatex|context|none
305 [latex].
306 -thick Render thick 3D lines [true].
308 -thin Render thin 3D lines [true].
310 -threads
312 Use POSIX threads for 3D rendering [true].
313 -toolbar
315 Show 3D toolbar in PDF output [true].
316 -s,-translate
318 Show translated virtual machine code [false].
319 -twice Run LaTeX twice (to resolve references) [false].
321 -twosided
323 Use two-sided 3D lighting model for rendering [true].
324 -u,-user str
326 General purpose user string.
327 -v,-verbose
329 Increase verbosity level (can specify multiple times) 0.
330 -version
332 Show version; command-line only.
333 -vibrateTime ms
335 WebGL shift mode vibrate duration [25].
336 -viewportmargin pair
338 Horizontal and vertical 3D viewport margin [(0.5,0.5)].
339 -wait Wait for child processes to finish before exiting [false].
341 -warn str
343 Enable warning; command-line only.
344 -webgl2
346 Use webgl2 if available [false].
347 -where Show where listed variables are declared [false].
349 -wsl Run asy under the Windows Subsystem for Linux [false].
351 -xasy Interactive mode for xasy [false].
353 -zoomPinchCap limit
355 WebGL maximum zoom pinch [100].
356 -zoomPinchFactor n
358 WebGL zoom pinch sensitivity [10].
359 -zoomfactor factor
361 Zoom step factor [1.05].
362 -zoomstep step
364 Mouse motion zoom step [0.1].
365
368 Asymptote is documented fully in the asymptote Info page. The manual
369 can also be accessed in interactive mode with the "help" command.
370
373 Asymptote was written by Andy Hammerlindl, John Bowman, and Tom Prince.
374 This manual page was written by Hubert Chan for the Debian project (but
376 may be used by others).
377 1 Dec 2004 ASY(1)