diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/TODO.txt | 4 | ||||
| -rw-r--r-- | doc/openscad.1 | 47 |
2 files changed, 49 insertions, 2 deletions
diff --git a/doc/TODO.txt b/doc/TODO.txt index 26dd6c8..7df6a4d 100644 --- a/doc/TODO.txt +++ b/doc/TODO.txt @@ -52,6 +52,7 @@ o Preferences - OpenGL params - Default language feature settings - Make the library search path configurable? + - Turn on/off caching (advanced) o MDI - Think about how to do MDI the right way - Ctrl-W should close the current dialog, not the current main window @@ -117,6 +118,7 @@ o Misc - If trying to export STL/DXF but source is newer than the CGAL rendering, ask for confirmation. - Go through keyboard shortcuts and make them more conformant to platform standards + - Show design info/stats (sizes, caches etc.) o Cmd-line - Add verbose option (PRINT command from mainwin.cc and progress output) @@ -230,7 +232,5 @@ o Use a logging framework to get debugging/info output more under control? MISC ---- -o Streamline the cmd-line interface a bit - - Implicit output file format o Write checklists for typical extension work (add new module, add new function) -> make sure new test files are added diff --git a/doc/openscad.1 b/doc/openscad.1 new file mode 100644 index 0000000..a4c03dd --- /dev/null +++ b/doc/openscad.1 @@ -0,0 +1,47 @@ +.TH OPENSCAD 1 "2011-11-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, DXF or CSG 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 +\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. +.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). |