Start up and Configuration/fr: Difference between revisions

From FreeCAD Documentation
(Created page with "Une fois que FreeCAD est chargé, c'est à vous de le faire interagir avec votre application hôte de toutes les manières que vous pouvez imaginer !")
(Created page with "== Ensemble de configuration ==")
Line 72: Line 72:
Une fois que FreeCAD est chargé, c'est à vous de le faire interagir avec votre application hôte de toutes les manières que vous pouvez imaginer !
Une fois que FreeCAD est chargé, c'est à vous de le faire interagir avec votre application hôte de toutes les manières que vous pouvez imaginer !


== The Config set ==
== Ensemble de configuration ==


On every Startup FreeCAD examines its surrounding and the command line parameters. It builds up a '''configuration set''' which holds the essence of the runtime information. This information is later used to determine the place where to save user data or log files. It is also very important for post postmortem analyzes. Therefore it is saved in the log file.
On every Startup FreeCAD examines its surrounding and the command line parameters. It builds up a '''configuration set''' which holds the essence of the runtime information. This information is later used to determine the place where to save user data or log files. It is also very important for post postmortem analyzes. Therefore it is saved in the log file.

Revision as of 21:39, 31 October 2014

Cette page montre, les différentes façons de lancer FreeCAD, et, ses configurations les plus importantes.

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 SOEM.

Les 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

Les réponses disponibles, sont dans les paramètres :

Usage:
FreeCAD [options] File1 File2 .....
Allowed options:  

Generic options:
 -v [ --version ]      print version string
 -h [ --help ]         print help message
 -c [ --console ]      start in console mode

Configuration:
 -l [ --write-log ] arg    write a log file
 -t [ --run-test ] arg     test level
 -M [ --module-path ] arg  additional module paths
 -P [ --python-path ] arg  additional python paths
 --response-file arg       can be specified with '@name', too

"Response" fichiers de configurations

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 ont une limite assez courte de la longueur de la chaîne, en ligne de commande. La façon courante de contourner ces limitations, est l'utilisation des fichiers de Response. Un fichier de Response n'est qu'un fichier de configuration, qui utilise la même syntaxe qu'a la ligne de commande. Si la ligne de commande spécifie un nom de fichier de Response à utiliser, il est chargé analysé, et s'ajoute à 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 X logical font description.
  • -bg or -background color, définit la couleur de fond par défaut et une palette d'applications (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, puis 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 privées à l'application, sur un affichage 8-bits.


Démarrer FreeCAD sans interface utilisateur

Normalement, FreeCAD démarre en mode graphique (GUI), mais vous pouvez aussi le forcer à démarrer en mode console en tapant :

FreeCAD -c

En ligne de commande. En mode console, aucune interface utilisateur, ne sera affichée, et l'invite vous sera présenté avec un interpréteur Python.

A partir de ce prompt Python, vous avez les mêmes fonctionnalités que l'interpréteur Python qui fonctionne 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.


Exécuter FreeCAD comme un module Python

FreeCAD peut également être utilisé et exécuté en tant que module Python à l'intérieur d'autres applications, qui utilisent Python, ou, à partir d'un shell Python externe. Pour cela, l'application hôte Python doit savoir où résident vos libs FreeCAD. La meilleure façon de l'obtenir, c'est d'annexer temporairement le chemin des libs de FreeCAD à la variable sys.path. Le code suivant tapé à partir de n'importe quel shell Python va importer FreeCAD, et vous permettre de l'exécuter de la même manière que dans le mode console :

import sys
sys.path.append("path/to/FreeCAD/lib") # change this by your own FreeCAD lib path
import FreeCAD

Une fois que FreeCAD est chargé, c'est à vous de le faire interagir avec votre application hôte de toutes les manières que vous pouvez imaginer !

Ensemble de configuration

On every Startup FreeCAD examines its surrounding and the command line parameters. It builds up a configuration set which holds the essence of the runtime information. This information is later used to determine the place where to save user data or log files. It is also very important for post postmortem analyzes. Therefore it is saved in the log file.

User related information

User config entries
Config var name Synopsis Example M$ Example Posix (Linux)
UserAppData Path where FreeCAD stores User Related application data. C:\Documents and Settings\username\Application Data\FreeCAD /home/username/.FreeCAD
UserParameter File where FreeCAD stores User Related application data. C:\Documents and Settings\username\Application Data\FreeCAD\user.cfg /home/username/.FreeCAD/user.cfg
SystemParameter File where FreeCAD stores Application Related data. C:\Documents and Settings\username\Application Data\FreeCAD\system.cfg /home/username/.FreeCAD/system.cfg
UserHomePath Home path of the current user C:\Documents and Settings\username\My Documents /home/username

Command line arguments

User config entries
Config var name Synopsis Example
LoggingFile 1 if the logging is switched on 1
LoggingFileName File name where the log is placed C:\Documents and Settings\username\Application Data\FreeCAD\FreeCAD.log
RunMode This indicates how the main loop will work. "Script" means that the given script is called and then exit. "Cmd" runs the command line interpreter. "Internal" runs an internal script. "Gui" enters the Gui event loop. "Module" loads a given python module. "Cmd"
FileName Meaning depends on the RunMode
ScriptFileName Meaning depends on the RunMode
Verbose Verbosity level of FreeCAD "" or "strict"
OpenFileCount Holds the number of files opened through command line arguments "12"
AdditionalModulePaths Holds the additional Module paths given in the cmd line "extraModules/"

System related

User config entries
Config var name Synopsis Example M$ Example Posix (Linux)
AppHomePath Path where FreeCAD is installed c:/Progam Files/FreeCAD_0.7 /user/local/FreeCAD_0.7
PythonSearchPath Holds a list of paths which python search modules. This is at startup can change during execution

Some libraries need to call system environment variables. Sometimes when there is a problem with a FreeCAD installation, it is because some environment variable is absent or set wrongly. Therefore, some important variables get duplicated in the Config and saved in the log file.

Python related environment variables:

  • PYTHONPATH
  • PYTHONHOME
  • TCL_LIBRARY
  • TCLLIBPATH

OpenCascade related environment variables:

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

System related environment variables:

  • PATH

Build related information

The table below shows the availible informations about the Build version. Most of it comes from the Subversion repository. This stuff is needed to exactly rebuild a version!

User config entries
Config var name Synopsis Example
BuildVersionMajor Major Version number of the Build. Defined in src/Build/Version.h.in 0
BuildVersionMinor Minor Version number of the Build. Defined in src/Build/Version.h.in 7
BuildRevision SVN Repository Revision number of the src in the Build. Generated by SVN 356
BuildRevisionRange Range of differnt changes 123-356
BuildRepositoryURL Repository URL https://free-cad.svn.sourceforge.net/svnroot/free-cad/trunk/src
BuildRevisionDate Date of the above Revision 2007/02/03 22:21:18
BuildScrClean Indicates if the source was changed ager checkout Src modified
BuildScrMixed Src not mixed


Branding related

These Config entries are related to the branding mechanism of FreeCAD. See Branding for more details.

User config entries
Config var name Synopsis Example
ExeName Name of the build Executable file. Can diver from FreeCAD if a different main.cpp is used. FreeCAD.exe
ExeVersion Over all Version shows up at start time V0.7
AppIcon Icon which is used for the Executable, shows in Application MainWindow. "FCIcon"
ConsoleBanner Banner which is prompted in console mode
SplashPicture Name of the Icon used for the Splash Screen "FreeCADSplasher"
SplashAlignment Alignment of the Text in the Splash dialog Left"
SplashTextColor Color of the splasher Text "#000000"
StartWorkbench Name of the Workbech which get started automaticly after Startup "Part design"
HiddenDockWindow List of dockwindows (separated by a semicolon) which will be disabled "Property editor"
Third Party Tools
FreeCAD Build Tool