Documenting environment variables

This commit is contained in:
Bill Kendrick 2021-05-11 01:08:12 -07:00
parent cc4cc3db4f
commit d502566f77
11 changed files with 1144 additions and 1 deletions

View file

@ -8,7 +8,7 @@ http://www.tuxpaint.org/
$Id$ $Id$
2021.May.9 (0.9.26) 2021.May.11 (0.9.26)
* New Features * New Features
------------ ------------
* Larger UI buttons * Larger UI buttons
@ -62,6 +62,9 @@ $Id$
+ Japanese + Japanese
TOYAMA Shin-ichi <shin1@wmail.plala.or.jp> TOYAMA Shin-ichi <shin1@wmail.plala.or.jp>
* Adding documentation that covers some of the
environment variables that Tux Paint utilizes.
* Expanded the steps for making and posting releases. * Expanded the steps for making and posting releases.
* Documented how to build Tux Paint using old macOS * Documented how to build Tux Paint using old macOS

94
docs/en/ENVVARS.txt Normal file
View file

@ -0,0 +1,94 @@
Tux Paint
version 0.9.26
Environment Variables Documentation
Copyright © 2021-2021 by various contributors; see AUTHORS.
http://www.tuxpaint.org/
May 11, 2021
----------------------------------------------------------------------
Tux Paint understands a number of environment variables, either directly,
or indirectly by the libraries that it utilizes.
Storage-related environment variables
HOME
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.
A few examples of where "$HOME" is used include:
* The location of Tux Paint's configuration file
* The basis of where Tux Paint saves and loads users' drawings
* The location of a user's private collection of data files —
stamps, brushes, etc. — (versus those available system wide)
XDG_CONFIG_HOME
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 "user-dirs.dirs", where the
"XDG_PICTURES_DIR" might be defined. It is used for exporting
drawings and animated GIFs. Generally it's set to something like
"$HOME/Pictures/". If not specified, Tux Paint checks in the
directory "$HOME/.config/". If the configuration cannot be found,
Tux Paint simply exports drawings and GIFs to "$HOME".
XDG_DATA_HOME
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 "Trash" directory. It is used when
deleting images from Tux Paint's "Open" dialog. If not set, the
location "$HOME/.local/share/Trash/" is used, if available. If
not, images are simply deleted, rather than moved anywhere.
TEMP
Specifies the location where temporary files may be created. Only
used by Tux Paint on Microsoft Windows OSes. Uses "userdata" if
not set.
Language-related environment variables
LANG
LANGUAGE
LC_ALL
LC_MESSAGES
Specify the language Tux Paint should utilize in its user
interface. Overridde by the "--lang" and "--locale" command-line
options or their configuration file counterparts. The "LANGUAGE"
environment variable is used, if set. If not, "LC_ALL" is used as
a fallback. Then "LC_MESSAGES", and finally "LANG".
Display-related environment variables
The following are a few of the environment variables supported by Simple
DirectMedia Layer (libSD) — 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.
SDL_VIDEO_ALLOW_SCREENSAVER
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 "--allowscreensaver" or its configuration file
counterpart.
SDL_VIDEO_WINDOW_POS
Requests where to position Tux Paint's window. Normally set to
"center" by Tux Paint itself, unless the environment variable is
already set (e.g., to "nopref", meaning "no preference").

134
docs/en/html/ENVVARS.html Normal file
View file

@ -0,0 +1,134 @@
<!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.26<br/>
Environment Variables Documentation </h1>
<p>
Copyright &copy; 2021-2021 by various contributors; see AUTHORS.<br>
<a href="http://www.tuxpaint.org/">http://www.tuxpaint.org/</a>
</p>
<p>
May 11, 2021 </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 &mdash; stamps, brushes, etc. &mdash; (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. Overridde 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 (libSD) &mdash; which Tux Paint utilizes for displaying graphics, playing sounds, and receiving mouse, keyboard, and joystick input &mdash; 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. Normally set to "<code>center</code>" by Tux Paint itself, unless the environment variable is already set (e.g., to "<code>nopref</code>", meaning "no preference"). </p>
</dd>
</dl>
</body>
</html>

View file

@ -0,0 +1,94 @@
Tux Paint
versión 0.9.26
Environment Variables Documentation
Copyright © 2021-2021 by various contributors; see AUTHORS.
http://www.tuxpaint.org/
mayo 11, 2021
----------------------------------------------------------------------
Tux Paint understands a number of environment variables, either directly,
or indirectly by the libraries that it utilizes.
Storage-related environment variables
HOME
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.
A few examples of where "$HOME" is used include:
* The location of Tux Paint's configuration file
* The basis of where Tux Paint saves and loads users' drawings
* The location of a user's private collection of data files —
stamps, brushes, etc. — (versus those available system wide)
XDG_CONFIG_HOME
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 "user-dirs.dirs", where the
"XDG_PICTURES_DIR" might be defined. It is used for exporting
drawings and animated GIFs. Generally it's set to something like
"$HOME/Pictures/". If not specified, Tux Paint checks in the
directory "$HOME/.config/". If the configuration cannot be found,
Tux Paint simply exports drawings and GIFs to "$HOME".
XDG_DATA_HOME
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 "Trash" directory. It is used when
deleting images from Tux Paint's "Open" dialog. If not set, the
location "$HOME/.local/share/Trash/" is used, if available. If
not, images are simply deleted, rather than moved anywhere.
TEMP
Specifies the location where temporary files may be created. Only
used by Tux Paint on Microsoft Windows OSes. Uses "userdata" if
not set.
Language-related environment variables
LANG
LANGUAGE
LC_ALL
LC_MESSAGES
Specify the language Tux Paint should utilize in its user
interface. Overridde by the "--lang" and "--locale" command-line
options or their configuration file counterparts. The "LANGUAGE"
environment variable is used, if set. If not, "LC_ALL" is used as
a fallback. Then "LC_MESSAGES", and finally "LANG".
Display-related environment variables
The following are a few of the environment variables supported by Simple
DirectMedia Layer (libSD) — 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.
SDL_VIDEO_ALLOW_SCREENSAVER
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 "--allowscreensaver" or its configuration file
counterpart.
SDL_VIDEO_WINDOW_POS
Requests where to position Tux Paint's window. Normally set to
"center" by Tux Paint itself, unless the environment variable is
already set (e.g., to "nopref", meaning "no preference").

View file

@ -0,0 +1,134 @@
<!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>
versi&oacute;n 0.9.26<br/>
Environment Variables Documentation </h1>
<p>
Copyright &copy; 2021-2021 by various contributors; see AUTHORS.<br>
<a href="http://www.tuxpaint.org/">http://www.tuxpaint.org/</a>
</p>
<p>
mayo 11, 2021 </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 &mdash; stamps, brushes, etc. &mdash; (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. Overridde 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 (libSD) &mdash; which Tux Paint utilizes for displaying graphics, playing sounds, and receiving mouse, keyboard, and joystick input &mdash; 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. Normally set to "<code>center</code>" by Tux Paint itself, unless the environment variable is already set (e.g., to "<code>nopref</code>", meaning "no preference"). </p>
</dd>
</dl>
</body>
</html>

View file

@ -0,0 +1,94 @@
Tux Paint
version 0.9.26
Environment Variables Documentation
Copyright © 2021-2021 by various contributors; cf AUTHORS.
http://www.tuxpaint.org/
mai 11, 2021
----------------------------------------------------------------------
Tux Paint understands a number of environment variables, either directly,
or indirectly by the libraries that it utilizes.
Storage-related environment variables
HOME
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.
A few examples of where "$HOME" is used include:
* The location of Tux Paint's configuration file
* The basis of where Tux Paint saves and loads users' drawings
* The location of a user's private collection of data files —
stamps, brushes, etc. — (versus those available system wide)
XDG_CONFIG_HOME
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 "user-dirs.dirs", where the
"XDG_PICTURES_DIR" might be defined. It is used for exporting
drawings and animated GIFs. Generally it's set to something like
"$HOME/Pictures/". If not specified, Tux Paint checks in the
directory "$HOME/.config/". If the configuration cannot be found,
Tux Paint simply exports drawings and GIFs to "$HOME".
XDG_DATA_HOME
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 "Trash" directory. It is used when
deleting images from Tux Paint's "Open" dialog. If not set, the
location "$HOME/.local/share/Trash/" is used, if available. If
not, images are simply deleted, rather than moved anywhere.
TEMP
Specifies the location where temporary files may be created. Only
used by Tux Paint on Microsoft Windows OSes. Uses "userdata" if
not set.
Language-related environment variables
LANG
LANGUAGE
LC_ALL
LC_MESSAGES
Specify the language Tux Paint should utilize in its user
interface. Overridde by the "--lang" and "--locale" command-line
options or their configuration file counterparts. The "LANGUAGE"
environment variable is used, if set. If not, "LC_ALL" is used as
a fallback. Then "LC_MESSAGES", and finally "LANG".
Display-related environment variables
The following are a few of the environment variables supported by Simple
DirectMedia Layer (libSD) — 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.
SDL_VIDEO_ALLOW_SCREENSAVER
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 "--allowscreensaver" or its configuration file
counterpart.
SDL_VIDEO_WINDOW_POS
Requests where to position Tux Paint's window. Normally set to
"center" by Tux Paint itself, unless the environment variable is
already set (e.g., to "nopref", meaning "no preference").

View file

@ -0,0 +1,134 @@
<!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.26<br/>
Environment Variables Documentation </h1>
<p>
Copyright &copy; 2021-2021 by various contributors; cf AUTHORS.<br>
<a href="http://www.tuxpaint.org/">http://www.tuxpaint.org/</a>
</p>
<p>
mai 11, 2021 </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 &mdash; stamps, brushes, etc. &mdash; (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. Overridde 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 (libSD) &mdash; which Tux Paint utilizes for displaying graphics, playing sounds, and receiving mouse, keyboard, and joystick input &mdash; 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. Normally set to "<code>center</code>" by Tux Paint itself, unless the environment variable is already set (e.g., to "<code>nopref</code>", meaning "no preference"). </p>
</dd>
</dl>
</body>
</html>

View file

@ -0,0 +1,94 @@
Tux Paint
versión 0.9.26
Environment Variables Documentation
Copyright © 2021-2021 por varios colaboradores; vexa AUTHORS (AUTORES).
http://www.tuxpaint.org/
11 de Maio de 2021
----------------------------------------------------------------------
Tux Paint understands a number of environment variables, either directly,
or indirectly by the libraries that it utilizes.
Storage-related environment variables
HOME
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.
A few examples of where "$HOME" is used include:
* The location of Tux Paint's configuration file
* The basis of where Tux Paint saves and loads users' drawings
* The location of a user's private collection of data files —
stamps, brushes, etc. — (versus those available system wide)
XDG_CONFIG_HOME
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 "user-dirs.dirs", where the
"XDG_PICTURES_DIR" might be defined. It is used for exporting
drawings and animated GIFs. Generally it's set to something like
"$HOME/Pictures/". If not specified, Tux Paint checks in the
directory "$HOME/.config/". If the configuration cannot be found,
Tux Paint simply exports drawings and GIFs to "$HOME".
XDG_DATA_HOME
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 "Trash" directory. It is used when
deleting images from Tux Paint's "Open" dialog. If not set, the
location "$HOME/.local/share/Trash/" is used, if available. If
not, images are simply deleted, rather than moved anywhere.
TEMP
Specifies the location where temporary files may be created. Only
used by Tux Paint on Microsoft Windows OSes. Uses "userdata" if
not set.
Language-related environment variables
LANG
LANGUAGE
LC_ALL
LC_MESSAGES
Specify the language Tux Paint should utilize in its user
interface. Overridde by the "--lang" and "--locale" command-line
options or their configuration file counterparts. The "LANGUAGE"
environment variable is used, if set. If not, "LC_ALL" is used as
a fallback. Then "LC_MESSAGES", and finally "LANG".
Display-related environment variables
The following are a few of the environment variables supported by Simple
DirectMedia Layer (libSD) — 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.
SDL_VIDEO_ALLOW_SCREENSAVER
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 "--allowscreensaver" or its configuration file
counterpart.
SDL_VIDEO_WINDOW_POS
Requests where to position Tux Paint's window. Normally set to
"center" by Tux Paint itself, unless the environment variable is
already set (e.g., to "nopref", meaning "no preference").

View file

@ -0,0 +1,134 @@
<!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>
versión 0.9.26<br/>
Environment Variables Documentation </h1>
<p>
Copyright &copy; 2021-2021 por varios colaboradores; vexa AUTHORS (AUTORES).<br>
<a href="http://www.tuxpaint.org/">http://www.tuxpaint.org/</a>
</p>
<p>
11 de Maio de 2021 </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 &mdash; stamps, brushes, etc. &mdash; (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. Overridde 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 (libSD) &mdash; which Tux Paint utilizes for displaying graphics, playing sounds, and receiving mouse, keyboard, and joystick input &mdash; 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. Normally set to "<code>center</code>" by Tux Paint itself, unless the environment variable is already set (e.g., to "<code>nopref</code>", meaning "no preference"). </p>
</dd>
</dl>
</body>
</html>

View file

@ -0,0 +1,94 @@
Tux Paint
バージョン 0.9.26
Environment Variables Documentation
Copyright © 2021-2021 by various contributors; "AUTHORS" 参照.
http://www.tuxpaint.org/
2021年5月11日
----------------------------------------------------------------------
Tux Paint understands a number of environment variables, either directly,
or indirectly by the libraries that it utilizes.
Storage-related environment variables
HOME
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.
A few examples of where "$HOME" is used include:
* The location of Tux Paint's configuration file
* The basis of where Tux Paint saves and loads users' drawings
* The location of a user's private collection of data files —
stamps, brushes, etc. — (versus those available system wide)
XDG_CONFIG_HOME
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 "user-dirs.dirs", where the
"XDG_PICTURES_DIR" might be defined. It is used for exporting
drawings and animated GIFs. Generally it's set to something like
"$HOME/Pictures/". If not specified, Tux Paint checks in the
directory "$HOME/.config/". If the configuration cannot be found,
Tux Paint simply exports drawings and GIFs to "$HOME".
XDG_DATA_HOME
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 "Trash" directory. It is used when
deleting images from Tux Paint's "Open" dialog. If not set, the
location "$HOME/.local/share/Trash/" is used, if available. If
not, images are simply deleted, rather than moved anywhere.
TEMP
Specifies the location where temporary files may be created. Only
used by Tux Paint on Microsoft Windows OSes. Uses "userdata" if
not set.
Language-related environment variables
LANG
LANGUAGE
LC_ALL
LC_MESSAGES
Specify the language Tux Paint should utilize in its user
interface. Overridde by the "--lang" and "--locale" command-line
options or their configuration file counterparts. The "LANGUAGE"
environment variable is used, if set. If not, "LC_ALL" is used as
a fallback. Then "LC_MESSAGES", and finally "LANG".
Display-related environment variables
The following are a few of the environment variables supported by Simple
DirectMedia Layer (libSD) — 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.
SDL_VIDEO_ALLOW_SCREENSAVER
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 "--allowscreensaver" or its configuration file
counterpart.
SDL_VIDEO_WINDOW_POS
Requests where to position Tux Paint's window. Normally set to
"center" by Tux Paint itself, unless the environment variable is
already set (e.g., to "nopref", meaning "no preference").

View file

@ -0,0 +1,134 @@
<!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>
バージョン 0.9.26<br/>
Environment Variables Documentation </h1>
<p>
Copyright &copy; 2021-2021 by various contributors; "AUTHORS" 参照.<br>
<a href="http://www.tuxpaint.org/">http://www.tuxpaint.org/</a>
</p>
<p>
2021年5月11日 </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 &mdash; stamps, brushes, etc. &mdash; (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. Overridde 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 (libSD) &mdash; which Tux Paint utilizes for displaying graphics, playing sounds, and receiving mouse, keyboard, and joystick input &mdash; 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. Normally set to "<code>center</code>" by Tux Paint itself, unless the environment variable is already set (e.g., to "<code>nopref</code>", meaning "no preference"). </p>
</dd>
</dl>
</body>
</html>