projects / packages / freecad.git / blame
| Commit | Line | Data |
|---|---|---|
| dfd2f590 AM |
1 | .\" Hey, EMACS: -*- nroff -*- |
| 2 | .\" First parameter, NAME, should be all caps | |
| 3 | .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection | |
| 4 | .\" other parameters are allowed: see man(7), man(1) | |
| 5 | .TH FREECAD 1 "July 25, 2007" freecad "Linux User's Manual" | |
| 6 | .\" Please adjust this date whenever revising the manpage. | |
| 7 | .\" | |
| 8 | .\" Some roff macros, for reference: | |
| 9 | .\" .nh disable hyphenation | |
| 10 | .\" .hy enable hyphenation | |
| 11 | .\" .ad l left justify | |
| 12 | .\" .ad b justify to both left and right margins | |
| 13 | .\" .nf disable filling | |
| 14 | .\" .fi enable filling | |
| 15 | .\" .br insert line break | |
| 16 | .\" .sp <n> insert n+1 empty lines | |
| 17 | .\" for manpage-specific macros, see man(7) | |
| 18 | .SH NAME | |
| 19 | freecad \- An extensible Open Source CAx program for Unix/X11 | |
| 20 | .SH SYNOPSIS | |
| 21 | .B freecad | |
| 22 | .RI [ options ] " files" | |
| 23 | .br | |
| 24 | .B freecadcmd | |
| 25 | .RI [ options ] " files" | |
| 26 | .SH DESCRIPTION | |
| 27 | .B FreeCAD | |
| 28 | is an Open Source CAx RAD based on OpenCasCade, Qt and Python. It features | |
| 29 | some key concepts like macro recording, workbenches, ability to run as a | |
| 30 | server and dynamically loadable application extensions and it is designed | |
| 31 | to be platform independent. | |
| 32 | .\" TeX users may be more comfortable with the \fB<whatever>\fP and | |
| 33 | .\" \fI<whatever>\fP escape sequences to invode bold face and italics, | |
| 34 | .\" respectively. | |
| 35 | .SH USAGE | |
| 36 | \fBfreecad\fR starts with a GUI while \fBfreecadcmd\fR is only a pure command line version that starts a Python interpreter. | |
| 37 | .SH OPTIONS | |
| 38 | These programs follow the usual GNU command line syntax, with long | |
| 39 | options starting with two dashes (`-'). | |
| 40 | A summary of the options supported by \fBfreecad\fR is included below. | |
| 41 | .SS "Generic options" | |
| 42 | .TP | |
| 43 | \fB\-h, \-\-help\fR | |
| 44 | Show summary of options. | |
| 45 | .TP | |
| 46 | \fB\-v, \-\-version\fR | |
| 47 | Show version of program. | |
| 48 | .TP | |
| 49 | \fB\-c, \-\-console\fR | |
| 50 | Start in console mode. | |
| 51 | .TP | |
| 52 | \fB\-\-response\-file\fR \fIarg\fR | |
| 53 | Can be specified with '@name', too. | |
| 54 | ||
| 55 | .SS "Configuration" | |
| 56 | .TP | |
| 57 | \fB\-l, \-\-write\-log\fR | |
| 58 | Write a log file. | |
| 59 | .TP | |
| 60 | \fB\-t, \-\-run\-test\fR \fIarg\fR | |
| 61 | Test level. | |
| 62 | .TP | |
| 63 | \fB\-M, \-\-module\-path\fR \fIarg\fR | |
| 64 | Additional module path. | |
| 65 | .TP | |
| 66 | \fB\-P, \-\-python\-path\fR \fIarg\fR | |
| 67 | Additional Python path. | |
| 68 | .SH SEE ALSO | |
| 69 | To get more information about \fBFreeCAD\fR, please visit \fIhttp://juergen\-riegel.net/FreeCAD/Docu/index.php/Main_Page\fR | |
| 70 | .SH BUGS | |
| 71 | To report a bug, please visit \fIhttp://free-cad.sf.net/\fR | |
| 72 | .SH AUTHOR | |
| 73 | This manual page was written by Werner Mayer. |