Sync docs after various doc source updates

...mostly in terms of modularizing how various file
and directory (folder) paths are shown (for consistency in
both name and styling); add some missing paths (e.g., where
does Tux Paint save drawings on Haiku?)
This commit is contained in:
Bill Kendrick 2024-04-27 12:42:55 -07:00
parent 9c2a75455d
commit e268b598ff
71 changed files with 1074 additions and 873 deletions

View file

@ -5,7 +5,7 @@
Copyright © 2002-2024 by various contributors; see AUTHORS.txt.
https://tuxpaint.org/
janúar 26, 2024
apríl 27, 2024
+-----------------------------------------+
| Table of Contents |

View file

@ -226,15 +226,19 @@ Where does Tux Paint save my drawings?
Windows Vista, Windows 8, Windows 10, Windows 11
In the user's "AppData" folder:
e.g., C:\Users\Username\AppData\Roaming\TuxPaint\saved
e.g., "C:\Users\username\AppData\Roaming\TuxPaint\saved\"
macOS
In the user's "Application Support" folder:
e.g., /Users/Username/Library/Applicaton Support/TuxPaint/saved/
e.g., "/Users/username/Library/Application Support/TuxPaint/saved/"
Linux / Unix
In the user's home directory ("$HOME"), under a ".tuxpaint" subfolder:
e.g., /home/username/.tuxpaint/saved/
In the user's "home directory" folder:
e.g., "/home/username/.tuxpaint/saved/"
Haiku
In the user's "settings" folder:
e.g., "/boot/home/config/settings/TuxPaint/saved/"
The images are stored as PNG bitmaps, which most modern programs should be
@ -478,13 +482,13 @@ Tux Paint won't run
Paint!", this means it has been launched in the last 30 seconds. (On Unix/
Linux, this message would appear in a terminal console if you ran Tux Paint
from a command-line. On Windows, this message would appear in a file named
"stdout.txt" in the same folder where TuxPaint.exe resides (e.g., in "C:\
Program Files\TuxPaint").
"stdout.txt" in the same folder where TuxPaint.exe resides (e.g., in
"C:\Program Files\TuxPaint\").
A lockfile ("~/.tuxpaint/lockfile.dat" on Linux and Unix, "userdata\
lockfile.dat" on Windows) is used to make sure Tux Paint isn't run too many
times at once (e.g., due to a child impatiently clicking its icon more than
once).
A lockfile (e.g., "/home/username/.tuxpaint/lockfile.dat" on Linux and
Unix, "userdata\lockfile.dat" on Windows) is used to make sure Tux Paint
isn't run too many times at once (e.g., due to a child impatiently clicking
its icon more than once).
Even if the lockfile exists, it contains the 'time' Tux Paint was last run.
If it's been more than 30 seconds, Tux Paint should run fine, and simply
@ -557,9 +561,14 @@ Tux Paint is using options I didn't specify!
+ Windows
Under Windows, Tux Paint first examines the configuration file:
Under Windows, it first examines the system-wide configuration file,
located here:
C:\Users\Username\AppData\Roaming\TuxPaint\tuxpaint.cfg
C:\Program Files\TuxPaint\tuxpaint.cfg
It then examines the user's personal configuration file:
C:\Users\username\AppData\Roaming\TuxPaint\tuxpaint.cfg
Finally, any options sent as command-line arguments are used.
@ -572,7 +581,7 @@ Tux Paint is using options I didn't specify!
It then examines the user's personal configuration file:
/Users/Username/Library/Application Support/TuxPaint/tuxpaint.cfg
/Users/username/Library/Application Support/TuxPaint/tuxpaint.cfg
Finally, any options sent as command-line arguments are used.
@ -606,8 +615,8 @@ Tux Paint is using options I didn't specify!
nosound=yes
...then you can reenable sound by either adding this option to your own "/
home/username/.tuxpaintrc" file:
...then you can reenable sound by either adding this option to your own
"/home/username/.tuxpaintrc" file:
sound=yes

View file

@ -2,10 +2,10 @@
version 0.9.33
Installation Documentation
Copyright © 2002-2023 by various contributors; see AUTHORS.txt.
Copyright © 2002-2024 by various contributors; see AUTHORS.txt.
https://tuxpaint.org/
maí 13, 2023
apríl 27, 2024
+---------------------------------------------------+
| Table of Contents |
@ -465,8 +465,8 @@ If Something Goes Wrong
If, when you double-click on the shortcut to run Tux Paint, nothing happens, it
is probably because some of these command-line options are wrong. Open an
Explorer, and look for a file called "stderr.txt" in your personal saving
folder for TuxPaint which is normaly "C:\Users\username\AppData\Roaming\
TuxPaint".
folder for TuxPaint which is normaly
"C:\Users\username\AppData\Roaming\TuxPaint\".
It will contain a description of what was wrong. Usually it will just be due to
incorrect character-case (capital 'Z' instead of lowercase 'z') or a missing

View file

@ -1136,17 +1136,19 @@ Save Printer Configuration
If you do not override it, the default location is:
o Linux & Unix — Under a hidden directory named ".tuxpaint" in your
home directory (aka "~" or "$HOME")
Example: /home/username/.tuxpaint/saved/
o Windows — Inside a folder named "TuxPaint" in your "Application
Data" folder.
Example: C:\Documents and Settings\Username\Application Data\
TuxPaint\saved\
o macOS — Inside a folder named "TuxPaint" in your "Application
Support" folder.
Example: /Users/Username/Library/Application Support/TuxPaint/saved
/
Linux / Unix
Under a hidden directory in your home directory:
/home/username/.tuxpaint/saved/
Windows
C:\Users\username\AppData\Roaming\TuxPaint\saved\
macOS
/Users/username/Library/Application Support/TuxPaint/saved/
Haiku
/boot/home/config/settings/TuxPaint/saved/
💡 Note: When specifying a Windows drive (e.g., "H:\"), you must also
specify a subdirectory.

View file

@ -154,8 +154,9 @@ the 'Tux Paint Installer,' but chose not to have shortcuts installed, you'll
need to double-click the "tuxpaint.exe" icon in the "Tux Paint" folder on your
computer.
By default, the 'Tux Paint Installer' will put Tux Paint's folder in "C:\
Program Files\", though you may have changed this when you ran the installer.
By default, the 'Tux Paint Installer' will put Tux Paint's folder in
"C:\Program Files\TuxPaint\", though you may have changed this when you ran the
installer.
If you used the 'ZIP-file' download, Tux Paint's folder will be wherever you
extracted the contents of the ZIP file.
@ -1155,21 +1156,21 @@ You can simply convert the picture to the format Tux Paint uses — PNG (Portabl
Network Graphic) — and place it in Tux Paint's "saved" directory/folder. Here
is where to find it (by default):
Windows 10, 8, 7, Vista
Inside the user's "AppData" folder, e.g.: "C:\Users\username\AppData\
Roaming\TuxPaint\saved\".
Windows 2000, XP
Inside the user's "Application Data" folder, e.g.: "C:\Documents and
Settings\username\Application Data\TuxPaint\saved\".
Windows Vista, Windows 8, Windows 10, Windows 11
In the user's "AppData" folder:
e.g., "C:\Users\username\AppData\Roaming\TuxPaint\saved\"
macOS
Inside the user's "Library" folder, e.g.: "/Users/username/Library/
Application Support/Tux Paint/saved/".
In the user's "Application Support" folder:
e.g., "/Users/username/Library/Application Support/TuxPaint/saved/"
Linux/Unix
Inside a hidden ".tuxpaint" directory, in the user's home directory
("$HOME"), e.g. "/home/username/.tuxpaint/saved/".
Linux / Unix
In the user's "home directory" folder:
e.g., "/home/username/.tuxpaint/saved/"
Haiku
In the user's "settings" folder:
e.g., "/boot/home/config/settings/TuxPaint/saved/"
💡 Note: It is also from this folder that you can copy or open pictures drawn in

View file

@ -100,7 +100,7 @@
</p>
<p>
janúar 26, 2024 </p>
apríl 27, 2024 </p>
</center>
</header>

View file

@ -312,27 +312,34 @@
Unless you asked Tux Paint to save into a specific location (using the "savedir" option), Tux Paint saves into a standard location on your local drive: </p>
<dl>
<dt>
<cite>Windows Vista, Windows 8, Windows 10, Windows 11</cite>
</dt>
<dt>
<cite>Windows Vista, Windows 8, Windows 10, Windows 11</cite>
</dt>
<dd>
In the user's "AppData" folder:<br> e.g., <code>C:\Users\<i>Username</i>\AppData\Roaming\TuxPaint\saved</code> </dd>
<dd>
In the user's "AppData" folder:<br> e.g., <nobr>"<code>C:\Users\username\AppData\Roaming\TuxPaint\saved\</code>"</nobr> </dd>
<dt>
<cite>macOS</cite>
</dt>
<dt>
<cite>macOS</cite>
</dt>
<dd>
In the user's "Application Support" folder:<br> e.g., <code>/Users/<i>Username</i>/Library/Applicaton Support/TuxPaint/saved/</code> </dd>
<dd>
In the user's "Application Support" folder:<br> e.g., <nobr>"<code>/Users/username/Library/Application Support/TuxPaint/saved/</code>"</nobr> </dd>
<dt>
<cite>Linux / Unix</cite>
</dt>
<dt>
<cite>Linux / Unix</cite>
</dt>
<dd>
In the user's home directory ("<code>$HOME</code>"), under a ".tuxpaint" subfolder:<br> e.g., <code>/home/<i>username</i>/.tuxpaint/saved/</code> </dd>
</dl>
<dd>
In the user's "home directory" folder:<br> e.g., <nobr>"<code>/home/username/.tuxpaint/saved/</code>"</nobr> </dd>
<dt>
<cite>Haiku</cite>
</dt>
<dd>
In the user's "settings" folder:<br> e.g., <nobr>"<code>/boot/home/config/settings/TuxPaint/saved/</code>"</nobr> </dd>
</dl>
<p>
The images are stored as PNG bitmaps, which most modern programs should be able to load (image editors, word processors, web browsers, etc.) </p>
@ -610,10 +617,10 @@
<dd>
<p>
If Tux Paint aborts with the message: "You're already running a copy of Tux Paint!", this means it has been launched in the last 30 seconds. (On Unix/Linux, this message would appear in a terminal console if you ran Tux Paint from a command-line. On Windows, this message would appear in a file named "<code>stdout.txt</code>" in the same folder where <code>TuxPaint.exe</code> resides (e.g., in "<code>C:\Program Files\TuxPaint</code>"). </p>
If Tux Paint aborts with the message: "You're already running a copy of Tux Paint!", this means it has been launched in the last 30 seconds. (On Unix/Linux, this message would appear in a terminal console if you ran Tux Paint from a command-line. On Windows, this message would appear in a file named "<code>stdout.txt</code>" in the same folder where <code>TuxPaint.exe</code> resides (e.g., in <nobr>"<code>C:\Program Files\TuxPaint\</code>"</nobr>). </p>
<p>
A lockfile ("~/.tuxpaint/lockfile.dat" on Linux and Unix, "userdata\lockfile.dat" on Windows) is used to make sure Tux Paint isn't run too many times at once (e.g., due to a child impatiently clicking its icon more than once). </p>
A lockfile (e.g., <nobr>"<code>/home/username/.tuxpaint/lockfile.dat</code>"</nobr> on Linux and Unix, <nobr>"<code>userdata\lockfile.dat</code>"</nobr> on Windows) is used to make sure Tux Paint isn't run too many times at once (e.g., due to a child impatiently clicking its icon more than once). </p>
<p>
Even if the lockfile exists, it contains the 'time' Tux Paint was last run. If it's been more than 30 seconds, Tux Paint should run fine, and simply update the lockfile with the current time. </p>
@ -694,12 +701,19 @@
<li>
<cite>Windows</cite>
<p>
Under Windows, Tux Paint first examines the configuration file: </p>
Under Windows, it first examines the system-wide configuration file, located here: </p>
<blockquote>
<p>
<code>C:\Users\<i>Username</i>\AppData\Roaming\TuxPaint\tuxpaint.cfg</code>
</p>
<nobr><code>C:\Program Files\TuxPaint\tuxpaint.cfg</code></nobr> </p>
</blockquote>
<p>
It then examines the user's personal configuration file: </p>
<blockquote>
<p>
<nobr><code>C:\Users\username\AppData\Roaming\TuxPaint\tuxpaint.cfg</code></nobr> </p>
</blockquote>
<p>
@ -713,8 +727,7 @@
<blockquote>
<p>
<code>/Library/Application Support/TuxPaint/tuxpaint.cfg</code>
</p>
<nobr><code>/Library/Application Support/TuxPaint/tuxpaint.cfg</code></nobr> </p>
</blockquote>
<p>
@ -722,8 +735,7 @@
<blockquote>
<p>
<code>/Users/<i>Username</i>/Library/Application Support/TuxPaint/tuxpaint.cfg</code>
</p>
<nobr><code>/Users/username/Library/Application Support/TuxPaint/tuxpaint.cfg</code></nobr> </p>
</blockquote>
<p>
@ -737,8 +749,7 @@
<blockquote>
<p>
<code>/etc/tuxpaint/tuxpaint.conf</code>
</p>
<nobr><code>/etc/tuxpaint/tuxpaint.conf</code></nobr> </p>
</blockquote>
<p>
@ -746,8 +757,7 @@
<blockquote>
<p>
<code>/home/username/.tuxpaintrc</code>
</p>
<nobr><code>/home/username/.tuxpaintrc</code></nobr> </p>
</blockquote>
<p>
@ -761,8 +771,7 @@
<blockquote>
<p>
<code>/boot/home/config/settings/TuxPaint/tuxpaint.conf</code>
</p>
<nobr><code>/boot/home/config/settings/TuxPaint/tuxpaint.conf</code></nobr> </p>
</blockquote>
<p>
@ -774,7 +783,7 @@
This means that if anything is set in a configuration file that you don't want set, you'll need to either change the config. file (if you can), or override the option on the command-line. </p>
<p>
For example, on Linux and Unix, if "<code>/etc/tuxpaint/tuxpaint.conf</code>" includes this option to disable sound... </p>
For example, on Linux and Unix, if <nobr>"<code>/etc/tuxpaint/tuxpaint.conf</code>"</nobr> includes this option to disable sound... </p>
<blockquote>
<p>
@ -783,7 +792,7 @@
</blockquote>
<p>
...then you can reenable sound by either adding this option to your own "<code>/home/username/.tuxpaintrc</code>" file: </p>
...then you can reenable sound by either adding this option to your own <nobr>"<code>/home/username/.tuxpaintrc</code>"</nobr> file: </p>
<blockquote>
<p>

View file

@ -93,12 +93,12 @@
Installation Documentation </h1>
<p>
Copyright &copy; 2002-2023 by various contributors; see <a href="../../AUTHORS.txt">AUTHORS.txt</a>.<br>
Copyright &copy; 2002-2024 by various contributors; see <a href="../../AUTHORS.txt">AUTHORS.txt</a>.<br>
<a href="https://tuxpaint.org/">https://tuxpaint.org/</a>
</p>
<p>
maí 13, 2023 </p>
apríl 27, 2024 </p>
</center>
</header>
@ -757,7 +757,7 @@
</header>
<p>
If, when you double-click on the shortcut to run Tux Paint, nothing happens, it is probably because some of these command-line options are wrong. Open an Explorer, and look for a file called "<code>stderr.txt</code>" in your personal saving folder for TuxPaint which is normaly "C:\Users\<i>username</i>\AppData\Roaming\TuxPaint". </p>
If, when you double-click on the shortcut to run Tux Paint, nothing happens, it is probably because some of these command-line options are wrong. Open an Explorer, and look for a file called "<code>stderr.txt</code>" in your personal saving folder for TuxPaint which is normaly <nobr>"<code>C:\Users\username\AppData\Roaming\TuxPaint\</code>"</nobr>. </p>
<p>
It will contain a description of what was wrong. Usually it will just be due to incorrect character-case (capital 'Z' instead of lowercase 'z') or a missing (or extra) '-' (dash). </p>

View file

@ -1786,17 +1786,24 @@
<p>
If you do not override it, the <b><i>default</i></b> location is: </p>
<ul>
<li>Linux &amp; Unix — Under a hidden directory named "<code>.tuxpaint</code>" in your home directory (aka "<code>~</code>" or "<code>$HOME</code>")<br>
Example: <code>/home/<i>username</i>/.tuxpaint/saved/</code> </li>
<dl>
<dt>Linux / Unix</dt>
<dd>
Under a hidden directory in your home directory:<br/>
<nobr><code>/home/username/.tuxpaint/saved/</code></nobr> </dd>
<li>Windows — Inside a folder named "<code>TuxPaint</code>" in your "<code>Application Data</code>" folder.<br>
Example: <code>C:\Documents and Settings\<i>Username</i>\Application Data\TuxPaint\saved\</code> <br>
</li>
<dt>Windows</dt>
<dd>
<nobr><code>C:\Users\username\AppData\Roaming\TuxPaint\saved\</code></nobr> </dd>
<li>macOS — Inside a folder named "<code>TuxPaint</code>" in your "<code>Application Support</code>" folder.<br>
Example: <code>/Users/<i>Username</i>/Library/Application Support/TuxPaint/saved/</code> </li>
</ul>
<dt>macOS</dt>
<dd>
<nobr><code>/Users/username/Library/Application Support/TuxPaint/saved/</code></nobr> </dd>
<dt>Haiku</dt>
<dd>
<nobr><code>/boot/home/config/settings/TuxPaint/saved/</code></nobr> </dd>
</dl>
<p class="note">
<span title="Information">&#128161;</span> <strong>Note:</strong> When specifying a Windows drive (e.g., "<code>H:\</code>"), you must also specify a subdirectory. </p>

View file

@ -318,7 +318,7 @@
If you're using the 'portable' (ZIP-file) version of Tux Paint, or if you used the 'Tux Paint Installer,' but chose not to have shortcuts installed, you'll need to double-click the "<code>tuxpaint.exe</code>" icon in the "<code>Tux Paint</code>" folder on your computer. </p>
<p>
By default, the 'Tux Paint Installer' will put Tux Paint's folder in "<code>C:\Program Files\</code>", though you may have changed this when you ran the installer. </p>
By default, the 'Tux Paint Installer' will put Tux Paint's folder in <nobr>"<code>C:\Program Files\TuxPaint\</code>"</nobr>, though you may have changed this when you ran the installer. </p>
<p>
If you used the 'ZIP-file' download, Tux Paint's folder will be wherever you extracted the contents of the ZIP file. </p>
@ -1669,36 +1669,36 @@
<p>
You can simply convert the picture to the format Tux Paint uses &mdash; PNG (Portable Network Graphic) &mdash; and place it in Tux Paint's "<code>saved</code>" directory/folder. Here is where to find it (by default): </p>
<dl>
<dt>
<strong>Windows 10, 8, 7, Vista</strong>
</dt>
<dd>
Inside the user's "<code>AppData</code>" folder, e.g.: "<code>C:\Users\<em>username</em>\AppData\Roaming\TuxPaint\saved\</code>". </dd>
<dt>
<strong>Windows 2000, XP</strong>
</dt>
<dd>
Inside the user's "<code>Application Data</code>" folder, e.g.: "<code>C:\Documents and Settings\<em>username</em>\Application Data\TuxPaint\saved\</code>". </dd>
<dt>
<strong>macOS</strong>
</dt>
<dd>
Inside the user's "<code>Library</code>" folder, e.g.: "<code>/Users/<em>username</em>/Library/Application Support/Tux Paint/saved/</code>". </dd>
<dt>
<strong>Linux/Unix</strong>
</dt>
<dd>
Inside a hidden "<code>.tuxpaint</code>" directory, in the user's home directory ("<code>$HOME</code>"), e.g. "<code>/home/<em>username</em>/.tuxpaint/saved/</code>". </dd>
</dl>
<dt>
<cite>Windows Vista, Windows 8, Windows 10, Windows 11</cite>
</dt>
<dd>
In the user's "AppData" folder:<br> e.g., <nobr>"<code>C:\Users\username\AppData\Roaming\TuxPaint\saved\</code>"</nobr> </dd>
<dt>
<cite>macOS</cite>
</dt>
<dd>
In the user's "Application Support" folder:<br> e.g., <nobr>"<code>/Users/username/Library/Application Support/TuxPaint/saved/</code>"</nobr> </dd>
<dt>
<cite>Linux / Unix</cite>
</dt>
<dd>
In the user's "home directory" folder:<br> e.g., <nobr>"<code>/home/username/.tuxpaint/saved/</code>"</nobr> </dd>
<dt>
<cite>Haiku</cite>
</dt>
<dd>
In the user's "settings" folder:<br> e.g., <nobr>"<code>/boot/home/config/settings/TuxPaint/saved/</code>"</nobr> </dd>
</dl>
<p class="note">
<span title="Information">&#128161;</span> <strong>Note:</strong> It is also from this folder that you can copy or open pictures drawn in Tux Paint using <em>other</em> applications, though the 'Export' option from Tux Paint's 'Open' dialog can be used to copy them to a location that's easier and safer to access. </p>