Difference between revisions of "Environment Variables"
From Synfig Studio :: Documentation
m (document the environment variables synfig reads) |
(→Environment Variables: Add SYNFIG_USER_SETTINGS environment variable, as requested in https://github.com/synfig/synfig/issues/716) |
||
| (15 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| + | <!-- Page info --> | ||
| + | {{Title|Environment Variables}} | ||
| + | {{NewTerminology}} | ||
| + | <!-- Page info end --> | ||
| + | |||
| + | == Environment Variables == | ||
| + | |||
| + | Several environment variables can be set to affect the behavior of Synfig Studio: | ||
| + | |||
{| border="1" cellspacing="0" | {| border="1" cellspacing="0" | ||
|'''variable'''||'''description''' | |'''variable'''||'''description''' | ||
| Line 4: | Line 13: | ||
| SYNFIG_DISABLE_AUTOMATIC_DOCUMENT_CREATION || If no documents are specified when synfig is run, it will create a new blank document unless this variable is set. | | SYNFIG_DISABLE_AUTOMATIC_DOCUMENT_CREATION || If no documents are specified when synfig is run, it will create a new blank document unless this variable is set. | ||
|- | |- | ||
| − | | SYNFIG_ENABLE_NEW_CANVAS_EDIT_PROPERTIES || When a new document is created, the | + | | SYNFIG_ENABLE_NEW_CANVAS_EDIT_PROPERTIES || When a new document is created, the {{l|Canvas Properties Dialog}} will only be shown if this variable is set. |
|- | |- | ||
| SYNFIG_DISABLE_OPTIMIZE<br/>SYNFIG_DISABLE_OPTIMIZE_TRANS<br/>SYNFIG_DISABLE_REMOVE_DUPS || These three variables, when set, disable various steps of the animated gif optimization process in the magick++ module. Namely: disable optimization completely, disable optimization of transparent pixels, and disable the removal of adjacent duplicate frames respectively. | | SYNFIG_DISABLE_OPTIMIZE<br/>SYNFIG_DISABLE_OPTIMIZE_TRANS<br/>SYNFIG_DISABLE_REMOVE_DUPS || These three variables, when set, disable various steps of the animated gif optimization process in the magick++ module. Namely: disable optimization completely, disable optimization of transparent pixels, and disable the removal of adjacent duplicate frames respectively. | ||
|- | |- | ||
| − | | SYNFIG_DISABLE_DRAW<br/>SYNFIG_DISABLE_POLYGON<br/>SYNFIG_DISABLE_SKETCH || These can be used to disable the named tools from being shown in the | + | | SYNFIG_DISABLE_DRAW<br/>SYNFIG_DISABLE_POLYGON<br/>SYNFIG_DISABLE_SKETCH || These can be used to disable the named tools from being shown in the {{l|Toolbox}}. |
|- | |- | ||
| − | | SYNFIG_ENABLE_WIDTH || If set, this enables the (mostly broken) | + | | SYNFIG_ENABLE_WIDTH || If set, this enables the (mostly broken) {{l|Width Tool}} in the {{l|Toolbox}}. |
|- | |- | ||
| − | | SYNFIG_TIMETRACK_HEADER_HEIGHT<br/>SYNFIG_TIMETRACK_ROW_HEIGHT || These are used to change the header and row heights in the | + | | SYNFIG_TIMETRACK_HEADER_HEIGHT<br/>SYNFIG_TIMETRACK_ROW_HEIGHT || These are used to change the header and row heights in the {{l|Timetrack_Panel}}. This is sometimes needed to make the timetrack panel rows line up with the parameter panel's rows. |
|- | |- | ||
| SYNFIG_DISABLE_POPUP_WINDOWS || When set, this makes the splash screen and "one moment please" popup windows behave like regular windows - ie. they can be minimized, and covered by other windows. | | SYNFIG_DISABLE_POPUP_WINDOWS || When set, this makes the splash screen and "one moment please" popup windows behave like regular windows - ie. they can be minimized, and covered by other windows. | ||
|- | |- | ||
| − | | SYNFIG_DISABLE_TILE_RENDER || When set, the workarea is always rendered using the scanline renderer, rather than being broken up into small square tiles which are rendered separately. | + | | SYNFIG_DISABLE_TILE_RENDER || When set, the workarea is always rendered using the scanline renderer, rather than being broken up into small square tiles which are rendered separately. This is overridden by SYNFIG_FORCE_TILE_RENDER. |
| + | |- | ||
| + | | SYNFIG_FORCE_TILE_RENDER || When set, the workarea is always rendered using the tile renderer, rather than being rendered in a single block. This overrides SYNFIG_DISABLE_TILE_RENDER. | ||
| + | |- | ||
| + | | SYNFIG_SHOW_TILE_OUTLINES || For debugging, this draws a red outline around each tile when using the tile renderer. | ||
|- | |- | ||
| SYNFIG_ENABLE_POPUP_MENU_IN_ALL_TOOLS || Allow the right-click context menu to be used in all the various tool states. | | SYNFIG_ENABLE_POPUP_MENU_IN_ALL_TOOLS || Allow the right-click context menu to be used in all the various tool states. | ||
| Line 24: | Line 37: | ||
| SYNFIG_ROOT || Specifies the path to the synfig resources. It should be the directory which contains share/pixmaps/synfigstudio/ - usually /usr or /usr/local. | | SYNFIG_ROOT || Specifies the path to the synfig resources. It should be the directory which contains share/pixmaps/synfigstudio/ - usually /usr or /usr/local. | ||
|- | |- | ||
| − | | | + | | SYNFIG_USER_SETTINGS || Specifies the path user settings directory. |
| + | |- | ||
| + | | SYNFIG_TOOLS_CLEAR_SELECTION || When set, unselect all layers before creating a new layer in any of the tools (other than the {{l|Draw Tool}}, which always leaves selected layers selected so that their {{l|Handle|Handles}} can be linked to). | ||
| + | |- | ||
| + | | SYNFIG_TRANSIENT_DIALOGS || Some window managers fail to associate synfig's panels with the toolbox. Setting this can help. It seems to work quite well on Windows too, preventing the panels from taking up space on the task bar, but be careful not to minimize any of the panels, it can cause problems. | ||
| + | |- | ||
| + | | SYNFIG_DEBUG_DESTRUCTORS || Logs the sequence of destructions that go on when closing things down. | ||
| + | |- | ||
| + | | SYNFIG_SHOW_FULL_TIME_ON_FOCUS || When editing a Time field, start with the full formatted time, ie. "0h 0m 1s 0f" rather than "1s". | ||
| + | |- | ||
| + | | SYNFIG_WINDOW_POSITION_X_OFFSET<br/>SYNFIG_WINDOW_POSITION_Y_OFFSET || Added on to the stored position of each panel when studio starts up. Used to combat the pixel-by-pixel drifting that happens with some window managers. | ||
| + | |- | ||
| + | | SYNFIG_SHOW_CANVAS_PARAM_WAYPOINTS || In {{l|Group Layer|Group Layers}}, show waypoints for the Canvas parameter itself, rather than for the canvas that is the parameter's value. Experimental. | ||
| + | |- | ||
| + | | SYNFIG_KEEP_ABORTED_DRAW_LINES || In the {{l|Draw Tool}}, if you make a very fast stroke, it's not used. Synfig Studio always used to leave the unused stroke on the display until a longer stroke was made. SVN r1689 changed things so that these short strokes are immediately hidden. Setting this variable restores the previous behavior. | ||
|- | |- | ||
| − | | | + | | SYNFIG_DISABLE_OPTIMIZE_LAYER_TREE || Before starting to render a tree of layers, Synfig makes an optimized copy of the layer tree, omitting any layers that currently have an amount of 0. The aim is to make the render go faster, but it may introduce some instability into the application. Set this variable to disable the optimization step. |
|} | |} | ||
Latest revision as of 10:31, 9 February 2019
Environment Variables
Several environment variables can be set to affect the behavior of Synfig Studio:
| variable | description |
| SYNFIG_DISABLE_AUTOMATIC_DOCUMENT_CREATION | If no documents are specified when synfig is run, it will create a new blank document unless this variable is set. |
| SYNFIG_ENABLE_NEW_CANVAS_EDIT_PROPERTIES | When a new document is created, the Canvas Properties Dialog will only be shown if this variable is set. |
| SYNFIG_DISABLE_OPTIMIZE SYNFIG_DISABLE_OPTIMIZE_TRANS SYNFIG_DISABLE_REMOVE_DUPS |
These three variables, when set, disable various steps of the animated gif optimization process in the magick++ module. Namely: disable optimization completely, disable optimization of transparent pixels, and disable the removal of adjacent duplicate frames respectively. |
| SYNFIG_DISABLE_DRAW SYNFIG_DISABLE_POLYGON SYNFIG_DISABLE_SKETCH |
These can be used to disable the named tools from being shown in the Toolbox. |
| SYNFIG_ENABLE_WIDTH | If set, this enables the (mostly broken) Width Tool in the Toolbox. |
| SYNFIG_TIMETRACK_HEADER_HEIGHT SYNFIG_TIMETRACK_ROW_HEIGHT |
These are used to change the header and row heights in the Time Track Panel. This is sometimes needed to make the timetrack panel rows line up with the parameter panel's rows. |
| SYNFIG_DISABLE_POPUP_WINDOWS | When set, this makes the splash screen and "one moment please" popup windows behave like regular windows - ie. they can be minimized, and covered by other windows. |
| SYNFIG_DISABLE_TILE_RENDER | When set, the workarea is always rendered using the scanline renderer, rather than being broken up into small square tiles which are rendered separately. This is overridden by SYNFIG_FORCE_TILE_RENDER. |
| SYNFIG_FORCE_TILE_RENDER | When set, the workarea is always rendered using the tile renderer, rather than being rendered in a single block. This overrides SYNFIG_DISABLE_TILE_RENDER. |
| SYNFIG_SHOW_TILE_OUTLINES | For debugging, this draws a red outline around each tile when using the tile renderer. |
| SYNFIG_ENABLE_POPUP_MENU_IN_ALL_TOOLS | Allow the right-click context menu to be used in all the various tool states. |
| SYNFIG_MODULE_LIST | Specifies where to load the list of dynamic modules from. |
| SYNFIG_ROOT | Specifies the path to the synfig resources. It should be the directory which contains share/pixmaps/synfigstudio/ - usually /usr or /usr/local. |
| SYNFIG_USER_SETTINGS | Specifies the path user settings directory. |
| SYNFIG_TOOLS_CLEAR_SELECTION | When set, unselect all layers before creating a new layer in any of the tools (other than the Draw Tool, which always leaves selected layers selected so that their Handles can be linked to). |
| SYNFIG_TRANSIENT_DIALOGS | Some window managers fail to associate synfig's panels with the toolbox. Setting this can help. It seems to work quite well on Windows too, preventing the panels from taking up space on the task bar, but be careful not to minimize any of the panels, it can cause problems. |
| SYNFIG_DEBUG_DESTRUCTORS | Logs the sequence of destructions that go on when closing things down. |
| SYNFIG_SHOW_FULL_TIME_ON_FOCUS | When editing a Time field, start with the full formatted time, ie. "0h 0m 1s 0f" rather than "1s". |
| SYNFIG_WINDOW_POSITION_X_OFFSET SYNFIG_WINDOW_POSITION_Y_OFFSET |
Added on to the stored position of each panel when studio starts up. Used to combat the pixel-by-pixel drifting that happens with some window managers. |
| SYNFIG_SHOW_CANVAS_PARAM_WAYPOINTS | In Group Layers, show waypoints for the Canvas parameter itself, rather than for the canvas that is the parameter's value. Experimental. |
| SYNFIG_KEEP_ABORTED_DRAW_LINES | In the Draw Tool, if you make a very fast stroke, it's not used. Synfig Studio always used to leave the unused stroke on the display until a longer stroke was made. SVN r1689 changed things so that these short strokes are immediately hidden. Setting this variable restores the previous behavior. |
| SYNFIG_DISABLE_OPTIMIZE_LAYER_TREE | Before starting to render a tree of layers, Synfig makes an optimized copy of the layer tree, omitting any layers that currently have an amount of 0. The aim is to make the render go faster, but it may introduce some instability into the application. Set this variable to disable the optimization step. |
 |
Language: |
English |
