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 -V,-View
34 View output; command-line only.
35 -absolute
37 Use absolute WebGL dimensions [false].
38 -a,-align C|B|T|Z
40 Center, Bottom, Top, or Zero page alignment [C].
41 -aligndir pair
43 Directional page alignment (overrides align) [(0,0)].
44 -antialias n
46 Antialiasing width for rasterized output [2].
47 -auto3D
49 Automatically activate 3D scene [true].
50 -autobillboard
52 3D labels always face viewer by default [true].
53 -autoimport string
55 Module to automatically import.
56 -autoplain
58 Enable automatic importing of plain [true].
59 -autoplay
61 Autoplay 3D animations [false].
62 -autorotate
64 Enable automatic PDF page rotation [false].
65 -axes3 Show 3D axes in PDF output [true].
67 -batchMask
69 Mask fpu exceptions in batch mode [false].
70 -batchView
72 View output in batch mode [false].
73 -bw Convert all colors to black and white [false].
75 -cd directory
77 Set current directory; command-line only.
78 -cmyk Convert rgb colors to cmyk [false].
80 -c,-command string
82 Command to autoexecute.
83 -compact
85 Conserve memory at the expense of speed [false].
86 -compress
88 Compress images in PDF output [true].
89 -d,-debug
91 Enable debugging messages [false].
92 -devicepixelratio n
94 Ratio of physical to logical pixels [1].
95 -digits n
97 Default output file precision [7].
98 -divisor n
100 Garbage collect using purge(divisor=n) [2].
101 -embed Embed rendered preview image [true].
103 -envmap
105 Enable environment map image-based lighting (Experimental)
106 [false].
107 -exitonEOF
109 Exit interactive mode on EOF [true].
110 -fitscreen
112 Fit rendered image to screen [true].
113 -framedelay ms
115 Additional frame delay [0].
116 -framerate frames/s
118 Animation speed [30].
119 -globalread
121 Allow read from other directory [true].
122 -globalwrite
124 Allow write to other directory [false].
125 -gray Convert all colors to grayscale [false].
127 -h,-help
129 Show summary of options; command-line only.
130 -historylines n
132 Retain n lines of history [1000].
133 -iconify
135 Iconify rendering window [false].
136 -inlineimage
138 Generate inline embedded image [false].
139 -inlinetex
141 Generate inline TeX code [false].
142 -interactiveMask
144 Mask fpu exceptions in interactive mode [true].
145 -interactiveView
147 View output in interactive mode [true].
148 -interactiveWrite
150 Write expressions entered at the prompt to stdout [true].
151 -k,-keep
153 Keep intermediate files [false].
154 -keepaux
156 Keep intermediate LaTeX .aux files [false].
157 -level n
159 Postscript level [3].
160 -l,-listvariables
162 List available global functions and variables [false].
163 -localhistory
165 Use a local interactive history file [false].
166 -loop Loop 3D animations [false].
168 -m,-mask
170 Mask fpu exceptions; command-line only.
171 -maxtile pair
173 Maximum rendering tile size [(1024,768)].
174 -maxviewport pair
176 Maximum viewport size [(0,0)].
177 -multiline
179 Input code over multiple lines at the prompt [false].
180 -multipleView
182 View output from multiple batch-mode files [false].
183 -multisample n
185 Multisampling width for screen images [4].
186 -offline
188 Produce offline html files [false].
189 -O,-offset pair
191 PostScript offset [(0,0)].
192 -f,-outformat format
194 Convert each output file to specified format.
195 -o,-outname name
197 Alternative output directory/filename.
198 -p,-parseonly
200 Parse file [false].
201 -pdfreload
203 Automatically reload document in pdfviewer [false].
204 -pdfreloaddelay usec
206 Delay before attempting initial pdf reload [750000].
207 -position pair
209 Initial 3D rendering screen position [(0,0)].
210 -prc Embed 3D PRC graphics in PDF output [true].
212 -prompt string
214 Prompt [> ].
215 -prompt2 string
217 Continuation prompt for multiline input [..].
218 -q,-quiet
220 Suppress welcome text and noninteractive stdout [false].
221 -render n
223 Render 3D graphics using n pixels per bp (-1=auto) [-1].
224 -resizestep step
226 Resize step [1.2].
227 -reverse
229 reverse 3D animations [false].
230 -rgb Convert cmyk colors to rgb [false].
232 -safe Disable system call [true].
234 -scroll n
236 Scroll standard output n lines at a time [0].
237 -shiftHoldDistance n
239 WebGL touch screen distance limit for shift mode [20].
240 -shiftWaitTime ms
242 WebGL touch screen shift mode delay [200].
243 -spinstep deg/s
245 Spin speed [60].
246 -svgemulation
248 Emulate unimplemented SVG shading [true].
249 -tabcompletion
251 Interactive prompt auto-completion [true].
252 -tex engine
254 latex|pdflatex|xelatex|lualatex|tex|pdftex|luatex|context|none
255 [latex].
256 -thick Render thick 3D lines [true].
258 -thin Render thin 3D lines [true].
260 -threads
262 Use POSIX threads for 3D rendering [true].
263 -toolbar
265 Show 3D toolbar in PDF output [true].
266 -s,-translate
268 Show translated virtual machine code [false].
269 -twice Run LaTeX twice (to resolve references) [false].
271 -twosided
273 Use two-sided 3D lighting model for rendering [true].
274 -u,-user string
276 General purpose user string.
277 -v,-verbose
279 Increase verbosity level (can specify multiple times) [0].
280 -version
282 Show version; command-line only.
283 -vibrateTime ms
285 WebGL shift mode vibrate duration [25].
286 -viewportmargin pair
288 Horizontal and vertical 3D viewport margin [(0.5,0.5)].
289 -wait Wait for child processes to finish before exiting [false].
291 -warn string
293 Enable warning; command-line only.
294 -where Show where listed variables are declared [false].
296 -xasy Special interactive mode for xasy [false].
298 -zoomPinchCap limit
300 WebGL maximum zoom pinch [100].
301 -zoomPinchFactor n
303 WebGL zoom pinch sensitivity [10].
304 -zoomfactor factor
306 Zoom step factor [1.05].
307 -zoomstep step
309 Mouse motion zoom step [0.1].
310
313 Asymptote is documented fully in the asymptote Info page. The manual
314 can also be accessed in interactive mode with the "help" command.
315
318 Asymptote was written by Andy Hammerlindl, John Bowman, and Tom Prince.
319 This manual page was written by Hubert Chan for the Debian project (but
321 may be used by others).
322 1 Dec 2004 ASY(1)