134 lines
5.4 KiB
HTML
134 lines
5.4 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<html>
|
|
<head>
|
|
<title>
|
|
Tux Paint Environment Variables Documentation </title>
|
|
<meta http-equiv="Content-Type"
|
|
content="text/html; charset=utf-8">
|
|
</head>
|
|
<body bgcolor="#FFFFFF"
|
|
text="#000000"
|
|
link="#0000FF"
|
|
vlink="#FF0000"
|
|
alink="#FF00FF">
|
|
<center>
|
|
<h1>
|
|
<img src="../../html/images/tuxpaint-title.png"
|
|
width="205"
|
|
height="210"
|
|
alt="Tux Paint"><br>
|
|
version 0.9.33<br/>
|
|
Environment Variables Documentation </h1>
|
|
|
|
<p>
|
|
Copyright © 2021-2023 by various contributors; see <a href="../../AUTHORS.txt">AUTHORS.txt</a>.<br>
|
|
<a href="https://tuxpaint.org/">https://tuxpaint.org/</a>
|
|
</p>
|
|
|
|
<p>
|
|
May 5, 2023 </p>
|
|
</center>
|
|
|
|
<hr>
|
|
|
|
<p>
|
|
Tux Paint understands a number of environment variables, either directly, or indirectly by the libraries that it utilizes. </p>
|
|
|
|
<h2>
|
|
Storage-related environment variables </h2>
|
|
<dl>
|
|
<dt>
|
|
<code>HOME</code>
|
|
</dt>
|
|
|
|
<dd>
|
|
<p>
|
|
Specifies the user's "home directory", which is used to locate numerous other files or directories. In some cases, it is utilized as part of a fall-back location, when other environment variables (elsewhere in this documentation) are not set. Sometimes, the location to use can be overridden by options provided on the command-line or via Tux Paint's configuration file. See the "OPTIONS" documentation for details. </p>
|
|
|
|
<p>
|
|
A few examples of where "<code>$HOME</code>" is used include: </p>
|
|
|
|
<ul>
|
|
<li>The location of Tux Paint's configuration file</li>
|
|
<li>The basis of where Tux Paint saves and loads users' drawings</li>
|
|
<li>The location of a user's private collection of data files — stamps, brushes, etc. — (versus those available system wide)</li>
|
|
</ul>
|
|
</dd>
|
|
|
|
<dt>
|
|
<code>XDG_CONFIG_HOME</code>
|
|
</dt>
|
|
|
|
<dd>
|
|
<p>
|
|
On Linux and other platforms where the X Desktop Group standards are used, the location of the user's configuration files. Specifically, where to find "<code>user-dirs.dirs</code>", where the "<code>XDG_PICTURES_DIR</code>" might be defined. It is used for exporting drawings and animated GIFs. Generally it's set to something like "<code>$HOME/Pictures/</code>". If not specified, Tux Paint checks in the directory "<code>$HOME/.config/</code>". If the configuration cannot be found, Tux Paint simply exports drawings and GIFs to "<code>$HOME</code>". </p>
|
|
</dd>
|
|
|
|
<dt>
|
|
<code>XDG_DATA_HOME</code>
|
|
</dt>
|
|
|
|
<dd>
|
|
<p>
|
|
On Linux and other platforms where the X Desktop Group standards are used, the location of the user's data directories. Specifically, where to find the "<code>Trash</code>" directory. It is used when deleting images from Tux Paint's "Open" dialog. If not set, the location "<code>$HOME/.local/share/Trash/</code>" is used, if available. If not, images are simply deleted, rather than moved anywhere. </p>
|
|
</dd>
|
|
|
|
<dt>
|
|
<code>TEMP</code>
|
|
</dt>
|
|
|
|
<dd>
|
|
<p>
|
|
Specifies the location where temporary files may be created. Only used by Tux Paint on Microsoft Windows OSes. Uses "<code>userdata</code>" if not set. </p>
|
|
</dl>
|
|
|
|
|
|
<h2>
|
|
Language-related environment variables </h2>
|
|
<dl>
|
|
<dt>
|
|
<code>LANG</code>
|
|
</dt>
|
|
<dt>
|
|
<code>LANGUAGE</code>
|
|
</dt>
|
|
<dt>
|
|
<code>LC_ALL</code>
|
|
</dt>
|
|
<dt>
|
|
<code>LC_MESSAGES</code>
|
|
</dt>
|
|
|
|
<dd>
|
|
<p>
|
|
Specify the language Tux Paint should utilize in its user interface. Overridden by the "<code>--lang</code>" and "<code>--locale</code>" command-line options or their configuration file counterparts. The "<code>LANGUAGE</code>" environment variable is used, if set. If not, "<code>LC_ALL</code>" is used as a fallback. Then "<code>LC_MESSAGES</code>", and finally "<code>LANG</code>". </p>
|
|
</dd>
|
|
|
|
</dl>
|
|
|
|
<h2>
|
|
Display-related environment variables </h2>
|
|
|
|
<p>
|
|
The following are a few of the environment variables supported by Simple DirectMedia Layer (libSDL) — which Tux Paint utilizes for displaying graphics, playing sounds, and receiving mouse, keyboard, and joystick input — and which may be useful to users of Tux Paint.
|
|
<dl>
|
|
<dt>
|
|
<code>SDL_VIDEO_ALLOW_SCREENSAVER</code>
|
|
</dt>
|
|
<dd>
|
|
<p>
|
|
Specifies whether Tux Paint should allow a screensaver to run. Can be set to '1' (true) by Tux Paint itself by issuing the command-line option "<code>--allowscreensaver</code>" or its configuration file counterpart. </p>
|
|
</dd>
|
|
<dt>
|
|
<code>SDL_VIDEO_WINDOW_POS</code>
|
|
</dt>
|
|
<dd>
|
|
<p>
|
|
Requests where to position Tux Paint's window, and can be used to specify what display to place a fullscreen Tux Paint in a multi-monitor configuration. If not set, or set to "<code>nopref</code>" (meaning "no preference"), Simple DirectMedia Layer (libSDL) decides. Can be set to an <code>X,Y</code> coordinate (e.g. <code>200,100</code>), or "<code>center</code>" (meaning "center"). </p>
|
|
</dd>
|
|
|
|
</dl>
|
|
|
|
</body>
|
|
</html>
|
|
|