Tweaks to w3m.sh to improve TXT version of docs

Make headers and description terms more apparent, by adding
some more regexps into the `sed` that the HTML is piped through
before being sent to `w3m`.
This commit is contained in:
Bill Kendrick 2024-10-14 17:08:31 -07:00
parent 3032afb85f
commit a62db7f9c2
1060 changed files with 10160 additions and 9743 deletions

View file

@ -28,7 +28,7 @@
Requirements
Simple DirectMedia Layer library (libSDL)
### Simple DirectMedia Layer library (libSDL) ###
Tux Paint requires the Simple DirectMedia Layer Library (libSDL), an Open
Source multimedia programming library available under the GNU Lesser General
@ -58,13 +58,13 @@ Debian's "apt").
development versions of the packages. (For example, install both
"SDL2-2.24.0.rpm" and "SDL2-devel-2.24.0.rpm".)
Other Libraries
## Other Libraries ##
Tux Paint also takes advantage of a number of other free, LGPL'd libraries.
Under Linux, just like SDL, they should either already be installed, or are
readily available for installation as part of your Linux distribution.
libPNG
libPNG
Tux Paint uses PNG (Portable Network Graphics) format for its data files.
SDL_image will require libPNG be installed.
@ -72,8 +72,8 @@ libPNG
http://www.libpng.org/pub/png/libpng.html
gettext
gettext
Tux Paint uses your system's locale settings along with the "gettext"
library to support various languages (e.g., Spanish). You'll need the
@ -82,8 +82,8 @@ gettext
http://www.gnu.org/software/gettext/
libpaper (Linux/Unix only)
libpaper (Linux/Unix only)
As of Tux Paint 0.9.17, Tux Paint can determine your system's default paper
size (e.g., A4 or Letter), or can be told to use a particular paper size,
@ -92,8 +92,8 @@ libpaper (Linux/Unix only)
https://github.com/naota/libpaper
FriBiDi
FriBiDi
Tux Paint's "Text" and also "Label" tools support bidirectional languages,
thanks to the "FriBiDi" library.
@ -101,31 +101,31 @@ FriBiDi
http://fribidi.org/
SVG graphics support
SVG graphics support
As of Tux Paint 0.9.17, Tux Paint can load SVG (Scalable Vector Graphics)
images as stamps. Two sets of libraries are supported, and SVG support can
be completely disabled (via "make SVG_LIB:=")
librsvg-2 & libCairo2 (newer libraries)
librsvg-2 & libCairo2 (newer libraries)
o libRSVG 2: http://librsvg.sourceforge.net/
o Cairo 2: http://www.cairographics.org/
o These also depend on the following:
# GdkPixbuf & GLib: http://www.gtk.org/
# Pango: http://www.pango.org/
Older SVG libraries
Older SVG libraries
o libcairo1, libsvg1, & libsvg-cairo1: http://www.cairographics.org/
o These also depend on the following:
# libxml2: https://gitlab.gnome.org/GNOME/libxml2
Animated GIF Export feature
→ Animated GIF Export feature ←
To support export of animated GIFs (slideshows), the "libimagequant"
library (from the "pngquant2" project) is required.
@ -133,8 +133,8 @@ Animated GIF Export feature
https://github.com/ImageOptim/libimagequant
NetPBM Tools (optional) No longer used, by default
NetPBM Tools (optional) No longer used, by default
📜 Under Linux and Unix, earlier versions of Tux Paint used the NetPBM tools
to assist with printing. (A PNG is generated by Tux Paint, and converted
@ -144,7 +144,7 @@ NetPBM Tools (optional) No longer used, by default
http://netpbm.sourceforge.net/
Compiling and Installation
@ -154,11 +154,11 @@ available freely.
-----------------------------------------------------------------------
Windows
### Windows ###
júlí 10, 2022 Shin-ichi TOYAMA <dolphin6k@wmail.plala.or.jp>
Compiling Set-Up
## Compiling Set-Up ##
As of February 2005 (starting with Tux Paint 0.9.15), the "Makefile" includes
support for building on a Windows system using MinGW/MSYS (https://
@ -168,7 +168,7 @@ Many tools and libraries are required to build Tux Paint. The package
management system "pacman" helps you install them automatically solving
complicated dependencies.
MYSYS2
# MYSYS2 #
Download the latest MSYS2 environment from https://www.msys2.org/ and install
it where you'd like (the default is "C:\msys64")
@ -196,7 +196,7 @@ environment.
-----------------------------------------------------------
MinGW 64bit (x86_64) compiler and tools
# MinGW 64bit (x86_64) compiler and tools #
Within the MSYS2 shell, run the following command to install 64bit compiler and
basic development tools:
@ -207,7 +207,7 @@ basic development tools:
Link Library (.dll) files they depends on. Tux Paint's packaging process for
binary distribution uses it to find required .dll files.
64bit (x86_64) dependency libraries for Tux Paint and Tux Paint Config
# 64bit (x86_64) dependency libraries for Tux Paint and Tux Paint Config #
You can install tools and libraries required for compiling Tux Paint and Tux
Paint Config on MSYS2/MINGW using "pacman" except for SDL2_Pango and
@ -221,7 +221,7 @@ installing it if you are only building "Tux Paint".
💡 Note: Close the shell before proceeding to the remaining process.
Install SDL2_Pango and libunibreak on the 64bit environment
# Install SDL2_Pango and libunibreak on the 64bit environment #
SDL2_Pango and libunibreak should be installed manually.
@ -253,7 +253,7 @@ ImageMagick" section if you need only a 64bit build environment.
-----------------------------------------------------------
MinGW 32bit (i686) compiler and tools
# MinGW 32bit (i686) compiler and tools #
Within the MSYS2 shell, run the following command to install 32bit compiler and
basic development tools:
@ -264,7 +264,7 @@ basic development tools:
Link Library (.dll) files they depends on. Tux Paint's packaging process for
binary distribution uses it to find required .dll files.
32bit (i686) dependency libraries for Tux Paint and Tux Paint Config
# 32bit (i686) dependency libraries for Tux Paint and Tux Paint Config #
You can install tools and libraries required for compiling Tux Paint and Tux
Paint Config on MSYS2/MINGW using "pacman" except for SDL2_Pango and
@ -278,7 +278,7 @@ installing it if you are only building "Tux Paint".
💡 Note: Close the shell before proceeding to the remaining process.
Install SDL2_Pango and libunibreak on the 32bit environment
# Install SDL2_Pango and libunibreak on the 32bit environment #
SDL2_Pango and libunibreak should be installed manually.
@ -305,7 +305,7 @@ You can fetch the source code from the git repositry and compile it as follows.
$ cd libunibreak
$ ./augogen.sh --prefix=/mingw32 && make && make install
ImageMagick
## ImageMagick ##
ImageMagick is a compilation of command line tools to create, edit, compose, or
convert bitmap images supporting quite a large number of image formats. Tux
@ -327,7 +327,7 @@ your "PATH" environment variable. For example:
You can make this permanent by adding the above to your the BASH shell
configuration file, "~/.bash_profile".
Tux Paint & Tux Paint Config.
## Tux Paint & Tux Paint Config. ##
You can compile 64-bit binaries using "MSYS2 64bit" shell, and 32-bit binaries
using "MSYS2 32bit" shell, respectively.
@ -337,7 +337,7 @@ using "MSYS2 32bit" shell, respectively.
* Select "MSYS2 64bit" → "MSYS2 MinGW 32-bit" from the "Start Menu" to open
the 32bit shell.
Tux Paint Config.
# Tux Paint Config. #
"Tux Paint Config" is a useful graphical tool for tweaking Tux Paint's
behavior. You have to build this component before compiling Tux Paint if you
@ -365,7 +365,7 @@ Now you can build Tux Paint Config. as follows:
$ cd tuxpaint-config
$ make win32
Tux Paint
# Tux Paint #
You can use either (a) a stable tar-ball release, or (b) the developing source
tree.
@ -393,7 +393,7 @@ collected in the directory for binary distribution "bdist" directory under
"win32". You can start them by double-clicking their executable (.exe) files in
the "bdist" directory.
Building the Tux Paint Windows Installer
## Building the Tux Paint Windows Installer ##
Inno Setup is used to build executable installer for Tux Paint. Therefore you
have to install it in the first place.
@ -415,7 +415,7 @@ Then, you can easily build an executable installer by right-clicking on the
list. It will run for a while, and eventually you will find a "tuxpaint-X.Y.Z
-windows-<arch>-installer.exe" file in the same directory.
Running the Tux Paint Windows Installer
## Running the Tux Paint Windows Installer ##
Double-click the Tux Paint installer executable (.EXE file) and follow the
instructions.
@ -433,7 +433,7 @@ location.
At this point, you can click 'Install' to install Tux Paint!
Changing the Settings Using the Shortcut
## Changing the Settings Using the Shortcut ##
To change program settings, right-click on the TuxPaint shortcut and select
'Properties' (at the bottom).
@ -460,7 +460,7 @@ pushed the "Apply" button!).
When you have finished, click "OK."
If Something Goes Wrong
## 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
@ -474,9 +474,9 @@ incorrect character-case (capital 'Z' instead of lowercase 'z') or a missing
-----------------------------------------------------------------------
Linux/Unix
### Linux/Unix ###
Compiling:
## Compiling: ##
💡 Note: Tux Paint does not use autoconf/automake, so there is no "./configure"
script to run. Compiling should be straight-forward though, assuming everything
@ -487,7 +487,8 @@ shell prompt (e.g., "$"):
$ make
Disabling SVG support (and hence Cairo, libSVG, and svg-cairo dependencies):
## Disabling SVG support (and hence Cairo, libSVG, and svg-cairo dependencies):
##
To disable SVG support (e.g., if your system is not currently supported by the
Cairo library or other SVG-related dependencies), you can run "make" with
@ -495,7 +496,7 @@ Cairo library or other SVG-related dependencies), you can run "make" with
$ make SVG_LIB= SVG_CFLAGS=
Disabling Sound at Compile-time
## Disabling Sound at Compile-time ##
If you don't have a sound card, or would prefer to build the program with no
sound support (and therefore without a the SDL_mixer dependency), you can run
@ -503,12 +504,12 @@ sound support (and therefore without a the SDL_mixer dependency), you can run
$ make SDL_MIXER_LIB=
Other options
## Other options ##
Various other options (e.g., installation paths) may be overridden; see them in
"Makefile" for further details.
If you get errors
## If you get errors ##
If you receive any errors during compile-time, make sure you have the
appropriate libraries installed (see above). If using packaged versions of the
@ -516,7 +517,7 @@ libraries (e.g., RPMs under RedHat or DEBs under Debian), be sure to get the
corresponding "-dev" or "-devel" packages as well, otherwise you won't be able
to compile Tux Paint (and other programs) from source!
Installng
## Installng ##
Assuming no fatal errors occured, you can now install the program so that it
can be run by users on the system. By default, this must be done by the "root"
@ -542,7 +543,7 @@ Ubuntu Linux):
local/bin/". The data files (images, sounds, etc.) are placed in "/usr/local/
share/tuxpaint/".
Changing Where Things Go
# Changing Where Things Go #
You can change where things will go by setting "Makefile"variables on the
command line. "DESTDIR" is used to place output in a staging area for package
@ -551,48 +552,48 @@ default, set to "/usr/local".
Other variables are:
BIN_PREFIX
BIN_PREFIX
Where the "tuxpaint" binary will be installed. (Set to "$(PREFIX)/bin" by
default - e.g., "/usr/local/bin")
DATA_PREFIX
DATA_PREFIX
Where the data files (sound, graphics, brushes, stamps, fonts) will go, and
where Tux Paint will look for them when it's run. (Set to "$(PREFIX)/share/
tuxpaint")
DOC_PREFIX
DOC_PREFIX
Where the documentation text files (the "docs" directory) will go. (Set to
"$(PREFIX)/share/doc/tuxpaint")
MAN_PREFIX
MAN_PREFIX
Where the manual page for Tux Paint will go. (Set to "$(PREFIX)/share/man")
ICON_PREFIX — $(PREFIX)/share/pixmaps
X11_ICON_PREFIX — $(PREFIX)/X11R6/include/X11/pixmaps
GNOME_PREFIX — $(PREFIX)/share/gnome/apps/Graphics
KDE_PREFIX — $(PREFIX)/share/applnk/Graphics
ICON_PREFIX — $(PREFIX)/share/pixmaps
X11_ICON_PREFIX — $(PREFIX)/X11R6/include/X11/pixmaps
GNOME_PREFIX — $(PREFIX)/share/gnome/apps/Graphics
KDE_PREFIX — $(PREFIX)/share/applnk/Graphics
Where the icons and launchers (for GNOME and KDE) will go.
LOCALE_PREFIX
LOCALE_PREFIX
Where the translation files for Tux Paint will go, and where Tux Paint will
look for them. (Set to "$(PREFIX)/share/locale/") (Final location of a
translation file will be under the locale's directory (e.g., "es" for
Spanish), within the "LC_MESSAGES" subdirectory.)
💡 Note: This list is out of date. See "Makefile" and "Makefile-i18n" for a
complete list.
-----------------------------------------------------------------------
macOS
### macOS ###
júní 5, 2022 Mark Kim <markuskimius@gmail.com>
Starting with Tux Paint 0.9.23, Tux Paint for macOS is built as though it were
a Linux application.
Prerequisites
## Prerequisites ##
Although Tux Paint is built without the Xcode IDE, Xcode itself is still
required to build Tux Paint. Download it from the App Store, and launch it once
@ -628,7 +629,7 @@ of Tux Paint.
^* Not available from MacPorts as of this writing, see below.
libimagequant
# libimagequant #
libimagequant is not available from MacPorts as of this writing. It can be
installed from the source code as follows. It should be installed to /opt/local
@ -640,7 +641,7 @@ installed from the source code as follows. It should be installed to /opt/local
$ cargo build --release # Must use cargo from MacPorts
$ sudo make PREFIX=/opt/local install
sdl2_pango
# sdl2_pango #
sdl2_pango is not available from MacPorts as of this writing. It can be
installed from the source code as follows. It should be installed to /opt/local
@ -654,7 +655,7 @@ WARNING: Having any UNIX-like toolset installed on your Mac besides MacPorts
and Xcode, such as Fink or Brew, will prevent your app bundle from being
portable. Be sure Fink and Brew are not accessible from your build environment.
How to Build
## How to Build ##
Simply, run:
@ -668,7 +669,7 @@ TuxPaint.dmg'.
Additional steps are required when building a Unviersal Binary. See "Building a
Universal Binary" below.
Known Issues
## Known Issues ##
* A macOS binary built on a specific version of macOS only runs on that
version of macOS or later. To ensure Tux Paint can run on the oldest
@ -685,7 +686,7 @@ Known Issues
(from MacPorts) need to be recompiled. See "Recompiling MacPorts" below for
the instructions.
Old Versions of macOS
## Old Versions of macOS ##
Some old versions of macOS can be downloaded from Apple's support page: https:/
/support.apple.com/en-us/HT211683
@ -725,7 +726,7 @@ the Xcode command line tools (do not run "xcode-select --install") but
otherwise build Tux Paint using the same steps described in the earlier part of
this document.
Recompiling MacPorts
## Recompiling MacPorts ##
To recompile MacPorts to be usable on older versions of macOS, set the
following options in /opt/local/etc/macports/macports.conf:
@ -749,7 +750,7 @@ they can only be built to run natively on the hardware on which they were
built. See "Building a Universal Binary" below for instructions on how to build
Tux Paint as a Universal Binary.
Building a Universal Binary
## Building a Universal Binary ##
To build Tux Paint as a Universal Binary, compile Tux Paint for the Intel CPU
and the Apple Silicon separately first. Then rename the app bundle for the
@ -763,7 +764,7 @@ two application bundles as below. The DMG file can be built afterwards:
-----------------------------------------------------------------------
Android
### Android ###
mars 29, 2023 Pere Pujal i Carabantes <perepujal@gmail.com> (Edited by Bill
Kendrick)
@ -772,7 +773,7 @@ As of March 2023, the Android build of Tux Paint is maintained in a separate
code repository at GitHub: https://github.com/tux4kids/Tuxpaint-Android.
Detailed instructions are there; this acts as an overview.
Prerequisites
## Prerequisites ##
You will need recent versions of:
@ -797,7 +798,7 @@ one another, and the script in the directory containing both.
Fill the app/src/main/assets directory by running cd app/src/main/jni/tuxpaint
&& ./mkzip_assets.sh
Building
## Building ##
The Gradle build generates some variants: PlayStore, debugPlayStore,
offPlayStore and debugoffPlayStore. You must sign the non-debug ones to be able
@ -826,36 +827,37 @@ the makebuildserver tool they provide, then, from the root of fdroiddata, run
-----------------------------------------------------------------------
Haiku
### Haiku ###
maí 7, 2023 Luc Schrijvers <begasus@gmail.com> (Edited by Bill Kendrick)
Prerequisites
## Prerequisites ##
Install the required develop packages in Terminal:
32-bit:
32-bit:
pkgman install xcairo_x86_devel fribidi_x86_devel gdk_pixbuf_x86_devel
libiconv_x86_devel libimagequant_x86_devel gettext_x86_libintl
libpaper_x86_devel pango_x86_devel libpng16_x86_devel librsvg_x86_devel
libsdl2_x86_devel sdl2_image_x86_devel sdl2_gfx_x86_devel
sdl2_mixer_x86_devel sdl2_pango_x86_devel sdl2_ttf_x86_devel zlib_x86_devel
64-bit:
64-bit:
pkgman install xcairo_devel fribidi_devel gdk_pixbuf_devel libiconv_devel
libimagequant_devel gettext_libintl libpaper_devel pango_devel
libpng16_devel librsvg_devel libsdl2_devel sdl2_image_devel sdl2_gfx_devel
sdl2_mixer_devel sdl2_pango_devel sdl2_ttf_devel zlib_devel
For 32-bit you need to switch to the new compiler (currently gcc 11.2.0) with
setarch x86
Building
## Building ##
make PREFIX=/boot/home/config/non-packaged
Tux Paint Stamps
## Tux Paint Stamps ##
make install-all DATA_PREFIX=/boot/home/config/non-packaged/share/tuxpaint/
@ -868,9 +870,9 @@ setting "DEBUG" (and, if verbose logging is wanted, "VERBOSE") #defines in "src
Uninstalling Tux Paint
Windows
### Windows ###
Using the Uninstaller
## Using the Uninstaller ##
If you installed the Start Menu shortcuts (the default), then go to the
TuxPaint folder and select "Uninstall". A box will be displayed that will
@ -879,19 +881,19 @@ you want to permanently remove Tux Paint, click on the 'Uninstall' button.
When it has finished, click on the close button.
Using the Control Panel
## Using the Control Panel ##
It is also possible to use the entry "TuxPaint (remove only)" in the Control
Panel Add/Remove programs section.
macOS
### macOS ###
Delete "TuxPaint.app" from the "/Applications" folder. Data files, including
the configuration files, stamps, and saved pictures, may be found in
"/Library/Application Support/TuxPaint/" (all users) and
"/Users/username/Library/Application Support/TuxPaint/" (individual users).
Linux
### Linux ###
Within the Tux Paint source directory (where you compiled Tux Paint), you can
use the "make uninstall" target to uninstall Tux Paint. By default, this must