mirror of https://github.com/vitalif/openscad
117 lines
4.6 KiB
Groff
117 lines
4.6 KiB
Groff
.TH OPENSCAD 1 "2015.03"
|
|
.\" Please adjust this date whenever revising the manpage.
|
|
.SH NAME
|
|
openscad \- script file based graphical CAD environment
|
|
.SH SYNOPSIS
|
|
.B openscad
|
|
.RI [ options ]
|
|
.RI [ file ]
|
|
.SH DESCRIPTION
|
|
This manual page documents briefly the \fBopenscad\fP command.
|
|
.PP
|
|
\fBopenscad\fP is a software for creating solid 3D CAD objects. It focuses on
|
|
CAD aspects rather than artistic ones.
|
|
|
|
OpenSCAD will start as a graphical program unless export options are given (see
|
|
below). For the usage of the GUI and a description of the OpenSCAD language see
|
|
the OpenSCAD user manual at http://en.wikibooks.org/wiki/OpenSCAD_User_Manual.
|
|
.SH OPTIONS
|
|
|
|
.TP
|
|
\fB-o\fP \fIoutputfile\fP
|
|
Export the given file to \fIoutputfile\fP in STL, OFF, AMF, DXF, SVG, or PNG
|
|
format, depending on file extension of \fIoutputfile\fP. If this
|
|
option is given, the GUI will not be started.
|
|
|
|
Additional formats, which are mainly used for debugging and testing (but can
|
|
also be used in automation), are AST (the input file as parsed and serialized
|
|
again), CSG (an OpenSCAD language representation of the input file with
|
|
calculations done and module calls applied), TERM (the constructive solid
|
|
geometry expression passed to OpenCSG). If \fIoutputfile\fP is \fBnull\fP, no
|
|
output file will be written, but the file will still be evaluated and all
|
|
\fBecho\fP commands will be written to the standard error output. (The
|
|
rendering process will still take place if the \fB\-\-render\fP option is
|
|
given.)
|
|
.TP
|
|
\fB\-d\fP \fIfile.deps\fP
|
|
If the \fB-d\fP option is given, all files accessed while exporting are written
|
|
to the given deps file in the syntax of a Makefile.
|
|
.TP
|
|
\fB-m\fP \fImake_command\fP
|
|
If a nonexisting file is accessed during OpenSCAD's operation, it will try to
|
|
invoke \fImake_command missing_file\fP to create the missing file, and then
|
|
read it again.
|
|
.TP
|
|
\fB-D\fP \fIvar=val\fP
|
|
This option can be used to assign constant values to OpenSCAD variables. The
|
|
variable's value is an expression, so if this mechanism is used to assign
|
|
strings, care has to be taken that the shell does not consume quotation marks.
|
|
More than one \fB-D\fP option can be given.
|
|
.TP
|
|
.B \-\-render
|
|
If exporting an image, render the model fully. (Default is preview)
|
|
.TP
|
|
.B \-\-preview[=throwntogether]
|
|
If exporting an image, use an OpenCSG preview (optionally in throwntogether mode for quicker rendering).
|
|
.TP
|
|
.B \-\-csglimit=limit
|
|
If exporting an image as an OpenCSG preview, stop rendering after encountering \fIlimit\fP elements to avoid runaway resource usage.
|
|
.TP
|
|
.B \-\-camera=transx,transy,transz,rotx,roty,rotz,distance
|
|
If exporting an image, use a Gimbal camera with the given parameters.
|
|
Rot is rotation around the x, y, and z axis, trans is the distance to
|
|
move the object in the x, y, and z directions, and distance is the
|
|
distance between the camera and the center of the object.
|
|
.TP
|
|
.B \-\-camera=eyex,eyey,eyez,centerx,centery,centerz
|
|
If exporting an image, use a Vector camera with the given parameters.
|
|
The first three are for the Eye position, while the next three are for
|
|
the Center (or target) that the camera will look at. The 'up' vector is
|
|
not currently supported.
|
|
.TP
|
|
.B \-\-viewall
|
|
If exporting an image, adjust camera distance to fit the whole design in the frame
|
|
.TP
|
|
.B \-\-autocenter
|
|
If exporting an image, center the design in the frame
|
|
.TP
|
|
.B \-\-imgsize=width,height
|
|
If exporting an image, specify the pixel width and height
|
|
.TP
|
|
.B \-\-projection=[o|ortho|p|perspective]
|
|
If exporting an image, specify whether to use orthographic or perspective
|
|
projection
|
|
.TP
|
|
.B \-\-colorscheme=[Cornfield|Sunset|Metallic|Starnight|BeforeDawn|Nature|DeepOcean]
|
|
If exporting an image, use the specified color scheme for the rendering.
|
|
.TP
|
|
.B \-v, \-\-version
|
|
Show version of program.
|
|
.TP
|
|
.B \-\-info
|
|
Show which versions of libraries were used to compile the program, and which
|
|
OpenGL details are discovered.
|
|
.SH COMMAND LINE EXAMPLES
|
|
.PP
|
|
|
|
Render example001.scad into the .stl format (raw triangle data):
|
|
.PP
|
|
.B openscad -o example001.stl examples/example001.scad
|
|
.PP
|
|
Compile a 2d image using a camera rotated 25 degrees in x and 35 in z,
|
|
distance 500, with orthographic projection:
|
|
.PP
|
|
.B openscad -o o.png o.scad --camera=0,0,0,25,0,35,500 --projection=ortho
|
|
.PP
|
|
Set the 'mode' variable in example017 so that it will render only the
|
|
parts of the shape. Export to a .dxf file.
|
|
.PP
|
|
.B openscad -x example017.dxf -D'mode="parts"' examples/example017.scad
|
|
|
|
.SH AUTHOR
|
|
OpenSCAD was written by Clifford Wolf, Marius Kintel, and others.
|
|
.PP
|
|
This manual page was written by chrysn <chrysn@fsfe.org>,
|
|
for the Debian project (and may be used by others). Updated by
|
|
the OpenSCAD team.
|