Démarrage et Configuration

From FreeCAD Documentation
Jump to: navigation, search
This page is a translated version of the page Start up and Configuration and the translation is 100% complete.

Other languages:
čeština • ‎Deutsch • ‎English • ‎español • ‎français • ‎italiano • ‎polski • ‎română • ‎русский • ‎svenska • ‎Türkçe
Arrow-left.svg Page précédente: Outils tiers

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/beast/.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

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 /bin et doit être nommé FreeCAD.cfg. 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

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é FreeCAD, et un uniquement en ligne de commande FreeCADCmd. FreeCAD peut être utilisé en mode console en utilisant le commutateur "-c", c'est le comportement par défaut de FreeCADCmd :

FreeCAD -c

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.

Les macros Python de FreeCAD peuvent être spécifiées comme arguments de ligne de commande pour l'un des exécutables mentionnés ci-dessus.

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")
Entrées de configuration utilisateur
Nom var config Synopsis Exemple M$ Exemple Posix (Linux)
UserAppData Chemin où FreeCAD met les données utilisateur de l'application. C:\Documents and Settings\username\AppData\FreeCAD /home/username/.FreeCAD
UserParameter Chemin où FreeCAD met les fichier utilisateur de l'application. C:\Documents and Settings\username\AppData\FreeCAD\user.cfg /home/username/.FreeCAD/user.cfg
SystemParameter Fichier où sont les données de l'application. C:\Documents and Settings\username\AppData\FreeCAD\system.cfg /home/username/.FreeCAD/system.cfg
UserHomePath Chemin racine de l'utilisateur courant. C:\Documents and Settings\username\My Documents /home/username

Arguments en ligne de commande

Entrées de configuration utilisateur
Nom var config Synopsis Exemple
LoggingFile 1 si l'enregistrement est activé 1
LoggingFileName Nom du fichier ou le joural est placé C:\Documents and Settings\username\AppData\FreeCAD\FreeCAD.log
RunMode Cela indique comment la boucle principale travaillera. "Script" signifie que le script donné est appelé puis quitté. "Cmd" est destiné à l’interpréteur en ligne de commande. "Internal" exécute un script interne. "Gui" entre dans la boucle d'évènement Gui. "Module" charge un module Python donné. "Cmd"
FileName Dépend du RunMode
ScriptFileName Dépend du RunMode
Verbose Niveau de verbosité de FreeCAD "" or "strict"
OpenFileCount Donne le nombre de dossiers ouverts par les arguments en ligne de commande "12"
AdditionalModulePaths Contient les chemins des modules supplémentaires donnés dans la ligne de commande "extraModules/"

Relations au système

L'appel se fait de la manière suivante :

path = FreeCAD.ConfigGet("AppHomePath")
Entrées de configuration utilisateur
Nom var config Synopsis Exemple M$ Exemple Posix (Linux)
AppHomePath Chemin où est installé FreeCAD c:/Progam Files/FreeCAD_0.7 /user/local/FreeCAD_0.7
PythonSearchPath Donne une liste de chemins que les modules Python recherchent. S'effectue au démarrage, et peut changer en cours d'exécution

Exemple d’exécution d'un fichier

Ligne de commande pour exécuter un fichier
Fichier a exécuter Système Command line configuration
Module, cfg Windows "C:\Program Files\FreeCAD\bin\FreeCAD.exe" -M "C:\FreeCAD\Mod\Draft" -u "C:\FreeCAD\Config\user.cfg" -s "C:\FreeCAD\Config\system.cfg"
Linux todo
.FCMacro or .py Windows "C:\Program Files\FreeCAD\bin\FreeCAD.exe" "C:\Users\userName\AppData\Roaming\FreeCAD\Mod\WorkFeature\start_WF.FCMacro"
Linux todo


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

Variables d’environnement relatives au Système :

  • PATH

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 !

Entrées de configuration utilisateur
Nom var config Synopsis Exemple
BuildVersionMajor Numéro de version majeure de la construction. Définie dans src/Build/Version.h.in 0
BuildVersionMinor Numéro de version mineure de la construction. Définie dans src/Build/Version.h.in 7
BuildRevision Numéro de révision du référentiel SVN du src de construction. Généré par SVN 356
BuildRevisionRange Gamme de différents changements 123-356
BuildRepositoryURL URL de référence https://free-cad.svn.sourceforge.net/svnroot/free-cad/trunk/src
BuildRevisionDate Date de la révision ci-dessus 2007/02/03 22:21:18
BuildScrClean Indique si la source a été modifiée après la dernière construction Src modifié
BuildScrMixed Src non mixé

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.

Entrées de configuration utilisateur
Nom var config Synopsis Exemple
ExeName Nom du fichier exécutable de compilation. Ce nom peut être différent de FreeCAD si un main.cpp différent est utilisé. FreeCAD.exe
ExeVersion La version présente au moment de la compilation V0.7
AppIcon L'icône qui est utilisé pour l'exécutable, affichée dans la fenêtre principale d'application "FCIcon"
ConsoleBanner Bannière du prompt en mode console
SplashPicture Nom de l'icône utilisée pour l'écran de démarrage "FreeCADSplasher"
SplashAlignment Alignement du texte dans la boîte de dialogue Splash "Bottom" ou "Left"
SplashTextColor Couleur du texte splashé "#000000"
StartWorkbench Nom de l'atelier lancé automatiquement après le démarrage "Part design"
HiddenDockWindow Liste des dockwindows (séparés par un point-virgule) qui seront désactivés "Property editor"

Pages connexes

Arrow-left.svg Page précédente: Outils tiers