Start up and Configuration/fr

Vue d'ensemble
Cette page montre les différentes façons de lancer FreeCAD et ses éléments de configuration les plus importants.

Démarrer FreeCAD en ligne de commande
FreeCAD peut être lancé normalement en double-cliquant sur son icône qui est sur le bureau, ou en le sélectionnant dans le menu de démarrage, mais il peut également être lancé directement à partir de la ligne de commande. Cela vous permet de changer les options de démarrage par défaut.

Utilisation des options en ligne de commande sans utiliser le shell

 * Sur Ubuntu, vous pouvez créer une icône de bureau et modifier leurs propriétés. Ajoutez les options de ligne de commande séparées par des espaces derrière le nom du programme dans le champ "Commande".
 * Sous Windows, créez un raccourci et modifiez ses propriétés. Ajoutez les options de ligne de commande séparées par des espaces dans le champ "Cible".

Options disponibles en ligne de commande
Les options en ligne de commande sont l'objet de fréquents changements. Il est donc sage de vérifier les options de votre version courante en tapant : FreeCAD --help La réponse vous permet de connaître les paramètres disponibles : 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.

Fichiers de configuration et Response
Vous pouvez lire certaines options de FreeCAD à partir d'un fichier de configuration. Ce fichier doit être dans le répertoire et doit être nommé. Notez que les options spécifiées en ligne de commande remplacent le fichier de configuration !

Certains systèmes d'exploitation ne permettent qu'un nombre de caractères assez limité en ligne de commande. La façon courante de contourner cette limitation, est l'utilisation des fichiers response. Un fichier response n'est qu'un fichier de configuration, qui utilise la même syntaxe qu'en ligne de commande. Si la ligne de commande spécifie un nom de fichier response à utiliser, il est chargé, analysé et ajouté à la ligne de commande :

FreeCAD @ResponseFile.txt

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

or: FreeCAD --response-file ResponseFile.txt

Options cachées
Il y a des options qui sont invisibles à l'utilisateur. Ces options sont, par exemple, les paramètres X-Window analysés par le système Windows :
 * -display display, définit l'affichage X (valeur par défaut est $DISPLAY).
 * -geometry geometry, la géométrie fixe de la première fenêtre client qui est affichée.
 * -fn or -font font, définit la police de l'application. La police doit être spécifié en utilisant la description de police logique X.
 * -bg or -background color, définit la couleur de fond par défaut et une palette d'application (tons clairs et foncés sont calculés).
 * -fg or -foreground color, définit la couleur de premier plan par défaut.
 * -btn or -button color, définit la couleur des boutons par défaut.
 * -name name, définit le nom de l'application.
 * -title title, définit le titre de l'application.
 * -visual TrueColor, force l'application à utiliser un visuel TrueColor sur un affichage 8-bits.
 * -ncols count, limite le nombre de couleurs allouées dans le cube de couleur sur un écran 8-bits, si l'application utilise la spécification de couleur QApplication::ManyColor. Si le nombre est 216, un cube 6x6x6 couleurs est utilisé (soit 6 niveaux de rouge, 6 de vert, et 6 de bleu); pour d'autres valeurs un cube à peu près proportionnel à un cube 2x3x1 couleurs est utilisé.
 * -cmap, provoque l'installation d'une carte de couleurs réservée à l'application, sur un affichage 8-bits.

Démarrer FreeCAD sans interface graphique utilisateur
FreeCAD est généralement construit avec deux exécutables : un compatible avec une interface graphique appelé, et un uniquement en ligne de commande. FreeCAD peut être utilisé en mode console en utilisant le commutateur "-c", c'est le comportement par défaut de : FreeCAD --console En ligne de commande. En mode console, aucune interface utilisateur ne sera affichée, et l'invite vous sera présentée avec un interpréteur Python.

A partir de ce prompt Python, vous avez les mêmes fonctionnalités que l'interpréteur Python lancé au sein de l'interface graphique de FreeCAD, et un accès normal à tous les modules et plugins de FreeCAD, à l'exception du module FreeCADGui. Notez que les modules qui dépendent de FreeCADGui peuvent également être inaccessibles.

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

Exemple d’exécution d'un fichier
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?).

Certaines bibliothèques ont besoin d'appeler les variables d'environnement système. Parfois, lorsqu'il y a des problèmes avec une installation de FreeCAD, c'est que certaines variables d'environnements sont absentes ou mal réglées. C'est pour cela que certaines variables importantes sont dupliquées dans la configuration et enregistrées dans le fichier journal (log file).

Variables d’environnement relatives à Python :


 * PYTHONPATH
 * PYTHONHOME
 * TCL_LIBRARY
 * TCLLIBPATH

Variables d’environnement relatives à OpenCascade :


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

Ensemble de configuration
A chaque démarrage, FreeCAD examine son environnement, ainsi que les paramètres en ligne de commande. Il construit un ensemble de configuration qui détient le cœur des informations d'exécution. Ces informations sont ensuite utilisées pour déterminer l’emplacement où enregistrer les données des utilisateurs ou des fichiers journaux. Il est également très important pour les analyses post-mortem. Par conséquent, il est enregistré dans le fichier journal (log file).

Informations correspondant à l'utilisateur
L'appel se fait de la manière suivante : path = FreeCAD.ConfigGet("UserAppData")

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

Relations au système
L'appel se fait de la manière suivante : path = FreeCAD.ConfigGet("AppHomePath")

Informations relatives à la version
Le tableau ci-dessous montre les informations générées par la version disponible. La plupart proviennent du dépôt de sous-version. Cette astuce est nécessaire pour reconstruire exactement une version !

Identité liée à la marque
Ces entrées de configuration sont liées au dispositif d'identification à la marque FreeCAD. Voir Branding pour plus de renseignements.

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)