Start up and Configuration
Command line parameter
The Config set
On every Startup FreeCAD examine its surrounding and the command line parameter and build up a configuration set which hold the essence of the runtime information. This information is later used to determine the place where to save user data or log files. Its also very important for post postmortem analyzes. There fore it get saved in the log file.
Config var name | Synopsis | Example M$ | Example Posix (Linux) |
---|---|---|---|
UserAppData | Path where FreeCAD stors 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 argument triggered
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 throught command line argumends | "" or "strict" |
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 excution |
Some libraries trigger on system set environment variables. If a FreeCAD installation has a problem, somtimes environment variables are responsibel for that. Therefore some importent variables get dublicated in the Config and there fore 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"
Info about the Build
Here information about the Build. Mostly out of the Subversion repository. This stuff is needed to exactly rebuild a version!
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 |
This config entries are related to the branding mechanism of FreeCAD. See Branding for details
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 promted in console mode | |
SplashPicture | Name of the Icon used for the Splasch 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 (sepearated by a smicolon) which will be disabled | "Property editor" |