source: tuxpaint/trunk/fuentes/docs/INSTALL.txt @ 219

Last change on this file since 219 was 219, checked in by mabarracus, 4 years ago

added sources from trusty

File size: 14.0 KB
Line 
1INSTALL.txt for Tux Paint
2
3Tux Paint - A simple drawing program for children.
4
5Copyright 2002-2007 by Bill Kendrick and others
6bill@newbreedsoftware.com
7http://www.tuxpaint.org/
8
9June 27, 2002 - July 12, 2007
10$Id: INSTALL.txt,v 1.14 2009/07/01 21:58:37 wkendrick Exp $
11
12
13Requirements:
14-------------
15  Windows Users:
16  --------------
17    The Windows version of Tux Paint comes pre-packaged with the
18    necessary pre-compiled libraries (in ".DLL" form), so no extra
19    downloading is needed.
20   
21  libSDL
22  ------
23    Tux Paint requires the Simple DirectMedia Layer Library (libSDL),
24    an Open Source multimedia programming library available under the
25    GNU Lesser General Public License (LGPL).
26
27    Along with libSDL, Tux Paint depends on a number of other SDL 'helper'
28    libraries:  SDL_Image (for graphics files), SDL_TTF and (optionally)
29    SDL_Pango (for True Type Font support) and, optionally,
30    SDL_Mixer (for sound effects).
31
32    Linux/Unix Users:
33    -----------------
34      The SDL libraries are available as source-code, or as RPM or Debian
35      packages for various distributions of Linux.  They can be downloaded
36      from:
37
38        libSDL:      http://www.libsdl.org/
39        SDL_Image:   http://www.libsdl.org/projects/SDL_image/
40        SDL_TTF:     http://www.libsdl.org/projects/SDL_ttf/
41        SDL_Pango:   http://sourceforge.net/projects/sdlpango/   [OPTIONAL]
42        SDL_Mixer:   http://www.libsdl.org/projects/SDL_mixer/   [OPTIONAL]
43
44      They are also typically available along with your Linux distribution
45      (e.g. on an installation CD, or available via package maintainance
46      software like Debian's "apt-get").
47
48      NOTE: When installing from packages, be sure to ALSO install the
49      "-devel" versions of the packages.  (For example, install both
50      "SDL-1.2.4.rpm" AND "SDL-1.2.4-devel.rpm")
51
52  Other Libraries:
53  ----------------
54    Tux Paint also takes advantage of a number of other
55    free, LGPL'd libraries.  Under Linux, just like SDL, they should
56    either already be installed, or are readily available for installation
57    as part of your Linux distribution.
58   
59    libPNG
60    ------
61      Tux Paint uses PNG (Portable Network Graphics) format for its
62      data files.  SDL_image will require libPNG be installed.
63
64        http://www.libpng.org/pub/png/libpng.html
65
66    gettext
67    -------
68      Tux Paint uses your system's locale settings along with the
69      "gettext" library to support various languages (e.g., Spanish).
70      You'll need the gettext library installed.
71
72        http://www.gnu.org/software/gettext/
73
74    libpaper (Linux/Unix only)
75    --------------------------
76      As of Tux Paint 0.9.17, Tux Paint can determine your system's
77      default paper size (e.g., A4 or Letter), or can be told to use a
78      particular paper size, thanks to libpaper.
79
80        http://www.debian.org/
81
82    FriBiDi
83    -------
84      As of Tux Paint 0.9.21, Tux Paint's "Text" tool supports bidirectional
85      languages, thanks to the FriBiDi library:
86
87        http://fribidi.org/
88
89    SVG graphics support
90    --------------------
91      As of Tux Paint 0.9.17, Tux Paint can load SVG
92      (Scalable Vector Graphics) images as stamps.
93      Two sets of libraries are supported, and SVG support can be
94      completely disabled (via "make SVG_LIB:=")
95
96      librsvg-2, libCairo2  [newer libraries]
97      --------------------------------------------------------------
98        libRSVG 2
99          http://librsvg.sourceforge.net/
100
101        Cairo 2
102          http://www.cairographics.org/
103
104        Also depends on:
105          GdkPixbuf
106          GLib
107            http://www.gtk.org/
108
109          Pango
110            http://www.pango.org/
111
112      Older libraries
113      -------------------------------
114        libcairo1
115        libsvg1
116        libsvg-cairo1
117          http://www.cairographics.org/
118
119        Also depends on:
120          libxml2
121
122    NetPBM Tools  [OPTIONAL]  [No longer used, by default]
123    ------------------------
124      Under Linux and Unix, the NetPBM tools are what are currently
125      used for printing.  (A PNG is generated by TuxPaint, and converted
126      into a PostScript using the 'pngtopnm' and 'pnmtops' NetPBM command-line
127      tools.)
128
129        http://netpbm.sourceforge.net/
130       
131
132Compiling and Installation:
133---------------------------
134  Tux Paint is released under the GNU General Public License (GPL)
135  (see "COPYING.txt" for details), and therefore the 'source code' to
136  the program is included.
137
138  Windows Users:
139  --------------
140    Compiling:
141    ----------
142      Tux Paint comes pre-compiled for Windows, so no compilation is
143      necessary.
144     
145      As of February 2005 (starting with Tux Paint 0.9.15), the Makefile
146      includes support for building on a Windows system using MinGW/MSYS.
147      ( http://www.mingw.org/ )
148     
149      After configuring the environment and building and installing all the
150      dependencies, use these commands, in MSYS, to build, install and run:
151
152      Prior to version 0.9.20:
153
154        $ make win32
155        $ make install-win32
156        $ tuxpaint
157
158      Version 0.9.20 and beyond:
159
160        $ make
161        $ make install
162        $ tuxpaint
163
164      Use the following command to build a version suitable for
165      redistribution with the installer or in a zip-file:
166
167        $ make bdist-win32
168
169      Or if building for Win9x/ME:
170
171        $ BDIST_WIN9X=1 make bdist-win32
172
173      Before any of the above will work, you need to configure the
174      environment and build or install the libraries that Tux Paint depends
175      upon.  John Popplewell put together some instructions for doing that
176      here:
177
178        http://johnnypops.demon.co.uk/mingw/index.html
179     
180      Read the relevant notes if building for Win9X/ME.
181
182    Installer:
183    ----------
184      Double-click the Tux Paint installer executable (.EXE file) and
185      follow the instructions.
186
187      First, you will be asked to agree to the license.
188      (It is the GNU General Public License (GPL), which is also
189      available as "COPYING.txt".)
190
191      You will then be asked whether you want to install shortcuts
192      to Tux Paint in your Windows Start Menu and on your Windows Desktop.
193      (Both options are set by default.)
194
195      Then you will be asked where you wish to install Tux Paint.
196      The default should be suitable, as long as there is space available.
197      Otherwise, pick a different location.
198
199      At this point, you can click 'Install' to install Tux Paint!
200
201    Changing the Settings Using the Shortcut:
202    -----------------------------------------
203      To change program settings, right-click on the TuxPaint shortcut
204      and select 'Properties' (at the bottom).
205       
206      Make sure the 'Shortcut' tab is selected in the window that
207      appears, and examine the 'Target:' field.  You should see
208      something like this :
209
210        "C:\Program Files\TuxPaint\TuxPaint.exe"
211
212      You can now add command-line options which will be enabled when
213      you double-click the icon.
214       
215      For example, to make the game run in fullscreen mode,
216      with simple shapes (no rotation option) and in French,
217      add the options (after 'TuxPaint.exe'), like so:
218
219        "C:\Program Files\TuxPaint\TuxPaint.exe" -f -s --lang french
220
221      (See "README.txt" for a full list of available command-line options.)
222       
223      If you make a mistake or it all disappears use Ctrl-Z to undo or
224      just hit the [ESC] key and the box will close with no changes made
225      (unless you pushed the "Apply" button!).
226       
227      When you have finished, click "OK."
228
229    If Something Goes Wrong
230    -----------------------
231      If, when you double-click on the shortcut to run the game,
232      nothing happens, it is probably because some of these command-line
233      options are wrong. Open an Explorer like before, and look for a file
234      called 'stderr.txt' in the TuxPaint folder.
235       
236      It will contain a description of what was wrong. Usually it will
237      just be due to incorrect character-case (capital 'Z' instead
238      of lowercase 'z') or a missing (or extra) '-' (dash).
239 
240 
241  Linux/Unix Users:
242  -----------------
243    Compiling:
244    ----------
245      Note: Currently, Tux Paint does not use autoconf/automake, so there
246      is no "./configure" script to run.  (Sorry!)  Compiling should be
247      straight-forward though, assuming everything Tux Paint needs is installed.
248
249      To compile the program from source, simply run the following command
250      from a shell prompt (e.g., "$"):
251
252        $ make
253
254    Disabling SVG support (and hence Cairo, libSVG and svg-cairo dependencies):
255    ---------------------------------------------------------------------------
256      To disable SVG support (e.g., if your system is not currently supported
257      by the Cairo library or other SVG-related dependencies), you can
258      run "make" with "SVG_LIB= SVG_CFLAGS= NOSVGFLAG=NOSVG" added:
259
260        $ make SVG_LIB= SVG_CFLAGS=
261
262    Disabling Pango support (and hence Pango, Cairo, etc. dependencies):
263    --------------------------------------------------------------------
264      Prior to version 0.9.18, Tux Paint used the libSDL_ttf library for
265      rendering text using TrueType Fonts.  Since 0.9.18, libSDL_Pango is
266      used, as it has much greater support for internationalization.
267      However, if you wish to disable the use of SDL_Pango, you may do so
268      running "make" with "SDL_PANGO_LIB=" added:
269
270        $ make SDL_PANGO_LIB=
271
272    Disabling Sound at Compile-time:
273    --------------------------------
274      If you don't have a sound card, or would prefer to build the program
275      with no sound support (and therefore without a the SDL_mixer dependency),
276      you can run "make" with "SDL_MIXER_LIB=" added:
277
278        $ make SDL_MIXER_LIB=
279
280    If you get errors:
281    ------------------
282      If you receive any errors during compile-time, make sure you have
283      the appropriate libraries installed (see above).  If using packaged
284      versions of the libraries (e.g., RPMs under RedHat or DEBs under Debian),
285      be sure to get the corresponding "-dev" or "-devel" packages as well,
286      otherwise you won't be able to compile Tux Paint (and other programs)
287      from source!
288
289
290    Installing:
291    -----------
292      Assuming no fatal errors occured, you can now install the program
293      so that it can be run by users on the system.  By default, this must
294      be done by the "root" user ('superuser').  Switch to "root" by
295      typing the command:
296
297        $ su
298
299      Enter "root"'s password at the prompt.  You should now be "root"
300      (with a prompt like "#").  To install the program and its
301      data files, type:
302
303        # make install
304
305      Finally, you can switch back to your regular user by exiting
306      superuser mode:
307
308        # exit
309
310
311      Alternatively, you may be able to simply use the "sudo" command
312      (e.g., on Ubuntu Linux):
313
314        $ sudo make install
315
316
317      NOTE: By default, "tuxpaint", the executable program, is
318      placed in "/usr/local/bin/".  The data files (images, sounds, etc.)
319      are placed in "/usr/local/share/tuxpaint/".
320
321
322      Changing Where Things Go
323      ------------------------
324        You can change where things will go by setting Makefile variables
325        on the command line.  DESTDIR is used to place output in a staging
326        area for package creation. "PREFIX" is the basis of where all other
327        files go, and is, by default, set to "/usr/local".
328
329        Other variables are:
330          BIN_PREFIX
331            Where the "tuxpaint" binary will be installed.
332            (Set to "$(PREFIX)/bin" by default - e.g., "/usr/local/bin")
333         
334          DATA_PREFIX
335            Where the data files (sound, graphics, brushes, stamps, fonts)
336            will go, and where Tux Paint will look for them when it's run.
337            (Set to "$(PREFIX)/share/tuxpaint")
338       
339          DOC_PREFIX
340            Where the documentation text files (the "docs" directory) will go.
341            (Set to "$(PREFIX)/share/doc/tuxpaint")
342       
343          MAN_PREFIX
344            Where the manual page for Tux Paint will go.
345            (Set to "$(PREFIX)/share/man")
346       
347          ICON_PREFIX                      $(PREFIX)/share/pixmaps
348          X11_ICON_PREFIX                  $(PREFIX)/X11R6/include/X11/pixmaps
349          GNOME_PREFIX                     $(PREFIX)/share/gnome/apps/Graphics
350          KDE_PREFIX                       $(PREFIX)/share/applnk/Graphics
351            Where the icons and launchers (for GNOME and KDE) will go.
352       
353          LOCALE_PREFIX
354            Where the translation files for Tux Paint will go, and where
355            Tux Paint will look for them.
356            (Set to "$(PREFIX)/share/locale/")
357            (Final location of a translation file will be
358            under the locale's directory (e.g., "es" for Spanish),
359            within the "LC_MESSAGES" subdirectory.)
360
361        FIXME: This list is out of date.  See Makefile and Makefile-i18n for
362        a complete list.
363       
364       
365Uninstalling Tux Paint:
366-----------------------
367  Windows
368  -------
369    Using the Uninstaller
370    ---------------------
371      If you installed the Start Menu shortcuts (the default), then go to the
372      TuxPaint folder and select "Uninstall". A box will be displayed that will
373      confirm that you are about to uninstall Tux Paint and, if you are certain
374      that you want to permanently remove Tux Paint, click on the 'Uninstall'
375      button.
376
377      When it has finished, click on the close button.
378
379      It is also possible to use the entry "TuxPaint (remove only)" in the
380      Control Panel Add/Remove programs section.
381
382      NOTE: because the pictures that are created are saved inside the Tux Paint
383      folder, this folder and the 'userdata' folder inside it are NOT removed.
384
385
386  Linux
387  -----
388    Within the Tux Paint source directory (where you compiled Tux Paint),
389    you can use a 'Makefile' target to uninstall Tux Paint.
390    By default, this must be done by the "root" user ('superuser').
391    (See the installation instructions above for further information.)
392
393    Switch to "root" by typing the command:
394
395      $ su
396
397    Enter "root"'s password at the prompt.  You should now be "root"
398    (with a prompt like "#").  To uninstall the program and its data files
399    (the default rubber-stamp images, if any, will also be removed), type:
400
401      # make uninstall
402
403    Finally, you can switch back to your regular user by exiting
404    superuser mode:
405
406      # exit
407
Note: See TracBrowser for help on using the repository browser.