1ASY(1)                      General Commands Manual                     ASY(1)
2
3
4

NAME

6       asy - Asymptote: a script-based vector graphics language
7

SYNOPSIS

9       asy [options] [file ...]
10

DESCRIPTION

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

OPTIONS

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

SEE ALSO

347       Asymptote  is  documented fully in the asymptote Info page.  The manual
348       can also be accessed in interactive mode with the "help" command.
349
350

AUTHOR

352       Asymptote was written by Andy Hammerlindl, John Bowman, and Tom Prince.
353
354       This manual page was written by Hubert Chan for the Debian project (but
355       may be used by others).
356
357
358
359                                  1 Dec 2004                            ASY(1)
Impressum