summaryrefslogtreecommitdiff
path: root/Build/source/utils/asymptote/doc/asy.1
blob: d9e680befc76fea0eb8176ac9dbbde9e82c3795b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
.\"                                      Hey, EMACS: -*- nroff -*-
.TH ASY 1 "1 Dec 2004"
.SH NAME
asy \- Asymptote: a script-based vector graphics language
.SH SYNOPSIS
.B asy
.RI [ options ]
.RI [ file \ ...]
.SH DESCRIPTION
\fBAsymptote\fP is a powerful descriptive vector graphics language for
technical drawings, inspired by MetaPost but with an improved C++-like syntax.
Asymptote provides for figures the same high-quality level of typesetting that
LaTeX does for scientific text.
.SH OPTIONS
If no arguments are given, Asymptote runs in interactive mode.
.PP
If "\-" is given as the file argument, Asymptote reads from standard input.
.PP
A summary of options is included below. The effect of most options
can be negated by prepending 
.B no
to the option name. 
Default values for most options may also be entered in the 
file 
.B .asy/config.asy
in the user's home directory using the long form:
.PP
     import settings;
     batchView=true;
.PP
For a complete
description, see the Info files.
.TP
.B \-V,\-View            
View output; command-line only.
.TP
.B \-a,\-align C|B|T|Z   
Center, Bottom, Top, or Zero page alignment [C].
.TP
.B \-antialias n        
Antialiasing width for rasterized output [2].
-arcballradius pixels Arcball radius [750]
.TP
.B \-auto3D             
Automatically activate 3D scene [true].
-autobillboard        3D labels always face viewer by default [true]
.TP
.B \-autoimport string  
Module to automatically import.
.TP
.B \-autoplain          
Enable automatic importing of plain [true].
.TP
.B \-autoplay           
Autoplay 3D animations [false].
.TP
.B \-autorotate         
Enable automatic PDF page rotation [false].
.TP
.B \-batchMask          
Mask fpu exceptions in batch mode [false].
.TP
.B \-batchView          
View output in batch mode [false].
.TP
.B \-bw                 
Convert all colors to black and white [false].
.TP
.B \-cd directory       
Set current directory; command-line only.
.TP
.B \-cmyk               
Convert rgb colors to cmyk [false].
.TP
.B \-c,\-command string  
Command to autoexecute.
.TP
.B \-compact            
Conserve memory at the expense of speed [false].
.TP
.B \-d,\-debug           
Enable debugging messages [false].
.TP
.B \-divisor n          
Garbage collect using purge(divisor=n) [2].
.TP
.B \-doubleclick ms     
Emulated double-click timeout [200].
.TP
.B \-embed              
Embed rendered preview image [true].
.TP
.B \-exitonEOF          
Exit interactive mode on EOF [true].
.TP
.B \-fitscreen          
Fit rendered image to screen [true].
.TP
.B \-framedelay ms      
Additional frame delay [0].
.TP
.B \-framerate frames/s 
Animation speed [30].
.TP
.B \-globalwrite        
Allow write to other directory [false].
.TP
.B \-gray               
Convert all colors to grayscale [false].
.TP
.B \-h,\-help            
Show summary of options; command-line only.
.TP
.B \-historylines n     
Retain n lines of history [1000].
.TP
.B \-iconify            
Iconify rendering window [false].
.TP
.B \-inlineimage        
Generate inline embedded image [false].
.TP
.B \-inlinetex          
Generate inline TeX code [false].
.TP
.B \-interactiveMask    
Mask fpu exceptions in interactive mode [true].
.TP
.B \-interactiveView    
View output in interactive mode [true].
.TP
.B \-interactiveWrite   
Write expressions entered at the prompt to stdout [true].
.TP
.B \-k,\-keep            
Keep intermediate files [false].
.TP
.B \-keepaux            
Keep intermediate LaTeX .aux files [false].
.TP
.B \-level n            
Postscript level [3].
.TP
.B \-l,\-listvariables   
List available global functions and variables [false].
.TP
.B \-localhistory       
Use a local interactive history file [false].
.TP
.B \-loop               
Loop 3D animations [false].
.TP
.B \-m,\-mask            
Mask fpu exceptions; command-line only.
.TP
.B \-maxtile pair       
Maximum rendering tile size [(0,0)].
.TP
.B \-maxviewport pair   
Maximum viewport size [(2048,2048)].
.TP
.B \-multiline          
Input code over multiple lines at the prompt [false].
.TP
.B \-multipleView       
View output from multiple batch-mode files [false].
.TP
.B \-multisample n      
Multisampling width for screen images [4].
.TP
.B \-O,\-offset pair     
PostScript offset [(0,0)].
.TP
.B \-f,\-outformat format
Convert each output file to specified format.
.TP
.B \-o,\-outname name    
Alternative output directory/filename.
.TP
.B \-p,\-parseonly       
Parse file [false].
.TP
.B \-pdfreload          
Automatically reload document in pdfviewer [false].
.TP
.B \-pdfreloaddelay usec
Delay before attempting initial pdf reload [750000].
.TP
.B \-position pair      
Initial 3D rendering screen position [(0,0)].
.TP
.B \-prc                
Embed 3D PRC graphics in PDF output [true].
.TP
.B \-prompt string      
Prompt [> ].
.TP
.B \-prompt2 string     
Continuation prompt for multiline input  [..].
.TP
.B \-q,\-quiet           
Suppress welcome message [false].
.TP
.B \-render n           
Render 3D graphics using n pixels per bp (-1=auto) [-1].
.TP
.B \-resizestep step    
Resize step [1.2].
.TP
.B \-reverse            
reverse 3D animations [false].
.TP
.B \-rgb                
Convert cmyk colors to rgb [false].
.TP
.B \-safe               
Disable system call [true].
.TP
.B \-scroll n           
Scroll standard output n lines at a time [0].
.TP
.B \-spinstep deg/s     
Spin speed [60].
.TP
.B \-svgemulation       
Emulate unimplemented SVG shading [false].
.TP
.B \-tabcompletion      
Interactive prompt auto-completion [true].
.TP
.B \-tex engine         
latex|pdflatex|xelatex|tex|pdftex|context|none [latex].
.TP
.B \-thick              
Render thick 3D lines [true].
.TP
.B \-thin               
Render thin 3D lines [true].
.TP
.B \-threads            
Use POSIX threads for 3D rendering [true].
.TP
.B \-toolbar            
Show 3D toolbar in PDF output [true].
.TP
.B \-s,\-translate       
Show translated virtual machine code [false].
.TP
.B \-twice              
Run LaTeX twice (to resolve references) [false].
.TP
.B \-twosided           
Use two-sided 3D lighting model for rendering [true].
.TP
.B \-u,\-user string     
General purpose user string.
.TP
.B \-v,\-verbose         
Increase verbosity level (can specify multiple times) [0].
.TP
.B \-version            
Show version; command-line only.
.TP
.B \-wait               
Wait for child processes to finish before exiting [false].
.TP
.B \-warn string        
Enable warning; command-line only.
.TP
.B \-where              
Show where listed variables are declared [false].
.TP
.B \-zoomfactor factor  
Zoom step factor [1.05].
.TP
.B \-zoomstep step      
Mouse motion zoom step [0.1].

.SH SEE ALSO
Asymptote is documented fully in the asymptote Info page.
The manual can also be accessed in interactive mode with the "help" command.

.SH AUTHOR
Asymptote was written by Andy Hammerlindl, John Bowman, and Tom Prince.
.PP
This manual page was written by Hubert Chan for the Debian project (but may
be used by others).