Sync docs after stylizing Notes in OPTIONS

This commit is contained in:
Bill Kendrick 2022-03-31 01:24:25 -07:00
parent efd284f8c8
commit 799670ac24
10 changed files with 1088 additions and 1043 deletions

View file

@ -99,7 +99,7 @@ Video/Sound
Run the program in full screen mode, rather than in a window.
Note: If used in a system-wide configuration file, may be
Note: If used in a system-wide configuration file, may be
overridden by the user's configuration file using "fullscreen=no".
In both cases, may be overridden by the command-line option
"--windowed".
@ -132,7 +132,7 @@ Video/Sound
rotating the window on portait displays, such as a tablet PC
that's in tablet orientation.
Note: If used in a system-wide configuration file, may be
Note: If used in a system-wide configuration file, may be
overridden by the user's configuration file using
"orient=landscape". In both cases, may be overridden by the
command-line option "--orient=landscape".
@ -152,7 +152,7 @@ Video/Sound
"SDL_VIDEO_ALLOW_SCREENSAVER" environment variable on your system
to "1".)
Note: If used in a system-wide configuration file, may be
Note: If used in a system-wide configuration file, may be
overridden by the user's configuration file using
"allowscreensaver=no" or "disablescreensaver=yes". In both cases,
may be overridden by the command-line option
@ -165,7 +165,7 @@ Video/Sound
Disable sound effects. (Note: Pressing [Alt] + [S] cannot be used
to reenable sounds if they were disabled using this option.)
Note: If used in a system-wide configuration file, may be
Note: If used in a system-wide configuration file, may be
overridden by the user's configuration file using "nosound=no" or
"sound=yes". In both cases, may be overridden by the command-line
option "--sound".
@ -176,7 +176,7 @@ Video/Sound
impairment in one ear, or places where a single speaker or
headphone is being used.)
Note: If used in a system-wide configuration file, may be
Note: If used in a system-wide configuration file, may be
overridden by the user's configuration file using "nostereo=no" or
"stereo=yes". In both cases, may be overridden by the command-line
option "--stereo".
@ -194,8 +194,8 @@ Video/Sound
between 24 and 192, inclusive. Most buttons are square, and this
will affect their width and height.
Note: If the chosen button size would cause the buttons to be too
large for all required UI elements to appear under Tux Paint's
💡 Note: If the chosen button size would cause the buttons to be
too large for all required UI elements to appear under Tux Paint's
chosen window size, the largest possible button size will be used.
(A note will appear in stderr.)
@ -218,7 +218,7 @@ Mouse/Keyboard
In some enviornments, the fancy cursors cause problems. Use this
option to avoid them.
Note: If used in a system-wide configuration file, may be
Note: If used in a system-wide configuration file, may be
overridden by the user's configuration file using
"nofancycursors=no" or "fancycursors=yes". In both cases, may be
overridden by the command-line option "--fancycursors".
@ -229,7 +229,7 @@ Mouse/Keyboard
This is useful for touchscreen devices, such as tablet PCs.
Note: If used in a system-wide configuration file, may be
Note: If used in a system-wide configuration file, may be
overridden by the user's configuration file using "hidecursor=no"
or "showcursor=yes". In both cases, may be overridden by the
command-line option "--showcursor".
@ -244,7 +244,7 @@ Mouse/Keyboard
This is useful to prevent unwanted commands from being activated
by children who aren't experienced with keyboards.
Note: If used in a system-wide configuration file, may be
Note: If used in a system-wide configuration file, may be
overridden by the user's configuration file using "noshortcuts=no"
or "shortcuts=yes". In both cases, may be overridden by the
command-line option "--shortcuts".
@ -262,7 +262,7 @@ Mouse/Keyboard
[Ctrl]-[Escape], etc. This is especially useful in fullscreen
mode.
Note: If used in a system-wide configuration file, may be
Note: If used in a system-wide configuration file, may be
overridden by the user's configuration file using "grab=no" or
"dontgrab=yes". In both cases, may be overridden by the
command-line option "--dontgrab".
@ -272,7 +272,7 @@ Mouse/Keyboard
This disables support for the wheel on mice that have it.
(Normally, the wheel will scroll the selector menu on the right.)
Note: If used in a system-wide configuration file, may be
Note: If used in a system-wide configuration file, may be
overridden by the user's configuration file using
"nowheelmouse=no" or "wheelmouse=yes". In both cases, may be
overridden by the command-line option "--wheelmouse".
@ -289,7 +289,7 @@ Mouse/Keyboard
disabled (returning Tux Paint to its old behavior) by using this
option.
Note: If used in a system-wide configuration file, may be
Note: If used in a system-wide configuration file, may be
overridden by the user's configuration file using
"nobuttondistinction=no" or "buttondistinction=yes". In both
cases, may be overridden by the command-line option
@ -304,7 +304,7 @@ Simplification
Disable the rotation step of the 'Shape' tool. Click, drag and
release is all that will be needed to draw a shape.
Note: If used in a system-wide configuration file, may be
Note: If used in a system-wide configuration file, may be
overridden by the user's configuration file using
"simpleshapes=no" or "complexshapes=yes". In both cases, may be
overridden by the command-line option "--complexshapes".
@ -317,7 +317,7 @@ Simplification
This can help when Tux Paint is run on very slow computers, or
displayed on a remote X-Window display.
Note: If used in a system-wide configuration file, may be
Note: If used in a system-wide configuration file, may be
overridden by the user's configuration file using "nooutlines=no"
or "outlines=yes". In both cases, may be overridden by the
command-line option "--outlines".
@ -328,7 +328,7 @@ Simplification
"BRUSH"). Useful for children who can read, but who have only
learned uppercase letters so far.
Note: If used in a system-wide configuration file, may be
Note: If used in a system-wide configuration file, may be
overridden by the user's configuration file using "uppercase=no"
or "mixedcase=yes". In both cases, may be overridden by the
command-line option "--mixedcase".
@ -359,7 +359,7 @@ Simplification
You can also use the following keyboard combination to quit:
[Shift] + [Control] + [Escape].
Note: If used in a system-wide configuration file, may be
Note: If used in a system-wide configuration file, may be
overridden by the user's configuration file using "noquit=no" or
"quit=yes". In both cases, may be overridden by the command-line
option "--quit".
@ -373,7 +373,7 @@ Simplification
memory usage while it's running. Of course, no stamps will be
available at all.
Note: If used in a system-wide configuration file, may be
Note: If used in a system-wide configuration file, may be
overridden by the user's configuration file using "nostamps=no" or
"stamps=yes". In both cases, may be overridden by the command-line
option "--stamps".
@ -384,7 +384,7 @@ Simplification
have their size changed. This option disables the controls, and
only provides the basic stamps.
Note: If used in a system-wide configuration file, may be
Note: If used in a system-wide configuration file, may be
overridden by the user's configuration file using
"nostampcontrols=no" or "stampcontrols=yes". In both cases, may be
overridden by the command-line option "--stampcontrols".
@ -396,7 +396,7 @@ Simplification
controls, and only provides the default functionality (usually
paint-mode).
Note: If used in a system-wide configuration file, may be
Note: If used in a system-wide configuration file, may be
overridden by the user's configuration file using
"nomagiccontrols=no" or "magiccontrols=yes". In both cases, may be
overridden by the command-line option "--magiccontrols".
@ -407,7 +407,7 @@ Simplification
allow changing how shapes are drawn — centered around the initial
mouse click, or with a corner at the initial mouse click.
Note: If used in a system-wide configuration file, may be
Note: If used in a system-wide configuration file, may be
overridden by the user's configuration file using
"noshapecontrols=no" or "shapecontrols=yes". In both cases, may be
overridden by the command-line option "--shapecontrols".
@ -417,7 +417,7 @@ Simplification
Disables the Label tool: the tool that allows text entry which can
be edited later.
Note: If used in a system-wide configuration file, may be
Note: If used in a system-wide configuration file, may be
overridden by the user's configuration file using "nolabel=no" or
"label=yes". In both cases, may be overridden by the command-line
option "--label".
@ -427,11 +427,11 @@ Simplification
Disables the brush spacing option of the Paint and Lines tools.
The brushes' default spacings will be used.
Note: The brush spacing option was added to Tux Paint's user
📜 Note: The brush spacing option was added to Tux Paint's user
interface in version 0.9.28. For more information on brush
spacing, see EXTENDING.html
Note: If used in a system-wide configuration file, may be
Note: If used in a system-wide configuration file, may be
overridden by the user's configuration file using
"nobrushspacing=no" or "brushspacing=yes". In both cases, may be
overridden by the command-line option "--brushspacing".
@ -719,7 +719,7 @@ Languages
This can be useful for people who prefer things right-to-left,
rather than left-to-right.
Note: If used in a system-wide configuration file, may be
Note: If used in a system-wide configuration file, may be
overridden by the user's configuration file using
"mirrorstamps=no" or "dontmirrorstamps=yes". In both cases, may be
overridden by the command-line option "--dontmirrorstamps".
@ -732,7 +732,7 @@ Languages
the Text tool) from your operating system. Normally, Tux Paint
will only load the ones that came bundled with Tux Paint.
Note: If used in a system-wide configuration file, may be
Note: If used in a system-wide configuration file, may be
overridden by the user's configuration file using "sysfonts=no" or
"nosysfonts=yes". In both cases, may be overridden by the
command-line option "--nosysfonts".
@ -748,7 +748,7 @@ Languages
To load all locale-specific fonts (the old behavior), set this
option.
Note: If used in a system-wide configuration file, may be
Note: If used in a system-wide configuration file, may be
overridden by the user's configuration file using
"alllocalefonts=no" or "currentlocalefont=yes". In both cases, may
be overridden by the command-line option "--currentlocalefont".
@ -766,7 +766,7 @@ Printing
Restrict printing so that printing can occur only once every
SECONDS seconds.
Note: If used in a system-wide configuration file, may be
Note: If used in a system-wide configuration file, may be
overridden by the user's configuration file using "printdelay=0".
In both cases, may be overridden by the command-line option
"--printdelay=0".
@ -804,12 +804,14 @@ Printing
Push the [Alt] key while clicking the 'Print' button in Tux
Paint to cause a Windows print dialog window to appear.
(Note: This only works when not running Tux Paint in fullscreen
mode.) Any configuration changes made in this dialog will be
saved to the file "userdata/print.cfg" , and used again, as long
as the "printcfg" option is set.
Any configuration changes made in this dialog will be saved to
the file "userdata/print.cfg" , and used again, as long as the
"printcfg" option is set.
Note: If used in a system-wide configuration file, may be
💡 Note: This only works when not running Tux Paint in fullscreen
mode.
⚙ Note: If used in a system-wide configuration file, may be
overridden by the user's configuration file using "printcfg=no"
or "noprintcfg=yes". In both cases, may be overridden by the
command-line option "--noprintcfg".
@ -826,9 +828,9 @@ Printing
lpr
Note: Versions of Tux Paint prior to 0.9.15 sent PNG format data
to the print command (which defaulted to "pngtopnm | pnmtops |
lpr").
📜 Note: Versions of Tux Paint prior to 0.9.15 sent PNG format
data to the print command (which defaulted to "pngtopnm |
pnmtops | lpr").
If you set an alternative printcommand in the configuration file
prior to version 0.9.15, you will need to change it.
@ -896,7 +898,7 @@ Saving
starts up, rather than loading the last image that was being
edited.
Note: If used in a system-wide configuration file, may be
Note: If used in a system-wide configuration file, may be
overridden by the user's configuration file using
"startblank=no" or "startlast=yes". In both cases, may be
overridden by the command-line option "--startlast".
@ -906,7 +908,7 @@ Saving
Places the blank color options in the New dialog at the end, so
that any Starters and/or Templates are shown first.
Note: If used in a system-wide configuration file, may be
Note: If used in a system-wide configuration file, may be
overridden by the user's configuration file using
"newcolorslast=no" or "newcolorsfirst=yes". In both cases, may
be overridden by the command-line option "--newcolorsfirst".
@ -933,10 +935,10 @@ Saving
Example: /Users/Username/Library/Application
Support/TuxPaint/saved/
Note: When specifying a Windows drive (e.g., "H:\"), you must
💡 Note: When specifying a Windows drive (e.g., "H:\"), you must
also specify a subdirectory.
Note: Prior to version 0.9.18, Tux Paint would also use the
📜 Note: Prior to version 0.9.18, Tux Paint would also use the
setting or default for "savedir" as the place to search for
personal data files (brushes, stamps, starters and fonts). As of
version 0.9.18, they may be specified separately (see the
@ -969,10 +971,11 @@ Saving
[OK].
* macOS — TBD!
Note: When the defaults are used, a new "TuxPaint" subdirectory
will be created and used. (e.g., "~/Pictures/TuxPaint") When the
"--exportdir" option is used, the exact path specified will be
used (no "TuxPaint" subdirectory is created).
💡 Note: When the defaults are used, a new "TuxPaint"
subdirectory will be created and used. (e.g.,
"~/Pictures/TuxPaint") When the "--exportdir" option is used,
the exact path specified will be used (no "TuxPaint"
subdirectory is created).
The directory itself (e.g., "~/Pictures/TuxPaint") will be
created, if it doesn't exist.
@ -992,7 +995,7 @@ Saving
situations where the program is only being used for fun, or in a
test environment.
Note: If used in a system-wide configuration file, may be
Note: If used in a system-wide configuration file, may be
overridden by the user's configuration file using "nosave=no" or
"save=yes". In both cases, may be overridden by the command-line
option "--save".
@ -1002,7 +1005,7 @@ Saving
This prevents Tux Paint from asking whether you want to save the
current picture when quitting, and assumes you do.
Note: If used in a system-wide configuration file, may be
Note: If used in a system-wide configuration file, may be
overridden by the user's configuration file using "autosave=no"
or "noautosave=yes". In both cases, may be overridden by the
command-line option "--noautosave".
@ -1027,7 +1030,7 @@ Data
By default, the lockfile is stored in "~/.tuxpaint/" under Linux
and Unix, and "userdata\" under Windows.
Note: If used in a system-wide configuration file, may be
Note: If used in a system-wide configuration file, may be
overridden by the user's configuration file using
"nolockfile=no" or "lockfile=yes". In both cases, may be
overridden by the command-line option "--lockfile".
@ -1058,11 +1061,11 @@ Data
Example: /Users/Username/Library/Application
Support/TuxPaint/brushes/
Note: Prior to version 0.9.18, Tux Paint would use the same
📜 Note: Prior to version 0.9.18, Tux Paint would use the same
setting or default as for "savedir" to search for data files. As
of version 0.9.18, they may be specified separately.
Note: When specifying a Windows drive (e.g., "H:\"), you must
💡 Note: When specifying a Windows drive (e.g., "H:\"), you must
also specify a subdirectory.
Example: datadir=/home/johnny/tuxpaint-data/
@ -1135,17 +1138,19 @@ Accessibility
respectively
* To click-and-drag, hold one of the 'click' keys (e.g.,
[Insert]), and use the movement keys (e.g., [Left]).
* Note: The "mouse accessibility" feature works with the
keyboard mouse controls. With both options enabled,
painting tools can be used to draw by pressing a
'click' key to start clicking, movement keys to move
around (which will draw), and another 'click' key to
end the click (stop drawing).
💡 >Note: The "mouse accessibility" feature works with the
keyboard mouse controls. With both options enabled,
painting tools can be used to draw by pressing a 'click'
key to start clicking, movement keys to move around (which
will draw), and another 'click' key to end the click (stop
drawing).
* A regular mouse and/or joystick may still be used (so you
can, e.g., move with the mouse, and click with the
keyboard, or vice-versa)
Note: If used in a system-wide configuration file, may be
Note: If used in a system-wide configuration file, may be
overridden by the user's configuration file using "keyboard=no"
or "mouse=yes". In both cases, may be overridden by the
command-line option "--mouse".
@ -1172,7 +1177,7 @@ Accessibility
Note: Using this option implies automatically
onscreen-keyboard=yes, so setting both is redundant.
Note: If used in a system-wide configuration file, may be
Note: If used in a system-wide configuration file, may be
overridden by the user's configuration file using
"onscreen-keyboard-disable-change=no". In both cases, may be
overridden by the command-line option
@ -1794,7 +1799,7 @@ Available Languages
represented using a Latin character set, like the others. See the
"Special Fonts" section, below.
Note: Tux Paint provides an alternative input method for entering
💡 Note: Tux Paint provides an alternative input method for entering
characters with the Text tool in some locales. The key comibation(s)
listed can be used to cycle through the supported input methods while
the Text tool is active.
@ -1816,7 +1821,7 @@ Setting Your Environment's Locale
"/etc/locale.gen" on your system and then running the program
"locale-gen" as root.
Note: Debian users may be able to simply run the command
💡 Note: Debian users may be able to simply run the command
"dpkg-reconfigure locales" as root to bring up a configuration dialog.
Ubuntu users may be able to run "sudo dpkg-reconfigure localeconf" (the
"localeconf" package may need to be installed first), or you may need to
@ -1871,7 +1876,7 @@ Special Fonts
the Tux Paint download, and are available separately. (See the table
above, under the "Choosing a Different Language" section.)
Note: As of version 0.9.18, Tux Paint uses the "SDL_Pango" library,
📜 Note: As of version 0.9.18, Tux Paint uses the "SDL_Pango" library,
which utilizes the "Pango" library to render text in the user interface,
rather than using "SDL_ttf" directly. Unless your copy of Tux Paint was
built without Pango support, special fonts should no longer be