1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
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.28<br/>
Environment Variables Documentation </h1>
<p>
Copyright © 2021-2022 by various contributors; see <a href="../../AUTHORS.txt">AUTHORS.txt</a>.<br>
<a href="https://tuxpaint.org/">https://tuxpaint.org/</a>
</p>
<p>
June 4, 2022 </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. 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) — 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. 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>
|
