logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

asy - Asymptote: a script-based vector graphics language

Author

       Asymptote was written by Andy Hammerlindl, John Bowman, and Tom Prince.

       This manual page was written by Hubert Chan for the Debian project (but may be used by others).

                                                   1 Dec 2004                                             ASY(1)

Description

Asymptote 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.

Name

       asy - Asymptote: a script-based vector graphics language

Options

       If no arguments are given, Asymptote runs in interactive mode.

       If "-" is given as the file argument, Asymptote reads from standard input.

       A summary of options is included below. The effect of most options can be negated by prepending no to the
       option name.  Default values for most options may also be entered in  the  file  .asy/config.asy  in  the
       user's home directory using the long form:

            import settings;
            batchView=true;

       For a complete description, see the Info files.

       -GPUblockSizen
              Compute shader block size [8].

       -GPUcompress
              Compress GPU transparent fragment counts [false].

       -GPUindexing
              Compute indexing partial sums on GPU [true].

       -GPUinterlock
              Use fragment shader interlock [true].

       -GPUlocalSizen
              Compute shader local size [256].

       -V,-View
              View output; command-line only.

       -absolute
              Use absolute WebGL dimensions [false].

       -a,-alignC|B|T|Z
              Center, Bottom, Top, or Zero page alignment [C].

       -aligndirpair
              Directional page alignment (overrides align) [(0,0)].  -animating             [false]

       -antialiasn
              Antialiasing width for rasterized output [2].

       -auto3D
              Automatically activate 3D scene [true].

       -autobillboard
              3D labels always face viewer by default [true].

       -autoimportstr
              Module to automatically import.

       -autoplain
              Enable automatic importing of plain [true].

       -autoplay
              Autoplay 3D animations [false].

       -autorotate
              Enable automatic PDF page rotation [false].

       -axes3 Show 3D axes in PDF output [true].

       -batchMask
              Mask fpu exceptions in batch mode [false].

       -batchView
              View output in batch mode [false].

       -bw    Convert all colors to black and white false.

       -cddirectory
              Set current directory; command-line only.

       -cmyk  Convert rgb colors to cmyk false.

       -c,-commandstr
              Command to autoexecute.

       -compact
              Conserve memory at the expense of speed false.

       -compress
              Compress images in PDF output [true].  -convertOptions str    []

       -d,-debug
              Enable debugging messages and traceback [false].

       -devicepixelration
              Ratio of physical to logical pixels [1].

       -digitsn
              Default output file precision [7].

       -divisorn
              Garbage collect using purge(divisor=n) [2].  -dvipsOptions str      []

       -dvisvgmMultipleFiles
              dvisvgm supports multiple files [true].  -dvisvgmOptions str    [--optimize]

       -embed Embed rendered preview image [true].

       -e,-environment
              Show summary of environment settings; command-line only.

       -exitonEOF
              Exit interactive mode on EOF [true].

       -fitscreen
              Fit rendered image to screen [true].

       -framerateframes/s
              Animation speed [30].  -glOptions str         []

       -globalread
              Allow read from other directory true.

       -globalwrite
              Allow write to other directory false.

       -gray  Convert all colors to grayscale false.  -gsOptions str         []

       -h,-help
              Show summary of options; command-line only.

       -historylinesn
              Retain    n    lines   of   history   [1000].    -htmlviewerOptions   str   -hyperrefOptions   str
              [setpagesize=false,unicode,pdfborder=0 0 0]

       -ibl   Enable environment map image-based lighting [false].

       -iconify
              Iconify rendering window [false].

       -imagestr
              Environment image name [snowyField].

       -imageDirstr
              Environment image library directory [ibl].

       -inlineimage
              Generate inline embedded image [false].

       -inlinetex
              Generate inline TeX code [false].

       -inpipen
              Input pipe [-1].

       -interactiveMask
              Mask fpu exceptions in interactive mode [true].

       -interactiveView
              View output in interactive mode [true].

       -interactiveWrite
              Write expressions entered at the prompt to stdout [true].  -interrupt             [false]

       -k,-keep
              Keep intermediate files [false].

       -keepaux
              Keep intermediate LaTeX .aux files [false].

       -leveln
              Postscript level [3].

       -l,-listvariables
              List available global functions and variables [false].

       -localhistory
              Use a local interactive history file [false].

       -loop  Loop 3D animations [false].

       -lossy Use single precision for V3D reals [false].

       -lsp   Interactive mode for the Language Server Protocol [false].

       -m,-mask
              Mask fpu exceptions; command-line only.

       -maxtilepair
              Maximum rendering tile size [(1024,768)].

       -maxviewportpair
              Maximum viewport size [(0,0)].

       -multiline
              Input code over multiple lines at the prompt [false].

       -multipleView
              View output from multiple batch-mode files [false].

       -multisamplen
              Multisampling width for screen images [4].

       -offline
              Produce offline html files [false].

       -O,-offsetpair
              PostScript offset [(0,0)].

       -f,-outformatformat
              Convert each output file to specified format.

       -o,-outnamename
              Alternative output directory/file prefix.

       -outpipen
              Output pipe [-1].

       -paperheightbp
              Default page height [0].

       -paperwidthbp
              Default page width [0].

       -p,-parseonly
              Parse file [false].

       -pdfreload
              Automatically reload document in pdfviewer [false].  -pdfreloadOptions str  []

       -pdfreloaddelayusec
              Delay before attempting initial pdf reload [750000].  -pdfviewerOptions str  []

       -positionpair
              Initial 3D rendering screen position [(0,0)].

       -prc   Embed 3D PRC graphics in PDF output [false].

       -prerenderresolution
              Prerender V3D objects (0 implies vector output) [0].

       -promptstr
              Prompt [> ].

       -prompt2str
              Continuation prompt for multiline input  [..].  -psviewerOptions str   []

       -q,-quiet
              Suppress welcome text and noninteractive stdout [false].

       -rendern
              Render 3D graphics using n pixels per bp (-1=auto) [-1].

       -resizestepstep
              Resize step [1.2].

       -reverse
              reverse 3D animations [false].

       -rgb   Convert cmyk colors to rgb false.

       -safe  Disable system call true.

       -scrolln
              Scroll standard output n lines at a time [0].

       -shiftHoldDistancen
              WebGL touch screen distance limit for shift mode [20].

       -shiftWaitTimems
              WebGL touch screen shift mode delay [200].

       -spinstepdeg/s
              Spin speed [60].

       -svgemulation
              Emulate unimplemented SVG shading [true].

       -tabcompletion
              Interactive prompt auto-completion [true].

       -texengine
              latex|pdflatex|xelatex|lualatex|tex|pdftex|luatex|context|none [latex].

       -thick Render thick 3D lines [true].

       -thin  Render thin 3D lines [true].

       -threads
              Use POSIX threads for 3D rendering [true].

       -toolbar
              Show 3D toolbar in PDF output [true].

       -s,-translate
              Show translated virtual machine code [false].

       -twice Run LaTeX twice (to resolve references) [false].

       -twosided
              Use two-sided 3D lighting model for rendering [true].

       -u,-userstr
              General purpose user string.

       -v3d   Embed 3D V3D graphics in PDF output [false].

       -v,-verbose
              Increase verbosity level (can specify multiple times) 0.

       -version
              Show version; command-line only.

       -vibrateTimems
              WebGL shift mode vibrate duration [25].

       -viewportmarginpair
              Horizontal and vertical 3D viewport margin [(0.5,0.5)].

       -wait  Wait for child processes to finish before exiting [false].

       -warnstr
              Enable warning; command-line only.

       -webgl2
              Use webgl2 if available [false].

       -where Show where listed variables are declared [false].

       -wsl   Run asy under the Windows Subsystem for Linux [false].

       -xasy  Interactive mode for xasy [false].

       -zoomPinchCaplimit
              WebGL maximum zoom pinch [100].

       -zoomPinchFactorn
              WebGL zoom pinch sensitivity [10].

       -zoomfactorfactor
              Zoom step factor [1.05].

       -zoomstepstep
              Mouse motion zoom step [0.1].

See Also

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

Synopsis

asy [options] [file ...]

See Also