summaryrefslogtreecommitdiff
path: root/docs/leocad.1
diff options
context:
space:
mode:
authorleo2000-09-22 18:10:41 +0000
committerleo2000-09-22 18:10:41 +0000
commit6fc2592e88ef2892024450b182ce4d09cb916946 (patch)
tree9d696d3967bdde2254d64c954d654bfccc0b6e88 /docs/leocad.1
parentc1dd3edd6caec100ae8e5f6b0c9d4bb8cd4667f0 (diff)
Added new command line options
git-svn-id: http://svn.leocad.org/trunk@142 c7d43263-9d01-0410-8a33-9dba5d9f93d6
Diffstat (limited to 'docs/leocad.1')
-rw-r--r--docs/leocad.175
1 files changed, 61 insertions, 14 deletions
diff --git a/docs/leocad.1 b/docs/leocad.1
index 3a1362c..daeab56 100644
--- a/docs/leocad.1
+++ b/docs/leocad.1
@@ -4,7 +4,7 @@
.SH NAME
LeoCAD \- CAD program using plastic bricks.
.SH SYNOPSIS
-\fIleocad \fR [\fIfile\fR] [\fI\-l path\fR] \fIinfile [ -i outfile.ext \fR[\fI-w x\fR]\fI \fR[\fI-h y\fR] ]
+\fIleocad \fR[\fI infile \fR[ -i \fR[\fI outfile.ext \fR]\fI \fR[\fI-w x\fR]\fI \fR[\fI-h y\fR] ] \fR] [\fI\-l path\fR]
.SH "DESCRIPTION"
This manual page documents briefly the \fILeoCAD \fRprogram.
It was written for the Debian GNU/Linux distribution
@@ -17,32 +17,79 @@ in many toys (but not any particular brand). It supports animation
as well as exportation to various file formats including POV-Ray.
.SH OPTIONS
-.TP
-.B \-l path
-Use alternate pieces library found in \fIpath \fR. The Debian version
-of \fILeoCAD \fRuses /usr/share/leocad/ as the default.
+Below is a summary of all of the options that \fILeoCAD\fR
+accepts. Most options have two equivalent names, one of
+which is a single letter preceded by -, and the other of
+which is a long name preceded by --. Brackets ([ and ])
+indicate that an option takes an optional argument.
.TP
.B infile
-Loads the file \fIinfile\fR
+Loads the project file \fIinfile\fR
.TP
-.B \-i outfile.ext
+.BI "\-i [" outfile.ext ]
+.ns
+.TP
+.BI "\-\-image [" outfile.ext ]
Saves a picture to \fIoutfile.ext \fR in the image format specified
-by \fIext\fR and exits. \fIext\fR can be gif, bmp, png or jpg.
+by \fIext\fR and exits. If outfile is not given then the program will
+use a name based on \fIinfile\fR. The file format is selected by \fIext\fR
+and can be gif, bmp, png or jpg (if \fIext\fR is not present then the
+default preferences format will be used).
+
+.TP
+.BI "\-w "width
+.ns
+.TP
+.BI "\-\-width "width
+Sets the width of the picture to \fIwidth\fR.
+
+.TP
+.BI "\-h "height
+.ns
+.TP
+.BI "\-\-height "height
+Sets the height of the picture to \fIheight\fR.
.TP
-.B \-w x
-Sets the width of the picture to \fIx\fR.
+.BI "\-f "time
+.ns
+.TP
+.BI "\-\-from "time
+Start saving pictures at the step or frame \fItime\fR.
.TP
-.B \-h y
-Sets the height of the picture to \fIy\fR.
+.BI "\-t "time
+.ns
+.TP
+.BI "\-\-to "time
+Save pictures until the step or frame \fItime\fR.
+
+.TP
+.B \-\-animation
+Tells the program to save animations instead of instructions.
+
+.TP
+.B \-\-instructions
+Tells the program to save instructions instead of animations (default).
+
+.TP
+.B \-\-highlight
+Adds a border around the pieces in the step or frame they appear when saving pictures.
+
+.TP
+.BI "\-l "path
+.ns
+.TP
+.BI "\-\-libpath "path
+Use alternate pieces library found in \fIpath \fR. The Debian version
+of \fILeoCAD \fRuses /usr/share/leocad/ as the default.
.TP
-.B \-\-libgl library
+.BI "\-\-libgl "library
Sets the name of the OpenGL dynamic library used by the program to \fIlibrary\fR.
-The default libraries are libGL.so and libMesaGL.so.
+The default libraries names searched are libGL.so and libMesaGL.so.
.SH ENVIRONMENT
``LEOCAD_LIB'' may be set to the path of the pieces library.