Start up and Configuration/es

En FreeCAD versión 0.20, se modificó la ubicación predeterminada de los archivos de configuración, datos y caché del programa para Linux.
Consulte Notas de la versión 0.20 para obtener más información. Esta página aún no se ha actualizado.

Vista general

Esta página muestra las diferentes formas de iniciar FreeCAD y las características de configuración más importantes.

Iniciar FreeCAD desde la línea de comandos

FreeCAD se puede iniciar normalmente haciendo doble clic en su icono del escritorio o seleccionándolo desde el menú Inicio, pero también se puede iniciar directamente desde la línea de comandos. Esto permite modificar algunas de las opciones de inicio predeterminadas.

Uso de las opciones de línea de comandos sin un intérprete de línea de comandos

Opciones de la línea de comandos

Las opciones de la línea de comandos están sujetas a cambios frecuentes. Por lo tanto, es una buena idea comprobar las opciones actuales escribiendo:

FreeCAD --help

En la respuesta se pueden leer los parámetros posibles. Para la versión 1.0 de FreeCAD son:

 Usage: FreeCAD [options] File1 File2 ...
 
 Allowed options:
 
 Generic options:
   -v [ --version ]          Prints version string
   --verbose                 Prints verbose 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
   --set-config arg          Sets the value of a configuration key
   --keep-deprecated-paths   If set then config files are kept on the old 
                             location
 
 Configuration:
   -l [ --write-log ]        Writes FreeCAD.log to the user directory.
   --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     Run a given test case (use 0 (zero) to run all 
                             tests). If no argument is provided then return list
                             of all available tests.
   -r [ --run-open ] arg     Run a given test case (use 0 (zero) to run all 
                             tests). If no argument is provided then return list
                             of all available tests.  Keeps UI open after 
                             test(s) complete.
   -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
   --safe-mode               Force enable safe mode
   --pass arg                Ignores the following arguments and pass them 
                             through to be used by a script

En la siguiente tabla se describen con más detalle algunas de las opciones seleccionadas:

Opción larga Correspondiente a config var name Sinopsis
--user-cfg <nombre_del_archivo> Parámetro de usuario Nombre de archivo o ruta relativa que termina con un nombre de archivo. Por defecto, user.cfg.
--module-path <dir> Antepone a AdditionalModulePaths Directorio que contiene los módulos. Esta opción se puede especificar repetidamente para indicar varios directorios.
--get-config <nombre_variable_configuración> most Muestra el valor solicitado en un cuadro de diálogo emergente. Sale tras confirmar con OK. No se puede usar repetidamente. Si se usa un nombre de variable desconocido o no válido, la respuesta está vacía. No se respeta la opción --console.

Las opciones se pueden escribir de dos formas: --long-option arg y --long-option=arg.

Archivos de respuesta y configuración

FreeCAD puede leer algunas de estas opciones desde un archivo de configuración. Este archivo debe estar en la ruta bin y llamarse FreeCAD.cfg. ¡Tenga en cuenta que las opciones especificadas en la línea de comandos anulan el archivo de configuración!

Algunos sistemas operativos tienen un límite muy bajo de caracteres en la línea de comandos. La forma habitual de sortear estas limitaciones es mediante el uso de archivos de respuesta. Un archivo de respuesta es simplemente un archivo de configuración que utiliza la misma sintaxis que la línea de comandos. Si la línea de comandos especifica un archivo de respuesta, este se carga y se analiza junto con la línea de comandos.

FreeCAD @ResponseFile.txt 

o:

FreeCAD --response-file=ResponseFile.txt

o:

FreeCAD --response-file ResponseFile.txt

Opciones ocultas

Existen algunas opciones no visibles para el usuario. Estas opciones son, por ejemplo, los parámetros de X-Window interpretados por el sistema Windows:

Ejecutando FreeCAD sin interfaz gráfica (sin cabeza)

FreeCAD suele compilarse con dos ejecutables: uno con interfaz gráfica de usuario (GUI), llamado FreeCAD o freecad, y otro sin interfaz gráfica, llamado FreeCADCmd o freecadcmd.

FreeCAD puede utilizarse en modo consola mediante el modificador --console (que es el comportamiento predeterminado de FreeCADCmd):

FreeCAD --console

En el modo consola, no se mostrará ninguna interfaz gráfica de usuario y aparecerá el intérprete de Python: >>>. Desde este intérprete, tendrá la misma funcionalidad que el intérprete de Python que se ejecuta dentro de la interfaz gráfica de FreeCAD, así como acceso a todos los módulos y complementos de FreeCAD, excepto el módulo FreeCADGui. Tenga en cuenta que los módulos que dependen de FreeCADGui podrían no estar disponibles.

Para obtener más información sobre el modo de consola o sin interfaz gráfica, consulte FreeCAD sin interfaz gráfica.

Ejecución de módulos, macros y scripts

Tipo de archivo Sistema Ejemplo de línea de comandos
Módulo Windows "C:\Program Files\FreeCAD\bin\FreeCAD.exe" -M "C:\FreeCAD\Mod\Draft"
Linux FreeCAD_0.19 -M ~/.FreeCAD/Mod/Draft
Linux (AppImage) path/to/FreeCADXXX.AppImage -M ~/.FreeCAD/Mod/Draft
.FCMacro o .py Windows "C:\Program Files\FreeCAD\bin\FreeCAD.exe" "C:\Users\userName\AppData\Roaming\FreeCAD\Mod\WorkFeature\start_WF.FCMacro"
Linux FreeCAD_0.19 ~/.FreeCAD/Mod/WorkFeature/start_WF.FCMacro
Linux (AppImage) path/to/FreeCADXXX.AppImage ~/.FreeCAD/Mod/WorkFeature/start_WF.FCMacro

Consulte Macro al inicio para obtener información sobre cómo configurar una macro para que se ejecute automáticamente al iniciar FreeCAD.

Variables de entorno

FreeCAD admite las siguientes variables de entorno, que se pueden usar para configurar directorios: introduced in 0.19

Variable de entorno correspondiente Nombre de la variable de configuración Sinopsis
FREECAD_USER_HOME UserHomePath Directorio base de FreeCAD para almacenar los datos locales del usuario.
FREECAD_USER_DATA UserAppData Si no se especifica, se usa por defecto FREECAD_USER_HOME/.FreeCAD, pero solo si se especifica FREECAD_USER_HOME.
FREECAD_USER_TEMP AppTempPath Si no se especifica, se usa por defecto FREECAD_USER_HOME/temp, pero solo si se especifica FREECAD_USER_HOME.

Si la ruta especificada no existe, ¡la configuración se ignora!

Las variables de entorno mencionadas anteriormente están diseñadas para crear un entorno FreeCAD "portátil". Para ver un ejemplo de cómo usar las variables de entorno desde la línea de comandos en Linux, consulte las notas para usuarios de Linux en la página de descargas.

HOME

FreeCAD utiliza Qt, que sí respeta la variable de entorno HOME. Por lo tanto, configurar HOME se puede usar para especificar el directorio base de los archivos de configuración relacionados con Qt (.config/FreeCAD/FreeCAD.conf).

FreeCAD no tiene en cuenta la variable de entorno HOME (ya que determina el directorio principal del usuario a partir de una API del sistema de nivel inferior). Para ello, utilice FREECAD_USER_HOME.

TMPDIR

El directorio temporal predeterminado es /tmp/. La variable de entorno TMPDIR se puede usar para anular el valor predeterminado. (Editor: ¿precedencia?).

Bibliotecas

Algunas bibliotecas necesitan acceder a variables de entorno del sistema. En ocasiones, uno de los problemas con la instalación de FreeCAD se debe a que alguna variable de entorno falta o es incorrecta. Por lo tanto, algunas variables importantes se duplican en el archivo de configuración y se guardan en el archivo de registro.

Python

OpenCascade

Ajustes de configuración

En cada inicio, FreeCAD examina su entorno y los parámetros de la línea de comandos. Crea un conjunto de configuración que contiene la información esencial del tiempo de ejecución. Esta información se utiliza posteriormente para determinar dónde guardar los datos del usuario o los archivos de registro. También es fundamental para los análisis de depuración, por lo que se guarda en el archivo de registro.

Para encontrar rápidamente la ubicación de los archivos de configuración (por ejemplo, para eliminarlos y, por lo tanto, restablecer FreeCAD a la "configuración de fábrica") en su máquina, ejecute el siguiente comando en la consola de Python de FreeCAD:

App.getUserConfigDir()

Información relacionada con el usuario

Nombre de la variable de configuración Sinopsis Ejemplo Windows Ejemplo Linux
UserAppData Ruta donde FreeCAD almacena los datos de la aplicación relacionados con el usuario. C:\Users\username\AppData\Roaming\FreeCAD
Ruta corta: %APPDATA%\FreeCAD
/home/username/.local/share/FreeCAD
Ruta corta: ~/.local/share/FreeCAD
UserParameter Archivo donde FreeCAD almacena los datos de la aplicación relacionados con el usuario. C:\Users\username\AppData\Roaming\FreeCAD\user.cfg
Ruta corta: %APPDATA%\FreeCAD\user.cfg
/home/username/.config/FreeCAD/user.cfg
Ruta corta: ~/.config/FreeCAD/user.cfg o $HOME/.config/FreeCAD/user.cfg
SystemParameter Archivo donde FreeCAD almacena los datos relacionados con la aplicación. C:\Users\username\AppData\Roaming\FreeCAD\system.cfg
Ruta corta: %APPDATA%\FreeCAD\system.cfg
Ruta corta: /home/username/.config/FreeCAD/system.cfg
Ruta corta: ~/.config/FreeCAD/system.cfg o $HOME/.config/FreeCAD/system.cfg
Ruta de inicio del usuario Ruta de inicio del usuario actual C:\Users\username
Ruta corta: %USERPROFILE%
/home/username
Ruta corta: ~

Nota: Para las distribuciones de Linux, puede existir un archivo de configuración adicional relacionado con Qt en la ruta /home/username/.config/FreeCAD/FreeCAD.conf.

Argumentos de la línea de comandos

Nombre de la variable de configuración Sinopsis Ejemplo
LoggingFile 1 si el registro está activado 1
LoggingFileName Nombre del archivo donde se guarda el registro C:\Users\username\AppData\Roaming\FreeCAD\FreeCAD.log
RunMode Indica cómo funcionará el bucle principal. "Script" significa que se ejecuta el script especificado y luego se finaliza. "Cmd" ejecuta el intérprete de línea de comandos. "Internal" ejecuta un script interno. "Gui" entra en el bucle de eventos de la interfaz gráfica de usuario (GUI). "Módulo" carga un módulo de Python especificado. "Cmd"
NombreArchivo Su significado depende del modo de ejecución
NombreArchivoScript Su significado depende del modo de ejecución
Detallado Nivel de detalle de FreeCAD "" o "estricto"
NúmeroArchivosAbiertos Indica el número de archivos abiertos mediante argumentos de línea de comandos "12"
RutasMóduloAdicionales Indica las rutas de los módulos adicionales especificadas en la línea de comandos "extraModules/"

Relativos al sistema

Nombre de la variable de configuración Sinopsis Ejemplo Windows Ejemplo Linux
AppHomePath Ruta donde está instalado FreeCAD c:/Archivos de programa/FreeCAD_0.19 /user/local/FreeCAD_0.19
PythonSearchPath Contiene una lista de rutas donde Python busca módulos. Se establece al inicio y puede cambiar durante la ejecución
AppTempPath Ruta del directorio temporal. Se puede especificar mediante la variable de entorno TMPDIR o mediante el editor de parámetros Parameter Editor: Tools → Edit parameters... → BaseApp → Preferences → General → TempPath /tmp/ (predeterminado)

Información relacionada con la compilación

La tabla que aparece a continuación muestra la información disponible sobre la versión de compilación. La mayor parte proviene del repositorio de Subversion. ¡Esta información es necesaria para reconstruir una versión con precisión!

Nombre de la variable de configuración Sinopsis Ejemplo
BuildVersionMajor Número de versión principal de la compilación. Definido en src/Build/Version.h.in 0
BuildVersionMinor Número de versión secundaria de la compilación. Definido en src/Build/Version.h.in 7
BuildRevision Número de revisión del repositorio SVN del código fuente en la compilación. Generado por SVN 356
BuildRevisionRange Rango de cambios diferentes 123-356
BuildRepositoryURL URL del repositorio https://free-cad.svn.sourceforge.net/svnroot/free-cad/trunk/src
BuildRevisionDate Fecha de la revisión anterior 2007/02/03 22:21:18
BuildScrClean Indica si el código fuente se modificó después de la extracción Código fuente modificado
BuildScrMixed Código fuente no mezclado

== Relacionado con el marcado

Estas entradas de configuración están relacionadas con el mecanismo de personalización de FreeCAD. Consulte Personalización para obtener más detalles.

Nombre de la variable de configuración Sinopsis Ejemplo
ExeName Nombre del archivo ejecutable de compilación. Puede diferir de FreeCAD si se utiliza un main.cpp diferente. FreeCAD.exe
ExeVersion Versión general que se muestra al inicio "0.19"
AppIcon Icono que se utiliza para el ejecutable, se muestra en la ventana principal de la aplicación. "FCIcon"
ConsoleBanner Banner que se muestra en el modo consola
SplashPicture Nombre del icono utilizado para la pantalla de inicio "FreeCADSplasher"
Alineación de la pantalla de inicio Alineación del texto en el cuadro de diálogo de inicio "Abajo" o "Izquierda"
Color del texto de la pantalla de inicio "#000000"
Entorno de trabajo inicial Nombre del entorno de trabajo que se inicia automáticamente al arrancar "Diseño de piezas"
Ventana acoplable oculta Lista de ventanas acoplables (separadas por punto y coma) que se deshabilitarán "Editor de propiedades"

Consultando la configuración

Desde la consola de Python de FreeCAD

Las entradas del conjunto de configuración se pueden consultar con el parámetro config var name (ver tablas anteriores) desde la consola de Python. Por ejemplo:

>>> FreeCAD.ConfigGet("ExeVersion")

'0.19' Si no se encuentra el nombre, se devuelve una cadena vacía.

Desde la línea de comandos

Utilice la opción --get-config <config-var-name> para consultar un único nombre. No todos los nombres son compatibles. Por ejemplo:

FreeCAD --get-config ExeVersion

Utilice la opción --dump-config para obtener una lista de nombres y sus valores. No todos los nombres son compatibles.

Desde la consola de FreeCAD

Inicie FreeCAD en modo consola con --console y realice consultas con código Python. Por ejemplo:

$ FreeCAD --console

[Modo consola de FreeCAD <Use Ctrl+D (es decir, EOF) para salir.>]

>>> FreeCAD.ConfigGet("ExeVersion")

'0.19'

>>> exit()

Para Linux (consola bash), puede modificar la siguiente línea de comandos según sus necesidades:

$ FreeCAD --console <<EOF

print( "FREECAD_USER_HOME: " + ( "no está configurado" if ( os.environ.get('FREECAD_USER_HOME') is None ) else os.environ.get('FREECAD_USER_HOME') ) )

print( "UserHomePath: " + FreeCAD.ConfigGet("UserHomePath") ) exit()

EOF

Iniciando FreeCAD desde el escritorio

Linux: Creando una opción de inicio adicional

A continuación, se asume que su escritorio está configurado para que pueda iniciar FreeCAD desde él. Dependiendo de su distribución de Linux y entorno de escritorio, es posible que deba adaptar los siguientes pasos:

  1. Copie el archivo de entrada de FreeCAD en freedesktop desde /usr/share/applications/freecad.desktop a ~/.local/share/applications.
  1. Cambie el nombre de freecad.desktop a otro (por ejemplo, MyFreeCADConfig.desktop).
  1. Abra el archivo con un editor de texto y modifique la forma en que se invoca FreeCAD cambiando la línea que comienza con Exec.
  1. Como resultado, tendrá una entrada adicional en el menú de inicio/lanzador de aplicaciones. De esta manera, puede tener varias entradas de FreeCAD con diferentes opciones de inicio.

Iniciando FreeCAD desde un medio USB portátil

Windows

Coloque el ejecutable de FreeCAD, FreeCAD.exe, en el medio USB. Cree un archivo por lotes, FreeCAD.bat, y colóquelo en el mismo directorio que FreeCAD.exe. Dentro del archivo por lotes escriba:

set CURRENTDIR=%cd%
set FREECAD_USER_HOME=%CURRENTDIR%
start FreeCAD.exe -u FreeCAD/user.cfg -s FreeCAD/system.cfg --write-log

Or with FREECAD_USER_DATA (see):

set CURRENTDIR="%cd%"
set FREECAD_USER_DATA=%CURRENTDIR%/..
start FreeCAD.exe -u %FREECAD_USER_DATA%/user.cfg -s %FREECAD_USER_DATA%/system.cfg

Con el lote en la raíz del medio USB:

set CURRENTDIR=%cd%
set FREECAD_USER_DATA=%CURRENTDIR%FreeCAD\
start %cd%FreeCAD\bin\FreeCAD.exe -u %FREECAD_USER_DATA%user.cfg -s %FREECAD_USER_DATA%system.cfg

Ahora haga doble clic en el archivo por lotes para iniciar FreeCAD. (consultar)