Start up and Configuration/de

Übersicht
Diese Seite zeigt die verschiedene Wege, FreeCAD zu starten, und die wichtigsten Konfigurationsmöglichkeiten.

FreeCAD von der Kommandozeile starten
FreeCad kann normal gestartet werden, durch Doppelklick auf das entsprechende Desktopicon oder Auswahl aus dem START-Menue. Es kann aber auch direkt von der Kommandozeile gestartet werden. Das ermöglicht die Änderung der Standard-Start-Optionen.

Kommandozeilenoptionen ohne eine Kommandozeilen Shell verwenden

 * Auf Ubuntu lässt sich ein Desktopsymbol erstellen und die Eigenschaften anpassen. Die Kommandozeilenoptionen können im "Command"-Feld hinter dem Programmnamen durch Leerzeichen voneinander getrennt eingetragen werden.
 * Auf Windows wird eine Verknüpfung erstellt und die Eigenschaften angepasst. Die Kommandozeilenoptionen können im "Ziel"-Feld durch Leerzeichen voneinander getrennt eingetragen werden.

Kommandozeilenoptionen
Die Kommandozeilenoptionen sind Gegenstand ständiger Veränderungen, es ist deshalb empfehlenswert, die aktuellen Optionen wie folgt zu überprüfen: FreeCAD --help Die Ausgabe zeigt die möglichen Parameter: Usage: FreeCAD [options] File1 File2 ... Allowed options: Generic options: -v [ --version ]         Prints version string -h [ --help ]            Prints help message -c [ --console ]         Starts in console mode --response-file arg      Can be specified with '@name', too --dump-config            Dumps configuration --get-config arg         Prints the value of the requested configuration key Configuration: -l [ --write-log ]       Writes a log file to: /home/username/.FreeCAD/FreeCAD.log --log-file arg           Unlike --write-log this allows logging to an                               arbitrary file -u [ --user-cfg ] arg    User config file to load/save user settings -s [ --system-cfg ] arg  System config file to load/save system settings -t [ --run-test ] arg    Test case - or 0 for all -M [ --module-path ] arg Additional module paths -P [ --python-path ] arg Additional python paths --single-instance        Allow to run a single instance of the application

In the following table, selected options are described in more detail:

Options can written in two forms: and.

Parameter- und Konfigurationsdateien
FreeCad kann einige dieser Optionen aus einer Konfigurationsdatei lesen. Diese Datei muss im bin-Verzeichnis sein und heißen. Beachten Sie, dass Optionen auf der Kommandozeile die aus der Konfigurationsdatei übersteuern!

Bei einigen Betriebssystemen ist die Länge der Kommandozeile sehr kurz. Der übliche Weg zur Umgehung dieser Beschränkungen ist es, Parameterdateien zu benutzen. Eine Parameterdatei ist einfach nur eine Konfigurationsdatei, die die gleiche Syntax wie die Kommandozeile benutzt. Wenn die Kommandozeile eine Parameterdatei angibt, wird diese geladen und zusätzlich zur Kommandozeile analysiert.

FreeCAD @ResponseFile.txt

oder: FreeCAD --response-file=ResponseFile.txt

or: FreeCAD --response-file ResponseFile.txt

Versteckte Optionen
Es gibt eine Reihe von Optionen, die nicht für den Benutzer sichtbar sind. Diese Optionen sind z.B. die X-Window-Parameter, die durch das Windows-System analysiert werden:
 * "-display" - setzt das X-Display (Standardwert ist $DISPLAY).
 * "-geometry" - setzt die Client-Geometrie des ersten angezeigten Fensters.
 * "-fn" oder "-font" - definiert die Anwendungsschriftart. Die Schriftart sollte durch eine X logische Schriftartbeschreibung angegeben werden.
 * "-bg" oder "-background" - setzt die Standardhintergrundfarbe und eine Anwendungspalette (helle und dunkle Farbschattierungen werden berechnet).
 * "-fg" oder "foreground" - setzt die Standardvordergrundfarbe.
 * "-btn" oder "-button" - setzt die Standard-Button-Farbe.
 * "-name" - setzt den Anwendungsnamen.
 * "-title" - setzt den Anwendungstitel.
 * "-visual" - zwingt die Anwendung, TrueColor anstatt einer 8-Bit-Farbanzeige zu nutzen.
 * "-ncols" - begrenzt die Anzahl der im Farbwürfel verwendeten Farben auf einer 8-Bit-Anzeige, wenn die Anwendung die QApplication::ManyColor-Angabe verwendet. Wenn die Anzahl 216 ist, dann wird ein 6x6x6-Farbwürfel (d.h. 6 Stufen für Rot, 6 Stufen für Grün und 6 Stufen für Blau); bei anderen Werten wird ein Quader annähernd zu einem 2x3x1-Quader verwendet.
 * "-cmap" - führt dazu, dass die Anwendung eine eigene Farbpalette für eine 8-Bit-Anzeige installiert.

FreeCAD ohne grafische Benutzeroberfläche ausführen
FreeCAD wird normalerweise mit zwei Programmen geliefert: ein GUI-taugliches namens und eine Kommandozeilenversion namens. FreeCAD kann mithilfe der Option "-c" im Konsolenmodus betrieben werden, dies ist das Standardverhalten von : FreeCAD --console von der Kommandozeile. Im Konsolenmodus wird kein Benutzerinterface angezeigt, sondern ein Python-Interpreter-Prompt. Dieser bietet die gleiche Funktionalität wie der in die FreeCAD-GUI eingebaute, und normalen Zugang zu allen FreeCAD-Modulen und -Plugins, außer dem FreeCADGui-Modul. Bitte beachten Sie, dass von FreeCADGui abhängige Module möglicherweise ebenfalls nicht verfügbar sind.

To read more about console or headless mode, checkout Headless FreeCAD.

Beispiel zum Auführen einer Datei
See Macro at Startup on how to set up a macro to automatically run at FreeCAD startup.

Environment variables
FreeCAD supports the following environment variables, which can be used to configure directories: If the specified path does not exist, the setting is ignored!

The above environment variables are meant to be used to realize a portable FreeCAD environment. For an example how environment variables can be used from the command line on Linux refer to the notes for Linux users on the downloads page.

FreeCAD uses Qt, which does honor the environmental variable. Thus, setting can be used to specify the base directory of Qt-related configuration files.

FreeCad itself does not honor the environmental variable (because it determines the user's home directory from a lower-level system API). Use for this pupose.

The default temporary directory is. The environmental variable can be used to override the default. (Editor: precedence?).

Einige Bibliotheken benötigen Zugriff zu Systemumgebungsvariablen. Manchmal, wenn es ein Problem mit einer FreeCAD-Installation gibt, liegt es daran, dass eine Umgebungsvariable nicht oder falsch gesetzt ist. Deshalb werden einige wichtige Variablen in die Konfiguration dupliziert und in der Log-Datei gespeichert.

Python-bezogene Umgebungsvariablen


 * PYTHONPATH
 * PYTHONHOME
 * TCL_LIBRARY
 * TCLLIBPATH

OpenCascade-bezogene Umgebungsvariablen:


 * CSF_MDTVFontDirectory
 * CSF_MDTVTexturesDirectory
 * CSF_UnitsDefinition
 * CSF_UnitsLexicon
 * CSF_StandardDefaults
 * CSF_PluginDefaults
 * CSF_LANGUAGE
 * CSF_SHMessage
 * CSF_XCAFDefaults
 * CSF_GraphicShr
 * CSF_IGESDefaults
 * CSF_STEPDefaults

Der Konfigurationssatz
FreeCAD untersucht bei jedem Start die Umgebung und die Kommandozeilenparameter. Es erstellt einen "Konfigurationssatz", der das Wesentliche der Laufzeitinformationen enthält. Diese Informationen werden später genutzt, um den Platz festzulegen, an dem Benutzerdaten oder Log-Dateien gespeichert werden. Sie sind auch wichtig für "post postmortem"-Analysen. Daher werden sie in der Log-Datei gespeichert.

Benutzerbezogene Informationen
Note: For Linux distributions, an additional configuration file that relates to Qt may exist at path.

Programmpaket [Build]-bezogene Informationen
Die folgende Tabelle zeigt die verfügbaren Informationen zur Programmpaketversion. Das Meiste kommt aus dem Subversion-Repository. Diese Dinge werden benötigt, eine Version genau so wieder erstellen zu können.

"Branding"-verwandt (Warenkennzeichnung)
Diese Konfigurationseinträge beziehen sich auf den "Branding"-Mechanismus von FreeCAD. Mehr Details unter Branding.

Querying the configuration
From FreeCAD's Python console

Entries of the the configuration set can be queried with the config var name (see tables above) from the Python console. For example: >>> FreeCAD.ConfigGet("ExeVersion") '0.19' If the name is not found, an empty string is returned.

From command line

Use the option to query a single name. Not all names are supported. For example: FreeCAD_0.19 --get-config ExeVersion

Use the option to get a list of names and their values. Not all names are supported.

From FreeCAD console

Start FreeCAD in console mode with and query with Python code. For example: $ FreeCAD_0.19 --console [FreeCAD Console mode ] >>> FreeCAD.ConfigGet("ExeVersion") '0.19' >>> exit

For Linux (bash shell) you can modify the following command line to suit your needs: $ FreeCAD_0.19 --console <<EOF print( "FREECAD_USER_HOME: " + ( "not set" if ( os.environ.get('FREECAD_USER_HOME') is None ) else os.environ.get('FREECAD_USER_HOME') ) ) print( "UserHomePath: " + FreeCAD.ConfigGet("UserHomePath") ) exit EOF

Linux: Creating an additional start option
The following assumes that your desktop is configured such that you can launch FreeCAD from it. Depending on your Linux distribution and desktop environment, you may have to adapt the following steps:
 * 1) Copy the freedesktop entry file for FreeCAD from  to.
 * 2) Change the name from  to something else (e.g. ).
 * 3) Open the file with a text editor and change how FreeCAD is invoked by modifying the line starting with.
 * 4) As a result, an additional entry in your start menu/application launcher is available. This way, you can have multiple FreeCAD entries with various launch options.

Starting FreeCAD from a portable USB medium
Windows

Put the FreeCAD executable,, on the USB medium. Create a batch file,, and put it into the same directory as. Inside the batch file write:

or with

Now double-click the batch file to start FreeCAD. (see)