summaryrefslogtreecommitdiff
path: root/doc/openscad.1
diff options
context:
space:
mode:
authordonbright <hugh.m.bright@gmail.com>2013-03-05 23:47:14 (GMT)
committerdonbright <hugh.m.bright@gmail.com>2013-03-05 23:47:14 (GMT)
commit42f21c3a0850083d245aa3ac346a53e876f0679e (patch)
treefacf41750e0fe27cc4cdaf352c9c8e687011d103 /doc/openscad.1
parent422c668dcb538f181683ae51305bf8d3404f48d6 (diff)
parent4734172c3a16cc06b09e4d2131aa8e380bd0f226 (diff)
Merge pull request #288 from openscad/issue11_2
Issue11 2
Diffstat (limited to 'doc/openscad.1')
-rw-r--r--doc/openscad.146
1 files changed, 43 insertions, 3 deletions
diff --git a/doc/openscad.1 b/doc/openscad.1
index a4c03dd..a93c33f 100644
--- a/doc/openscad.1
+++ b/doc/openscad.1
@@ -1,4 +1,4 @@
-.TH OPENSCAD 1 "2011-11-03"
+.TH OPENSCAD 1 "2013-03-xx"
.\" Please adjust this date whenever revising the manpage.
.SH NAME
openscad \- script file based graphical CAD environment
@@ -19,7 +19,7 @@ the OpenSCAD user manual at http://en.wikibooks.org/wiki/OpenSCAD_User_Manual.
.TP
\fB-o\fP \fIoutputfile\fP
-Export the given file to \fIoutputfile\fP in STL, OFF, DXF or CSG format,
+Export the given file to \fIoutputfile\fP in STL, OFF, DXF, CSG, or PNG format,
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
@@ -40,8 +40,48 @@ 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)
+.TP
+.B \-\-camera=rotx,roty,rotz,transx,transy,transz,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 \-\-imgsize=width,height
+If exporting an image, specify the pixel width and height
+.TP
+.B \-\-projection=[o|p]
+If exporting an image, specify whether to use orthographic or perspective
+projection
+.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).
+for the Debian project (and may be used by others). Updated by
+the OpenSCAD team.
contact: Jan Huwald // Impressum