782 lines
36 KiB
HTML
782 lines
36 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<html>
|
|
<head>
|
|
<title>
|
|
Tux Paint Installation 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.27<br/>
|
|
Installation Documentation </h1>
|
|
|
|
<p>
|
|
Copyright © 2002-2021 by various contributors; see AUTHORS.<br>
|
|
<a href="http://www.tuxpaint.org/">http://www.tuxpaint.org/</a>
|
|
</p>
|
|
|
|
<p>
|
|
August 31, 2021 </p>
|
|
</center>
|
|
|
|
<hr size="2" noshade />
|
|
|
|
<table border="2"
|
|
cellspacing="0"
|
|
cellpadding="2"
|
|
summary="Table of Contents">
|
|
<tr>
|
|
<th>
|
|
Table of Contents </th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>
|
|
<ul>
|
|
<li>
|
|
<a href="#requirements">Requirements</a>
|
|
<ul>
|
|
<li>
|
|
<a href="#req-libsdl">Simple DirectMedia Layer library (libSDL)</a>
|
|
</li>
|
|
<li>
|
|
<a href="#req-other-libs">Other Libraries</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<a href="#compiling">Compiling and Installation</a>
|
|
<ul>
|
|
<li>
|
|
<a href="#compiling-windows">Windows Users</a>
|
|
</li>
|
|
<li>
|
|
<a href="#compiling-linux">Linux/Unix Users</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<a href="#debugging">Debugging</a>
|
|
</li>
|
|
<li>
|
|
<a href="#uninstalling">Uninstalling Tux Paint</a>
|
|
<ul>
|
|
<li>
|
|
<a href="#uninstalling-windows">Windows</a>
|
|
</li>
|
|
<li>
|
|
<a href="#uninstalling-linux">Linux</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<hr size="2" noshade />
|
|
|
|
<h2>
|
|
<a name="requirements" id="requirements">
|
|
Requirements </a>
|
|
</h2>
|
|
<blockquote>
|
|
|
|
<h3>
|
|
<a name="req-libsdl" id="req-libsdl">
|
|
Simple DirectMedia Layer library (libSDL) </a>
|
|
</h3>
|
|
<blockquote>
|
|
<p>
|
|
Tux Paint requires the Simple DirectMedia Layer Library (libSDL), an Open Source multimedia programming library available under the GNU Lesser General Public License (LGPL). </p>
|
|
|
|
<p>
|
|
Along with libSDL, Tux Paint depends on a number of other SDL 'helper' libraries: SDL_Image (for graphics files), SDL_TTF and (optionally) SDL_Pango (for True Type Font support) and, optionally, SDL_Mixer (for sound effects). </p>
|
|
|
|
<h4>Linux/Unix Users:</h4>
|
|
<blockquote>
|
|
<p>
|
|
The SDL libraries are available as source-code, or as RPM or Debian packages for various distributions of Linux. They can be downloaded from: </p>
|
|
<ul>
|
|
<li>libSDL: <a href="http://www.libsdl.org/">http://www.libsdl.org/</a></li>
|
|
<li>SDL_Image: <a href="http://www.libsdl.org/projects/SDL_image/">http://www.libsdl.org/projects/SDL_image/</a></li>
|
|
<li>SDL_TTF: <a href="http://www.libsdl.org/projects/SDL_ttf/">http://www.libsdl.org/projects/SDL_ttf/</a></li>
|
|
<li>SDL_Pango: <a href="http://sourceforge.net/projects/sdlpango/">http://sourceforge.net/projects/sdlpango/</a> (optional)</li>
|
|
<li>SDL_Mixer: <a href="http://www.libsdl.org/projects/SDL_mixer/">http://www.libsdl.org/projects/SDL_mixer/</a> (optional)</li>
|
|
</ul>
|
|
|
|
<p>
|
|
They are also typically available along with your Linux distribution (e.g. on an installation media, or available via package maintainance software like Debian's "<code>apt</code>"). </p>
|
|
|
|
<p>
|
|
<b>Note:</b> When installing libraries from packages, be sure to ALSO install the development versions of the packages. (For example, install both "<code>SDL-1.2.4.rpm</code>" <em>and</em> "<code>SDL-1.2.4-devel.rpm</code>".) </p>
|
|
</blockquote>
|
|
</blockquote>
|
|
|
|
<h3>
|
|
<a name="req-other-libs" id="req-other-libs">
|
|
Other Libraries </a>
|
|
</h3>
|
|
<blockquote>
|
|
<p>
|
|
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. </p>
|
|
|
|
<h4>libPNG</h4>
|
|
<blockquote>
|
|
<p>
|
|
Tux Paint uses PNG (Portable Network Graphics) format for its data files. SDL_image will require libPNG be installed. </p>
|
|
|
|
<p>
|
|
<a href="http://www.libpng.org/pub/png/libpng.html">http://www.libpng.org/pub/png/libpng.html</a>
|
|
</p>
|
|
</blockquote>
|
|
|
|
<h4>gettext</h4>
|
|
<blockquote>
|
|
<p>
|
|
Tux Paint uses your system's locale settings along with the "gettext" library to support various languages (e.g., Spanish). You'll need the gettext library installed. </p>
|
|
|
|
<p>
|
|
<a href="http://www.gnu.org/software/gettext/">http://www.gnu.org/software/gettext/</a>
|
|
</p>
|
|
</blockquote>
|
|
|
|
<h4>libpaper (Linux/Unix only)</h4>
|
|
<blockquote>
|
|
<p>
|
|
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, thanks to "libpaper". </p>
|
|
|
|
<p>
|
|
<a href="https://github.com/naota/libpaper">https://github.com/naota/libpaper</a>
|
|
</p>
|
|
</blockquote>
|
|
|
|
<h4>FriBiDi</h4>
|
|
<blockquote>
|
|
<p>
|
|
Tux Paint's "Text" and also "Label" tools support bidirectional languages, thanks to the "FriBiDi" library. </p>
|
|
|
|
<p>
|
|
<a href="http://fribidi.org/">http://fribidi.org/</a>
|
|
</p>
|
|
</blockquote>
|
|
|
|
<h4>SVG graphics support</h4>
|
|
<blockquote>
|
|
<p>
|
|
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 "<code>make SVG_LIB:=</code>") </p>
|
|
|
|
<h5>librsvg-2 & libCairo2 (newer libraries)</h5>
|
|
<ul>
|
|
<li>libRSVG 2: <a href="http://librsvg.sourceforge.net/">http://librsvg.sourceforge.net/</a></li>
|
|
<li>Cairo 2: <a href="http://www.cairographics.org/">http://www.cairographics.org/</a></li>
|
|
<li>These also depend on the following: <ul>
|
|
<li>GdkPixbuf & GLib: <a href="http://www.gtk.org/">http://www.gtk.org/</a></li>
|
|
<li>Pango: <a href="http://www.pango.org/">http://www.pango.org/</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
|
|
<h5>Older SVG libraries</h5>
|
|
<ul>
|
|
<li>libcairo1, libsvg1, & libsvg-cairo1: <a href="http://www.cairographics.org/">http://www.cairographics.org/</a></li>
|
|
<li>These also depend on the following: <ul>
|
|
<li>libxml2: <a href="https://gitlab.gnome.org/GNOME/libxml2">https://gitlab.gnome.org/GNOME/libxml2</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</blockquote>
|
|
|
|
<h4>Animated GIF Export feature</h4>
|
|
<blockquote>
|
|
<p>
|
|
To support export of animated GIFs (slideshows), the "libimagequant" library (from the "pngquant2" project) is required. </p>
|
|
|
|
<p>
|
|
<a href="https://github.com/ImageOptim/libimagequant">https://github.com/ImageOptim/libimagequant</a>
|
|
</p>
|
|
</blockquote>
|
|
|
|
<h4>NetPBM Tools (optional) No longer used, by default</h4>
|
|
<blockquote>
|
|
<p>
|
|
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 into a PostScript using the '<code>pngtopnm</code>' and '<code>pnmtops</code>' NetPBM command-line tools.) </p>
|
|
|
|
<p>
|
|
<a href="http://netpbm.sourceforge.net/">http://netpbm.sourceforge.net/</a>
|
|
</p>
|
|
</blockquote>
|
|
</blockquote>
|
|
</blockquote>
|
|
|
|
<hr size="2" noshade />
|
|
|
|
<h2>
|
|
<a name="compiling" id="compiling">
|
|
Compiling and Installation </a>
|
|
</h2>
|
|
<blockquote>
|
|
<p>
|
|
Tux Paint is released under the GNU General Public License (GPL) (see "COPYING.txt" for details), and therefore the 'source code' to the program is available freely. </p>
|
|
|
|
<h3>
|
|
<a name="compiling-windows" id="compiling-windows">
|
|
Windows Users </a>
|
|
</h3>
|
|
<blockquote>
|
|
<h4>Compiling Set-Up</h4>
|
|
<blockquote>
|
|
<p>
|
|
As of February 2005 (starting with Tux Paint 0.9.15), the "<code>Makefile</code>" includes support for building on a Windows system using MinGW/MSYS (<a href="https://sourceforge.net/projects/msys2/">https://sourceforge.net/projects/msys2/</a>). </p>
|
|
|
|
<p>
|
|
Many tools and libraries are required to build Tux Paint. The package management system "<code>pacman</code>" helps you install them automatically solving complicated dependencies. </p>
|
|
|
|
<p>
|
|
Download the latest MSYS2 environment from <a href="https://sourceforge.net/projects/msys2/files/Base/">https://sourceforge.net/projects/msys2/files/Base/</a> and install it where you'd like (the default is "<a href="https://sourceforge.net/projects/msys2/files/Base/">https://sourceforge.net/projects/msys2/files/Base/</a>") </p>
|
|
<p>
|
|
Open the MSYS2 shell from the "Start Menu" -> "MSYS2 64bit" -> "MSYS2 MSYS" and execute following command (press <b><code>[Enter]</code></b> or <b><code>[Return]</code></b> to accept the defaults for all questions):
|
|
<blockquote>
|
|
<code>
|
|
pacman -Syu
|
|
</code>
|
|
</blockquote>
|
|
</p>
|
|
|
|
<p>
|
|
This will update core system and the window will close automatically. Repeat the steps above one more time to finish the remaining update process. </p>
|
|
|
|
<p>
|
|
Within the MSYS2 shell, run the following command to install basic development tools: <blockquote>
|
|
<code>
|
|
pacman -S base-devel msys2-devel git
|
|
</code>
|
|
</blockquote>
|
|
</p>
|
|
|
|
</blockquote>
|
|
|
|
<p>
|
|
<i>
|
|
Proceed to the next "<a href="#64bit">MinGW 64bit (x86_64) toolchains</a>" section, or skip to the "<a href="#32bit">MinGW 32bit (i686) toolchains</a>" section if you need only a 32bit build environment. </i>
|
|
</p>
|
|
|
|
<h4>
|
|
<a name="64bit" id="64bit">
|
|
MinGW 64bit (x86_64) toolchains </a>
|
|
</h4>
|
|
|
|
<blockquote>
|
|
<p>
|
|
Within the MSYS2 shell, run the following command to install basic 64bit development tools: <blockquote>
|
|
<code>
|
|
pacman -S mingw-w64-x86_64-toolchain
|
|
</code>
|
|
</blockquote>
|
|
</p>
|
|
|
|
</blockquote>
|
|
|
|
<h4>
|
|
64bit (x86_64) dependency libraries for Tux Paint </h4>
|
|
|
|
<blockquote>
|
|
<p>
|
|
You can install tools and libraries required for compiling Tux Paint on MSYS2/MINGW using "<code>pacman</code>" except for SDL_Pango. </p>
|
|
<p>
|
|
"<code>ntldd</code>" is a small tool which examine windows executable files to list Dynamic Link Library (<code>.dll</code>) files they depends on. Tux Paint's packaging process for binary distribution uses it to find required <code>.dll</code> files. </p>
|
|
<p>
|
|
FLTK is a cross-platform GUI toolkit used by "Tux Paint Config.". You can skip installing it if you are <em>only</em> building "Tux Paint". </p>
|
|
<p>
|
|
<blockquote>
|
|
<code>
|
|
$ pacman -S mingw-w64-x86_64-SDL_{image,mixer,ttf}<br/>
|
|
$ pacman -S mingw-w64-x86_64-librsvg<br/>
|
|
$ pacman -S mingw-w64-x86_64-fribidi<br/>
|
|
$ pacman -S mingw-w64-x86_64-libimagequant<br/>
|
|
$ pacman -S mingw-w64-x86_64-fltk<br/>
|
|
$ pacman -S mingw64/mingw-w64-x86_64-ntldd-git
|
|
</code>
|
|
</blockquote>
|
|
</p>
|
|
<p>
|
|
<strong>Note:</strong> Close the shell before proceeding to the remaining process. </p>
|
|
|
|
</blockquote>
|
|
|
|
<h4>
|
|
Install SDL_Pango and re-install SDL on the 64bit environment </h4>
|
|
|
|
<blockquote>
|
|
<p>
|
|
SDL_Pango should be installed manually. In addition, you have to re-install SDL from the source code or you will see unnecessary blank window opens when starting Tux Paint. </p>
|
|
<p>
|
|
This time, use the MinGW "64bit" shell. Open the shell from the "Start Menu" -> "MSYS2 64bit" -> "MSYS2 MinGW 64-bit" </p>
|
|
|
|
<h5>SDL_Pango</h5>
|
|
|
|
<blockquote>
|
|
|
|
<p>
|
|
At first, you have to prepare source tar-ball and a required patch in the same directory. </p>
|
|
<ul>
|
|
<li>
|
|
Download <a href="https://sourceforge.net/projects/sdlpango/files/SDL_Pango/0.1.2/SDL_Pango-0.1.2.tar.gz/download">source tar-ball of SDL_Pango-0.1.2</a> from <a href="https://sourceforge.net/projects/sdlpango/">SDL_Pango's page on Sourceforge.net</a>. </li>
|
|
<li>
|
|
Download <a href="http://johnnypops.co.uk/tuxpaint/SDL_Pango-configure-extra-api.patch">a patch file</a> from <a href="http://www.johnnypops.co.uk/tuxpaint/">John Popplewell's "Tux Paint - MinGW/MSYS build instructions" webpage</a>. (This adds some extra (required) functionality to SDL_Pango.) </li>
|
|
</ul>
|
|
<p>
|
|
Build and install SDL_Pango as follows. <blockquote>
|
|
<code>
|
|
$ tar zxvf SDL_Pango-0.1.2.tar.gz<br/>
|
|
$ cd SDL_Pango-0.1.2/<br/>
|
|
$ patch -p0 < ../SDL_Pango-configure-extra-api.patch<br/>
|
|
$ ./configure --prefix=/mingw64 && make && make install
|
|
</code>
|
|
</blockquote>
|
|
</p>
|
|
</blockquote>
|
|
|
|
<h5>SDL</h5>
|
|
<blockquote>
|
|
<p>
|
|
Download <a href="http://www.libsdl.org/release/SDL-1.2.15.tar.gz">source tar-ball of SDL_1.2.15</a> from <a href="http://www.libsdl.org/">libsdl.org</a>. </p>
|
|
<p>
|
|
Re-install SDL as follows. <blockquote>
|
|
<code>
|
|
$ tar zxvf SDL-1.2.15.tar.gz<br/>
|
|
$ cd SDL-1.2.15<br/>
|
|
$ ./configure --prefix=/mingw64 && make && make install
|
|
</code>
|
|
</blockquote>
|
|
</p>
|
|
</blockquote>
|
|
|
|
</blockquote>
|
|
|
|
<p>
|
|
<i>
|
|
Proceed to the next "<a href="#32bit">MinGW 32bit (i686) toolchains</a>" section, or skip to the "<a href="#imagemagick">ImageMagick</a>" section if you need only a 64bit build environment. </i>
|
|
</p>
|
|
<h4>
|
|
<a name="32bit" id="32bit">
|
|
MinGW 32bit (i686) toolchains </a>
|
|
</h4>
|
|
|
|
<blockquote>
|
|
<p>
|
|
Within the MSYS2 shell, run the following command to install basic 32bit development tools: <blockquote>
|
|
<code>
|
|
pacman -S mingw-w64-i686-toolchain
|
|
</code>
|
|
</blockquote>
|
|
</p>
|
|
|
|
</blockquote>
|
|
|
|
<h4>
|
|
32bit (i686) dependency libraries for Tux Paint </h4>
|
|
|
|
<blockquote>
|
|
<p>
|
|
You can install tools and libraries required for compiling Tux Paint on MSYS2/MINGW using "<code>pacman</code>" except for SDL_Pango. </p>
|
|
<p>
|
|
"<code>ntldd</code>" is a small tool which examine windows executable files to list Dynamic Link Library (<code>.dll</code>) files they depends on. Tux Paint's packaging process for binary distribution uses it to find required <code>.dll</code> files. </p>
|
|
<p>
|
|
FLTK is a cross-platform GUI toolkit used by "Tux Paint Config.". You can skip installing it if you are <em>only</em> building "Tux Paint". </p>
|
|
<p>
|
|
<blockquote>
|
|
<code>
|
|
$ pacman -S mingw-w64-i686-SDL_{image,mixer,ttf}<br/>
|
|
$ pacman -S mingw-w64-i686-librsvg<br/>
|
|
$ pacman -S mingw-w64-i686-fribidi<br/>
|
|
$ pacman -S mingw-w64-i686-libimagequant<br/>
|
|
$ pacman -S mingw-w64-i686-fltk<br/>
|
|
$ pacman -S mingw-w64-i686-ntldd-git
|
|
</code>
|
|
</blockquote>
|
|
</p>
|
|
<p>
|
|
<strong>Note:</strong> Close the shell before proceeding to the remaining process. </p>
|
|
|
|
</blockquote>
|
|
|
|
<h4>
|
|
Install SDL_Pango and re-install SDL on the 32bit environment </h4>
|
|
|
|
<blockquote>
|
|
<p>
|
|
SDL_Pango should be installed manually. In addition, you have to re-install SDL from the source code or you will see unnecessary blank window opens when starting Tux Paint. </p>
|
|
<p>
|
|
This time, use the MinGW "32bit" shell. Open the shell from the "Start Menu" -> "MSYS2 64bit" -> "MSYS2 MinGW 32-bit" </p>
|
|
|
|
<h5>SDL_Pango</h5>
|
|
|
|
<blockquote>
|
|
|
|
<p>
|
|
At first, you have to prepare source tar-ball and a required patch in the same directory. </p>
|
|
<ul>
|
|
<li>
|
|
Download <a href="https://sourceforge.net/projects/sdlpango/files/SDL_Pango/0.1.2/SDL_Pango-0.1.2.tar.gz/download">source tar-ball of SDL_Pango-0.1.2</a> from <a href="https://sourceforge.net/projects/sdlpango/">SDL_Pango's page on Sourceforge.net</a>. </li>
|
|
<li>
|
|
Download <a href="http://johnnypops.co.uk/tuxpaint/SDL_Pango-configure-extra-api.patch">a patch file</a> from <a href="http://www.johnnypops.co.uk/tuxpaint/">John Popplewell's "Tux Paint - MinGW/MSYS build instructions" webpage</a>. (This adds some extra (required) functionality to SDL_Pango.) </li>
|
|
</ul>
|
|
<p>
|
|
Build and install SDL_Pango as follows. <blockquote>
|
|
<code>
|
|
$ tar zxvf SDL_Pango-0.1.2.tar.gz<br/>
|
|
$ cd SDL_Pango-0.1.2/<br/>
|
|
$ patch -p0 < ../SDL_Pango-configure-extra-api.patch<br/>
|
|
$ ./configure --prefix=/mingw32 && make && make install
|
|
</code>
|
|
</blockquote>
|
|
</p>
|
|
</blockquote>
|
|
|
|
<h5>SDL</h5>
|
|
<blockquote>
|
|
<p>
|
|
Download <a href="http://www.libsdl.org/release/SDL-1.2.15.tar.gz">source tar-ball of SDL_1.2.15</a> from <a href="http://www.libsdl.org/">libsdl.org</a>. </p>
|
|
<p>
|
|
Re-install SDL as follows. <blockquote>
|
|
<code>
|
|
$ tar zxvf SDL-1.2.15.tar.gz<br/>
|
|
$ cd SDL-1.2.15<br/>
|
|
$ ./configure --prefix=/mingw32 && make && make install
|
|
</code>
|
|
</blockquote>
|
|
</p>
|
|
</blockquote>
|
|
|
|
</blockquote>
|
|
|
|
|
|
<h4>
|
|
<a name="imagemagick" id="imagemagick">ImageMagick</a>
|
|
</h4>
|
|
|
|
<blockquote>
|
|
<p>
|
|
<a href="https://imagemagick.org">ImageMagick</a> is a compilation of command line tools to create, edit, compose, or convert bitmap images supporting quite a large number of image formats. Tux Paint uses two functions ("convert" and "composite") in it to generate thumbnails for startar images and templates during the build process. </p>
|
|
<p>
|
|
Using official binary release available from "<a href="https://imagemagick.org/script/download.php#windowsand">Windows Binary Release</a>" is recommended, due to the commands installed with "<code>pacman</code>" on MinGW/MSYS not working as expected! </p>
|
|
<p>
|
|
Do not forget to enable "Install legacy utilities (e.g. convert)" while installing it, because Tux Paint's build process uses them. </p>
|
|
<p>
|
|
Add the path to the directory in which ImageMagick is installed at the top of your "PATH" environment variable. For example: <blockquote>
|
|
<code>
|
|
$ export PATH=/c/Program\ Files/ImageMagick-7.0.10-Q16-HDRI:$PATH
|
|
</code>
|
|
</blockquote>
|
|
</p>
|
|
<p>
|
|
You can make this permanent by adding the above to your the BASH shell configuration file, "<code>~/.bash_profile</code>". </p>
|
|
</blockquote>
|
|
|
|
<h4>Tux Paint</h4>
|
|
|
|
<blockquote>
|
|
<p>
|
|
You can compile 64bit binaries using MSYS2 64bit shell, and 32bit binaries using MSYS2 32bit shell, respectively. </p>
|
|
<ul>
|
|
<li>
|
|
Select "MSYS2 64bit" -> "MSYS2 MinGW 64-bit" from the "Start Menu" to open the 64bit shell. </li>
|
|
<li>
|
|
Select "MSYS2 64bit" -> "MSYS2 MinGW 32-bit" from the "Start Menu" to open the 32bit shell. </li>
|
|
</ul>
|
|
<p>
|
|
Compile Tux Paint with the following command: <blockquote>
|
|
<code>
|
|
$ make bdist-win32
|
|
</code>
|
|
</blockquote>
|
|
</p>
|
|
<p>
|
|
<strong>Note:</strong> At this point, you will want to build "Tux Paint Config." for Windows, so it can be included along with "Tux Paint", if you're making an official (or test) release. The build process will look for it in a directory named "<code>tuxpaint-config</code>" (with no version number, e.g., "<code>tuxpaint-config-X.Y.Z</code>"). See "Tux Paint Config."'s INSTALL.txt documentation for details. </p>
|
|
<p>
|
|
All the files needed for starting Tux Paint (and Tux Paint Config.) are collected in the directory for binary distribution "<code>bdist</code>" directory under "<code>win32</code>". You can start them by double-clicking their executable (<code>.exe</code>) files in the "<code>bdist</code>" directory. </p>
|
|
</blockquote>
|
|
|
|
<h4>Building the Tux Paint Windows Installer:</h4>
|
|
<blockquote>
|
|
|
|
<p>
|
|
<a href="https://jrsoftware.org/isinfo.php">Inno Setup</a> is used to build executable installer for Tux Paint. Therefore you have to install it in the first place. </p>
|
|
<p>
|
|
</p>
|
|
<p>
|
|
Then, you can easily build an executable installer by right-clicking on the "<code>tuxpaint.iss</code>" icon in the "<code>win32</code>" directory and selecting "Compile" on the list. It will run for a while, and eventually you will find a "<code>tuxpaint-<i>X.Y.Z</i>-win32-installer.exe</code>" file in the same directory. </p>
|
|
</blockquote>
|
|
|
|
<h4>Running the Tux Paint Windows Installer:</h4>
|
|
<blockquote>
|
|
<p>
|
|
Double-click the Tux Paint installer executable (.EXE file) and follow the instructions.
|
|
<p>
|
|
First, you will be asked to agree to the license. (It is the GNU General Public License (GPL), which is also available as "COPYING.txt".) </p>
|
|
|
|
<p>
|
|
You will then be asked whether you want to install shortcuts to Tux Paint in your Windows Start Menu and on your Windows Desktop. (Both options are set by default.) </p>
|
|
|
|
<p>
|
|
Then you will be asked where you wish to install Tux Paint. The default should be suitable, as long as there is space available. Otherwise, pick a different location. </p>
|
|
|
|
<p>
|
|
At this point, you can click 'Install' to install Tux Paint! </p>
|
|
</blockquote>
|
|
|
|
<h4>Changing the Settings Using the Shortcut:</h4>
|
|
<blockquote>
|
|
<p>
|
|
To change program settings, right-click on the TuxPaint shortcut and select 'Properties' (at the bottom). </p>
|
|
|
|
<p>
|
|
Make sure the 'Shortcut' tab is selected in the window that appears, and examine the 'Target:' field. You should see something like this: </p>
|
|
|
|
<blockquote>
|
|
<code>
|
|
"C:\Program Files\TuxPaint\TuxPaint.exe"
|
|
</code>
|
|
</blockquote>
|
|
|
|
<p>
|
|
You can now add command-line options which will be enabled when you double-click the icon. </p>
|
|
|
|
<p>
|
|
For example, to make the game run in fullscreen mode, with simple shapes (no rotation option) and in French, add the options (after 'TuxPaint.exe'), like so: </p>
|
|
|
|
<blockquote>
|
|
<code>
|
|
"C:\Program Files\TuxPaint\TuxPaint.exe" -f -s --lang french
|
|
</code>
|
|
</blockquote>
|
|
|
|
<p>
|
|
(See the main documentation for a full list of available command-line options.) </p>
|
|
|
|
<p>
|
|
If you make a mistake or it all disappears use <b><code>[Ctrl]</code></b> + <b><code>[Z]</code></b> to undo or just hit the <b><code>[Esc]</code></b> key and the box will close with no changes made (unless you pushed the "Apply" button!). </p>
|
|
|
|
<p>
|
|
When you have finished, click "OK." </p>
|
|
</blockquote>
|
|
|
|
<h4>If Something Goes Wrong:</h4>
|
|
<blockquote>
|
|
<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 like before, and look for a file called "<code>stderr.txt</code>" in the TuxPaint folder. </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>
|
|
</blockquote>
|
|
</blockquote>
|
|
|
|
<h3>
|
|
<a name="compiling-linux" id="compiling-linux">
|
|
Linux/Unix Users </a>
|
|
</h3>
|
|
<blockquote>
|
|
<h4>Compiling:</h4>
|
|
<blockquote>
|
|
<p>
|
|
Note: Tux Paint does not use <code>autoconf</code>/<code>automake</code>, so there is no "<code>./configure</code>" script to run. Compiling should be straight-forward though, assuming everything Tux Paint needs is installed. </p>
|
|
|
|
<p>
|
|
To compile the program from source, simply run the following command from a shell prompt (e.g., "$"): </p>
|
|
|
|
<blockquote>
|
|
<code>
|
|
$ make
|
|
</code>
|
|
</blockquote>
|
|
</blockquote>
|
|
|
|
<h4>
|
|
Disabling SVG support (and hence Cairo, libSVG, and svg-cairo dependencies): </h4>
|
|
<blockquote>
|
|
<p>
|
|
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 "<code>make</code>" with "<code>SVG_LIB= SVG_CFLAGS= NOSVGFLAG=NOSVG</code>" added:
|
|
<blockquote>
|
|
<code>
|
|
$ make SVG_LIB= SVG_CFLAGS=
|
|
</code>
|
|
</blockquote>
|
|
</blockquote>
|
|
|
|
<h4>
|
|
Disabling Pango support (and hence Pango, Cairo, etc. dependencies): </h4>
|
|
<blockquote>
|
|
<p>
|
|
Prior to version 0.9.18, Tux Paint used the <code>libSDL_ttf</code> library for rendering text using TrueType Fonts. Since 0.9.18, <code>libSDL_Pango</code> is used, as it has much greater support for internationalization. However, if you wish to disable the use of SDL_Pango, you may do so running "<code>make</code>" with "<code>SDL_PANGO_LIB=</code>" added: </p>
|
|
<blockquote>
|
|
<code>
|
|
$ make SDL_PANGO_LIB=
|
|
</code>
|
|
</blockquote>
|
|
</blockquote>
|
|
|
|
<h4>Disabling Sound at Compile-time:</h4>
|
|
<blockquote>
|
|
If you don't have a sound card, or would prefer to build the program with no sound support (and therefore without a the <code>SDL_mixer</code> dependency), you can run "<code>make</code>" with "<code>SDL_MIXER_LIB=</code>" added: </p>
|
|
<blockquote>
|
|
<code>
|
|
$ make SDL_MIXER_LIB=
|
|
</code>
|
|
</blockquote>
|
|
</blockquote>
|
|
|
|
<h4>Other options:</h4>
|
|
<blockquote>
|
|
<p>
|
|
Various other options (e.g., installation paths) may be overridden; see them in "<code>Makefile</code>" for further details. </p>
|
|
</blockquote>
|
|
|
|
<h4>If you get errors:</h4>
|
|
<blockquote>
|
|
<p>
|
|
If you receive any errors during compile-time, make sure you have the appropriate libraries installed (see above). If using packaged versions of the libraries (e.g., RPMs under RedHat or DEBs under Debian), be sure to get the corresponding "<code>-dev</code>" or "<code>-devel</code>" packages as well, otherwise you won't be able to compile Tux Paint (and other programs) from source! </p>
|
|
</blockquote>
|
|
|
|
<h4>Installng:</h4>
|
|
<blockquote>
|
|
<p>
|
|
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" user ('superuser'). Switch to "root" by typing the command: </p>
|
|
|
|
<blockquote>
|
|
<code>
|
|
$ su
|
|
</code>
|
|
</blockquote>
|
|
|
|
<p>
|
|
Enter "root"'s password at the prompt. You should now be "root" (with a prompt like "#"). To install the program and its data files, type: </p>
|
|
|
|
<blockquote>
|
|
<code>
|
|
# make install
|
|
</code>
|
|
</blockquote>
|
|
|
|
<p>
|
|
Finally, you can switch back to your regular user by exiting superuser mode: </p>
|
|
|
|
<blockquote>
|
|
<code>
|
|
# exit
|
|
</code>
|
|
</blockquote>
|
|
|
|
<p>
|
|
Alternatively, you may be able to simply use the "sudo" command (e.g., on Ubuntu Linux): </p>
|
|
|
|
<blockquote>
|
|
<code>
|
|
$ sudo make install
|
|
</code>
|
|
</blockquote>
|
|
|
|
<p>
|
|
<b>Note:</b> By default, "<code>tuxpaint</code>", the executable program, is placed in "<code>/usr/local/bin/</code>". The data files (images, sounds, etc.) are placed in "<code>/usr/local/share/tuxpaint/</code>". </p>
|
|
|
|
<h5>Changing Where Things Go</h5>
|
|
<blockquote>
|
|
<p>
|
|
You can change where things will go by setting "<code>Makefile</code>"variables on the command line. "<code>DESTDIR</code>" is used to place output in a staging area for package creation. "<code>PREFIX</code>" is the basis of where all other files go, and is, by default, set to "<code>/usr/local</code>". </p>
|
|
|
|
<p>
|
|
Other variables are: </p>
|
|
<dl>
|
|
<dt><code>BIN_PREFIX</code></dt>
|
|
<dd>
|
|
Where the "<code>tuxpaint</code>" binary will be installed. (Set to "<code>$(PREFIX)/bin</code>" by default - e.g., "<code>/usr/local/bin</code>") </dd>
|
|
|
|
<dt><code>DATA_PREFIX</code></dt>
|
|
<dd>
|
|
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 "<code>$(PREFIX)/share/tuxpaint</code>") </dd>
|
|
|
|
<dt><code>DOC_PREFIX</code></dt>
|
|
<dd>
|
|
Where the documentation text files (the "<code>docs</code>" directory) will go. (Set to "<code>$(PREFIX)/share/doc/tuxpaint</code>") </dd>
|
|
|
|
<dt><code>MAN_PREFIX</code></dt>
|
|
<dd>
|
|
Where the manual page for Tux Paint will go. (Set to "<code>$(PREFIX)/share/man</code>") </dd>
|
|
|
|
<dt><code>ICON_PREFIX</code> — <code>$(PREFIX)/share/pixmaps</code></dt>
|
|
<dt><code>X11_ICON_PREFIX</code> — <code>$(PREFIX)/X11R6/include/X11/pixmaps</code></dt>
|
|
<dt><code>GNOME_PREFIX</code> — <code>$(PREFIX)/share/gnome/apps/Graphics</code></dt>
|
|
<dt><code>KDE_PREFIX</code> — <code>$(PREFIX)/share/applnk/Graphics</code></dt>
|
|
<dd>
|
|
Where the icons and launchers (for GNOME and KDE) will go. </dd>
|
|
|
|
<dt><code>LOCALE_PREFIX</code></dt>
|
|
<dd>
|
|
Where the translation files for Tux Paint will go, and where Tux Paint will look for them. (Set to "<code>$(PREFIX)/share/locale/</code>") (Final location of a translation file will be under the locale's directory (e.g., "<code>es</code>" for Spanish), within the "<code>LC_MESSAGES</code>" subdirectory.) </dd>
|
|
</dl>
|
|
|
|
<p>
|
|
<b>Note:</b> This list is out of date. See "<code>Makefile</code>" and "<code>Makefile-i18n</code>" for a complete list. </p>
|
|
</blockquote>
|
|
</blockquote>
|
|
</blockquote>
|
|
</blockquote>
|
|
|
|
<hr size="2" noshade />
|
|
|
|
<h2>
|
|
<a name="debugging" id="debugging">
|
|
Debugging </a>
|
|
</h2>
|
|
<blockquote>
|
|
Debugging (to "STDOUT", e.g. to the terminal, or to a "<code>stdout.txt</code>" file, on Windows) can be enabled by setting "<code>DEBUG</code>" (and, if verbose logging is wanted, "<code>VERBOSE</code>") <code>#define</code>s in "<code>src/debug.h</code>". </blockquote>
|
|
|
|
<hr size="2" noshade />
|
|
|
|
<h2>
|
|
<a name="uninstalling" id="uninstalling">
|
|
Uninstalling Tux Paint </h2>
|
|
</h2>
|
|
<blockquote>
|
|
<h3>
|
|
<a name="uninstalling-windows" id="uninstalling-windows">
|
|
Windows </a>
|
|
</h3>
|
|
<blockquote>
|
|
<h4>Using the Uninstaller</h4>
|
|
<blockquote>
|
|
<p>
|
|
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 confirm that you are about to uninstall Tux Paint and, if you are certain that you want to permanently remove Tux Paint, click on the 'Uninstall' button. </p>
|
|
|
|
<p>
|
|
When it has finished, click on the close button. </p>
|
|
</blockquote>
|
|
|
|
<h4>Using the Control Panel</h4>
|
|
<blockquote>
|
|
<p>
|
|
It is also possible to use the entry "TuxPaint (remove only)" in the Control Panel Add/Remove programs section. </p>
|
|
</blockquote>
|
|
</blockquote>
|
|
|
|
<h3>
|
|
<a name="uninstalling-linux" id="uninstalling-linux">
|
|
Linux </a>
|
|
</h3>
|
|
<blockquote>
|
|
<p>
|
|
Within the Tux Paint source directory (where you compiled Tux Paint), you can use the "<code>make uninstall</code>" target to uninstall Tux Paint. By default, this must be done by the "root" user ('superuser'), but if you installed Tux Paint somewhere else (e.g., using a "<code>PREFIX=...</code>" setting to "<code>make</code>" and "<code>make install</code>"), you may not, and will want to provide those same settings here. (See the installation instructions above for further information.) </p>
|
|
</blockquote>
|
|
<blockquote>
|
|
</body>
|
|
</html>
|