1OPENSCAD(1) General Commands Manual OPENSCAD(1)
2
6 openscad - script file based graphical CAD environment
7
9 openscad [options] [file]
10
12 This manual page documents briefly the openscad command.
13 openscad is a software for creating solid 3D CAD objects. It focuses on
15 CAD aspects rather than artistic ones.
16 OpenSCAD will start as a graphical program unless export options are
18 given (see below). For the usage of the GUI and a description of the
19 OpenSCAD language see the OpenSCAD user manual at http://en.wiki‐
20 books.org/wiki/OpenSCAD_User_Manual.
21
23 -o outputfile
24 Export the given file to outputfile in STL, OFF, AMF, DXF, SVG,
25 or PNG format, depending on file extension of outputfile. If
26 this option is given, the GUI will not be started.
27 Additional formats, which are mainly used for debugging and
29 testing (but can also be used in automation), are AST (the input
30 file as parsed and serialized again), CSG (an OpenSCAD language
31 representation of the input file with calculations done and mod‐
32 ule calls applied), TERM (the constructive solid geometry
33 expression passed to OpenCSG). If outputfile is null, no output
34 file will be written, but the file will still be evaluated and
35 all echo commands will be written to the standard error output.
36 (The rendering process will still take place if the --render
37 option is given.)
38 -d file.deps
40 If the -d option is given, all files accessed while exporting
41 are written to the given deps file in the syntax of a Makefile.
42 -m make_command
44 If a nonexisting file is accessed during OpenSCAD's operation,
45 it will try to invoke make_command missing_file to create the
46 missing file, and then read it again.
47 -D var=val
49 This option can be used to assign constant values to OpenSCAD
50 variables. The variable's value is an expression, so if this
51 mechanism is used to assign strings, care has to be taken that
52 the shell does not consume quotation marks. More than one -D
53 option can be given.
54 --render
56 If exporting an image, render the model fully. (Default is pre‐
57 view)
58 --preview[=throwntogether]
60 If exporting an image, use an OpenCSG preview (optionally in
61 throwntogether mode for quicker rendering).
62 --csglimit=limit
64 If exporting an image as an OpenCSG preview, stop rendering
65 after encountering limit elements to avoid runaway resource
66 usage.
67 --camera=transx,transy,transz,rotx,roty,rotz,distance
69 If exporting an image, use a Gimbal camera with the given param‐
70 eters. Rot is rotation around the x, y, and z axis, trans is
71 the distance to move the object in the x, y, and z directions,
72 and distance is the distance between the camera and the center
73 of the object.
74 --camera=eyex,eyey,eyez,centerx,centery,centerz
76 If exporting an image, use a Vector camera with the given param‐
77 eters. The first three are for the Eye position, while the next
78 three are for the Center (or target) that the camera will look
79 at. The 'up' vector is not currently supported.
80 --viewall
82 If exporting an image, adjust camera distance to fit the whole
83 design in the frame
84 --autocenter
86 If exporting an image, center the design in the frame
87 --imgsize=width,height
89 If exporting an image, specify the pixel width and height
90 --projection=[o|ortho|p|perspective]
92 If exporting an image, specify whether to use orthographic or
93 perspective projection
94 --colorscheme=scheme
96 If exporting an image, use the specified color scheme for the
97 rendering. scheme can be any of Cornfield, Sunset, Metallic,
98 Starnight, BeforeDawn, Nature or DeepOcean.
99 -v, --version
101 Show version of program.
102 --info Show which versions of libraries were used to compile the pro‐
104 gram, and which OpenGL details are discovered.
105
107 Render example001.scad into the .stl format (raw triangle data):
108 openscad -o example001.stl examples/example001.scad
110 Compile a 2d image using a camera rotated 25 degrees in x and 35 in z,
112 distance 500, with orthographic projection:
113 openscad -o o.png o.scad --camera=0,0,0,25,0,35,500 --projection=ortho
115 Set the 'mode' variable in example017 so that it will render only the
117 parts of the shape. Export to a .dxf file.
118 openscad -x example017.dxf -D'mode="parts"' examples/example017.scad
120
123 OpenSCAD was written by Clifford Wolf, Marius Kintel, and others.
124 This manual page was written by chrysn <chrysn@fsfe.org>, for the
126 Debian project (and may be used by others). Updated by the OpenSCAD
127 team.
128 2015.03 OPENSCAD(1)