summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/TODO.txt2
-rw-r--r--doc/checklist-macosx.txt20
-rw-r--r--doc/openscad.146
-rw-r--r--doc/release-checklist.txt9
-rw-r--r--doc/testing.txt7
5 files changed, 55 insertions, 29 deletions
diff --git a/doc/TODO.txt b/doc/TODO.txt
index be03e98..d05df2c 100644
--- a/doc/TODO.txt
+++ b/doc/TODO.txt
@@ -122,7 +122,7 @@ OpenCSG-related
o OpenCSG rendering: Coincident surfaces causes z-buffer fighting. Is this somehow
avoidable tuning the depth tests in OpenCSG?
o When specifying a transparency with the color() statement,
- the object is not sorted and will be rendered wrongly
+ the object is not sorted and will be rendered wrongly. See issue #310 for some good test models.
o Bug: Using the background operator (%) on the only object in a scene triggers a
CSG error: No top level object found
diff --git a/doc/checklist-macosx.txt b/doc/checklist-macosx.txt
deleted file mode 100644
index a72a8d3..0000000
--- a/doc/checklist-macosx.txt
+++ /dev/null
@@ -1,20 +0,0 @@
-NB! This is the Mac OS X deployment checklist.
- See build-macosx.txt for how to build a development build of
- OpenSCAD for your system only without manually compiling all
- dependencies.
-
-o Macports:
- sudo port install cmake ImageMagick
-
-o Qt4
- - Download and install the combined 32-bit and 64-bit build for 10.5-10.6 from here:
- http://qt.nokia.com/downloads/qt-for-open-source-cpp-development-on-mac-os-x
-
-o Build dependencies from source
-
- scripts/macosx-build-dependencies.sh
-
-o Build and Deploy OpenSCAD
-
-# Update VERSION in publish-macosx.sh
- scripts/publish-macosx.sh
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.
diff --git a/doc/release-checklist.txt b/doc/release-checklist.txt
index c51c919..f5bb759 100644
--- a/doc/release-checklist.txt
+++ b/doc/release-checklist.txt
@@ -3,9 +3,12 @@ OpenSCAD Release Checklist
(See bottom of this file for how to build release binaries)
-o Update VERSION environment variable
+o Set VERSION and VERSIONDATE environment variable
+ (VERSIONDATE is new and used to identify releases. VERSION is for humans.
+ For development builds, set VERSION and VERSIONDATE to the same value)
export VERSION=2013.01
+ export VERSIONDATE=2013.01.17
It will be used by the commands below, as well as these files:
@@ -38,13 +41,15 @@ o Update external resources:
- http://en.wikipedia.org/wiki/OpenSCAD
o Notify package managers
- Ubuntu: https://launchpad.net/~chrysn
+ - Fedora: Miro HronĨok <miro@hroncok.cz> or <mhroncok@redhat.com>
- MacPorts:
Build and Upload Release Binaries
---------------------------------
-$ export VERSION=<openscad version, e.g. 2013.01>
+$ export VERSIONDATE=<date of release in YYYY.MM.DD format, e.g. 2013.01.17>
+$ export VERSION=<openscad version, e.g. 2013.01> # If development snapshot, you don't need version is the same as VERSIONDATE
$ tar xzf openscad-$VERSION.src.tar.gz
$ cd openscad-$VERSION
diff --git a/doc/testing.txt b/doc/testing.txt
index bbd7c18..0b14903 100644
--- a/doc/testing.txt
+++ b/doc/testing.txt
@@ -3,6 +3,9 @@ Running regression tests:
Prerequisites: cmake, python, ImageMagick 6.5.9.3 or newer
+First, get a working qmake GUI build. It is used by the tests.
+Next, get MCAD installed by using 'git submodule update --init'
+
A) Building test environment
Linux, Mac:
@@ -12,9 +15,7 @@ $ make
Windows + MSVC:
-First, get a normal build working by following instructions at
-http://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Building_on_Windows
-Then, from the QT command prompt:
+From the QT command prompt:
> cd tests
> cmake . -DCMAKE_BUILD_TYPE=Release
contact: Jan Huwald // Impressum