openscad/doc/openscad.1

57 lines
2.1 KiB
Groff
Raw Normal View History

2013-03-03 21:54:34 +04:00
.TH OPENSCAD 1 "2013-03-xx"
2011-11-03 21:40:54 +04:00
.\" 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
2013-01-31 08:17:35 +04:00
Export the given file to \fIoutputfile\fP in STL, OFF, DXF, CSG, or PNG format,
2011-11-03 21:40:54 +04:00
depending on file extension of \fIoutputfile\fP (which has to be lower case).
If this option is given, the GUI will not be started.
.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 options can be given.
.TP
.B \-v, \-\-version
Show version of program.
.TP
.B \-\-render
If exporting an image, use a full CGAL render. (Default is an OpenCSG compile)
2013-03-03 21:54:34 +04:00
.TP
.B \-\-gimbalcam=rotx,roty,rotz,transx,transy,transz,distance
If exporting an image, use a Gimbal camera with the given parameters
.TP
.B \-\-vectorcam=eyex,eyey,eyez,centerx,centery,centerz
If exporting an image, use a Vector camera with the given parameters
2011-11-03 21:40:54 +04:00
.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).