From 72019b15d1450701900768bd4aacab36b439f185 Mon Sep 17 00:00:00 2001 From: Bill Kendrick Date: Fri, 5 Feb 2021 00:40:17 -0800 Subject: [PATCH] Pulling in initial English from tuxpaint-docs Documentation is now maintained in a separate source repository, 'tuxpaint-docs', which allows for easier and more consisten translation of the documentation. Pulling in initial version of these docs, which contain a variety of minor updates (and also a few which had previously only been available as plain TXT are now available as HTML). Pulling in the English stuff. --- docs/CHANGES.txt | 12 +- docs/en/ADVANCED-STAMPS-HOWTO.txt | 70 +- docs/en/EXTENDING.txt | 432 ++--- docs/en/FAQ.txt | 254 ++- docs/en/INSTALL.txt | 555 +++--- docs/en/OPTIONS.txt | 190 +- docs/en/PNG.txt | 173 +- docs/en/README.txt | 574 ++++--- docs/en/SIGNALS.txt | 77 +- docs/en/SVG.txt | 59 +- docs/en/html/ADVANCED-STAMPS-HOWTO.html | 410 +---- docs/en/html/EXTENDING.html | 1237 +++---------- docs/en/html/FAQ.html | 917 +++------- docs/en/html/INSTALL.html | 458 +++++ docs/en/html/OPTIONS.html | 2097 ++++++++--------------- docs/en/html/PNG.html | 117 ++ docs/en/html/README.html | 1362 ++++----------- docs/en/html/SIGNALS.html | 75 + docs/en/html/SVG.html | 63 + 19 files changed, 3322 insertions(+), 5810 deletions(-) create mode 100644 docs/en/html/INSTALL.html create mode 100644 docs/en/html/PNG.html create mode 100644 docs/en/html/SIGNALS.html create mode 100644 docs/en/html/SVG.html diff --git a/docs/CHANGES.txt b/docs/CHANGES.txt index 626b2079c..175ea64b8 100644 --- a/docs/CHANGES.txt +++ b/docs/CHANGES.txt @@ -8,7 +8,7 @@ http://www.tuxpaint.org/ $Id$ -2021.January.18 (0.9.26) +2021.February.5 (0.9.26) * New Features ------------ * [WIP] Larger UI buttons @@ -24,10 +24,14 @@ $Id$ * Documentation updates --------------------- - * Expanded the steps for making and posting releases. + * Documentation is now maintained in a separate source repository, + 'tuxpaint-docs', which allows for easier and more consisten + translation of the documentation. Pulling in initial version of + these docs, which contain a variety of minor updates (and also a + few which had previously only been available as plain TXT are now + available as HTML). - * Mended some broken relative links in README.html that - pointed to other parts of the docs. + * Expanded the steps for making and posting releases. * Documented how to build Tux Paint using old macOS Mark K. Kim diff --git a/docs/en/ADVANCED-STAMPS-HOWTO.txt b/docs/en/ADVANCED-STAMPS-HOWTO.txt index d7ae8a4a2..8815c5e5f 100644 --- a/docs/en/ADVANCED-STAMPS-HOWTO.txt +++ b/docs/en/ADVANCED-STAMPS-HOWTO.txt @@ -1,24 +1,22 @@ Tux Paint - version 0.9.26 - Advanced Stamps HOWTO + version 0.9.26 Advanced Stamps 'How-To' - Copyright 2006-2008 by Albert Cahalan for the Tux Paint project - New Breed Software - - albert@users.sf.net + Copyright © 2006-2021 by Albert Cahalan and others; see AUTHORS. http://www.tuxpaint.org/ -About this HOWTO +About this 'How-To' - This HOWTO assumes that you want to make an excellent Tux Paint stamp, - in PNG bitmapped format, from a JPEG image (e.g., a digital photograph). - There are easier and faster methods that produce lower quality. + This 'How-To' assumes that you want to make an excellent Tux Paint + stamp, in PNG bitmapped format, from a JPEG image (e.g., a digital + photograph). There are easier and faster methods that produce lower + quality. - This HOWTO assumes you are dealing with normal opaque objects. Dealing - with semi-transparent objects (fire, moving fan blade, kid's baloon) or - light-giving objects (fire, lightbulb, sun) is best done with custom - software. Images with perfect solid-color backgrounds are also best done - with custom software, but are not troublesome to do as follows. + This 'How-To' assumes you are dealing with normal opaque objects. + Dealing with semi-transparent objects (fire, moving fan blade, kid's + balloon) or light-giving objects (fire, lightbulb, sun) is best done + with custom software. Images with perfect solid-color backgrounds are + also best done with custom software, but are not troublesome to do as + follows. Image choice is crucial @@ -36,13 +34,14 @@ Image choice is crucial suitable images. (Note: the *.mil sites include non-military content, too!) - Your own images can be placed in the Public Domain by declaring it so. - (Hire a lawyer if you feel the need for legal advice.) + Your own images can be placed in the Public Domain or a suitable + license, such as the Creative Commons CC0 by declaring it so. (Hire a + lawyer if you feel the need for legal advice.) For personal use, any image you can legitimately modify and use for your own personal use should be fine. - Image Size and Orientation: + Image Size and Orientation You need an image that has a useful orientation. Perspective is an enemy. Images that show an object from the corner are difficult to fit @@ -67,12 +66,11 @@ Image choice is crucial will need to draw new ones. If only one is buried, you might be able to copy the other one as a replacement. -Prepare the image: +Prepare the image First of all, be sure to avoid re-saving the image as a JPEG. This causes quality loss. There is a special tool called jpegtran that lets - you crop an image without the normal quality loss. If you want a GUI for - it, use ljcrop. Otherwise, use it like this: + you crop an image without the normal quality loss. jpegtran -trim -copy none -crop 512x1728+160+128 < src.jpg > cropped.jpg @@ -90,27 +88,27 @@ Prepare the image: top to bottom you will need something like this: 1. unmodified image (write-protect this if you can) - 2. an image you will modify — the "WIP" layer + 2. an image you will modify — the "work in progress" layer 3. solid green (write-protect this if you can) 4. solid magenta (write-protect this if you can) 5. unmodified image (write-protect this if you can) - Give the WIP layer a rough initial mask. You might start with a - selection, or by using the grayscale value of the WIP layer. You might - invert the mask. + Give the work in progress (WIP) layer a rough initial mask. You might + start with a selection, or by using the grayscale value of the WIP + layer. You might invert the mask. Warning: once you have the mask, you may not rotate or scale the image normally. This would cause data loss. You will be given special scaling instructions later. -Prepare the mask: +Prepare the mask - Get used to doing Ctrl-click and Alt-click on the thumbnail images in - the layers dialog. You will need this to control what you are looking at - and what you are editing. Sometimes you will be editing things you can't - see. For example, you might edit the mask of the WIP layer while looking - at the unmodified image. Pay attention so you don't screw up. Always - verify that you are editing the right thing. + Get used to doing [Ctrl]-click and [Alt]-click on the thumbnail images + in the layers dialog. You will need this to control what you are looking + at and what you are editing. Sometimes you will be editing things you + can't see. For example, you might edit the mask of the WIP layer while + looking at the unmodified image. Pay attention so you don't screw up. + Always verify that you are editing the right thing. Set an unmodified image as what you will view (the top one is easiest). Set the WIP mask as what you will edit. At some point, perhaps not @@ -163,7 +161,7 @@ Prepare the mask: expected color. Invert the selection, then paint these away using the pencil tool. Do this operation for both white and black. -Replace the fringe and junk pixels: +Replace the fringe and junk pixels Still viewing the mask, select by color. Choose black. Shrink the selection by several pixels, being sure to NOT shrink from the edges of @@ -187,7 +185,7 @@ Replace the fringe and junk pixels: * composited over magenta (mask enabled) * original (the top or bottom layer) * composited over the original (mask enabled) - * raw WIP layer (mask DISABLED) + * raw WIP layer (mask disabled) To reduce accidents, you may wish to select only those pixels that are not grey in the mask. (Select by color from the mask, choose black, add @@ -236,7 +234,7 @@ Save the image for Tux Paint almost certain to destroy all the 0% opaque areas. So here is a better way... - A Safer Way to Save: + A Safer Way to Save Drag the mask from the layers dialog to the unused portion of the toolbar (right after the last drawing tool). This will create a new @@ -260,7 +258,7 @@ Save the image for Tux Paint painted-away surroundings, without any mask thumbnail in the layers dialog. If you scaled the mask, then scale this image in exactly the same way. Save this image as a NetPBM portable pixmap (".ppm") file. - (Note: ppm, not pgm.) (If you choose the RAW PPM format, the second + (Note: .ppm, not .pgm.) (If you choose the RAW PPM format, the second byte of the file should be the ASCII digit "6", hex byte 0x36.) Now you need to merge the two files into one. Do that with the diff --git a/docs/en/EXTENDING.txt b/docs/en/EXTENDING.txt index cd30d7aac..2c28b102e 100644 --- a/docs/en/EXTENDING.txt +++ b/docs/en/EXTENDING.txt @@ -2,10 +2,10 @@ Tux Paint version 0.9.26 - Copyright (c) 2002-2020 by various contributors; see AUTHORS.txt + Copyright © 2002-2021 by various contributors; see AUTHORS. http://www.tuxpaint.org/ - June 14, 2002 - December 27, 2020 + 30 January 2021 ---------------------------------------------------------------------- @@ -18,16 +18,16 @@ | * Brushes | | * Brush Options | | * Stamps | - | * Images | - | * Description Text | - | * Sound Effects | - | * Descriptive Sound | + | * Stamp Images | + | * Stamp Descriptive Text | + | * Stamp Sound Effects | + | * Stamp Descriptive Sound | | * Stamp Options | - | * Pre-Mirrored and Flipped Images | + | * Pre-Mirrored and Flipped Stamps | | * Fonts | | * 'Starters' | - | * Coloring-Book Style | - | * Scene-Style | + | * Coloring-Book Style Starters | + | * Scene-Style Starters | | * 'Templates' | | * Translations | | * Alternative Input Methods | @@ -36,11 +36,11 @@ ---------------------------------------------------------------------- - If you wish to add or change things like Brushes, Starters, Rubber Stamps + If you wish to add or change things like Brushes, Starters, Rubber Stamps, and other content used by Tux Paint, you can do so fairly easily by simply adding, changing, or removing files where Tux Paint looks for them. - Note: You'll need to restart Tux Paint for the changes to take effect. + Note: You'll need to re-launch Tux Paint for the changes to take effect. ---------------------------------------------------------------------- @@ -53,7 +53,8 @@ Where Files Go Linux and Unix Where this directory goes depends on what value was set for - "DATA_PREFIX" when Tux Paint was built. See INSTALL.txt for details. + "DATA_PREFIX" when Tux Paint was built. See 'Install documentation' + for details. By default, though, the directory is: @@ -82,7 +83,7 @@ Where Files Go clicking the Tux Paint icon the in Finder. (If you have a mouse with more than one button, you can simply right-click the icon.) 2. Select "Show Contents" from the menu that appears. A new Finder - window will appear with a folder inside called "Contents." + window will appear with a folder inside called "Contents". 3. Open the "Contents" folder and open the "Resources" folder found inside. 4. There, you will find various sub-folders, such as "starters", @@ -101,48 +102,45 @@ Where Files Go /Library/Application Support/TuxPaint/ - It also looks for files in the user's "Application Support" folder: - - /Users/(username)/Library/Application Support/TuxPaint/ - When you upgrade to a newer version of Tux Paint, the contents of - this TuxPaint folder will stay the same and remain accessible by all - users of Tux Paint. + this "TuxPaint" folder will stay the same, and remain accessible by + all users of Tux Paint. ---------------------------------------------------------------------- Personal Files - You can also create brushes, stamps, fonts and 'starters' in your own - directory (folder) for Tux Paint to find. + You can also create brushes, stamps, 'starters', templates, and fonts + in your own user account directory (folder) for Tux Paint to find. Windows - Your personal Tux Paint folder is stored in your "Application Data". - For example, on newer Windows (set up for an English-speaking user): + Your personal Tux Paint folder is stored in your personal + "Application Data". For example, on newer Windows: C:\Documents and Settings\(username)\Application Data\TuxPaint\ macOS - Your personal Tux Paint folder is stored in your "Application - Support" folder: + Your personal Tux Paint folder is stored in your personal + "Application Support" folder: /Users/(username)/Library/Application Support/TuxPaint/ Linux and Unix - Your personal Tux Paint directory is "$(HOME)/.tuxpaint/" (also - known as "~/.tuxpaint/". + Your personal Tux Paint files go into a 'hidden directory' found in + your account's home directory: "$(HOME)/.tuxpaint/" (also known as + "~/.tuxpaint/"). - That is, if your home directory is "/home/karl", then your Tux Paint - directory is "/home/karl/.tuxpaint/". + That is, if your home directory is "/home/tux", then your personal + Tux Paint files go in "/home/tux/.tuxpaint/". - Don't forget the period (".") before the 'tuxpaint'! + Don't forget the period (".") before the "tuxpaint"! - To add brushes, stamps fonts, and 'starters,' create subdirectories - under your personal Tux Paint directory named "brushes", "stamps", - "fonts" and "starters" respectively. + To add your own brushes, stamps, 'starters,' templates, and fonts, + create subdirectories under your personal Tux Paint directory named + "brushes", "stamps", "starters", "templates", "fonts", respectively. (For example, if you created a brush named "flower.png", you would put it in "~/.tuxpaint/brushes/" under Linux or Unix.) @@ -167,11 +165,12 @@ Brushes attributes. To do this, you need to create a 'data file' for the brush. - A brush data file is simply a text file containing the options. + A brush's data file is simply a plain ASCII text file containing the + options for the brush. The file has the same name as the PNG image, but a ".dat" extension. - (e.g., "brush.png"'s data file is the text file "brush.dat" in the - same directory.) + (e.g., "brush.png"'s data file is the text file "brush.dat", found in + the same directory.) Brush Spacing @@ -180,7 +179,7 @@ Brushes will be the brush's height, divided by 4. Add a line containing the line "spacing=N" to the brush's data file, - where N is the spacing you want for the brush. (The lower the + where "N" is the spacing you want for the brush. (The lower the number, the more often the brush is drawn.) Animated Brushes @@ -192,7 +191,7 @@ Brushes brush is 30x30 and you have 5 frames, the image should be 150x30. Add a line containing the line "frames=N" to the brush's data file, - where N is the number of frames in the brush. + where "N" is the number of frames in the brush. Note: If you'd rather the frames be flipped through randomly, rather than sequentially, also add a line containing "random" to the @@ -210,14 +209,14 @@ Brushes region is used for no motion. The top right is used for motion that's both up, and to the right. And so on. - Add a line containing the line "directional" to the brush's data + Add a line containing the word "directional" to the brush's data file. Animated Directional Brushes You may mix both animated and directional features into one brush. Use both options ("frames=N" and "directional"), in separate lines - in the brush's "".dat" file. + in the brush's ".dat" file. Lay the brush out so that each 3x3 set of directional shapes are laid out across a wide PNG image. For example, if the brush is 30x30 @@ -229,8 +228,8 @@ Brushes directory. Note: If your new brushes all come out as solid squares or rectangles, - it's because you forgot to use alpha transparency! See the documentation - file "PNG.txt" for more information and tips. + it's because you forgot to use alpha transparency! See the 'PNG + documentation' in Tux Paint for more information and tips. ---------------------------------------------------------------------- @@ -241,7 +240,7 @@ Stamps stamps. (For example, you can have a "holidays" folder with "halloween" and "christmas" sub-folders.) - Images + Stamp Images Rubber Stamps in Tux Paint can be made up of a number of separate files. The one file that is required is, of course, the picture @@ -258,35 +257,35 @@ Stamps (smaller). SVGs are vector-based, and will be scaled appropriately for the canvas - being used in Tux Paint. + size being used in Tux Paint. - Note: If your new PNG stamps all have solid rectangular-shaped - outlines of a solid color (e.g., white or black), it's because you - forgot to use alpha transparency! See the documentation file "PNG.txt" - for more information and tips. + Note: If your new PNG-based stamps all come out as solid squares or + rectangles, it's because you forgot to use alpha transparency! See the + 'PNG documentation' in Tux Paint for more information and tips. Note: If your new SVG stamps seem to have a lot of whitespace, make sure the SVG 'document' is no larger than the shape(s) within. If they are being clipped, make sure the 'document' is large enough to contain - the shape(s). See the documentation file "SVG.txt" for more + the shape(s). See the 'SVG documentation' in Tux Paint for more information and tips. - Advanced Users: The Advanced Stamps HOWTO describes, in detail, how to - make PNG images which will scale perfectly when used as stamps in Tux - Paint. + Advanced Users: The 'Advanced Stamps How-To' document describes, in + detail, how to make PNG images which will scale perfectly when used as + stamps in Tux Paint. ---------------------------------------------------------------------- - Description Text + Stamp Descriptive Text - Text (".TXT") files with the same name as the PNG or SVG. (e.g., - "picture.png"'s description is stored in "picture.txt" in the same - directory.) + Tux Paint will display descriptive text when a stamp is selected. + These are placed in plain text files with the same name as the PNG or + SVG, but with a ".txt" filename extension. (e.g., "stamp.png"'s + description is stored in "stamp.txt" in the same directory.) The first line of the text file will be used as the US English description of the stamp's image. It must be encoded in UTF-8. - Language Support + Localization Support Additional lines can be added to the text file to provide translations of the description, to be displayed when Tux Paint is @@ -295,12 +294,12 @@ Stamps The beginning of the line should correspond to the language code of the language in question (e.g., "fr" for French, and "zh_TW" for Traditional Chinese), followed by ".utf8=" and the translated - description (encoded in UTF-8). + description (Unicode, encoded in UTF-8). - There are scripts in the "po" directory for converting the text - files to PO format (and back) for easy translation to different - languages. Therefore you should never add or change translations in - the .txt files directly. + For Tux Paint developers: There are scripts in the "po" directory + for converting the text files to PO format (and back) for easy + translation to different languages. Therefore you should never add + or change translations in the ".txt" files directly. If no translation is available for the language Tux Paint is currently running in, the US English text is used. @@ -313,65 +312,73 @@ Stamps ---------------------------------------------------------------------- - Sound Effects + Stamp Sound Effects - WAVE (".wav") or OGG Vorbis (".ogg") files with the same name as the - PNG or SVG. (e.g., "picture.svg"'s sound effect is the sound file - "picture.wav" in the same directory.) + Tux Paint can play a sound effect when a stamp is selected. For + example, the sound of a duck quaking when selecting a duck, or a brief + piece of music when a musical instrument is chosen. Files may be in + "WAVE (".wav")" or "OGG Vorbis (".ogg")" formats, and are given same + name as the PNG or SVG image. (e.g., "stamp.svg"'s sound effect is the + sound file "stamp.ogg" in the same directory.) - Language Support + Localization Support For sounds for different locales (e.g., if the sound is someone saying a word, and you want translated versions of the word said), also create WAV or OGG files with the locale's label in the - filename, in the form: "STAMP_LOCALE.EXT" + filename, in the form: "stamp_LOCALE.EXT" - "picture.png"'s sound effect, when Tux Paint is run in Spanish mode, - would be "picture_es.wav". In French mode, "picture_fr.wav". In - Brazilian Portuguese mode, "picture_pt_BR.wav". And so on... + "stamp.png"'s sound effect, when Tux Paint is run in Spanish mode, + would be "stamp.png". In French mode, "stamp_es.wav". In Brazilian + Portuguese mode, "stamp_fr.wav". And so on... If no localized sound effect can be loaded, Tux Paint will attempt - to load the 'default' sound file. (e.g., "picture.wav") + to load the 'default' sound file. (e.g., "stamp.wav") Note: For descriptive sounds (not sound effects, like a bang or a bird - chirping), consider using the Descriptive Sounds, described below. + chirping), consider using descriptive sounds; see 'Stamp Descriptive + Sound', below. ---------------------------------------------------------------------- - Descriptive Sound + Stamp Descriptive Sound - WAVE (".wav") or OGG Vorbis (".ogg") files with the same name as the - PNG or SVG, followed by "_desc" (e.g., "picture.svg"'s descriptive - sound is the sound file "picture_desc.ogg" in the same directory.) + Tux Paint can also play a descriptive sound when a stamp is selected. + For example, the sound of someone saying the word "duck" when + selecting a duck, or the name of a musical instrument when one is + chosen. Files may be in "WAVE (".wav")" or "OGG Vorbis (".ogg")" + formats, and are given same name as the PNG or SVG image, with "_desc" + at the end. (e.g., "stamp.svg"'s descriptive sound is the sound file + "stamp_desc.ogg" in the same directory.) - Language Support + Localization Support - For descriptions in different languages, also create WAV or OGG + For descriptive sounds for different locales, also create WAV or OGG files with both "_desc" and the locale's label in the filename, in - the form: "STAMP_desc_LOCALE.EXT" + the form: "stamp_desc_LOCALE.EXT" - "picture.png"'s descriptive sound, when Tux Paint is run in Spanish - mode, would be "picture_desc_es.wav". In French mode, - "picture_desc_fr.wav". In Brazilian Portuguese mode, - "picture_desc_br_PT.wav". And so on... + "stamp.png"'s descriptive sound, when Tux Paint is run in Spanish + mode, would be "stamp_desc_es.wav". In French mode, + "stamp_desc_fr.wav". In Brazilian Portuguese mode, + "stamp_desc_pt_BR.wav". And so on... If no localized descriptive sound can be loaded, Tux Paint will - attempt to load the 'default' descriptive sound file. (e.g., - "picture_desc.wav") + attempt to load the 'default' sound file. (e.g., "stamp_desc.wav") ---------------------------------------------------------------------- Stamp Options - Aside from a graphical shape, a textual description, and a sound - effect, stamps can also be given other attributes. To do this, you - need to create a 'data file' for the stamp. + Aside from a graphical shape, a textual description, a sound effect, + and a descriptive sound, stamps can also be given other attributes. To + do this, you need to create a 'data file' for the stamp. - A stamp data file is simply a text file containing the options. + A stamp's data file is simply a plain ASCII text file containing the + options for the stamp. The file has the same name as the PNG or SVG image, but a ".dat" - extension. (e.g., "picture.png"'s data file is the text file - "picture.dat" in the same directory.) + extension. (e.g., "stamp.png"'s data file is the text file + "stamp.dat", found in the same directory.) Colored Stamps @@ -406,18 +413,18 @@ Stamps Tux Paint use one of a number of methods when tinting it. Add one of the following lines to the stamp's data file: - "tinter=normal" (default) + Normal tinter — "tinter=normal" (the default) This is the normal tinting mode. (Hue range is ±18°, 27 replace.) - "tinter=anyhue" + 'Any hue' tinter — "tinter=anyhue" This remaps all hues in the stamp. (Hue range is ±180°.) - "tinter=narrow" - This like 'anyhue', but a narrower hue angle. (Hue range - is ±6°, 9 replace.) + Narrow tinter — "tinter=narrow" + This like the "anyhue" option, but with a narrower hue + angle. (Hue range is ±6°, 9 replace.) - "tinter=vector" + Vector tinter — "tinter=vector" This maps 'black through white' to 'black through destination'. @@ -432,33 +439,38 @@ Stamps stamps are symmetrical, so letting the user flip or mirror them isn't useful. - To make a stamp un-flippable, add the option "noflip" to the stamp's - data file. + To prevent a stamp from being flipped vertically, add the option + "noflip" to the stamp's data file. - To keep a stamp from being mirrored, add a line containing the word + To prevent a stamp from being mirrored horizontally, add the option "nomirror" to the stamp's data file. Initial Stamp Size By default, Tux Paint assumes that your stamp is sized appropriately - for unscaled display on a 608x472 canvas. This is the original Tux + for unscaled display on a 608x472 canvas. This was the original Tux Paint canvas size, provided by a 640x480 screen. Tux Paint will then adjust the stamp according to the current canvas size and, if enabled, the user's stamp size controls. If your stamp would be too big or too small, you can specify a scale factor. If your stamp would be 2.5 times as wide (or tall) as it - should be, add the option "scale 40%" or "scale 5/2" or "scale 2.5" - or "scale 2:5" to your image. You may include an "=" if you wish, as - in "scale=40%". + should be, add one of the following options, which represent the + same adjustment, to the stamp's data file. (An equals sign, "=", may + be included after the word "scale".) + + * "scale 40%" + * "scale 5/2" + * "scale 2.5" + * "scale 2:5" Windows Users - You can use NotePad or WordPad to create these file. Be sure to save - it as Plain Text, and make sure the filename has ".dat" at the end, - and not ".txt"... + Use NotePad or WordPad to edit/create these files. Be sure to save + them as plain-text, and make sure they have a ".txt" extension at + the end of the filename. - Pre-Mirrored and Flipped Images + Pre-Mirrored and Flipped Stamps In some cases, you may wish to provide a pre-drawn version of a stamp's mirror-image, flipped image, or even both. For example, @@ -471,9 +483,9 @@ Stamps ".png" or ".svg" graphics file with the same name, except with "_mirror" before the filename extension. - For example, for the stamp "truck.png" you would create another file - named "truck_mirror.png", which will be used when the stamp is - mirrored (rather than using a backwards version of 'truck.png'). + For example, for the stamp "stamp.png" you would create another file + named "stamp_mirror.png", which will be used when the stamp is + mirrored (rather than using a backwards version of "stamp.png"). As of Tux Paint 0.9.18, you may similarly provide a pre-flipped image with "_flip" in the name, and/or an image that is both mirrored and @@ -491,22 +503,20 @@ Fonts Simply place them in the "fonts" directory. Tux Paint will load the font and provide four different sizes in the 'Letters' selector when using - the 'Text' tool. + the 'Text' and 'Label' tools. ---------------------------------------------------------------------- 'Starters' 'Starter' images appear in the 'New' dialog, along with solid color - background choices. (Note: In earlier versions of Tux Paint, they - appeared in the 'Open' dialog, together with saved drawings.) + background choices. - Unlike pictures drawn in Tux Paint by users and then opened later, - opening a 'starter' creates a new drawing. When you save, the 'starter' - image is not overwritten. Additionally, as you edit your new picture, - the contents of the original 'starter' affect it. + When you use a 'starter' image, make modifications, and save it, the + original 'starter' image is not overwritten. Additionally, as you edit + your new picture, the contents of the original 'starter' can affect it. - Coloring-Book Style + Coloring-Book Style Starters The most basic kind of 'starter' is similar to a picture in a coloring book. It's an outline of a shape which you can then color in and add @@ -514,22 +524,13 @@ Fonts outline remains 'above' what you draw. You can erase the parts of the drawing you made, but you can't erase the outline. - To create this kind of 'starter' image, simply draw an outlined - picture in a paint program, make the rest of the graphic transparent - (that will come out as white in Tux Paint), and save it as a PNG - format file. + To create this kind of 'starter' image, simply create an outlined + black and white picture in a paint program, and save it as a raster + PNG file, or vector SVG. If saving as a PNG, you may optionally render + the image as black-and-transparent, rather than black-and-white, but + (as of Tux Paint 0.9.21) this is not required. - Note: Previous to Tux Paint 0.9.21, images needed to be black and - transparent. As of 0.9.21, if a Starter is black and white, with no - transparency, white will be converted to transparent when the Starter - is opened. - - Note: Previous to Tux Paint 0.9.22, Starters had to be in PNG or JPEG - (backgrounds only) format. As of 0.9.22, they may be in SVG (vector - graphics) or KPX (templates from Kid Pix, another childrens' drawing - program; they are special files which simply contain a JPEG within). - - Scene-Style + Scene-Style Starters Along with the 'coloring-book' style overlay, you can also provide a separate background image as part of a 'starter' picture. The overlay @@ -539,7 +540,7 @@ Fonts When the 'Eraser' tool is used on a picture based on this kind of 'starter' image, rather than turning the canvas to a solid color, such as white, it returns that part of the canvas to the original - background picture from the 'starter'. + background picture from the 'starter' image. By creating both an overlay and a background, you can create a 'starter' which simulates depth. Imagine a background that shows the @@ -548,34 +549,29 @@ Fonts 'in front of' the reef. To create this kind of 'starter' picture, simply create an overlay - (with transparency) as described above, and save it as a PNG. Then - create another image (without transparency), and save it with the same - filename, but with "-back" appended to the name. (e.g., - "reef-back.png" would be the background ocean picture that corresponds - to the "reef.png" overlay, or foreground.) + (with transparency) and save it as a PNG. Then create another image + (without transparency), and save it with the same filename, but with + "-back" (short for 'background') appended to the name. (e.g., + "starter-back.png" would be the background ocean picture that + corresponds to the overlay, or foreground.) - The 'starter' images should be the same size as Tux Paint's canvas. (See - the "Loading Other Pictures into Tux Paint" section of README for - details on sizing.) If they are not, they will be stretched, without - affecting the shape ("aspect ratio"); however some smudging may be - applied to the edges. + For best results, 'starter' images should be at least the same size as + Tux Paint's drawing canvas. (See the "Loading Other Pictures into Tux + Paint" section of Tux Paint's main documentation (README) for details on + sizing.) If they are not, they will be stretched or scaled. This is done + without affecting the shape ("aspect ratio"); however some smudging may + be applied to the edges. Place them in the "starters" directory. When the 'New' dialog is accessed in Tux Paint, the 'starter' images will appear in the screen that appears, after the various solid color choices. - Note: 'Starters' can't be saved over from within Tux Paint, since - loading a 'starter' is really like creating a new image. (Instead of - being blank, though there's already something there to work with.) The - 'Save' command simply creates a new picture, like it would if the 'New' - command had been used. - Note: 'Starters' are 'attached' to saved pictures, via a small text file that has the same name as the saved file, but with ".dat" as the - extension. This allows the overlay and background, if any, to continue - to affect the drawing even after Tux Paint has been quit, or another - picture loaded or started. (In other words, if you base a drawing on a - 'starter' image, it will always be affected by it.) + extension. This allows it to continue to affect the drawing even after + Tux Paint has been quit, or another picture is loaded or a new image is + created. (In other words, if you base a drawing on a 'starter' image, it + will always be affected by it.) ---------------------------------------------------------------------- @@ -590,44 +586,39 @@ Fonts 'template' image is not overwritten. Unlike 'starters', there is no immutable 'layer' above the canvas. You may draw over any part of it. - When the 'Eraser' tool is used on a picture based on a 'template', - rather than turning the canvas to a solid color, such as white, it - returns that part of the canvas to the original picture from the - 'template'. + When the 'Eraser' tool is used on a picture based on this kind of + 'template' image, rather than turning the canvas to a solid color, such + as white, it returns that part of the canvas to the original background + picture from the 'template' image. - 'Templates' are simply image files (in PNG, JPG, SVG or KPX format). No - preparation or conversion should be required. + 'Templates' are simply image files (in PNG, JPEG, SVG, or KPX (KidPix) + format). No preparation or conversion should be required. - The 'template' images should be the same size as Tux Paint's canvas. - (See the "Loading Other Pictures into Tux Paint" section of README for - details on sizing.) If they are not, they will be stretched, without - affecting the shape ("aspect ratio"); however some smudging may be - applied to the edges. + For best results, 'template' images should be at least the same size as + Tux Paint's drawing canvas. (See the "Loading Other Pictures into Tux + Paint" section of Tux Paint's main documentation (README) for details on + sizing.) If they are not, they will be stretched or scaled. This is done + without affecting the shape ("aspect ratio"); however some smudging may + be applied to the edges. Place them in the "templates" directory. When the 'New' dialog is accessed in Tux Paint, the 'template' images will appear in the screen - that appears, after the various solid color choices and 'starters'. - - Note: 'Templates' can't be saved over from within Tux Paint, since - loading a 'template' is really like creating a new image. (Instead of - being blank, though there's already something there to work with.) The - 'Save' command simply creates a new picture, like it would if the 'New' - command had been used. + that appears, after the various solid color choices. Note: 'Templates' are 'attached' to saved pictures, via a small text file that has the same name as the saved file, but with ".dat" as the - extension. This allows the background to continue to be available to the - drawing (e.g., when using the 'Eraser' tool) even after Tux Paint has - been quit, or another picture loaded or started. (In other words, if you - base a drawing on a 'template' image, it will always be affected by it.) + extension. This allows it to continue to affect the drawing even after + Tux Paint has been quit, or another picture is loaded or a new image is + created. (In other words, if you base a drawing on a 'template' image, + it will always be affected by it.) ---------------------------------------------------------------------- Translations Tux Paint supports numerous languages, thanks to use of the "gettext" - localization library. (See OPTIONS for how to change locales in Tux - Paint.) + localization library. (See "Options documentation" for how to change + locales in Tux Paint.) To translate Tux Paint to a new language, copy the translation template file, "tuxpaint.pot" (found in Tux Paint's source code, in the folder @@ -651,8 +642,13 @@ Translations msgid "Click and drag to draw large bricks." msgstr "Haz clic y arrastra para dibujar ladrillos grandes." - A graphical tool, called poEdit (http://www.poedit.net/), is available - for Linux, Windows and macOS. + Various tools exist to manage gettext translation catalogs, so you don't + have to edit them by hand in a text editor. Here are a few: + + * Poedit + * Gtranslator (GNOME Translator) + * Virtraal + * Lokalize Note: It is best to always work off of the latest Tux Paint text catalog template ("tuxpaint.pot"), since new text is added, and old text is @@ -673,22 +669,22 @@ Translations to the Git source code repository so that you may commit your changes directly. - Note: Additional locale support also requires additions to Tux Paint's - source code (/src/i18n.h and /src/i18n.c), and requires updates to the - Makefile, to have the ".po" gettext catalog source files compiled into - ".mo" files, and installed, for use at runtime. + Note: Support for new locales requires making additions to Tux Paint's + source code ("/src/i18n.h" and "/src/i18n.c"), and requires updates to + the Makefile, to ensure the ".po" files are compiled into ".mo" files, + and available for use at runtime. ---------------------------------------------------------------------- Alternative Input Methods - As of version 0.9.17, Tux Paint's "Text" tool can provide alternative - input methods for some languages. For example, when Tux Paint is running - with a Japanese locale, the right [Alt] key can be pressed to cycle - between Latin, Romanized Hiragana and Romanized Katakana modes. This - allows native characters and words to be entered into the "Text" tool by - typing one or more keys on a keyboard with Latin characters (e.g., a US - QWERTY keyboard). + Tux Paint's 'Text' and 'Label' tools can provide alternative input + methods for some languages. For example, when Tux Paint is running with + a Japanese locale, the right [Alt] key can be pressed to cycle between + Latin, Romanized Hiragana and Romanized Katakana modes. This allows + native characters and words to be entered into the 'Text' and 'Label' + tools by typing one or more keys on a keyboard with Latin characters + (e.g., a US QWERTY keyboard). To create an input method for a new locale, create a text file with a name based on the locale (e.g., "ja" for Japanese), with ".im" as the @@ -697,7 +693,7 @@ Alternative Input Methods The ".im" file can have multiple character mapping sections for different character mapping modes. For example, on a Japanese typing system, typing [K] [A] in Hiragana mode generates a different Unicode - character than typing [K] [A] in Katakana mode. + character ("か") than typing [K] [A] in Katakana mode ("カ"). List the character mappings in this file, one per line. Each line should contain (separated by whitespace): @@ -707,7 +703,7 @@ Alternative Input Methods some sequences to map to words) * the keycode sequence (the ASCII characters that must be entered to generate the Unicode character) - * a flag (or "-") + * a flag (or "-" if none) Start additional character mapping sections with a line containign the word "section". @@ -738,21 +734,22 @@ Alternative Input Methods used in Korean to handle Batchim, which may carry over to the next character. - Note: Additional input method support also requires additions to Tux - Paint's source code (/src/im.c), and requires updates to the Makefile, - to have the ".im" files installed, for use at runtime. + Note: Support for new input methods requires making additions to Tux + Paint's source code ("/src/im.c"), and requires updates to the Makefile, + to ensure the ".im" files are available for use at runtime. ---------------------------------------------------------------------- On-screen Keyboard - As of version 0.9.22, Tux Paint's "Text" and "Label" tools can present + As of version 0.9.22, Tux Paint's 'Text' and 'Label' tools can present an on-screen keyboard that allows the pointer (via a mouse, eye-tracking systems, etc.) to be used to input characters. Files that describe the - layout and available keys are stored in Tux Paint's "osk" directory. - Each keyboard layout is defined by a number of files (some of which may - be shared by different layouts). We'll use the QWERTY keyboard as an - example: + layout and available keys are stored in Tux Paint "osk" directory. Each + keyboard layout is defined by a number of files (some of which may be + shared by different layouts). + + We'll use the QWERTY keyboard as an example: Layout overview file ("qwerty.layout") @@ -774,15 +771,15 @@ On-screen Keyboard Keyboard layout file ("qwerty.h_layout") - This describes how big the keyboard is (as a W×H grid), and lists each - key with its numeric keycode (see the "keymap" file, below), the width - it should be drawn at (typically "1.0", to take one space on the - keyboard, but in the example below, notice the "TAB" and "SPACE" keys - are much wider), the character or text to display on the key, - depending on which modifier keys have been pressed (one each for: no - modifiers, [Shift], [AltGr], and [Shift]+[AltGr]), and finally whether - or not the key is affected by the [CapsLock] key (use "1") or [AltGr] - (alternate graphics) key (use "2"), or not at all (use "0"). + This describes how big the keyboard is (as a "width × height" grid), + and lists each key with its numeric keycode (see the "keymap" file, + below), the width it should be drawn at (typically "1.0", to take one + space on the keyboard, but in the example below, notice the "TAB" and + "SPACE" keys are much wider), the character or text to display on the + key, depending on which modifier keys have been pressed (one each for: + no modifiers, [Shift], [AltGr], and [Shift] + [AltGr]), and finally + whether or not the key is affected by the [CapsLock] key (use "1") or + [AltGr] (alternate graphics) key (use "2"), or not at all (use "0"). WIDTH 15 HEIGHT 5 @@ -814,7 +811,7 @@ On-screen Keyboard KEY 133 2.0 Cmp Cmp Cmp Cmp 0 - # The ALT or ALTGR keys are used in im to switch the input mode. + # The ALT or ALTGR keys are used in im to switch the input mode KEY 64 2.0 Alt Alt Alt Alt 0 # Space @@ -880,14 +877,14 @@ On-screen Keyboard Composemap file ("en_US.UTF-8_Compose") - This file describes characters that can be composed by multiple + This file describes single characters that can be composed by multiple inputs. For example, "[Compose]" followed by "[A]" and "[E]" can be used to create the "æ" character. The file that comes with Tux Paint is based on the US English UTF-8 (Unicode) composemap that comes with X.Org's X Window system. The - current version from the Xlib library as a web page at - https://www.x.org/releases/current/doc/libX11/i18n/compose/en_US.UTF-8.html). + current version from the Xlib library has a web located page at + https://www.x.org/releases/current/doc/libX11/i18n/compose/en_US.UTF-8.html. Keysym definitions file ("keysymdef.h") @@ -896,6 +893,9 @@ On-screen Keyboard (e.g., "XK_equal" corresponds to "U+003D", for the character "=" ("EQUALS SIGN"). + Note: This file is not compiled into Tux Paint, but is read and parsed + at runtime. + It is unlikely that any modification will be required of this file. ---------------------------------------------------------------------- diff --git a/docs/en/FAQ.txt b/docs/en/FAQ.txt index 943139262..de9431c5b 100644 --- a/docs/en/FAQ.txt +++ b/docs/en/FAQ.txt @@ -1,11 +1,10 @@ Tux Paint - version 0.9.26 - Frequently Asked Questions + version 0.9.26 Frequently Asked Questions - Copyright (c) 2002-2020 by various contributors; see AUTHORS.txt + Copyright © 2002-2021 by various contributors; see AUTHORS. http://www.tuxpaint.org/ - September 14, 2002 - December 27, 2020 + 23 January 2021 ---------------------------------------------------------------------- @@ -24,12 +23,12 @@ Drawing-related If you installed Tux Paint, but did not install the separate, optional "Stamps" collection, quit Tux Paint and install it now. - It should be available from the same place you got the main - Tux Paint program. (Note: As of version 0.9.14, Tux Paint comes - with a small collection of example stamps.) + It should be available from the same place you got the main Tux + Paint program. (Note: As of version 0.9.14, Tux Paint comes with a + small collection of example stamps.) If you don't want to install the default collection of stamps, you - can just create your own. See the EXTENDING TUX PAINT + can just create your own. See the "Extending Tux Paint" documentation for more on creating PNG and SVG image files, TXT text description files, Ogg Vorbis, MP3 or WAV sound files, and DAT text data files that make up stamps. @@ -39,15 +38,15 @@ Drawing-related (Either via a "--nostamps" option to Tux Paint's command line, or "nostamps=yes" in the configuration file.) - If so, either change/remove the "nostamps" option, or you can - override it with "--stamps" on the command line or "nostamps=no" - or "stamps=yes" in a configuration file. + Either change/remove the "nostamps" option, or you can override it + with "--stamps" on the command line or either "nostamps=no" or + "stamps=yes" in a configuration file. - The Magic "Fill" Tool Looks Bad + The "Fill" Tool Looks Bad Tux Paint is probably comparing exact pixel colors when filling. - This is faster, but looks worse. Run the command - "tuxpaint --version" from a command line, and you should see, + This is faster, but looks worse. Run the command "tuxpaint + --verbose-version" from a command line, and you should see, amongst the other output: "Low Quality Flood Fill enabled". To change this, you must rebuild Tux Paint from source. Be sure to @@ -61,8 +60,8 @@ Drawing-related Tux Paint was built with low-quality (but faster) stamp outlines. - Rebuild Tux Paint from source. Be sure to remove or comment out - any line that says: + To change this, you must rebuild Tux Paint from source. Be sure to + remove or comment out any line that says: #define LOW_QUALITY_STAMP_OUTLINE @@ -75,12 +74,13 @@ Interface Problems Stamp thumbnails in the Stamp Selector look bad Tux Paint was probably compiled with the faster, lower quality - thumbnail code enabled. Run the command: "tuxpaint --version" from - a command line. If, amongst the other output, you see the text: - "Low Quality Thumbnails enabled", then this is what's happening. + thumbnail code enabled. Run the command: "tuxpaint + --verbose-version" from a command line. If, amongst the other + output, you see the text: "Low Quality Thumbnails enabled", then + this is what's happening. - Rebuild Tux Paint from source. Be sure to remove or comment out - any line that says: + To change this, you must rebuild Tux Paint from source. Be sure to + remove or comment out any line that says: #define LOW_QUALITY_THUMBNAILS @@ -93,13 +93,13 @@ Interface Problems The color picker buttons are ugly squares, not pretty buttons! Tux Paint was probably compiled with the nice looking color - selector buttons disabled. Run the command: "tuxpaint --version" - from a command line. If, amongst the other output, you see the - text: "Low Quality Color Selector enabled", then this is what's - happening. + selector buttons disabled. Run the command: "tuxpaint + --verbose-version" from a command line. If, amongst the other + output, you see the text: "Low Quality Color Selector enabled", + then this is what's happening. - Rebuild Tux Paint from source. Be sure to remove or comment out - any line that says: + To change this, you must rebuild Tux Paint from source. Be sure to + remove or comment out any line that says: #define LOW_QUALITY_COLOR_SELECTOR @@ -109,26 +109,11 @@ Interface Problems The "uppercase" option is on. - If you're running Tux Paint from a command-line, make sure you're - not giving it an "--uppercase" option. + Either change/remove the "uppercase" option, or you can override + it with "--mixedcase" on the command line or either "uppercase=no" + or "mixedcase=yes" in a configuration file. - If you're running Tux Paint by double-clicking an icon, check the - properties of the icon to see if "--uppercase" is listed as a - command-line argument. - - If "--uppercase" isn't being sent on the command line, check - Tux Paint's configuration file ("~/.tuxpaintrc" under Linux and - Unix, "tuxpaint.cfg" under Windows) for a line reading: - "uppercase=yes". - - Either remove that line, or simply run Tux Paint with the - command-line argument: "--mixedcase", which will override the - uppercase setting. - - Or use Tux Paint Config. and make sure "Show Uppercase Text Only" - (under "Languages") is not checked. - - Tux Paint is in a different language! + Tux Paint is in a different language Make sure your locale setting is correct. See "Tux Paint won't switch to my language", below. @@ -136,13 +121,13 @@ Interface Problems * Linux and Unix users: Make sure the locale is available Make sure the locale you want is available. Check your - "/etc/locale.gen" file. See the OPTIONS documentation for the - locales Tux Paint uses (especially when using the "--lang" - option). + "/etc/locale.gen" file. See the "Options Documentation" for + the locales Tux Paint uses (especially when using the + "--lang" option). Note: Debian and derivative (e.g., Ubuntu) users can simply run "dpkg-reconfigure locales" if the locales are managed by - "dpkg." + "dpkg". * If you're using the "--lang" command-line option @@ -170,7 +155,7 @@ Interface Problems The appropriate fonts for such locales can be downloaded from the Tux Paint website: - http://www.tuxpaint,org/download/fonts/ + http://www.tuxpaint.org/download/fonts/ ---------------------------------------------------------------------- @@ -186,20 +171,20 @@ Printing the Common Unix Printing System, and do not have "cups-lpr" installed), you will need to specify an appropriate command using the "printcommand" option in Tux Paint's configuration file. (See - the OPTIONS documentation.) + the "Options Documentation".) Note: Versions of Tux Paint prior to 0.9.15 used a different - default command for printing, "pngtopnm | pnmtops | lpr", as - Tux Paint output PNG format, rather than PostScript. + default command for printing, "pngtopnm | pnmtops | lpr", as Tux + Paint output PNG format, rather than PostScript. If you had changed your "printcommand" option prior to Tux Paint 0.9.15, you will need to go back and alter it to accept PostScript. - I get the message "You can't print yet!" when I go to print! + I get the message "You can't print yet!" when I go to print - The "print delay" option is on. You can only print once every - X seconds. + The "print delay" option is on. You can only print once every X + seconds. If you're running Tux Paint from a command-line, make sure you're not giving it a "--printdelay=..." option. @@ -209,22 +194,18 @@ Printing command-line argument. If a "--printdelay=..." option isn't being sent on the command - line, check Tux Paint's configuration file ("~/.tuxpaintrc" under - Linux and Unix, "tuxpaint.cfg" under Windows) for a line reading: + line, check Tux Paint's configuration file for a line reading: "printdelay=...". Either remove that line, set the delay value to 0 (no delay), or - decrease the delay to a value you prefer. (See the OPTIONS - documentation). + decrease the delay to a value you prefer. (See the "Options + Documentation".) Or, you can simply run Tux Paint with the command-line argument: "--printdelay=0", which will override the configuration file's setting, and allow unlimited printing. (You won't have to wait between prints.) - Or use Tux Paint Config. and make sure "Print Delay" (under - "Printing") is set to "0 seconds." - I simply can't print! The button is greyed out! The "no print" option is on. @@ -233,12 +214,12 @@ Printing not giving it a "--noprint" option. If you're running Tux Paint by double-clicking an icon, check the - properties of the icon to see if "--noprint" is listed as an - argument. + properties of the icon to see if "--noprint" is listed as a + command-line argument. - If "--noprint" isn't on the command-line, check Tux Paint's - configuration file ("~/.tuxpaintrc" under Linux and Unix, - "tuxpaint.cfg" under Windows) for a line reading: "noprint=yes". + If a "--noprint" option isn't being sent on the command line, + check Tux Paint's configuration file for a line reading: + "noprint=yes". Either remove that line, or simply run Tux Paint with the command-line argument: "--print", which will override the @@ -254,7 +235,7 @@ Saving Where does Tux Paint save my drawings? Unless you asked Tux Paint to save into a specific location (using - the 'savedir' option), Tux Paint saves into a standard location on + the "savedir" option), Tux Paint saves into a standard location on your local drive: Windows Vista, Windows 8, Windows 10 @@ -273,15 +254,15 @@ Saving Support/TuxPaint/saved/ Linux / Unix - In the user's $HOME directory, under a ".tuxpaint" - subfolder: + In the user's home directory ("$HOME"), under a + ".tuxpaint" subfolder: e.g., /home/username/.tuxpaint/saved/ The images are stored as PNG bitmaps, which most modern programs should be able to load (image editors, word processors, web browsers, etc.) - Tux Paint always saves over my old picture! + Tux Paint always saves over my old picture The "save over" option is enabled. (This disables the prompt that would appear when you click 'Save.') @@ -290,12 +271,12 @@ Saving not giving it a "--saveover" option. If you're running Tux Paint by double-clicking an icon, check the - properties of the icon to see if "--saveover" is listed as an - argument. + properties of the icon to see if "--saveover" is listed as a + command-line argument. - If "--saveover" isn't on the command-line, check Tux Paint's - configuration file ("~/.tuxpaintrc" under Linux and Unix, - "tuxpaint.cfg" under Windows) for a line reading: "saveover=yes". + If a "--saveover" option isn't being sent on the command line, + check Tux Paint's configuration file for a line reading: + "saveover=yes". Either remove that line, or simply run Tux Paint with the command-line argument: "--saveoverask", which will override the @@ -359,22 +340,25 @@ Audio Problems program is "blocking" the sound device), then Tux Paint may be running with a "no sound" option. - Make sure you're not running Tux Paint with the "--nosound" - option as a command-line argument. (See the OPTIONS - documentation for details.) + If you're running Tux Paint from a command-line, make sure + you're not giving it a "--nosound" option. - If it's not, then check the configuration file - ("/etc/tuxpaint/tuxpaint.conf" and "~/.tuxpaintrc" under - Linux and Unix, and "tuxpaint.cfg" under Windows) for a line - reading: "nosound=yes". + If you're running Tux Paint by double-clicking an icon, check + the properties of the icon to see if "--nosound" is listed as + a command-line argument. + + If a "--nosound" option isn't being sent on the command line, + check Tux Paint's configuration file for a line reading: + "nosound=yes". Either remove that line, or simply run Tux Paint with the command-line argument: "--sound", which will override the configuration file's setting. - Alternatively, you can use Tux Paint Config. to change the - configuration file. Make sure "Enable Sound Effects" (under - "Video & Sound") is checked, then click "Apply". + Or, you can simply run Tux Paint with the command-line + argument: "Enable Sound Effects", which will override the + configuration file's setting, and allow unlimited printing. + (You won't have to wait between prints.) * Were sounds temporarily disabled? @@ -389,7 +373,7 @@ Audio Problems To test whether sound support was enabled when Tux Paint was compiled, run Tux Paint from a command line, like so: - tuxpaint --version + tuxpaint --verbose-version If, amongst the other information, you see "Sound disabled", then the version of Tux Paint you're running has sound @@ -405,26 +389,28 @@ Audio Problems * Press [Alt] + [S] while in Tux Paint to temporarily disable sounds. (Press that key sequence again to re-enable sounds.) * Run Tux Paint with the "no sound" option: - * Use Tux Paint Config to uncheck the "Enable Sound - Effects" option (under "Video & Sound"). - * Edit Tux Paint's configuration file (see OPTIONS for - details) and add a line containing "nosound=yes". * Run "tuxpaint --nosound" from the command line or shortcut or desktop icon. - * Recompile Tux Paint with sound support disabled. (See - above and INSTALL.txt.) + * Edit Tux Paint's configuration file (see "Options + Documentation" for details) and add a line containing + "nosound=yes". + * Or use Tux Paint Config. and make sure "Enable Sound + Effects" (under "Video & Sound") is not checked. + * Alternatively, recompile Tux Paint with sound support + disabled. (See above, and the 'Install' documentation. The stereo panning of sound effects is bothersome; can sound effects be monophonic? Run Tux Paint with the "no stereo" option: - * Use Tux Paint Config to uncheck the "Enable Stereo Sound" - option (under "Video & Sound"). - * Edit Tux Paint's configuration file (see OPTIONS for details) - and add a line containing "nostereo=yes". * Run "tuxpaint --nostereo" from the command line or shortcut or desktop icon. + * Edit Tux Paint's configuration file (see "Options + Documentation" for details) and add a line containing + "nostereo=yes". + * Or use Tux Paint Config. and make sure "Enable Stereo + Effects" (under "Video & Sound") is not checked. The sound effects sound strange @@ -432,15 +418,16 @@ Audio Problems (The buffer size chosen.) Please e-mail us with details about your computer system. - (Operating system and version, sound card, which version of - Tux Paint you're running (run "tuxpaint --version" to verify), and - so on.) + (Operating system and version, sound card, which version of Tux + Paint you're running (run "tuxpaint --version" to verify), and so + on.) ---------------------------------------------------------------------- Fullscreen Mode Problems - When I run Tux Paint full-screen and ALT-TAB out, the window turns black! + When I run Tux Paint full-screen and [Alt] + [Tab] out, the window turns + black! This is apparently a bug in the SDL library. Sorry. When I run Tux Paint full-screen, it has large borders around it @@ -448,8 +435,8 @@ Fullscreen Mode Problems Linux users - Your X-Window server is probably not set with the ability to switch to the desired resolution: 800×600. (or whatever resolution you have Tux Paint set to run at.) (This is typically - done manually under the X-Window server by pressing - [Ctrl]-[Alt]-[KeyPad Plus] and -[KeyPad Minus].) + done manually under the X-Window server by pressing [Ctrl] + [Alt] + + [Keypad Plus] and [Ctrl] + [Alt] + [Keypad Minus].) For this to work, your monitor must support that resolution, and you need to have it listed in your X server configuration. @@ -463,7 +450,7 @@ Fullscreen Mode Problems Add "800x600" (or whatever resolution(s) you want) to the appropriate "Modes" line. (e.g., in the "Display" subsection that contains 24-bit color depth ("Depth 24"), which is what Tux Paint - tries to use.) e.g.: + tries to use.) Modes "1280x1024" "1024x768" "800x600" "640x480" @@ -479,12 +466,11 @@ Fullscreen Mode Problems not giving it a "--fullscreen" option. If you're running Tux Paint by double-clicking an icon, check the - properties of the icon to see if "--fullscreen" is listed as an - argument. + properties of the icon to see if "--fullscreen" is listed as a + command-line argument. - If "--fullscreen" isn't on the command-line, check Tux Paint's - configuration file ("~/.tuxpaintrc" under Linux and Unix, - "tuxpaint.cfg" under Windows) for a line reading: + If a "--fullscreen" option isn't being sent on the command line, + check Tux Paint's configuration file for a line reading: "fullscreen=yes". Either remove that line, or simply run Tux Paint with the @@ -505,8 +491,8 @@ Other Probelms 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). + 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 @@ -521,38 +507,38 @@ Other Probelms stored (e.g., on a shared network drive), then you'll need to disable this feature. - To disable the lockfile, add the "--nolockfile" argument to - Tux Paint's command-line. + To disable the lockfile, add the "--nolockfile" argument to Tux + Paint's command-line, or "nolockfile=yes" to the configuration + file. I can't quit Tux Paint - The "noquit" option is set. This disables the "Quit" button in + The "no quit" option is set. This disables the "Quit" button in Tux Paint's toolbar (greying it out), and prevents Tux Paint from - being quit using the [Escape] key. + being exited via the [Escape] key. If Tux Paint is not in fullscreen mode, simply click the window - close button on Tux Paint's title bar. (i.e., the "(x)" at the - upper right.) + close button on Tux Paint's title bar. (i.e., the "ⓧ" at the upper + right.) If Tux Paint is in fullscreen mode, you will need to use the [Shift] + [Control] + [Escape] sequence on the keyboard to quit Tux Paint. - (Note: with or without "noquit" set, you can always use the [Alt] + (Note: with or without "no quit" set, you can always use the [Alt] + [F4] combination on your keyboard to quit Tux Paint.) - I don't want "noquit" mode enabled! + I don't want "no quit" mode enabled! If you're running Tux Paint from a command-line, make sure you're not giving it a "--noquit" option. If you're running Tux Paint by double-clicking an icon, check the - properties of the icon to see if "--noquit" is listed as an - argument. + properties of the icon to see if "--noquit" is listed as a + command-line argument. - If "--noquit" isn't on the command-line, check Tux Paint's - configuration file ("~/.tuxpaintrc" under Linux and Unix, - "tuxpaint.cfg" under Windows) for a line reading: "noquit=yes". + If a "--noquit" option isn't being sent on the command line, check + Tux Paint's configuration file for a line reading: "noquit=yes". Either remove that line, or simply run Tux Paint with the command-line argument: "--quit", which will override the @@ -568,8 +554,8 @@ Other Probelms finds while loading them), then it was probably compiled with debugging output turned on. - Rebuild Tux Paint from source. Be sure to remove or comment out - any line that says: + To change this, you must rebuild Tux Paint from source. Be sure to + remove or comment out any line that says: #define DEBUG @@ -600,23 +586,23 @@ Other Probelms tuxpaint.cfg - Then, any options sent as command-line arguments are used. + Finally, any options sent as command-line arguments are used. 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. - For example, if "/etc/tuxpaint/tuxpaint.conf" includes an option - to disable sound: + For example, on Linux and Unix, if "/etc/tuxpaint/tuxpaint.conf" + includes this option to disable sound... nosound=yes - You can reenable sound by either adding this option to your own - ".tuxpainrc" file: + ...then you can reenable sound by either adding this option to + your own ".tuxpaintrc" file: sound=yes - Or by using this command-line argument: + ...or by using this command-line argument: --sound diff --git a/docs/en/INSTALL.txt b/docs/en/INSTALL.txt index 1f94da5be..d07a83594 100644 --- a/docs/en/INSTALL.txt +++ b/docs/en/INSTALL.txt @@ -1,426 +1,387 @@ -INSTALL.txt for Tux Paint + Tux Paint + version 0.9.26 + Installation Documentation -Tux Paint - A simple drawing program for children. + Copyright © 2002-2021 by various contributors; see AUTHORS. + http://www.tuxpaint.org/ -Copyright (c) 2002-2020 -Various contributors (see below, and AUTHORS.txt) -http://www.tuxpaint.org/ - -June 27, 2002 - July 25, 2020 -$Id$ + 30 January 2021 + ---------------------------------------------------------------------- Requirements: -------------- - Windows Users: - -------------- - The Windows version of Tux Paint comes pre-packaged with the - necessary pre-compiled libraries (in ".DLL" form), so no extra - downloading is needed. libSDL - ------ - Tux Paint requires the Simple DirectMedia Layer Library (libSDL), - an Open Source multimedia programming library available under the - GNU Lesser General Public License (LGPL). - 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). + Tux Paint requires the Simple DirectMedia Layer Library (libSDL), an + Open Source multimedia programming library available under the GNU + Lesser General Public License (LGPL). + + 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). Linux/Unix Users: - ----------------- - The SDL libraries are available as source-code, or as RPM or Debian - packages for various distributions of Linux. They can be downloaded - from: - libSDL: http://www.libsdl.org/ - SDL_Image: http://www.libsdl.org/projects/SDL_image/ - SDL_TTF: http://www.libsdl.org/projects/SDL_ttf/ - SDL_Pango: http://sourceforge.net/projects/sdlpango/ [OPTIONAL] - SDL_Mixer: http://www.libsdl.org/projects/SDL_mixer/ [OPTIONAL] + The SDL libraries are available as source-code, or as RPM or Debian + packages for various distributions of Linux. They can be downloaded + from: - They are also typically available along with your Linux distribution - (e.g. on an installation CD, or available via package maintainance - software like Debian's "apt-get"). + * libSDL: http://www.libsdl.org/ + * SDL_Image: http://www.libsdl.org/projects/SDL_image/ + * SDL_TTF: http://www.libsdl.org/projects/SDL_ttf/ + * SDL_Pango: http://sourceforge.net/projects/sdlpango/ (optional) + * SDL_Mixer: http://www.libsdl.org/projects/SDL_mixer/ (optional) - NOTE: When installing from packages, be sure to ALSO install the - "-devel" versions of the packages. (For example, install both - "SDL-1.2.4.rpm" AND "SDL-1.2.4-devel.rpm") + 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 "apt"). - 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. + Note: When installing libraries from packages, be sure to ALSO + install the development versions of the packages. (For example, + install both "SDL-1.2.4.rpm" and "SDL-1.2.4-devel.rpm".) + + 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 - ------ - Tux Paint uses PNG (Portable Network Graphics) format for its - data files. SDL_image will require libPNG be installed. - http://www.libpng.org/pub/png/libpng.html + Tux Paint uses PNG (Portable Network Graphics) format for its data + files. SDL_image will require libPNG be installed. + + http://www.libpng.org/pub/png/libpng.html 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 gettext library installed. - http://www.gnu.org/software/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 gettext library installed. + + http://www.gnu.org/software/gettext/ 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, thanks to libpaper. - http://www.debian.org/ + 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". + + https://github.com/naota/libpaper FriBiDi - ------- - As of Tux Paint 0.9.21, Tux Paint's "Text" tool supports bidirectional - languages, thanks to the FriBiDi library: - http://fribidi.org/ + Tux Paint's "Text" and also "Label" tools support bidirectional + languages, thanks to the "FriBiDi" library. + + http://fribidi.org/ 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 - http://librsvg.sourceforge.net/ + 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:=") - Cairo 2 - http://www.cairographics.org/ + librsvg-2 & libCairo2 (newer libraries) - Also depends on: - GdkPixbuf - GLib - http://www.gtk.org/ + * libRSVG 2: http://librsvg.sourceforge.net/ + * Cairo 2: http://www.cairographics.org/ + * These also depend on the following: + * GdkPixbuf & GLib: http://www.gtk.org/ + * Pango: http://www.pango.org/ - Pango - http://www.pango.org/ + Older SVG libraries - Older libraries - ------------------------------- - libcairo1 - libsvg1 - libsvg-cairo1 - http://www.cairographics.org/ - - Also depends on: - libxml2 + * libcairo1, libsvg1, & libsvg-cairo1: + http://www.cairographics.org/ + * These also depend on the following: + * libxml2: https://gitlab.gnome.org/GNOME/libxml2 Animated GIF Export feature - --------------------------- - So support export of animated GIFs (slideshows), the - "libimagequant" library (from the "pngquant2" project) - is required. - https://github.com/ImageOptim/libimagequant + To support export of animated GIFs (slideshows), the "libimagequant" + library (from the "pngquant2" project) is required. - NetPBM Tools [OPTIONAL] [No longer used, by default] - ------------------------ - Under Linux and Unix, the NetPBM tools are what are currently - used for printing. (A PNG is generated by TuxPaint, and converted - into a PostScript using the 'pngtopnm' and 'pnmtops' NetPBM command-line - tools.) + https://github.com/ImageOptim/libimagequant - http://netpbm.sourceforge.net/ + 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 into a PostScript using the 'pngtopnm' and 'pnmtops' + NetPBM command-line tools.) + + http://netpbm.sourceforge.net/ Compiling and Installation: ---------------------------- - 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 included. + + 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. Windows Users: - -------------- + Compiling: - ---------- - Tux Paint comes pre-compiled for Windows, so no compilation is - necessary. - As of February 2005 (starting with Tux Paint 0.9.15), the Makefile - includes support for building on a Windows system using MinGW/MSYS. - ( http://www.mingw.org/ ) + As of February 2005 (starting with Tux Paint 0.9.15), the "Makefile" + includes support for building on a Windows system using MinGW/MSYS + (http://www.mingw.org/). - After configuring the environment and building and installing all the - dependencies, use these commands, in MSYS, to build, install and run: + After configuring the environment and building and installing all + the dependencies, use these commands, in MSYS, to build, install and + run: Prior to version 0.9.20: - $ make win32 - $ make install-win32 - $ tuxpaint + $ make win32 + $ make install-win32 + $ tuxpaint Version 0.9.20 and beyond: - $ make - $ make install - $ tuxpaint + $ make + $ make install + $ tuxpaint - Use the following command to build a version suitable for - redistribution with the installer or in a zip-file: + Use the following command to build a version suitable for + redistribution with the installer or in a zip-file: - $ make bdist-win32 + $ make bdist-win32 - Or if building for Win9x/ME: + Or if building for Win9x/ME: - $ BDIST_WIN9X=1 make bdist-win32 + $ BDIST_WIN9X=1 make bdist-win32 - Before any of the above will work, you need to configure the - environment and build or install the libraries that Tux Paint depends - upon. John Popplewell put together some instructions for doing that - here: + Before any of the above will work, you need to configure the + environment and build or install the libraries that Tux Paint + depends upon. John Popplewell put together some instructions for + doing that here: - http://www.johnnypops.co.uk/tuxpaint/ + http://www.johnnypops.co.uk/tuxpaint/ - Read the relevant notes if building for Win9X/ME. + Read the relevant notes if building for Win9X/ME. - Installer: - ---------- - Double-click the Tux Paint installer executable (.EXE file) and - follow the instructions. + Running the Installer: - 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".) + Double-click the Tux Paint installer executable (.EXE file) and + follow the instructions. - 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.) + 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".) - 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. + 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.) - At this point, you can click 'Install' to install Tux Paint! + 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. + + At this point, you can click 'Install' to install Tux Paint! Changing the Settings Using the Shortcut: - ----------------------------------------- - To change program settings, right-click on the TuxPaint shortcut - and select 'Properties' (at the bottom). - Make sure the 'Shortcut' tab is selected in the window that - appears, and examine the 'Target:' field. You should see - something like this : + To change program settings, right-click on the TuxPaint shortcut and + select 'Properties' (at the bottom). - "C:\Program Files\TuxPaint\TuxPaint.exe" + Make sure the 'Shortcut' tab is selected in the window that appears, + and examine the 'Target:' field. You should see something like this: - You can now add command-line options which will be enabled when - you double-click the icon. + "C:\Program Files\TuxPaint\TuxPaint.exe" - 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: + You can now add command-line options which will be enabled when you + double-click the icon. - "C:\Program Files\TuxPaint\TuxPaint.exe" -f -s --lang french + 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: - (See "README.txt" for a full list of available command-line options.) + "C:\Program Files\TuxPaint\TuxPaint.exe" -f -s --lang french - If you make a mistake or it all disappears use Ctrl-Z to undo or - just hit the [ESC] key and the box will close with no changes made - (unless you pushed the "Apply" button!). + (See the main documentation for a full list of available + command-line options.) - When you have finished, click "OK." + If you make a mistake or it all disappears use [Ctrl] + [Z] to undo + or just hit the [Esc] key and the box will close with no changes + made (unless you pushed the "Apply" button!). - If Something Goes Wrong - ----------------------- - If, when you double-click on the shortcut to run the game, - 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 'stderr.txt' in the TuxPaint folder. + When you have finished, click "OK." - 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). + 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 like before, and look for a file called + "stderr.txt" in the TuxPaint folder. + + 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). Linux/Unix Users: - ----------------- + Compiling: - ---------- - Note: Currently, Tux Paint does not use autoconf/automake, so there - is no "./configure" script to run. (Sorry!) Compiling should be - straight-forward though, assuming everything Tux Paint needs is installed. - To compile the program from source, simply run the following command - from a shell prompt (e.g., "$"): + Note: Tux Paint does not use autoconf/automake, so there is no + "./configure" script to run. Compiling should be straight-forward + though, assuming everything Tux Paint needs is installed. - $ make + To compile the program from source, simply run the following command + from a shell prompt (e.g., "$"): - 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 "SVG_LIB= SVG_CFLAGS= NOSVGFLAG=NOSVG" added: + $ make - $ make SVG_LIB= SVG_CFLAGS= + 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 "SVG_LIB= SVG_CFLAGS= NOSVGFLAG=NOSVG" + added: + + $ make SVG_LIB= SVG_CFLAGS= Disabling Pango support (and hence Pango, Cairo, etc. dependencies): - -------------------------------------------------------------------- - Prior to version 0.9.18, Tux Paint used the libSDL_ttf library for - rendering text using TrueType Fonts. Since 0.9.18, libSDL_Pango 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 "make" with "SDL_PANGO_LIB=" added: - $ make SDL_PANGO_LIB= + Prior to version 0.9.18, Tux Paint used the libSDL_ttf library for + rendering text using TrueType Fonts. Since 0.9.18, libSDL_Pango 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 "make" with "SDL_PANGO_LIB=" added: + + $ make SDL_PANGO_LIB= 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 "make" with "SDL_MIXER_LIB=" added: - $ make SDL_MIXER_LIB= + 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 "make" with "SDL_MIXER_LIB=" added: + + $ make SDL_MIXER_LIB= Other options: - -------------- - Various other options (e.g., installation paths) may be overridden; - see them in "Makefile" for further details. + + Various other options (e.g., installation paths) may be overridden; + see them in "Makefile" for further details. 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 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! + 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 "-dev" or "-devel" + packages as well, otherwise you won't be able to compile Tux Paint + (and other programs) from source! - Installing: - ----------- - 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: + Installng: - $ su + 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: - 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: + $ su - # make install + 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: - Finally, you can switch back to your regular user by exiting - superuser mode: + # make install - # exit + Finally, you can switch back to your regular user by exiting + superuser mode: + # exit - Alternatively, you may be able to simply use the "sudo" command - (e.g., on Ubuntu Linux): + Alternatively, you may be able to simply use the "sudo" command + (e.g., on Ubuntu Linux): - $ sudo make install - - - NOTE: By default, "tuxpaint", the executable program, is - placed in "/usr/local/bin/". The data files (images, sounds, etc.) - are placed in "/usr/local/share/tuxpaint/". + $ sudo make install + Note: By default, "tuxpaint", the executable program, is placed in + "/usr/local/bin/". The data files (images, sounds, etc.) are placed + in "/usr/local/share/tuxpaint/". 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 creation. "PREFIX" is the basis of where all other - files go, and is, by default, set to "/usr/local". - Other variables are: - BIN_PREFIX - Where the "tuxpaint" binary will be installed. - (Set to "$(PREFIX)/bin" by default - e.g., "/usr/local/bin") + 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 creation. "PREFIX" is the basis of where + all other files go, and is, by default, set to "/usr/local". - 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") + Other variables are: - DOC_PREFIX - Where the documentation text files (the "docs" directory) will go. - (Set to "$(PREFIX)/share/doc/tuxpaint") + BIN_PREFIX + Where the "tuxpaint" binary will be installed. (Set to + "$(PREFIX)/bin" by default - e.g., "/usr/local/bin") - MAN_PREFIX - Where the manual page for Tux Paint will go. - (Set to "$(PREFIX)/share/man") + 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") - 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. + DOC_PREFIX + Where the documentation text files (the "docs" directory) + will go. (Set to "$(PREFIX)/share/doc/tuxpaint") - 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.) + MAN_PREFIX + Where the manual page for Tux Paint will go. (Set to + "$(PREFIX)/share/man") - FIXME: This list is out of date. See Makefile and Makefile-i18n for - a complete list. + 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 + 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. Debugging: ----------- - Debugging (to stdout, e.g. terminal, or to a "stdout.txt" file, on Windows) - can be enabled by setting "DEBUG" (and, if verbose logging is wanted, - "VERBOSE") #define's in src/debug.h. + Debugging (to "STDOUT", e.g. to the terminal, or to a "stdout.txt" file, + on Windows) can be enabled by setting "DEBUG" (and, if verbose logging + is wanted, "VERBOSE") #defines in "src/debug.h". Uninstalling Tux Paint: ------------------------ + Windows - ------- + 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 - 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. - When it has finished, click on the close button. + 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. - It is also possible to use the entry "TuxPaint (remove only)" in the - Control Panel Add/Remove programs section. + When it has finished, click on the close button. - NOTE: because the pictures that are created are saved inside the Tux Paint - folder, this folder and the 'userdata' folder inside it are NOT removed. + Using the Control Panel + It is also possible to use the entry "TuxPaint (remove only)" in the + Control Panel Add/Remove programs section. Linux - ----- - Within the Tux Paint source directory (where you compiled Tux Paint), - you can use a 'Makefile' target to uninstall Tux Paint. - By default, this must be done by the "root" user ('superuser'). - (See the installation instructions above for further information.) - Switch to "root" by typing the command: - - $ su - - Enter "root"'s password at the prompt. You should now be "root" - (with a prompt like "#"). To uninstall the program and its data files - (the default rubber-stamp images, if any, will also be removed), type: - - # make uninstall - - Finally, you can switch back to your regular user by exiting - superuser mode: - - # exit + 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 be done by the "root" user ('superuser'), but if + you installed Tux Paint somewhere else (e.g., using a "PREFIX=..." + setting to "make" and "make install"), you may not, and will want to + provide those same settings here. (See the installation instructions + above for further information.) diff --git a/docs/en/OPTIONS.txt b/docs/en/OPTIONS.txt index f3682818b..850d677dc 100644 --- a/docs/en/OPTIONS.txt +++ b/docs/en/OPTIONS.txt @@ -3,19 +3,19 @@ Options Documentation - Copyright (c) 2002-2021 by various contributors; see AUTHORS.txt + Copyright © 2002-2021 by various contributors; see AUTHORS. http://www.tuxpaint.org/ - January 18, 2021 + 22 January 2021 ---------------------------------------------------------------------- Tux Paint Config. - As of Tux Paint version 0.9.14, a graphical tool is available that - allows you to change Tux Paint's behavior. However, if you'd rather not - install and use this tool, or want a better understanding of the - available options, please continue reading. + A graphical tool is available that allows you to change Tux Paint's + behavior. However, if you'd rather not install and use this tool, or + want a better understanding of the available options, please continue + reading. ---------------------------------------------------------------------- @@ -176,8 +176,8 @@ Windows Users 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"). + 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. @@ -187,10 +187,9 @@ Windows Users (Linux and Unix only) Use the command COMMAND to print a PostScript format file when - the 'Print' button is clicked while the [Alt] modifier key is - being held. (This is typically used for providing a print - dialog, similar to when pressing [Alt]+'Print' in Windows and - macOS.) + the 'Print' button is clicked while the modifier key is being + held. (This is typically used for providing a print dialog, + similar to when pressing [Alt]+'Print' in Windows and macOS.) If this option is not specifically not set, the default command is KDE's graphical print dialog: @@ -202,12 +201,12 @@ Windows Users (Windows and macOS only) Tux Paint will use a printer configuration file when printing. - Push the [Alt] key while clicking the 'Print' button in - Tux Paint to cause a Windows print dialog window to appear. + 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 + saved to the file "userdata/print.cfg" , and used again, as long as the "printcfg" option is set. altprint=always @@ -259,7 +258,7 @@ Windows Users To make Tux Paint ignore the lockfile, allowing it to run again, even if it was just launched less than 30 seconds ago, enable this setting in the configuration file, or run Tux Paint with - the '--nolockfile' option on the command-line. + the --nolockfile option on the command-line. By default, the lockfile is stored in "~/.tuxpaint/" under Linux and Unix, and "userdata\" under Windows. @@ -334,9 +333,8 @@ Windows Users sysfonts=yes This option causes Tux Paint to attempt to load fonts (for use - in the Text tool) from your operating system. Normally, - Tux Paint will only load the ones that came bundled with - Tux Paint. + in the Text tool) from your operating system. Normally, Tux + Paint will only load the ones that came bundled with Tux Paint. alllocalefonts=yes @@ -446,63 +444,63 @@ Windows Users joystick-btn-brush=BUTTON NUMBER Selects the joystick button number, as seen by SDL, that will be - a shortcurt to select the brush tool. + a shortcut to select the brush tool. joystick-btn-stamp=BUTTON NUMBER Selects the joystick button number, as seen by SDL, that will be - a shortcurt to select the stamp tool. + a shortcut to select the stamp tool. joystick-btn-lines=BUTTON NUMBER Selects the joystick button number, as seen by SDL, that will be - a shortcurt to select the lines tool. + a shortcut to select the lines tool. joystick-btn-shapes=BUTTON NUMBER Selects the joystick button number, as seen by SDL, that will be - a shortcurt to select the shapes tool. + a shortcut to select the shapes tool. joystick-btn-text=BUTTON NUMBER Selects the joystick button number, as seen by SDL, that will be - a shortcurt to select the text tool. + a shortcut to select the text tool. joystick-btn-label=BUTTON NUMBER Selects the joystick button number, as seen by SDL, that will be - a shortcurt to select the label tool. + a shortcut to select the label tool. joystick-btn-magic=BUTTON NUMBER Selects the joystick button number, as seen by SDL, that will be - a shortcurt to select the magic tool. + a shortcut to select the magic tool. joystick-btn-undo=BUTTON NUMBER Selects the joystick button number, as seen by SDL, that will be - a shortcurt to the undo tool. + a shortcut to invoke the undo tool. joystick-btn-redo=BUTTON NUMBER Selects the joystick button number, as seen by SDL, that will be - a shortcurt to the redo tool. + a shortcut to select redo tool. joystick-btn-eraser=BUTTON NUMBER Selects the joystick button number, as seen by SDL, that will be - a shortcurt for selecting the eraser tool. + a shortcut to select eraser tool. joystick-btn-new=BUTTON NUMBER Selects the joystick button number, as seen by SDL, that will be - a shortcurt to launch the dialog for opening a new draw. + a shortcut to launch the dialog for creating a new drawing. joystick-btn-open=BUTTON NUMBER Selects the joystick button number, as seen by SDL, that will be - a shortcurt to launch the dialog for opening an existing draw. + a shortcut to launch the dialog for opening an existing drawing. joystick-btn-save=BUTTON NUMBER Selects the joystick button number, as seen by SDL, that will be - a shortcurt for saving the draw. + a shortcut to save the drawing. joystick-btn-pgsetup=BUTTON NUMBER Selects the joystick button number, as seen by SDL, that will be - a shortcurt to launch the page setup dialog for printing. + a shortcut to launch the page setup dialog for printing. joystick-btn-print=BUTTON NUMBER Selects the joystick button number, as seen by SDL, that will be - a shortcurt to print. + a shortcut to print. joystick-buttons-ignore=BUTTON1,BUTTON2,... A set of joystick button numbers, as seen by SDL, that should be @@ -518,7 +516,7 @@ Windows Users stamp, which depends on the stamp itself, and Tux Paint's current canvas size. - Specifc "default" to let Tux Paint decide (it's standard + Specify "default" to let Tux Paint decide (its standard behavior). keyboard=yes @@ -529,7 +527,7 @@ Windows Users Features: - * Fine movement within canvas, or coarse movement if [Shift] + * Fine movement within canvas, or coarse movement if default is held. * Coarse movement within tool button areas. * Key controls: @@ -567,18 +565,16 @@ Windows Users If you do not override it, the default location is: * Linux & Unix — Under a hidden directory named ".tuxpaint" - in your home directory (aka "~" or "$HOME") - Example: "/home/username/.tuxpaint/saved/" - + in your home directory (aka ".tuxpaint" or "~") + Example: /home/username/.tuxpaint/saved/ * Windows — Inside a folder named "TuxPaint" in your "Application Data" folder. - Example: - "C:\Documents and Settings\Username\Application Data\TuxPaint\saved\" - + Example: C:\Documents and Settings\Username\Application + Data\TuxPaint\saved\ * macOS — Inside a folder named "TuxPaint" in your "Application Support" folder. - Example: - "/Users/Username/Library/Application Support/TuxPaint/saved/" + Example: /Users/Username/Library/Application + Support/TuxPaint/saved/ Note: When specifying a Windows drive (e.g., "H:\"), you must also specify a subdirectory. @@ -596,22 +592,18 @@ Windows Users Use this option to change where Tux Paint exports files — single images, or animated GIF slideshows — for external use. - If you do not override it, the default location is determined as - follows: + If you do not override it, the default location is: * Linux & Unix — If available, wherever your desktop environment is configured for pictures to be stored, based on your XDG (X Desktop Group) configuration. (Try running the command-line "xdg-user-dir PICTURES" to find out.) - - Typically (in an English locale), this will be a - "Pictures/" subdirectory in your home directory (i.e., - "$HOME/Pictures/" aka "~/Pictures"). - + Typically (in an English locale), this will be a "Pictures" + subdirectory in your home directory (i.e., "$HOME/Pictures" + aka "~/Pictures"). Tux Paint will fall back to using that typical directory, of no XDG configuration can be read, or nothing is set for "XDG_PICTURES_DIR". - * Windows — TBD! * macOS — TBD! @@ -623,9 +615,9 @@ Windows Users The directory itself (e.g., "~/Pictures/TuxPaint") will be created, if it doesn't exist. - If the parent directory (e.g., "~/Pictures") also does not - exist, Tux Paint will attempt to create it as well (but not any - directories higher than that). + If the parent directory (e.g., "~/Pictures/TuxPaint") also does + not exist, Tux Paint will attempt to create it as well (but not + any directories higher than that). Example: exportdir=/home/penguin/TuxPaintExports @@ -636,24 +628,22 @@ Windows Users specific to the current user). Tux Paint will search for subdirectories/subfolders named - "brushes", "stamps", "starters", "templates", and "fonts" under + "brushes", "stamps", "3$brushes", "templates", and "fonts" under the specified data directory. If you do not override it, the default location is: * Linux & Unix — Under a hidden directory named ".tuxpaint" - in your home directory (aka "~" or "$HOME") - Example: "/home/username/.tuxpaint/brushes/" - + in your home directory (aka ".tuxpaint" or "~") + Example: /home/username/.tuxpaint/brushes/ * Windows — Inside a folder named "TuxPaint" in your "Application Data" folder. - Example: - "C:\Documents and Settings\Username\Application Data\TuxPaint\brushes\" - + Example: C:\Documents and Settings\Username\Application + Data\TuxPaint\brushes\ * macOS — Inside a folder named "TuxPaint" in your "Application Support" folder. - Example: - "/Users/Username/Library/Application Support/TuxPaint/brushes/" + Example: /Users/Username/Library/Application + Support/TuxPaint/brushes/ 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 @@ -700,16 +690,16 @@ Windows Users You may override Tux Paint's default color palette by creating a plain ASCII text file that describes the colors you want, and - pointing to that file using the colorfile option. + pointing to that file using the "colorfile" option. The file should list one color per line. Colors are defined in terms of their Red, Green and Blue values, each from 0 (off) to 255 (brightest). (For more information, try Wikipedia's "RGB color model" article.) - Colors may be listed using three decimal numbers (e.g., - "255 68 136") or a 6- or 3-digit-long hexadecimal 'triplet' - (e.g., "#ff4488" or "#F48"). + Colors may be listed using three decimal numbers (e.g., "255 68 + 136") or a 6- or 3-digit-long hexadecimal 'triplet' (e.g., + "#ff4488" or "#F48"). After the color definition (on the same line) you may enter text to describe the color. Tux will display this text when the color @@ -987,7 +977,7 @@ Windows Users ---------------------------------------------------------------------- - Overriding System Config. Options using .tuxpaintrc + Overriding System Config. Options (For Linux and Unix users) @@ -1138,8 +1128,8 @@ Windows Users strings (e.g., "de_DE" for German) to use. (If your locale is already set, e.g. with the "$LANG" - environment variable, this option is not necessary, since - Tux Paint honors your environment's setting, if possible.) + environment variable, this option is not necessary, since Tux + Paint honors your environment's setting, if possible.) --nosysconfig @@ -1154,15 +1144,14 @@ Windows Users Command-Line Informational Options - The following options display some informative text on the screen. - Tux Paint doesn't actually start up and run afterwards, however. + The following options display some informative text on the screen. Tux + Paint doesn't actually start up and run afterwards, however. --version --verbose-version Display the version number and date of the copy of Tux Paint you are running. The "--verbose-version" also lists what - compile-time options were set. (See INSTALL.txt and - FAQ.txt). + compile-time options were set. (See INSTALL and FAQ). --copying Show brief license information about copying Tux Paint. @@ -1506,17 +1495,17 @@ Setting Your Environment's Locale 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 may need to edit the file - "/var/lib/locales/supported.d/local" first, and add locales they - want, from the list found in "/usr/share/i18n/SUPPORTED". + 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 edit the file "dpkg-reconfigure locales" + first, and add locales they want, from the list found in + "/var/lib/locales/supported.d/local". Then, before running Tux Paint, set your "$LANG" environment variable to one of the locales listed above. (If you want all programs that can be translated to be, you may wish to place the - following in your login script; e.g. ~/.profile, ~/.bashrc, - ~/.cshrc, etc.) + following in your login script; e.g. "~/.profile", "~/.bashrc", + "~/.cshrc", etc.) For example, in a Bourne Shell (like BASH): @@ -1536,41 +1525,16 @@ Setting Your Environment's Locale files by default. So this section is only for people trying different languages. - The simplest thing to do is to use the '--lang' switch in the - shortcut (see "INSTALL.txt"). However, by using an MSDOS Prompt - window, it is also possible to issue a command like this: + The simplest thing to do is to use the "--lang" switch in the + shortcut (see "INSTALL"). However, by using an MSDOS Prompt window, + it is also possible to issue a command like this: set LANG=es_ES ...which will set the language for the lifetime of that DOS window. For something more permanent, try editing your computer's - 'autoexec.bat' file using Windows' "sysedit" tool: - - Windows 95/98 - - 1. Click on the 'Start' button, and select 'Run...'. - 2. Type "sysedit" into the 'Open:' box (with or without quotes). - 3. Click 'OK'. - 4. Locate the AUTOEXEC.BAT window in the System Configuration - Editor. - 5. Add the following at the bottom of the file: - - set LANG=es_ES - - 6. Close the System Configuration Editor, answering yes to save the - changes. - 7. Restart your machine. - - To affect the entire machine, and all applications, it is possible - to use the "Regional Settings" control panel: - - 1. Click on the 'Start' button, and select - 'Settings | Control Panel'. - 2. Double click on the "Regional Settings" globe. - 3. Select a language/region from the drop down list. - 4. Click 'OK'. - 5. Restart your machine when prompted. + "autoexec.bat" file using Windows' "sysedit" tool: Special Fonts @@ -1585,8 +1549,8 @@ Setting Your Environment's Locale Tux Paint was built without Pango support, special fonts should no longer be necessary. - When running Tux Paint in a language that requires its own font, - Tux Paint will try to load the font file from its system-wide "fonts" + When running Tux Paint in a language that requires its own font, Tux + Paint will try to load the font file from its system-wide "fonts" directory (under a "locale" subdirectory). The name of the file corresponds to the first two letters in the 'locale' code of the language (e.g., "ko" for Korean, "ja" for Japanese, "zh_tw" for diff --git a/docs/en/PNG.txt b/docs/en/PNG.txt index 89bdd290a..d931b2973 100644 --- a/docs/en/PNG.txt +++ b/docs/en/PNG.txt @@ -1,149 +1,82 @@ -PNG.txt for Tux Paint + Tux Paint + version 0.9.26 + PNG Documentation -Tux Paint - A simple drawing program for children. + Copyright © 2007-2021 by various contributors; see AUTHORS. + http://www.tuxpaint.org/ -Copyright 2002-2007 by Bill Kendrick and others -bill@newbreedsoftware.com -http://www.tuxpaint.org/ - -June 27, 2002 - June 19, 2007 -$Id$ + 30 January 2021 + ---------------------------------------------------------------------- About PNGs ----------- - PNG is the Portable Network Graphic format. It is an open standard, - not burdened by patents (like GIFs). It is a highly compressed format - (though not "lossy" like JPEGs - lossiness allows files to be much - smaller, but introduces 'mistakes' in the image when saved), and - supports 24-bit color (16.7 million colors) as well as a full - "alpha channel" - that is, each pixel can have a varying degree of - transparency. - For more information, visit: http://www.libpng.org/ + PNG is the Portable Network Graphic format. It is an open standard, not + burdened by patents (like GIFs). It is a highly compressed format (though + not "lossy" like JPEGs - lossiness allows files to be much smaller, but + introduces 'mistakes' in the image when saved), and supports 24-bit color + (16.7 million colors) as well as a full "alpha channel" - that is, each + pixel can have a varying degree of transparency. - These features (openness, losslessness, compression, transparency/alpha) - make it the best choice for Tux Paint. (Tux Paint's support for the PNG - format comes from the Open Source SDL_Image library, which in turn gets - it from the libPNG library.) + For more information, visit: http://www.libpng.org/ - Support for many colors allows photo-quality "rubber stamp" images to - be used in Tux Paint, and alpha transparency allows for high-quality - "paint brushes." + These features (openness, losslessness, compression, transparency/alpha) + make it the best choice for Tux Paint. (Tux Paint's support for the PNG + format comes from the Open Source SDL_Image library, which in turn gets it + from the libPNG library.) + Support for many colors allows photo-quality "rubber stamp" images to be + used in Tux Paint, and alpha transparency allows for high-quality brushes. How To Make PNGs ----------------- - The following is a very _brief_ list of ways to create PNGs or - convert existing images into PNGs. + The following is a very brief list of ways to create PNGs or convert + existing images into PNGs. - Linux/Unix Users - ---------------- - The GIMP - -------- - The best tool with which to create PNG images for use in Tux Paint is - the GNU Image Manipulation Program ("The GIMP"), a high-quality - Open Source interactive drawing and photo editing program. + GIMP & Krita - It's probably already installed on your Linux system. If not, it's - almost definitely available on the install CD or from your - distribution's download site. Otherwise: + Excellent tools with which to create PNG images for use in Tux Paint are + GIMP and Krita, both high-quality Open Source interactive drawing and + photo editing programs. - http://www.gimp.org/ - - - Krita - ----- - Krita is a painting and image editing application for KOffice. - - http://koffice.kde.org/krita/ + It is likely that one or both are already installed on your system. If + not, they should be readily available from your Linux distribution's + software repository. If not, or to learn more, visit http://www.gimp.org/ + and http://www.krita.org/, respectively. + Command-line Tools NetPBM - ------ - The Portable Bitmap tools (collectively known as "NetPBM") is a - collection of Open Source command-line tools which convert to and from - various formats, including GIF, TIFF, BMP, PNG, and many more. - NOTE: The NetPBM formats (Portable Bitmap: PBM, - Portable Greymap: PGM, Portable Pixmap: PPM, and the catch-all - Portable Any Map: PNM) do not support alpha, so any transparency - information (e.g. from within a GIF) will be lost! Use The GIMP! - - It's probably already installed on your Linux system. If not, it's - almost definitely available on the install CD or from your - distribution's download site. Otherwise: - - http://netpbm.sourceforge.net/ + The Portable Bitmap tools (collectively known as "NetPBM") is a collection + of Open Source command-line tools which convert to and from various + formats, including GIF, TIFF, BMP, PNG, and many more. + It is possible that it's already installed on your system. If not, they it + be readily available from your Linux distribution's software repository. + If not, or to learn more, visit http://netpbm.sourceforge.net/. cjpeg/djpeg - ----------- - The "cjpeg" and "djpeg" command-line programs convert between - the NetPBM Portable Any Map (PNM) format and JPEGs. - - It's probably already installed on your Linux system. - (Under Debian, this is available in the package "libjpeg-progs".) - If not, it's almost definitely available on the install CD or from - your distribution's download site. Otherwise: - - ftp://ftp.uu.net/graphics/jpeg/ + The "cjpeg" and "djpeg" command-line programs convert between the NetPBM + Portable Any Map (PNM) format and JPEGs. It is possible that it's already + installed on your system. If not, they it be readily available from your + Linux distribution's software repository. If not, or to learn more, visit + https://jpegclub.org/. Windows Users - ------------- - The Gimp - http://www.gimp.org/~tml/gimp/win32/ - - Canvas (Deneba) - http://www.deneba.com/products/canvas8/default2.html - - CorelDRAW (Corel) - http://www.corel.com/ - - Fireworks (Macromedia) - http://macromedia.com/software/fireworks/ - - Illustrator (Adobe) - http://www.adobe.com/products/illustrator/main.html - - Paint Shop Pro (Jasc) - http://www.jasc.com/products/psp/ - - Photoshop (Adobe) - http://www.adobe.com/products/photoshop/main.html - - PIXresizer (Bluefive software) - http://bluefive.pair.com/pixresizer.htm + * CorelDRAW (Corel) — http://www.corel.com/ + * Illustrator (Adobe) — http://www.adobe.com/products/illustrator.html + * Paint Shop Pro (Corel) — https://www.paintshoppro.com/ + * Photoshop (Adobe) — http://www.adobe.com/products/photoshop.html + * PIXresizer (Bluefive software) — + http://bluefive.pair.com/pixresizer.htm Macintosh Users - --------------- - Canvas (Deneba) - http://www.deneba.com/products/canvas8/default2.html - - CorelDRAW (Corel) - http://www.corel.com/ - - Fireworks (Macromedia) - http://macromedia.com/software/fireworks/ - - GraphicConverter (Lemke Software) - http://www.lemkesoft.de/us_gcabout.html - - Illustrator (Adobe) - http://www.adobe.com/products/illustrator/main.html - - Photoshop (Adobe) - http://www.adobe.com/products/photoshop/main.html - - -More Info. ----------- - The libPNG website lists image editors and image converts that - support the PNG format: - - http://www.libpng.org/pub/png/pngaped.html - http://www.libpng.org/pub/png/pngapcv.html + * CorelDRAW (Corel) — http://www.corel.com/ + * GraphicConverter (Lemke Software) — + https://www.lemkesoft.de/mac-fotobearbeitung-mac-diashow-mac-grafikprogramm-mac-bildbetrachter/ + * Illustrator (Adobe) — http://www.adobe.com/products/illustrator.html + * Photoshop (Adobe) — http://www.adobe.com/products/photoshop.html diff --git a/docs/en/README.txt b/docs/en/README.txt index 515f52aeb..14043883a 100644 --- a/docs/en/README.txt +++ b/docs/en/README.txt @@ -3,19 +3,19 @@ A simple drawing program for children - Copyright 2002-2021 by various contributors; see AUTHORS.txt + Copyright © 2002-2021 by various contributors; see AUTHORS. http://www.tuxpaint.org/ - June 14, 2002 - January 13, 2021 + 2 February 2021 ---------------------------------------------------------------------- +-------------------------------------------+ |Table of Contents | |-------------------------------------------| - | * About | + | * About Tux Paint | | * Using Tux Paint | - | * Loading Tux Paint | + | * Launching Tux Paint | | * Title Screen | | * Main Screen | | * Available Tools | @@ -24,13 +24,14 @@ | * Loading Other Pictures into Tux Paint | | * Further Reading | | * How to Get Help | + | * How to Participate | +-------------------------------------------+ ---------------------------------------------------------------------- - About + About Tux Paint -What Is 'Tux Paint?' +What Is "Tux Paint"? Tux Paint is a free drawing program designed for young children (kids ages 3 and up). It has a simple, easy-to-use interface, fun sound @@ -58,7 +59,7 @@ Objectives: cartoon-style mouse pointer shapes. Extensibility - Tux Paint is extensible. Brushes and "rubber stamp" shapes can + Tux Paint is extensible. Brushes and 'rubber stamp' shapes can be dropped in and pulled out. For example, a teacher can drop in a collection of animal shapes and ask their students to draw an ecosystem. Each shape can have a sound which is @@ -68,9 +69,8 @@ Objectives: Portability Tux Paint is portable among various computer platforms: Windows, Macintosh, Linux, etc. The interface looks the same - among them all. Tux Paint runs suitably well on older systems - (like a Pentium 133), and can be built to run better on slow - systems. + among them all. Tux Paint runs suitably well on older systems, + and can be built to run better on slow systems. Simplicity There is no direct access to the computer's underlying @@ -84,7 +84,7 @@ Objectives: Using Tux Paint -Loading Tux Paint +Launching Tux Paint Linux/Unix Users @@ -97,33 +97,33 @@ Loading Tux Paint $ tuxpaint If any errors occur, they will be displayed on the terminal (to - "stderr"). + STDERR). ---------------------------------------------------------------------- Windows Users - [Icon] - Tux Paint + [Tux Paint Icon] + Tux Paint - If you installed Tux Paint on your computer using the - 'Tux Paint Installer,' it will have asked you whether you wanted a - 'Start' menu short-cut, and/or a desktop shortcut. If you agreed, - you can simply run Tux Paint from the 'Tux Paint' section of your - 'Start' menu (e.g., under "All Programs" on Windows XP), or by - double-clicking the "Tux Paint" icon on your desktop. + If you installed Tux Paint on your computer using the 'Tux Paint + Installer,' it will have asked you whether you wanted a 'Start' menu + short-cut, and/or a desktop shortcut. If you agreed, you can simply + run Tux Paint from the 'Tux Paint' section of your 'Start' menu + (e.g., under 'All Programs'), or by double-clicking the 'Tux Paint' + icon on your desktop, if you had the installer place one there. - If you installed Tux Paint using the 'ZIP-file' download, or if you - used 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. + 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 "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 the - installer ran. + "C:\Program Files\", 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 put it when you unzipped the ZIP file. + wherever you extracted the contents of the ZIP file. ---------------------------------------------------------------------- @@ -137,11 +137,11 @@ Title Screen When Tux Paint first loads, a title/credits screen will appear. - [Title Screenshot] + [Title screen] - Once loading is complete, press a key or click on the mouse to - continue. (Or, after about 30 seconds, the title screen will go away - automatically.) + Once loading is complete, press a key or click or tap in the Tux Paint + window to continue. (Or, after about 5 seconds, the title screen will + go away automatically.) ---------------------------------------------------------------------- @@ -161,19 +161,21 @@ Main Screen The largest part of the screen, in the center, is the drawing canvas. This is, obviously, where you draw! - [(Canvas)] + [Canvas] Note: The size of the drawing canvas depends on the size of - Tux Paint. You can change the size of Tux Paint using the - Tux Paint Config. configuration tool, or by other means. See - the OPTIONS documentation for more details. + Tux Paint. You can change the size of Tux Paint using the Tux + Paint Config. configuration tool, or by other means. See the + Options documentation for more details. Right Side: Selector Depending on the current tool, the selector shows different - things. e.g., when the Paint Brush tool is selected, it shows - the various brushes available. When the Rubber Stamp tool is - selected, it shows the different shapes you can use. + things. e.g., when the Paint Brush or Line tool is selected, + it shows the various brushes available. When the Rubber Stamp + tool is selected, it shows the different shapes you can use. + When the Text or Label tool is selected, it shows various + fonts. [Selectors - Brushes, Letters, Shapes, Stamps] @@ -185,22 +187,22 @@ Main Screen [Colors - Black, White, Red, Pink, Orange, Yellow, Green, Cyan, Blue, Purple, Brown, Grey] - On the far right are two special color options, the - "color picker", which has an outline of an eye-dropper, and - allows you to pick a color found within your drawing, and the - rainbow palette, which allows you to pick a color from within - a box containing thousands of colors. + On the far right are two special color options, the "color + picker", which has an outline of an eye-dropper, and allows + you to pick a color found within your drawing, and the rainbow + palette, which allows you to pick a color from within a box + containing thousands of colors. - (NOTE: You can define your own colors for Tux Paint. See the + (Note: You can define your own colors for Tux Paint. See the "Options" documentation.) Bottom: Help Area At the very bottom of the screen, Tux, the Linux Penguin, - provides tips and other information while you draw. + provides tips and other information while you use Tux Paint. -(For example: 'Pick a shape. Click to pick the center, drag, then let go when it - is the size you want. Move around to rotate it, and click to draw it.) +(Example tip: 'Pick a shape. Click to pick the center, drag, then let go when it + is the size you want. Move around to rotate it, and click to draw it.') ---------------------------------------------------------------------- @@ -208,7 +210,7 @@ Available Tools Drawing Tools - Paint (Brush) + "Paint" Tool (Brush) The Paint Brush tool lets you draw freehand, using various brushes (chosen in the Selector on the right) and colors @@ -222,7 +224,7 @@ Available Tools ---------------------------------------------------------------------- - Stamp (Rubber Stamp) + "Stamp" Tool (Rubber Stamps) The Stamp tool is like a set of rubber stamps or stickers. It lets you paste pre-drawn or photographic images (like a @@ -230,11 +232,12 @@ Available Tools As you move the mouse around the canvas, an outline follows the mouse, showing where the stamp will be placed, and how - big it will be. + big it will be. Click to place the stamp. There can be numerous categories of stamps (e.g., animals, plants, outer space, vehicles, people, etc.). Use the Left - and Right arrows to cycle through the collections. + and Right arrows near the bottom of the Selector to cycle + through the collections. Prior to 'stamping' an image onto your drawing, various effects can sometimes be applied (depending on the stamp): @@ -252,18 +255,18 @@ Available Tools right. Different stamps can have different sound effects and/or - descriptive (spoken) sounds. Buttons at the lower left (near - Tux, the Linux penguin) allow you to re-play the sound - effects and descriptive sounds for the currently-selected - stamp. + descriptive (spoken) sounds. Buttons in the Help Area at the + lower left (near Tux, the Linux penguin) allow you to + re-play the sound effects and descriptive sounds for the + currently-selected stamp. - (NOTE: If the "nostampcontrols" option is set, Tux Paint + (Note: If the "nostampcontrols" option is set, Tux Paint won't display the Mirror, Flip, Shrink and Grow controls for stamps. See the "Options" documentation.) ---------------------------------------------------------------------- - Lines + "Lines" Tool This tool lets you draw straight lines using the various brushes and colors you normally use with the Paint Brush. @@ -277,7 +280,7 @@ Available Tools ---------------------------------------------------------------------- - Shapes + "Shapes" Tool This tool lets you draw some simple filled, and un-filled shapes. @@ -302,7 +305,7 @@ Available Tools starting with Tux Paint version 0.9.25.) Note: If shape controls are disabled (e.g., with the - "--noshapecontrols" option), the controls will not be + "noshapecontrols" option), the controls will not be presented, and the "shapes from center" method will be used. In the canvas, click the mouse and hold it to stretch the @@ -313,7 +316,7 @@ Available Tools Let go of the mouse when you're done stretching. - Normal Mode + Normal Shapes Mode Now you can move the mouse around the canvas to rotate the shape. @@ -323,13 +326,13 @@ Available Tools Simple Shapes Mode If simple shapes are enabled (e.g., with the - "--simpleshapes" option), the shape will be - drawn on the canvas when you let go of the - mouse button. (There's no rotation step.) + "simpleshapes" option), the shape will be drawn + on the canvas when you let go of the mouse + button. (There's no rotation step.) ---------------------------------------------------------------------- - Text and Label + "Text" and "Label" Tools Choose a font (from the 'Letters' available on the right) and a color (from the color palette near the bottom). Click @@ -343,13 +346,13 @@ Available Tools the picture, but the cursor will move to the right of the text, rather than down a line, and to the left. (This can be useful to create a line of text with mixed colors, fonts, - styles and sizes: Like this.) + styles and sizes.) Clicking elsewhere in the picture while the text entry is still active causes the current line of text to move to that location (where you can continue editing it). - Text versus Label + "Text" versus "Label" The Text tool is the original text-entry tool in Tux Paint. Text entered using this tool @@ -368,9 +371,9 @@ Available Tools edited later. The Label tool can be disabled (e.g., by - selecting "Disable 'Label' Tool" in - Tux Paint Config. or running Tux Paint with the - "--nolabel" command-line option). + selecting "Disable 'Label' Tool" in Tux Paint + Config. or running Tux Paint with the "nolabel" + option). International Character Input @@ -395,45 +398,54 @@ Available Tools the characters you're trying to type. * Japanese — Romanized Hiragana and - Romanized Katakana — right [Alt] - * Korean — Hangul 2-Bul — right [Alt] or - left [Alt] - * Traditional Chinese — right [Alt] or - left [Alt] - * Thai — right [Alt] + Romanized Katakana — right [Alt] key + * Korean — Hangul 2-Bul — right [Alt] key or + left [Alt] key + * Traditional Chinese — right [Alt] key or + left [Alt] key + * Thai — right [Alt] key + + On-screen Keyboard + + An optional on-screen keyboard is available for + the Text and Label tools, which can provide a + variety of layouts and character composition + (e.g., composing "a" and "e" into "æ"). See the + "Options" and "Extending Tux Paint" + documentation for more information. ---------------------------------------------------------------------- - Fill + "Fill" Tool The 'Fill' tool 'flood-fills' a contiguous area of your drawing with a solid color of your choice. - Note: Prior to Tux Paint 0.9.24, this was a "Magic" tool - (see below). + Note: Prior to Tux Paint 0.9.24, this was a Magic tool (see + below). ---------------------------------------------------------------------- - Magic (Special Effects) + "Magic" Tool (Special Effects) - The 'Magic' tool is actually a set of special tools. Select - one of the "magic" effects from the selector on the right. + The Magic tool is actually a set of special tools. Select + one of the 'magic' effects from the selector on the right. Then, depending on the tool, you can either click and drag around the picture, and/or simply click the picture once, to apply the effect. If the tool can be used by clicking and dragging, a 'painting' button will be available on the left, below the - list of "magic" tools on the right side of the screen. If - the tool can affect the entire picture at once, an - 'entire picture' button will be available on the right. + list of Magic tools on the right side of the screen. If the + tool can affect the entire picture at once, an 'entire + picture' button will be available on the right. See the instructions for each Magic tool (in the 'magic-docs' folder). ---------------------------------------------------------------------- - Eraser + "Eraser" Tool This tool is similar to the Paint Brush. Wherever you click (or click and drag), the picture will be erased. (This may @@ -441,51 +453,51 @@ Available Tools depending on the picture.) A number of eraser sizes are available, both round and - square.. + square. As you move the mouse around, a square outline follows the pointer, showing what part of the picture will be erased to white. - As you erase, a "squeaky clean" eraser/wiping sound is + As you erase, a 'squeaky clean' eraser wiping sound is played. ---------------------------------------------------------------------- Other Controls - Undo + "Undo" Command Clicking this tool will undo the last drawing action. You can even undo more than once! - Note: You can also press [Control]-[Z] on the keyboard to - undo. + Note: You can also press [Control] + [Z] on the keyboard to + Undo. ---------------------------------------------------------------------- - Redo + "Redo" Command Clicking this tool will redo the drawing action you just - "undid" with the 'Undo' button. + un-did with the 'Undo' button. As long as you don't draw again, you can redo as many times - as you had "undone!" + as you had undone! - Note: You can also press [Control]-[R] on the keyboard to - redo. + Note: You can also press [Control] + [R] on the keyboard to + Redo. ---------------------------------------------------------------------- - New + "New" Command - Clicking the "New" button will start a new drawing. A dialog + Clicking the 'New' button will start a new drawing. A dialog will appear where you may choose to start a new picture using a solid background color, or using a 'Starter' or 'Template' image (see below). You will first be asked whether you really want to do this. - Note: You can also press [Control]-[N] on the keyboard to + Note: You can also press [Control] + [N] on the keyboard to start a new drawing. 'Starter' & Template Images @@ -509,54 +521,54 @@ Available Tools When you load a 'Starter' or 'Template', draw on it, and then click 'Save,' it creates a new picture file — it doesn't overwrite the original, so you can use it again - later (by accessing it from the 'New' dialoge).. + later (by accessing it from the 'New' dialog). ---------------------------------------------------------------------- - Open + "Open" Command This shows you a list of all of the pictures you've saved. - If there are more than can fit on the screen, use the "Up" - and "Down" arrows at the top and bottom of the list to - scroll through the list of pictures. + If there are more than can fit on the screen, use the up and + down arrows at the top and bottom of the list to scroll + through the list of pictures. - Click a picture to select it, then... + Click a picture to select it, and then... - * Click the green "Open" button at the lower left of + * Click the green 'Open' button at the lower left of the list to load the selected picture. (Alternatively, you can double-click a picture's icon to load it.) - * Click the brown "Erase" (trash can) button at the + * Click the brown 'Erase' (trash can) button at the lower right of the list to erase the selected picture. (You will be asked to confirm.) Note: As of version 0.9.22, the picture will be placed in your desktop's trash can, on Linux only. - * Click the "Export" button near the lower right to + * Click the 'Export' button near the lower right to export the image to your export folder. (e.g., "~/Pictures/TuxPaint/") - * Click the blue "Slides" (slide projector) button at + * Click the blue 'Slides' (slide projector) button at the lower left to go to slideshow mode. See "Slides", below, for details. - * Or click the red "Back" arrow button at the lower - right of the list to cancel and return to the picture - you were drawing. + * Click the red 'Back' arrow button at the lower right + of the list to cancel and return to the picture you + were drawing. If choose to open a picture, and your current drawing hasn't been saved, you will be prompted as to whether you want to save it or not. (See "Save," below.) - Note: You can also press [Control]-[O] on the keyboard to - get the 'Open' dialog. + Note: You can also press [Control] + [N] on the keyboard to + bring up the 'Open' dialog. ---------------------------------------------------------------------- - Save + "Save" Command This saves your current picture. @@ -568,21 +580,21 @@ Available Tools will simply save the picture, and play a "camera shutter" sound effect. - If you HAVE saved the picture before, or this is a picture + If you have saved the picture before, or this is a picture you just loaded using the "Open" command, you will first be asked whether you want to save over the old version, or create a new entry (a new file). - (NOTE: If either the "saveover" or "saveovernew" options are + Note: If either the "saveover" or "saveovernew" options are set, it won't ask before saving over. See the "Options" - documentation.) + documentation. - Note: You can also press [Control]-[S] on the keyboard to + Note: You can also press [Control] + [S] on the keyboard to save. ---------------------------------------------------------------------- - Print + "Print" Command Click this button and your picture will be printed! @@ -593,26 +605,22 @@ Available Tools Disabling Printing - If the "noprint" option was set (either with - "noprint=yes" in Tux Paint's configuration - file, or using "--noprint" on the - command-line), the "Print" button will be - disabled. + The "noprint" option can be set, which will + disable Tux Paint's 'Print' button. - See the "Options" documentation.) + See the "Options" documentation. Restricting Printing - If the "printdelay" option was used (either - with "printdelay=SECONDS" in the configuration - file, or using "--printdelay=SECONDS" on the - command-line), you can only print once every - SECONDS seconds. + The "printdelay" option can be set, which will + only allow occasional printing — once every so + many seconds, as configured by you. - For example, with "printdelay=60", you can - print only once a minute. + For example, with "printdelay=60" in Tux + Paint's configuration file, printing can only + occur once per minute (60 seconds). - See the "Options" documentation.) + See the "Options" documentation. Printing Commands @@ -625,24 +633,24 @@ Available Tools lpr - This command can be changed by setting the - "printcommand" value in Tux Paint's + This command can be changed by setting a + "printcommand" option in Tux Paint's configuration file. - If the [Alt] key on the keyboard is being - pushed while clicking the 'Print' button, as - long as you're not in fullscreen mode, an + An alternative print command can be invoked by + holding the "[Alt]" key on the keyboard while + clicking clicking the 'Print' button, as long + as you're not in fullscreen mode, an alternative program is run. By default, the program is KDE's graphical print dialog: kprinter - This command can be changed by setting the - "altprintcommand" value in Tux Paint's + This command can be changed by setting a + "altprintcommand" option in Tux Paint's configuration file. - For information on how to change the printing - commands, see the "Options" documentation. + See the "Options" documentation. Printer Settings @@ -653,57 +661,56 @@ Available Tools 'Print' button is pushed. However, if you hold the [Alt] (or [Option]) - key on the keyboard while pushing the button, - as long as you're not in fullscreen mode, your - operating system's printer dialog will appear, - where you can change the settings. + key on the keyboard while clicking the 'Print' + button, as long as you're not in fullscreen + mode, your operating system's printer dialog + will appear, where you can change the settings. You can have the printer configuration changes - stored by using the "printcfg" option, either - by using "--printcfg" on the command-line, or - "printcfg=yes" in Tux Paint's own configuration - file ("tuxpaint.cfg"). + stored between Tux Paint sessions by setting + the "printcfg" option. If the "printcfg" option is used, printer settings will be loaded from the file - "print.cfg" in your personal folder (see + "printcfg.cfg" in your personal folder (see below). Any changes will be saved there as well. - See the "Options" documentation.) + See the "Options" documentation. Printer Dialog Options By default, Tux Paint only shows the printer dialog (or, on Linux/Unix, runs the - "altprintcommand", e.g., "kprinter" instead of - "lpr") if the [Alt] (or [Option]) key is held - while clicking the 'Print' button. + "altprintcommand"; e.g., "altprintcommand" + instead of "kprinter") if the [Alt] (or + [Option]) key is held while clicking the + 'Print' button. However, this behavior can be changed. You can have the printer dialog always appear by using "--altprintalways" on the command-line, or "altprint=always" in Tux Paint's configuration - file. Or, you can prevent the [Alt]/[Option] - key from having any effect by using - "--altprintnever", or "altprint=never". + file. Conversely, you can prevent the + [Alt]/[Option] key from having any effect by + using "--altprintnever", or "altprint=never". - See the "Options" documentation.) + See the "Options" documentation. ---------------------------------------------------------------------- - Slides (under "Open") + "Slides" Command (under "Open") - The "Slides" button is available in the "Open" dialog. It + The 'Slides' button is available in the 'Open' dialog. It can be used to play a simple animation within Tux Paint, or a slideshow of pictures. It can also export an animated GIF based on the chosen images. Chosing pictures - When you enter the "Slides" section of - Tux Paint, it displays a list of your saved - files, just like the "Open" dialog. + When you enter the 'Slides' section of Tux + Paint, it displays a list of your saved files, + just like the 'Open' dialog. Click each of the images you wish to display in a slideshow-style presentation, one by one. A @@ -717,7 +724,7 @@ Available Tools Set playback speed A sliding scale at the lower left of the screen - (next to the "Play" button) can be used to + (next to the 'Play' button) can be used to adjust the speed of the slideshow or animated GIF, from slowest to fastest. Choose the leftmost setting to disable automatic @@ -734,44 +741,44 @@ Available Tools Playback in Tux Paint To play a slideshow within Tux Paint, click the - "Play" button. (Note: If you hadn't selected + 'Play' button. (Note: If you hadn't selected ANY images, then ALL of your saved images will be played in the slideshow!) During the slideshow, press [Space], [Enter] or - [Return], or the [Right Arrow] — or click the - "Next" button at the lower left — to manually - advance to the next slide. Press [Left] to go - back to the previous slide. + [Return], or the [Right arrow] — or click the + 'Next' button at the lower left — to manually + advance to the next slide. Press [Left arrow] + to go back to the previous slide. - Press [Escape], or click the "Back" button at + Press [Escape], or click the 'Back' button at the lower right, to exit the slideshow and return to the slideshow image selection screen. Exporting an animated GIF - Click the "GIF Export" button near the lower + Click the 'GIF Export' button near the lower right to have Tux Paint generate an animated GIF file based on the selected images. Note: At least two images must be selected. (To - export a single image, use the "Export" option - from the "Open" dialog.) If no images are + export a single image, use the 'Export' option + from the main 'Open' dialog.) If no images are selected, Tux Paint will NOT attempt to generate a GIF based on all saved images. - Pressing [Escape] during export will abort the - process, and return you to the "Slideshow" - dialog. + Pressing [Escape] during the export process + will abort the process, and return you to the + 'Slideshow' dialog. - Click "Back" in the slideshow image selection screen to - return to the "Open" dialog. + Click 'Back' in the slideshow image selection screen to + return to the 'Open' dialog. ---------------------------------------------------------------------- - Quit + "Quit" Command - Clicking the "Quit" button, closing the Tux Paint window, or + Clicking the 'Quit' button, closing the Tux Paint window, or pushing the [Escape] key will quit Tux Paint. You will first be prompted as to whether you really want to @@ -783,70 +790,70 @@ Available Tools over the old version, or create a new entry. (See "Save" above.) - NOTE: If the image is saved, it will be reloaded - automatically the next time you run Tux Paint! + Note: If the image is saved, it will be reloaded + automatically the next time you run Tux Paint -- unless the + "startblank" option is set. - NOTE: The "Quit" button and [Escape] key can be disabled - (e.g., by selecting "Disable 'Quit' Button" in - Tux Paint Config. or running Tux Paint with the "--noquit" - command-line option). + Note: The 'Quit' button within Tux Paint, and quitting via + the [Escape] key, may be disabled, via the "noquit" option. In that case, the "window close" button on Tux Paint's title bar (if not in fullscreen mode) or the [Alt] + [F4] key sequence may be used to quit. If neither of those are possible, the key sequence of - [Shift] + [Control] + [Escape] may be used to quit. (See the - "Options" documentation.) + [Shift] + [Control] + [Escape] may be used to quit. + + See the "Options" documentation. ---------------------------------------------------------------------- Sound Muting There is no on-screen control button at this time, but by - pressing [Alt] + [S], sound effects can be disabled and - re-enabled (muted and unmuted) while the program is running. + using the [Alt] + [S] keyboard sequence, sound effects can + be disabled and re-enabled (muted and unmuted) while the + program is running. - Note that if sounds are completely disabled (e.g., by - unselecting "Enable Sound Effects" in Tux Paint Config or - running Tux Paint with the "--nosound" command-line option), - the [Alt] + [S] key sequence has no effect. (i.e., it cannot - be used to turn on sounds when the parent/teacher wants them - disabled.) + Note that if sounds are completely disabled via the + "nosound" option, the [Alt] + [S] key combination has no + effect. (i.e., it cannot be used to turn on sounds when the + parent/teacher wants them disabled.) ---------------------------------------------------------------------- Loading Other Pictures into Tux Paint - Since Tux Paint's 'Open' dialog only displays pictures you created with - Tux Paint, what if you want to load some other picture or photograph - into Tux Paint to edit? + Tux Paint's 'Open' dialog only displays pictures you created with Tux + Paint. So what do you do if you want to load some other drawinng or even + a photograph into Tux Paint, so you can edit or draw on it? - To do so, you simply need to convert the picture into a PNG (Portable - Network Graphic) image file, and place it in Tux Paint's "saved" - directory: + You can simply convert the picture to the format Tux Paint uses — PNG + (Portable Network Graphic) — and place it in Tux Paint's "saved" + directory/folder. Here is where to find it (by default): - Windows Vista + Windows 10, 8, 7, Vista Inside the user's "AppData" folder, e.g.: - "C:\Users\(user name)\AppData\Roaming\TuxPaint\saved\" + "C:\Users\username\AppData\Roaming\TuxPaint\saved\". - Windows 95, 98, ME, 2000, XP + Windows 2000, XP Inside the user's "Application Data" folder, e.g.: "C:\Documents - and Settings\(user name)\Application Data\TuxPaint\saved\" + and Settings\username\Application Data\TuxPaint\saved\". macOS - Inside the user's "Library" folder: - "/Users/(user name)/Library/Application - Support/Tux Paint/saved/" + Inside the user's "Library" folder, e.g.: + "/Users/username/Library/Application Support/Tux Paint/saved/". Linux/Unix Inside a hidden ".tuxpaint" directory, in the user's home - directory: "$(HOME)/.tuxpaint/saved/" + directory ("$HOME"), e.g. "/home/username/.tuxpaint/saved/". - Note: It is from this folder that you can copy or open pictures drawn in - Tux Paint using other applications. + Note: It is also from this folder that you can copy or open pictures + drawn in Tux Paint using other 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. -Using 'tuxpaint-import' +Using the import script, "tuxpaint-import" Linux and Unix users can use the "tuxpaint-import" shell script which gets installed when you install Tux Paint. It uses some NetPBM tools @@ -855,20 +862,20 @@ Using 'tuxpaint-import' It also uses the "date" command to get the current time and date, which is the file-naming convention Tux Paint uses for saved files. - (Remember, you are never asked for a 'filename' when you go to Save or - Open pictures!) + (Remember, you are never asked for a 'filename' when you go to save or + open pictures!) - To use 'tuxpaint-import', simply run the command from a command-line - prompt and provide it the name(s) of the file(s) you wish to convert. + To use this script, simply run it from a command-line prompt, and + provide it the name(s) of the file(s) you wish to convert. - They will be converted and placed in your Tux Paint 'saved' directory. - (Note: If you're doing this for a different user - e.g., your child, + They will be converted and placed in your Tux Paint "saved" directory. + (Note: If you're doing this for a different user (e.g., your child) you'll need to make sure to run the command under their account.) Example: $ tuxpaint-import grandma.jpg - grandma.jpg -> /home/username/.tuxpaint/saved/20020921123456.png + grandma.jpg -> /home/username/.tuxpaint/saved/20210205001249.png jpegtopnm: WRITING A PPM FILE The first line ("tuxpaint-import grandma.jpg") is the command to run. @@ -878,13 +885,13 @@ Using 'tuxpaint-import' Now you can load Tux Paint, and a version of that original picture will be available under the 'Open' dialog. Just double-click its icon! -Doing it Manually +Importing Pictures Manually - Windows, macOS, BeOS, and Haiku users must currently do the conversion - manually. + Windows, macOS, and Haiku users who wish to import arbitrary images + into Tux Paint must do so via a manual process. Load a graphics program that is capable of both loading your picture - and saving a PNG format file. (See the documentation file "PNG.txt" + and saving a PNG format file. (See the documentation file "PNG.html" for a list of suggested software, and other references.) When Tux Paint loads an image that's not the same size as its drawing @@ -892,8 +899,8 @@ Doing it Manually that it fits within the canvas. To avoid having the image stretched or smeared, you can resize it to - Tux Paint's canvas size. This size depends on the size of the - Tux Paint window, or resolution at which Tux Paint is run, if in + Tux Paint's canvas size. This size depends on the size of the Tux + Paint window, or resolution at which Tux Paint is run, if in fullscreen. (Note: The default resolution is 800x600.) See "Calculating Image Dimensions", below. @@ -904,84 +911,87 @@ Doing it Manually YYYYMMDDhhmmss.png * YYYY = Year - * MM = Month (01-12) - * DD = Day (01-31) - * HH = Hour, in 24-hour format (00-23) - * mm = Minute (00-59) - * ss = Second (00-59) + * MM = Month (two digits, "01"-"12") + * DD = Day of month (two digits, "01"-"31") + * HH = Hour (two digits, in 24-hour format, "00"-"23") + * mm = Minute (two digits, "00"-"59") + * ss = Seconds (two digits, "00"-"59") - e.g.: + Example: "20210205001249.png", for 5 February 2021 at 00:12:49. - 20020921130500 - for September 21, 2002, 1:05:00pm - - Place this PNG file in your Tux Paint 'saved' directory. (See above.) + Place this PNG file in your Tux Paint "saved" directory/folder. (See + above.) Calculating Image Dimensions - The width of Tux Paint's canvas is simply the width of the window - (e.g., 640, 800 or 1024 pixels), minus 192. - - Calculating the height of Tux Paint's canvas requires multiple - steps: - - 1. Take the height of the window (e.g, 480, 600 or 768 pixels) and - subtract 144 - 2. Take the result of Step 1 and divide it by 48 - 3. Take the result of Step 2 and round it down (e.g., 9.5 becomes - simply 9) - 4. Take the result of Step 3 and multiply it by 48 - 5. Finally, take the result of Step 4 and add 40 - - Example: Tux Paint running at fullscreen on a 1440x900 display. - - * The canvas width is simply 1440 - 192, or 1248. - * The canvas height is calculated as: - 1. 900 - 144, or 756 - 2. 756 / 48, or 15.75 - 3. 15.75 rounded down, or 15 - 4. 15 * 48, or 720 - 5. 720 + 40, or 760 - - So the canvas within a 1440x900 Tux Paint window is 1248x760. + This part of the documentation needs to be rewritten, since the new + "buttonsize" option was added. For now, try drawing and saving an + image within Tux Paint, then determine what size (pixel width and + height) it came out to, and try to match that when scaling the + picture(s) you're importing into Tux Paint. ---------------------------------------------------------------------- Further Reading - Other documentation included with Tux Paint (in the "docs" - folder/directory) include: - * "Magic" Tool Documentation ("magic-docs") - Documentation for each of the currently-installed "Magic" tools. + Other documentation included with Tux Paint (found in the "docs" + folder/directory) includes: + * 'Magic' Tool Documentation ("magic-docs") + Documentation for each of the currently-installed 'Magic' tools. * AUTHORS.txt List of authors and contributors. * CHANGES.txt - Summary of changed between releases. + Summary of what has changed between releases of Tux Paint. * COPYING.txt - Copying license (The GNU General Public License). - * INSTALL.txt - Instructions for compiling/installing, when applicable. + Tux Paint's software license, the GNU General Public License (GPL) + * INSTALL.html + Instructions for compiling and installing Tux Paint, when + applicable. * EXTENDING.html - Detailed instructions on creating brushes, stamps and starters, and - adding fonts, to extend Tux Paint. + Detailed instructions on extending Tux Paint: creating brushes, + stamps, starters, and templates; adding fonts; and creating new + on-screen keyboard layouts and input methods. * OPTIONS.html Detailed instructions on command-line and configuration-file - options, for those who don't want to use Tux Paint Config. - * PNG.txt - Notes on creating PNG format bitmapped images for use in Tux Paint. - * SVG.txt + options, for those who don't want to use the Tux Paint Config. tool + to manage Tux Paint's configuration. + * PNG.html + Notes on creating PNG format bitmapped (raster) images for use in + Tux Paint. + * SVG.html Notes on creating SVG format vector images for use in Tux Paint. - * SIGNALS.txt - Information about POSIX signals Tux Paint responds to. + * SIGNALS.html + Information about the POSIX signals that Tux Paint responds to. ---------------------------------------------------------------------- How to Get Help - If you need help, feel free to contact New Breed Software: + If you need help, there are numerous ways to interact with Tux Paint + developers and other users. - http://www.newbreedsoftware.com/ + * Report bugs or request new features via the project's bug-tracking + system + * Participate in the various project mailing lists + * Chat with developers and other users over IRC + * Contact the developers directly - You may also wish to participate in the numerous Tux Paint mailing - lists: + To learn more, visit the "Contact" page of the official Tux Paint + website: http://tuxpaint.org/contact/ - http://www.tuxpaint.org/lists/ + ---------------------------------------------------------------------- + + How to Participate + + Tux Paint is a volunteer-driven project, and we're happy to accept your + help in a variety of ways. + + * Translate Tux Paint to another language + * Improve existing translations + * Create artwork (stamps, starters, templates, brushes) + * Add or improve features or magic tools + * Create classroom curriculum + * Promote or help support others using Tux Paint + + To learn more, visit the "Help Us" page of the official Tux Paint + website: http://tuxpaint.org/help/ diff --git a/docs/en/SIGNALS.txt b/docs/en/SIGNALS.txt index 17535dfd6..04d1de96b 100644 --- a/docs/en/SIGNALS.txt +++ b/docs/en/SIGNALS.txt @@ -1,50 +1,55 @@ -SIGNALS.txt for Tux Paint + Tux Paint + version 0.9.26 + Signals Documentation -Tux Paint - A simple drawing program for children. + Copyright © 2019-2021 by various contributors; see AUTHORS. + http://www.tuxpaint.org/ -Copyright 2019 by Bill Kendrick and others -bill@newbreedsoftware.com -http://www.tuxpaint.org/ + 30 January 2021 -April 3, 2019 + ---------------------------------------------------------------------- -Tux Paint responds to the following signals (which can be -sent to the program's process via `kill` or `killall`, for -example). + Tux Paint responds to the following signals (which can be sent to the + program's process via `kill` or `killall`, for example). - * SIGTERM (also, [Ctrl]+[C] from a terminal running "tuxpaint") + SIGTERM (also, [Ctrl] + [C] from a terminal running `tuxpaint`) - Tux Paint responds as if the "Quit" button were pressed, - or the desktop environment was told to close Tux Paint - (e.g., by clicking a window close button, or pressing - [Alt]+[F4] on most systems). + Tux Paint responds as if the "Quit" button were pressed, or the + desktop environment was told to close Tux Paint (e.g., by clicking + a window close button, or pressing [Alt] + [F4] on most systems). - From the main interface, Tux Paint will prompt whether or - not you wish to quit, and (unless overridden by "--autosave") - if you'd like to save the current drawing (if unsaved), - and if so, and it's a modified version of an existing drawing - (unless overridden by "--saveover" or "--saveovernew"), - whether or not to overwrite the existing drawing, or save - to a new file. + From the main interface, Tux Paint will prompt whether or not you + wish to quit, and (unless overridden by the auto-save option, e.g. + "--autosave") if you'd like to save the current drawing (if + unsaved), and if so, and it's a modified version of an existing + drawing (unless overridden by the options to save over old images, + or always save new images; e.g. "--saveover" and "--saveovernew", + respectively), whether or not to overwrite the existing drawing, + or save to a new file. - From other parts of the interface, the signal is currently - interpreted as a request to go back (e.g., from the - "New" dialog back to the main interface), as if a "Back" - button in Tux Paint were clicked, or the [Esc] key pressed. + Note: From other parts of the interface, the signal is currently + interpreted as a request to go back (e.g., from the "New" dialog + back to the main interface), as if a "Back" button in Tux Paint + were clicked, or the [Esc] was key pressed. - * SIGUSR1 & SIGUSR2 + Example: killall tuxpaint - Tux Paint responds by setting its "--autosave" option, and either - "--saveovernew" (for SIGUSR1) or "--saveover" (for SIGUSR2), - and sending itself a SIGTERM signal. + SIGUSR1 & SIGUSR2 - So, from the main interface, Tux Paint should quit almost immediately, - with no questions asked. + Tux Paint responds by setting its auto-save option (as if it had + been launched with "--autosave"), as well as either the option to + always save new images (as if launched with "--saveovernew") in + the case of receiving a SIGUSR1 signal, or to always save over the + existing image (as if launched with "--saveover") in the case of + receiving SIGUSR2. Then Tux Paint sends itself a SIGTERM signal, + in an attempt to quit. (See above.) - From other parts of the interface, unfortunately, Tux Paint - will go back one level in the interface. Therefore, at this time, - it may be necessary to send this signal to Tux Paint a few times, - for it to quit completely. + So, from the main interface, Tux Paint should quit almost + immediately, with no questions asked. - e.g., `killall -s SIGUSR1 tuxpaint` + Note: From other parts of the interface, unfortunately, Tux Paint + will go back one level in the interface. Therefore, at this time, + it may be necessary to send this signal to Tux Paint a few times, + for it to quit completely. + Example: killall -s SIGUSR1 tuxpaint diff --git a/docs/en/SVG.txt b/docs/en/SVG.txt index 83bb33de2..842e0d7e2 100644 --- a/docs/en/SVG.txt +++ b/docs/en/SVG.txt @@ -1,49 +1,34 @@ -SVG.txt for Tux Paint + Tux Paint + version 0.9.26 + SVG Documentation -Tux Paint - A simple drawing program for children. + Copyright © 2007-2021 by various contributors; see AUTHORS. + http://www.tuxpaint.org/ -Copyright 2002-2007 by Bill Kendrick and others -bill@newbreedsoftware.com -http://www.tuxpaint.org/ + 30 January 2021 -June 19, 2007 - June 19, 2007 -$Id$ + ---------------------------------------------------------------------- +About SVGs -SVG (Scalable Vector Graphics) is an open standard used to describe -two-dimensional vector graphics. It is great for diagrams and shapes, -while PNGs are better for photographs. SVG files are a bit like instructions -on how to make an image. This means that they can be resized without looking -pixelated or blocky. + SVG (Scalable Vector Graphics) is an open standard used to describe + two-dimensional vector graphics. It is great for diagrams and shapes, + while PNGs are better for photographs. SVG files are a bit like + instructions on how to make an image. This means that they can be resized + without looking pixelated or blocky. -Wikipedia, an online user-driven encyclopedia, has lots more info: -http://en.wikipedia.org/wiki/Scalable_Vector_Graphics - -SVGs On the Web ---------------- - Web browsers like Mozilla Firefox, Apple's Safari and Opera have some - SVG support. A plugin is available to see SVG images in older versions of - Microsoft Internet Explorer ( http://www.adobe.com/svg/viewer/install/ ). + For more information, visit: https://www.w3.org/Graphics/SVG/ How to make SVGs ----------------- - Linux/Unix users - ---------------- - A popular Open Source program used to make SVGs is Inkscape - ( http://www.inkscape.org/ ). This will most likely be packaged for - your distribution / operating system. - An earlier program (which Inkscape is based on) is Sodipodi - ( http://www.sodipodi.com/ ). + An excellent tool with which to create SVG images for use in Tux Paint is + Inkscape, a high-quality Open Source interactive drawing program. - Libraries which support SVG include Cairo ( http://cairographics.org/ ) - and Batik ( http://xmlgraphics.apache.org/batik/ ). - - Mac and Windows users - --------------------- - Inkscape is available for Mac OSX and Windows. (See above.) - - Commercial software like Adobe Illustrator, CorelDRAW and Microsoft Visio - have SVG support. + It is likely that is already installed on your system. If not, it should + be readily available from your Linux distribution's software repository. + If not, or to learn more, visit http://www.inkscape.org/, respectively. +Mac and Windows users + * CorelDRAW (Corel) — http://www.corel.com/ + * Illustrator (Adobe) — http://www.adobe.com/products/illustrator.html diff --git a/docs/en/html/ADVANCED-STAMPS-HOWTO.html b/docs/en/html/ADVANCED-STAMPS-HOWTO.html index 28475367e..37a151b41 100644 --- a/docs/en/html/ADVANCED-STAMPS-HOWTO.html +++ b/docs/en/html/ADVANCED-STAMPS-HOWTO.html @@ -1,11 +1,8 @@ - - Tux Paint Advanced Stamps HOWTO - + Tux Paint Advanced Stamps 'How-To' @@ -19,480 +16,207 @@ Tux Paint
- version 0.9.26
- Advanced Stamps HOWTO - + alt="Tux Paint">
+ version 0.9.26 Advanced Stamps 'How-To'

- Copyright 2006-2008 by Albert Cahalan for the Tux Paint - project
- New Breed Software -

- -

- albert@users.sf.net
- http://www.tuxpaint.org/ + Copyright © 2006-2021 by Albert Cahalan and others; see AUTHORS.
+ http://www.tuxpaint.org/

- About this HOWTO -

+ About this 'How-To'

- This HOWTO assumes that you want to make an excellent - Tux Paint stamp, in PNG bitmapped format, from a JPEG - image (e.g., a digital photograph). There are easier and - faster methods that produce lower quality. -

+ This 'How-To' assumes that you want to make an excellent Tux Paint stamp, in PNG bitmapped format, from a JPEG image (e.g., a digital photograph). There are easier and faster methods that produce lower quality.

- This HOWTO assumes you are dealing with normal opaque - objects. Dealing with semi-transparent objects (fire, - moving fan blade, kid's baloon) or light-giving objects - (fire, lightbulb, sun) is best done with custom software. - Images with perfect solid-color backgrounds are also best - done with custom software, but are not troublesome to do as - follows. -

+ This 'How-To' assumes you are dealing with normal opaque objects. Dealing with semi-transparent objects (fire, moving fan blade, kid's balloon) or light-giving objects (fire, lightbulb, sun) is best done with custom software. Images with perfect solid-color backgrounds are also best done with custom software, but are not troublesome to do as follows.

- Image choice is crucial -

+ Image choice is crucial

- License -

+ License

- If you wish to submit artwork to the Tux Paint - developers for consideration for inclusion in the - official project, or if you wish to release your own copy - of Tux Paint, bundled with your own graphics, you - need an image that is compatible with the GNU General Public License used by - Tux Paint. -

+ If you wish to submit artwork to the Tux Paint developers for consideration for inclusion in the official project, or if you wish to release your own copy of Tux Paint, bundled with your own graphics, you need an image that is compatible with the GNU General Public License used by Tux Paint.

- Images produced by the US government are Public Domain, - but be aware that the US government sometimes uses other - images on the web. Google image queries - including either site:gov or - site:mil will supply many suitable images. - (Note: the *.mil sites include non-military content, - too!) -

+ Images produced by the US government are Public Domain, but be aware that the US government sometimes uses other images on the web. Google image queries including either site:gov or site:mil will supply many suitable images. (Note: the *.mil sites include non-military content, too!)

- Your own images can be placed in the Public Domain - by declaring it so. (Hire a lawyer if you feel the need - for legal advice.) -

+ Your own images can be placed in the Public Domain or a suitable license, such as the Creative Commons CC0 by declaring it so. (Hire a lawyer if you feel the need for legal advice.)

- For personal use, any image you can legitimately modify - and use for your own personal use should be fine. -

+ For personal use, any image you can legitimately modify and use for your own personal use should be fine.

- Image Size and Orientation: -

+ Image Size and Orientation

- You need an image that has a useful orientation. - Perspective is an enemy. Images that show an object from - the corner are difficult to fit into a nice drawing. As a - general rule, telephoto side views are the best. The - impossible ideal is that, for example, two wheels of a - car are perfectly hidden behind the other two. -

+ You need an image that has a useful orientation. Perspective is an enemy. Images that show an object from the corner are difficult to fit into a nice drawing. As a general rule, telephoto side views are the best. The impossible ideal is that, for example, two wheels of a car are perfectly hidden behind the other two.

- Rotating an image can make it blurry, especially if you - only rotate by a few degrees. Images that don't need - rotation are best, images that need lots of rotation (30 - to 60 degrees) are next best, and images that need just a - few degrees are worst. Rotation will also make an image - darker because most image editing software is very bad - about gamma handling. (Rotation is only legitimate for - gamma=1.0 images.) -

+ Rotating an image can make it blurry, especially if you only rotate by a few degrees. Images that don't need rotation are best, images that need lots of rotation (30 to 60 degrees) are next best, and images that need just a few degrees are worst. Rotation will also make an image darker because most image editing software is very bad about gamma handling. (Rotation is only legitimate for gamma=1.0 images.)

- Very large images are more forgiving of mistakes, and - thus easier to work with. Choose an image with an object - that is over 1000 pixels across if you can. You can - shrink this later to hide your mistakes. -

+ Very large images are more forgiving of mistakes, and thus easier to work with. Choose an image with an object that is over 1000 pixels across if you can. You can shrink this later to hide your mistakes.

- Be sure that the image is not too grainy, dim, or washed - out. -

+ Be sure that the image is not too grainy, dim, or washed out.

- Pay attention to feet and wheels. If they are buried in - something, you will need to draw new ones. If only one is - buried, you might be able to copy the other one as a - replacement. -

+ Pay attention to feet and wheels. If they are buried in something, you will need to draw new ones. If only one is buried, you might be able to copy the other one as a replacement.

- Prepare the image: -

+ Prepare the image

- First of all, be sure to avoid re-saving the image as a - JPEG. This causes quality loss. There is a special tool - called jpegtran - that lets you crop an image without the normal quality - loss. If you want a GUI for it, use ljcrop. - Otherwise, use it like this: -

+ First of all, be sure to avoid re-saving the image as a JPEG. This causes quality loss. There is a special tool called jpegtran that lets you crop an image without the normal quality loss.

- jpegtran -trim -copy none -crop 512x1728+160+128 - < src.jpg > cropped.jpg + jpegtran -trim -copy none -crop 512x1728+160+128 < src.jpg > cropped.jpg

- Bring that image up in your image editor. If you didn't - crop it yet, you may find that your image editor is very - slow. Rotate and crop the image as needed. Save the image — - choose whatever native format supports layers, masks, - alpha, etc. GIMP users - should choose "XCF", and Adobe Photoshop users should - choose "PSD", for example. -

+ Bring that image up in your image editor. If you didn't crop it yet, you may find that your image editor is very slow. Rotate and crop the image as needed. Save the image — choose whatever native format supports layers, masks, alpha, etc. GIMP users should choose "XCF", and Adobe Photoshop users should choose "PSD", for example.

- If you have rotated or cropped the image in your image - editor, flatten it now. You need to have just one RGB layer - without mask or alpha. -

+ If you have rotated or cropped the image in your image editor, flatten it now. You need to have just one RGB layer without mask or alpha.

- Open the layers dialog box. Replicate the one layer several - times. From top to bottom you will need something like - this: -

+ Open the layers dialog box. Replicate the one layer several times. From top to bottom you will need something like this:

    -
  1. unmodified image (write-protect this if you can) -
    2. - -
  2. an image you will modify — the "WIP" layer -
    3. - -
  3. solid green (write-protect this if you can) -
    4. - -
  4. solid magenta (write-protect this if you can) -
    5. - -
  5. unmodified image (write-protect this if you can) +
  6. unmodified image (write-protect this if you can)
    7. +
  7. an image you will modify — the "work in progress" layer
    8. +
  8. solid green (write-protect this if you can)
    9. +
  9. solid magenta (write-protect this if you can)
    10. +
  10. unmodified image (write-protect this if you can)

- Give the WIP layer a rough initial mask. You might start - with a selection, or by using the grayscale value of the - WIP layer. You might invert the mask. -

+ Give the work in progress (WIP) layer a rough initial mask. You might start with a selection, or by using the grayscale value of the WIP layer. You might invert the mask.

- Warning: once you have the mask, you may not rotate - or scale the image normally. This would cause data loss. - You will be given special scaling instructions later. -

+ Warning: once you have the mask, you may not rotate or scale the image normally. This would cause data loss. You will be given special scaling instructions later.

- Prepare the mask: -

+ Prepare the mask

- Get used to doing Ctrl-click and Alt-click on the thumbnail - images in the layers dialog. You will need this to control - what you are looking at and what you are editing. Sometimes - you will be editing things you can't see. For example, you - might edit the mask of the WIP layer while looking at the - unmodified image. Pay attention so you don't screw up. - Always verify that you are editing the right thing. -

+ Get used to doing [Ctrl]-click and [Alt]-click on the thumbnail images in the layers dialog. You will need this to control what you are looking at and what you are editing. Sometimes you will be editing things you can't see. For example, you might edit the mask of the WIP layer while looking at the unmodified image. Pay attention so you don't screw up. Always verify that you are editing the right thing.

- Set an unmodified image as what you will view (the top one - is easiest). Set the WIP mask as what you will edit. At - some point, perhaps not immediately, you should magnify the - image to about 400% (each pixel of the image is seen and - edited as a 4x4 block of pixels on your screen). -

+ Set an unmodified image as what you will view (the top one is easiest). Set the WIP mask as what you will edit. At some point, perhaps not immediately, you should magnify the image to about 400% (each pixel of the image is seen and edited as a 4x4 block of pixels on your screen).

- Select parts of the image that need to be 100% opaque or 0% - opaque. If you can select the object or background somewhat - accurately by color, do so. As needed to avoid selecting - any pixels that should be partially opaque (generally at - the edge of the object) you should grow, shrink, and invert - the selection. -

+ Select parts of the image that need to be 100% opaque or 0% opaque. If you can select the object or background somewhat accurately by color, do so. As needed to avoid selecting any pixels that should be partially opaque (generally at the edge of the object) you should grow, shrink, and invert the selection.

- Fill the 100% opaque areas with white, and the 0% opaque - areas with black. This is most easily done by drag-and-drop - from the foreground/background color indicator. You should - not see anything happen, because you are viewing the - unmodified image layer while editing the mask of the WIP - layer. Large changes might be noticable in the thumbnail. -

+ Fill the 100% opaque areas with white, and the 0% opaque areas with black. This is most easily done by drag-and-drop from the foreground/background color indicator. You should not see anything happen, because you are viewing the unmodified image layer while editing the mask of the WIP layer. Large changes might be noticable in the thumbnail.

- Now you must be zoomed in. -

+ Now you must be zoomed in.

- Check your work. Hide the top unmodified image layer. - Display just the mask, which should be a white object on a - black background (probably with unedited grey at the edge). - Now display the WIP layer normally, so that the mask is - active. This should show your object over top of the next - highest enabled layer, which should be green or magenta as - needed for maximum contrast. You might wish to flip back - and forth between those backgrounds by repeatedly clicking - to enable/disable the green layer. Fix any obvious and easy - problems by editing the mask while viewing the mask. -

+ Check your work. Hide the top unmodified image layer. Display just the mask, which should be a white object on a black background (probably with unedited grey at the edge). Now display the WIP layer normally, so that the mask is active. This should show your object over top of the next highest enabled layer, which should be green or magenta as needed for maximum contrast. You might wish to flip back and forth between those backgrounds by repeatedly clicking to enable/disable the green layer. Fix any obvious and easy problems by editing the mask while viewing the mask.

- Go back to viewing the top unmodified layer while editing - the WIP mask. Set your drawing tool the paintbrush. For the - brush, choose a small fuzzy circle. The 5x5 size is good - for most uses. -

+ Go back to viewing the top unmodified layer while editing the WIP mask. Set your drawing tool the paintbrush. For the brush, choose a small fuzzy circle. The 5x5 size is good for most uses.

- With a steady hand, trace around the image. Use black - around the outside, and white around the inside. Avoid - making more than one pass without switching colors (and - thus sides). -

+ With a steady hand, trace around the image. Use black around the outside, and white around the inside. Avoid making more than one pass without switching colors (and thus sides).

- Flip views a bit, checking to see that the mask is working - well. When the WIP layer is composited over the green or - magenta, you should see a tiny bit of the original - background as an ugly fringe around the edge. If this - fringe is missing, then you made the object mask too small. - The fringe consists of pixels that are neither 100% object - nor 0% object. For them, the mask should be neither 100% - nor 0%. The fringe gets removed soon. -

+ Flip views a bit, checking to see that the mask is working well. When the WIP layer is composited over the green or magenta, you should see a tiny bit of the original background as an ugly fringe around the edge. If this fringe is missing, then you made the object mask too small. The fringe consists of pixels that are neither 100% object nor 0% object. For them, the mask should be neither 100% nor 0%. The fringe gets removed soon.

- View and edit the mask. Select by color, choosing either - black or white. Most likely you will see unselected specks - that are not quite the expected color. Invert the - selection, then paint these away using the pencil tool. Do - this operation for both white and black. -

+ View and edit the mask. Select by color, choosing either black or white. Most likely you will see unselected specks that are not quite the expected color. Invert the selection, then paint these away using the pencil tool. Do this operation for both white and black.

- Replace the fringe and junk pixels: -

+ Replace the fringe and junk pixels

- Still viewing the mask, select by color. Choose black. - Shrink the selection by several pixels, being sure to NOT - shrink from the edges of the mask (the shrink helps you - avoid and recover from mistakes). -

+ Still viewing the mask, select by color. Choose black. Shrink the selection by several pixels, being sure to NOT shrink from the edges of the mask (the shrink helps you avoid and recover from mistakes).

- Now disable the mask. View and edit the unmasked WIP layer. - Using the color picker tool, choose a color that is average - for the object. Drag-and-drop this color into the - selection, thus removing most of the non-object pixels. -

+ Now disable the mask. View and edit the unmasked WIP layer. Using the color picker tool, choose a color that is average for the object. Drag-and-drop this color into the selection, thus removing most of the non-object pixels.

- This solid color will compress well and will help prevent - ugly color fringes when Tux Paint scales the image - down. If the edge of the object has multiple colors that - are very different, you should split up your selection so - that you can color the nearby background to be similar. -

+ This solid color will compress well and will help prevent ugly color fringes when Tux Paint scales the image down. If the edge of the object has multiple colors that are very different, you should split up your selection so that you can color the nearby background to be similar.

- Now you will paint away the existing edge fringe. Be sure - that you are editing and viewing the WIP image. Frequent - layer visibility changes will help you to see what you are - doing. You are likely to use all of: -

+ Now you will paint away the existing edge fringe. Be sure that you are editing and viewing the WIP image. Frequent layer visibility changes will help you to see what you are doing. You are likely to use all of:

    -
  • composited over green (mask enabled) -
    • - -
  • composited over magenta (mask enabled) -
    • - -
  • original (the top or bottom layer) -
    • - -
  • composited over the original (mask enabled) -
    • - -
  • raw WIP layer (mask DISABLED) -
    • +
  • composited over green (mask enabled)
    • +
  • composited over magenta (mask enabled)
    • +
  • original (the top or bottom layer)
    • +
  • composited over the original (mask enabled)
    • +
  • raw WIP layer (mask disabled)

- To reduce accidents, you may wish to select only those - pixels that are not grey in the mask. (Select by color from - the mask, choose black, add mode, choose white, invert. - Alternately: Select all, select by color from the mask, - subtract mode, choose black, choose white.) If you do this, - you'll probably want to expand the selection a bit and/or - hide the "crawling ants" line that marks the selection. -

+ To reduce accidents, you may wish to select only those pixels that are not grey in the mask. (Select by color from the mask, choose black, add mode, choose white, invert. Alternately: Select all, select by color from the mask, subtract mode, choose black, choose white.) If you do this, you'll probably want to expand the selection a bit and/or hide the "crawling ants" line that marks the selection.

- Use the clone tool and the brush tool. Vary the opacity as - needed. Use small round brushes mostly, perhaps 3x3 or 5x5, - fuzzy or not. (It is generally nice to pair up fuzzy - brushes with 100% opacity and non-fuzzy brushes with about - 70% opacity.) Unusual drawing modes can be helpful with - semi-transparent objects. -

+ Use the clone tool and the brush tool. Vary the opacity as needed. Use small round brushes mostly, perhaps 3x3 or 5x5, fuzzy or not. (It is generally nice to pair up fuzzy brushes with 100% opacity and non-fuzzy brushes with about 70% opacity.) Unusual drawing modes can be helpful with semi-transparent objects.

- The goal is to remove the edge fringe, both inside and - outside of the object. The inside fringe, visible when the - object is composited over magenta or green, must be removed - for obvious reasons. The outside fringe must also be - removed because it will become visible when the image is - scaled down. As an example, consider a 2x2 region of pixels - at the edge of a sharp-edged object. The left half is black - and 0% opaque. The right half is white and 100% opaque. - That is, we have a white object on a black background. When - Tux Paint scales this to 50% (a 1x1 pixel area), the - result will be a grey 50% opaque pixel. The correct result - would be a white 50% opaque pixel. To get this result, we - would paint away the black pixels. They matter, despite - being 0% opaque. -

+ The goal is to remove the edge fringe, both inside and outside of the object. The inside fringe, visible when the object is composited over magenta or green, must be removed for obvious reasons. The outside fringe must also be removed because it will become visible when the image is scaled down. As an example, consider a 2x2 region of pixels at the edge of a sharp-edged object. The left half is black and 0% opaque. The right half is white and 100% opaque. That is, we have a white object on a black background. When Tux Paint scales this to 50% (a 1x1 pixel area), the result will be a grey 50% opaque pixel. The correct result would be a white 50% opaque pixel. To get this result, we would paint away the black pixels. They matter, despite being 0% opaque.

- Tux Paint can scale images down by a very large - factor, so it is important to extend the edge of your - object outward by a great deal. Right at the edge of your - object, you should be very accurate about this. As you go - outward away from the object, you can get a bit sloppy. It - is reasonable to paint outward by a dozen pixels or more. - The farther you go, the more Tux Paint can scale down - without creating ugly color fringes. For areas that are - more than a few pixels away from the object edge, you - should use the pencil tool (or sloppy select with - drag-and-drop color) to ensure that the result will - compress well. -

+ Tux Paint can scale images down by a very large factor, so it is important to extend the edge of your object outward by a great deal. Right at the edge of your object, you should be very accurate about this. As you go outward away from the object, you can get a bit sloppy. It is reasonable to paint outward by a dozen pixels or more. The farther you go, the more Tux Paint can scale down without creating ugly color fringes. For areas that are more than a few pixels away from the object edge, you should use the pencil tool (or sloppy select with drag-and-drop color) to ensure that the result will compress well.

- Save the image for Tux Paint -

+ Save the image for Tux Paint

- It is very easy to ruin your hard work. Image editors can - silently destroy pixels in 0% opaque areas. The conditions - under which this happens may vary from version to version. - If you are very trusting, you can try saving your image - directly as a PNG. Be sure to read it back in again to - verify that the 0% opaque areas didn't turn black or white, - which would create fringes when Tux Paint scales the - image down. If you need to scale your image to save space - (and hide your mistakes), you are almost certain to destroy - all the 0% opaque areas. So here is a better way... -

+ It is very easy to ruin your hard work. Image editors can silently destroy pixels in 0% opaque areas. The conditions under which this happens may vary from version to version. If you are very trusting, you can try saving your image directly as a PNG. Be sure to read it back in again to verify that the 0% opaque areas didn't turn black or white, which would create fringes when Tux Paint scales the image down. If you need to scale your image to save space (and hide your mistakes), you are almost certain to destroy all the 0% opaque areas. So here is a better way...

- A Safer Way to Save: -

+ A Safer Way to Save

- Drag the mask from the layers dialog to the unused - portion of the toolbar (right after the last drawing - tool). This will create a new image consisting of one - layer that contains the mask data. Scale this as desired, - remembering the settings you use. Often you should start - with an image that is about 700 to 1500 pixels across, - and end up with one that is 300 to 400. -

+ Drag the mask from the layers dialog to the unused portion of the toolbar (right after the last drawing tool). This will create a new image consisting of one layer that contains the mask data. Scale this as desired, remembering the settings you use. Often you should start with an image that is about 700 to 1500 pixels across, and end up with one that is 300 to 400.

- Save the mask image as a NetPBM portable greymap - (".pgm") file. (If you are using an old - release of The GIMP, you might need to convert the - image to greyscale before you can save it.) Choose the - more compact "RAW PGM" format. (The second character - of the file should be the ASCII digit "5", hex byte - 0x35.) -

+ Save the mask image as a NetPBM portable greymap (".pgm") file. (If you are using an old release of The GIMP, you might need to convert the image to greyscale before you can save it.) Choose the more compact "RAW PGM" format. (The second character of the file should be the ASCII digit "5", hex byte 0x35.)

- You may close the mask image. -

+ You may close the mask image.

- Going back to the multi-layer image, now select the WIP - layer. As you did with the mask, drag this from the - layers dialog to the toolbar. You should get a - single-layer image of your WIP data. If the mask came - along too, get rid of it. You should be seeing the object - and the painted-away surroundings, without any mask - thumbnail in the layers dialog. If you scaled the mask, - then scale this image in exactly the same way. Save this - image as a NetPBM portable pixmap (".ppm") - file. (Note: ppm, not pgm.) (If you choose the - RAW PPM format, the second byte of the file should - be the ASCII digit "6", hex byte 0x36.) -

+ Going back to the multi-layer image, now select the WIP layer. As you did with the mask, drag this from the layers dialog to the toolbar. You should get a single-layer image of your WIP data. If the mask came along too, get rid of it. You should be seeing the object and the painted-away surroundings, without any mask thumbnail in the layers dialog. If you scaled the mask, then scale this image in exactly the same way. Save this image as a NetPBM portable pixmap (".ppm") file. (Note: .ppm, not .pgm.) (If you choose the RAW PPM format, the second byte of the file should be the ASCII digit "6", hex byte 0x36.)

- Now you need to merge the two files into one. Do that - with the pnmtopng command, - like this: -

+ Now you need to merge the two files into one. Do that with the pnmtopng command, like this:

- pnmtopng -force -compression 9 -alpha mask.pgm - fg.ppm > final-stamp.png + pnmtopng -force -compression 9 -alpha mask.pgm fg.ppm > final-stamp.png

diff --git a/docs/en/html/EXTENDING.html b/docs/en/html/EXTENDING.html index 5fae55220..faede32f0 100644 --- a/docs/en/html/EXTENDING.html +++ b/docs/en/html/EXTENDING.html @@ -1,11 +1,8 @@ - - Extending Tux Paint - + Extending Tux Paint @@ -21,19 +18,15 @@ width="205" height="210" alt="Tux Paint">
- version 0.9.26 - + version 0.9.26

- Copyright (c) 2002-2020 by various contributors; see - AUTHORS.txt
- http://www.tuxpaint.org/ + Copyright © 2002-2021 by various contributors; see AUTHORS.
+ http://www.tuxpaint.org/

- June 14, 2002 - December 27, 2020 -

+ 30 January 2021

- Table of Contents - + Table of Contents @@ -78,20 +70,19 @@ Stamps @@ -114,12 +103,11 @@ 'Starters' @@ -133,8 +121,7 @@
  • - Alternative Input - Methods + Alternative Input Methods
  • @@ -149,19 +136,10 @@ noshade>

    - If you wish to add or change things like Brushes, Starters, - Rubber Stamps and - other content used by Tux - Paint, you can do so fairly easily by simply adding, - changing, or removing files where Tux Paint looks for them. -

    + If you wish to add or change things like Brushes, Starters, Rubber Stamps, and other content used by Tux Paint, you can do so fairly easily by simply adding, changing, or removing files where Tux Paint looks for them.

    - Note: You'll need to restart Tux Paint for the changes to - take effect. -

    + Note: You'll need to re-launch Tux Paint for the changes to take effect.

    @@ -179,35 +157,24 @@

    - Tux Paint looks - for its various data files in its 'data' - directory. -

    + Tux Paint looks for its various data files in its 'data' directory.

    - Linux and Unix -

    + Linux and Unix

    - Where this directory goes depends on what value was set - for "DATA_PREFIX" when Tux Paint was built. See - INSTALL.txt for details. -

    + Where this directory goes depends on what value was set for "DATA_PREFIX" when Tux Paint was built. See 'Install documentation' for details.

    - By default, though, the directory is: -

    + By default, though, the directory is:

    /usr/local/share/tuxpaint/

    - If you installed from a package, it is more likely to - be: -

    + If you installed from a package, it is more likely to be:

    /usr/share/tuxpaint/ @@ -220,16 +187,10 @@

    - Tux Paint - looks for a directory called 'data' in the same - directory as the executable. This is the directory that - the installer used when installing Tux Paint e.g.: -

    + Tux Paint looks for a directory called 'data' in the same directory as the executable. This is the directory that the installer used when installing Tux Paint e.g.:

    - C:\Program - Files\TuxPaint\data + C:\Program Files\TuxPaint\data
    @@ -239,84 +200,30 @@

    - Tux Paint - stores its data files inside the "Tux Paint" application - icon (which is actually a special kind of folder on - macOS & Mac OS - X before it). The following steps explain how to - get to the folders within it: -

    + Tux Paint stores its data files inside the "Tux Paint" application icon (which is actually a special kind of folder on macOS & Mac OS X before it). The following steps explain how to get to the folders within it:

      -
    1. Bring up a 'context' menu by holding the [Control] - key and clicking the Tux Paint icon the in - Finder. (If you have a mouse with more - than one button, you can simply right-click the icon.) -
      2. +
    2. Bring up a 'context' menu by holding the [Control] key and clicking the Tux Paint icon the in Finder. (If you have a mouse with more than one button, you can simply right-click the icon.)
      3. -
    3. Select "Show - Contents" from the menu that appears. A new - Finder window will appear with a folder - inside called "Contents." -
      4. +
    4. Select "Show Contents" from the menu that appears. A new Finder window will appear with a folder inside called "Contents".
      5. -
    5. Open the "Contents" folder and open - the "Resources" folder found inside. -
      6. +
    6. Open the "Contents" folder and open the "Resources" folder found inside.
      7. -
    7. There, you will find various sub-folders, such as - "starters", "stamps", - "brushes", etc. Adding new content to - these folders will make the content available to any - user that launches this copy (icon) of Tux Paint. -
      8. +
    8. There, you will find various sub-folders, such as "starters", "stamps", "brushes", etc. Adding new content to these folders will make the content available to any user that launches this copy (icon) of Tux Paint.

    - Note: If you install a newer version of - Tux Paint and - replace or discard the old version, you will lose - changes made by following the instructions above, so - keep backups of your new content (stamps, brushes, - etc.). -

    + Note: If you install a newer version of Tux Paint and replace or discard the old version, you will lose changes made by following the instructions above, so keep backups of your new content (stamps, brushes, etc.).

    - Tux Paint - also looks for files in a "TuxPaint" - folder that you can place in your system's - "Application - Support" folder (found under - "Library" at the root of your filesystem): -

    + Tux Paint also looks for files in a "TuxPaint" folder that you can place in your system's "Application Support" folder (found under "Library" at the root of your filesystem):

    - /Library/Application - Support/TuxPaint/ + /Library/Application Support/TuxPaint/

    - It also looks for files in the user's "Application Support" - folder: -

    - -
    - /Users/(username)/Library/Application - Support/TuxPaint/ -
    - -

    - When you upgrade to a newer version of Tux Paint, the contents - of this TuxPaint folder will stay the same - and remain accessible by all users of Tux Paint. -

    + When you upgrade to a newer version of Tux Paint, the contents of this "TuxPaint" folder will stay the same, and remain accessible by all users of Tux Paint.

    @@ -330,10 +237,7 @@

    - You can also create brushes, stamps, fonts and 'starters' - in your own directory (folder) for Tux Paint to find. -

    + You can also create brushes, stamps, 'starters', templates, and fonts in your own user account directory (folder) for Tux Paint to find.

    Windows @@ -341,16 +245,10 @@

    - Your personal Tux - Paint folder is stored in your "Application - Data". For example, on newer Windows (set up for an - English-speaking user): -

    + Your personal Tux Paint folder is stored in your personal "Application Data". For example, on newer Windows:

    - C:\Documents and - Settings\(username)\Application - Data\TuxPaint\ + C:\Documents and Settings\(username)\Application Data\TuxPaint\
    @@ -360,57 +258,32 @@

    - Your personal Tux - Paint folder is stored in your "Application - Support" folder: -

    + Your personal Tux Paint folder is stored in your personal "Application Support" folder:

    - /Users/(username)/Library/Application - Support/TuxPaint/ + /Users/(username)/Library/Application Support/TuxPaint/

    - Linux and Unix -

    + Linux and Unix

    - Your personal Tux - Paint directory is - "$(HOME)/.tuxpaint/" (also known as - "~/.tuxpaint/". -

    + Your personal Tux Paint files go into a 'hidden directory' found in your account's home directory: "$(HOME)/.tuxpaint/" (also known as "~/.tuxpaint/").

    - That is, if your home directory is - "/home/karl", then your Tux Paint directory is - "/home/karl/.tuxpaint/". -

    + That is, if your home directory is "/home/tux", then your personal Tux Paint files go in "/home/tux/.tuxpaint/".

    - Don't forget the period (".") before the - 'tuxpaint'! -

    + Don't forget the period (".") before the "tuxpaint"!

    - To add brushes, stamps fonts, and 'starters,' create - subdirectories under your personal Tux Paint directory named - "brushes", - "stamps", "fonts" - and "starters" respectively. -

    + To add your own brushes, stamps, 'starters,' templates, and fonts, create subdirectories under your personal Tux Paint directory named "brushes", "stamps", "starters", "templates", "fonts", respectively.

    - (For example, if you created a brush named - "flower.png", you would put it in - "~/.tuxpaint/brushes/" under Linux or Unix.) -

    + (For example, if you created a brush named "flower.png", you would put it in "~/.tuxpaint/brushes/" under Linux or Unix.)

    @@ -424,27 +297,17 @@

    - The brushes used for drawing with the 'Brush' and 'Lines' - tools in Tux - Paint are simply PNG image files. -

    + The brushes used for drawing with the 'Brush' and 'Lines' tools in Tux Paint are simply PNG image files.

    - The alpha (transparency) of the PNG image is used to - determine the shape of the brush, which means that the - shape can be 'anti-aliased' and even partially-transparent! -

    + The alpha (transparency) of the PNG image is used to determine the shape of the brush, which means that the shape can be 'anti-aliased' and even partially-transparent!

    - Greyscale pixels in the brush PNG will be drawn using the - currently-selected color in Tux Paint. Color pixels will - be tinted. -

    + Greyscale pixels in the brush PNG will be drawn using the currently-selected color in Tux Paint. Color pixels will be tinted.

    - Aside from a graphical shape, brushes can also be given - other attributes. To do this, you need to create a - 'data file' for - the brush. -

    + Aside from a graphical shape, brushes can also be given other attributes. To do this, you need to create a 'data file' for the brush.

    - A brush data file is simply a text file containing the - options. -

    + A brush's data file is simply a plain ASCII text file containing the options for the brush.

    - The file has the same name as the PNG image, but a - ".dat" extension. (e.g., - "brush.png"'s data file is the text file - "brush.dat" in the same directory.) -

    + The file has the same name as the PNG image, but a ".dat" extension. (e.g., "brush.png"'s data file is the text file "brush.dat", found in the same directory.)

    - Brush Spacing -

    + Brush Spacing

    - As of Tux - Paint version 0.9.16, you can now specify the - spacing for brushes (that is, how often they are - drawn). By default, the spacing will be the brush's - height, divided by 4. -

    + As of Tux Paint version 0.9.16, you can now specify the spacing for brushes (that is, how often they are drawn). By default, the spacing will be the brush's height, divided by 4.

    - Add a line containing the line - "spacing=N" to the brush's - data file, where N is the spacing you want for - the brush. (The lower the number, the more often the - brush is drawn.) -

    + Add a line containing the line "spacing=N" to the brush's data file, where "N" is the spacing you want for the brush. (The lower the number, the more often the brush is drawn.)

    - Animated Brushes -

    + Animated Brushes

    - As of Tux - Paint version 0.9.16, you may now create - animated brushes. As the brush is used, each frame of - the animation is drawn. -

    + As of Tux Paint version 0.9.16, you may now create animated brushes. As the brush is used, each frame of the animation is drawn.

    - Lay each frame out across a wide PNG image. For - example, if your brush is 30x30 and you have 5 frames, - the image should be 150x30. -

    + Lay each frame out across a wide PNG image. For example, if your brush is 30x30 and you have 5 frames, the image should be 150x30.

    - Add a line containing the line - "frames=N" to the brush's - data file, where N is the number of frames in - the brush. -

    + Add a line containing the line "frames=N" to the brush's data file, where "N" is the number of frames in the brush.

    - Note: If you'd rather the frames be flipped - through randomly, rather than sequentially, also add a - line containing "random" to the - brush's data file. -

    + Note: If you'd rather the frames be flipped through randomly, rather than sequentially, also add a line containing "random" to the brush's data file.

    - Directional Brushes -

    + Directional Brushes

    - As of Tux - Paint version 0.9.16, you may now create - directional brushes. As the brush is used, different - shapes are drawn, depending on the direction the brush - is going. -

    + As of Tux Paint version 0.9.16, you may now create directional brushes. As the brush is used, different shapes are drawn, depending on the direction the brush is going.

    - The directional shapes are divided into a 3x3 square in - a PNG image. For example, if your brush is 30x30, the - image should be 90x90, and each of the direction's - shapes placed in a 3x3 grid. The center region is used - for no motion. The top right is used for motion that's - both up, and to the right. And so on. -

    + The directional shapes are divided into a 3x3 square in a PNG image. For example, if your brush is 30x30, the image should be 90x90, and each of the direction's shapes placed in a 3x3 grid. The center region is used for no motion. The top right is used for motion that's both up, and to the right. And so on.

    - Add a line containing the line - "directional" to the brush's data - file. -

    + Add a line containing the word "directional" to the brush's data file.

    - Animated Directional Brushes -

    + Animated Directional Brushes

    - You may mix both animated and directional features into - one brush. Use both options - ("frames=N" and - "directional"), in separate lines - in the brush's "".dat" file. -

    + You may mix both animated and directional features into one brush. Use both options ("frames=N" and "directional"), in separate lines in the brush's ".dat" file.

    - Lay the brush out so that each 3x3 set of directional - shapes are laid out across a wide PNG image. For - example, if the brush is 30x30 and there are 5 frames, - it would be 450x90. (The leftmost 150x90 pixels of the - image represent the 9 direction shapes for the first - frame, for example.) -

    + Lay the brush out so that each 3x3 set of directional shapes are laid out across a wide PNG image. For example, if the brush is 30x30 and there are 5 frames, it would be 450x90. (The leftmost 150x90 pixels of the image represent the 9 direction shapes for the first frame, for example.)

    - Place the brush image PNGs (and any data text files) in the - "brushes" directory. -

    + Place the brush image PNGs (and any data text files) in the "brushes" directory.

    - Note: If your new brushes all come out as solid squares or - rectangles, it's because you forgot to use alpha - transparency! See the documentation file "PNG.txt" for more - information and tips. -

    + Note: If your new brushes all come out as solid squares or rectangles, it's because you forgot to use alpha transparency! See the 'PNG documentation' in Tux Paint for more information and tips.


    @@ -603,78 +396,38 @@

    - All stamp-related files go in the - "stamps" directory. It's useful to - create subdirectories and sub-subdirectories there to - organize the stamps. (For example, you can have a - "holidays" folder with - "halloween" and "christmas" - sub-folders.) -

    + All stamp-related files go in the "stamps" directory. It's useful to create subdirectories and sub-subdirectories there to organize the stamps. (For example, you can have a "holidays" folder with "halloween" and "christmas" sub-folders.)

    Images + id="stamps_images">Stamp Images

    - Rubber Stamps in Tux - Paint can be made up of a number of separate - files. The one file that is required is, of course, the - picture itself. -

    + Rubber Stamps in Tux Paint can be made up of a number of separate files. The one file that is required is, of course, the picture itself.

    - As of Tux Paint - version 0.9.17, Stamps may be either PNG bitmap images or - SVG vector images. They can be full-color or greyscale. - The alpha (transparency) channel of PNGs is used to - determine the actual shape of the picture (otherwise - you'll stamp a large rectangle on your drawings). -

    + As of Tux Paint version 0.9.17, Stamps may be either PNG bitmap images or SVG vector images. They can be full-color or greyscale. The alpha (transparency) channel of PNGs is used to determine the actual shape of the picture (otherwise you'll stamp a large rectangle on your drawings).

    - PNGs can be any size, and Tux Paint (by default) - provides a set of sizing buttons to let the user scale - the stamp up (larger) and down (smaller). -

    + PNGs can be any size, and Tux Paint (by default) provides a set of sizing buttons to let the user scale the stamp up (larger) and down (smaller).

    - SVGs are vector-based, and will be scaled appropriately - for the canvas being used in Tux Paint. -

    + SVGs are vector-based, and will be scaled appropriately for the canvas size being used in Tux Paint.

    - Note: If your new PNG stamps all have solid - rectangular-shaped outlines of a solid color (e.g., white - or black), it's because you forgot to use alpha - transparency! See the documentation file "PNG.txt" for more information and tips. -

    + Note: If your new PNG-based stamps all come out as solid squares or rectangles, it's because you forgot to use alpha transparency! See the 'PNG documentation' in Tux Paint for more information and tips.

    - Note: If your new SVG stamps seem to have a lot of - whitespace, make sure the SVG 'document' is no larger - than the shape(s) within. If they are being clipped, make - sure the 'document' is large enough to contain the - shape(s). See the documentation file "SVG.txt" for more information and tips. -

    + Note: If your new SVG stamps seem to have a lot of whitespace, make sure the SVG 'document' is no larger than the shape(s) within. If they are being clipped, make sure the 'document' is large enough to contain the shape(s). See the 'SVG documentation' in Tux Paint for more information and tips.

    - Advanced Users: The Advanced Stamps HOWTO - describes, in detail, how to make PNG images which will - scale perfectly when used as stamps in Tux Paint. -

    + Advanced Users: The 'Advanced Stamps How-To' document describes, in detail, how to make PNG images which will scale perfectly when used as stamps in Tux Paint.


    @@ -683,71 +436,38 @@

    Description Text + id="description_text">Stamp Descriptive Text

    - Text (".TXT") files with the same name as the PNG or SVG. - (e.g., "picture.png"'s description is stored - in "picture.txt" in the same directory.) -

    + Tux Paint will display descriptive text when a stamp is selected. These are placed in plain text files with the same name as the PNG or SVG, but with a ".txt" filename extension. (e.g., "stamp.png"'s description is stored in "stamp.txt" in the same directory.)

    - The first line of the text file will be used as the US - English description of the stamp's image. It must be - encoded in UTF-8. -

    + The first line of the text file will be used as the US English description of the stamp's image. It must be encoded in UTF-8.

    - Language Support -

    + Localization Support

    - Additional lines can be added to the text file to - provide translations of the description, to be - displayed when Tux - Paint is running in a different locale (like - French or Spanish). -

    + Additional lines can be added to the text file to provide translations of the description, to be displayed when Tux Paint is running in a different locale (like French or Spanish).

    - The beginning of the line should correspond to the - language code of the language in question (e.g., - "fr" for French, and "zh_TW" - for Traditional Chinese), followed by - ".utf8=" and the translated description - (encoded in UTF-8). -

    + The beginning of the line should correspond to the language code of the language in question (e.g., "fr" for French, and "zh_TW" for Traditional Chinese), followed by ".utf8=" and the translated description (Unicode, encoded in UTF-8).

    - There are scripts in the "po" directory - for converting the text files to PO format (and back) - for easy translation to different languages. Therefore - you should never add or change translations in the .txt - files directly. -

    + For Tux Paint developers: There are scripts in the "po" directory for converting the text files to PO format (and back) for easy translation to different languages. Therefore you should never add or change translations in the ".txt" files directly.

    - If no translation is available for the language - Tux Paint is - currently running in, the US English text is used. -

    + If no translation is available for the language Tux Paint is currently running in, the US English text is used.

    -

    - Windows Users -

    +

    Windows Users

    - Use NotePad or WordPad to - edit/create these files. Be sure to save them as - plain-text, and make sure they have a - ".txt" extension at the end of the - filename. -

    + Use NotePad or WordPad to edit/create these files. Be sure to save them as plain-text, and make sure they have a ".txt" extension at the end of the filename.

    @@ -756,55 +476,29 @@

    Sound Effects + id="sound_effects">Stamp Sound Effects

    - WAVE (".wav") or OGG Vorbis - (".ogg") files with the same name as the PNG - or SVG. (e.g., "picture.svg"'s sound effect - is the sound file "picture.wav" in the same - directory.) -

    + Tux Paint can play a sound effect when a stamp is selected. For example, the sound of a duck quaking when selecting a duck, or a brief piece of music when a musical instrument is chosen. Files may be in "WAVE (".wav")" or "OGG Vorbis (".ogg")" formats, and are given same name as the PNG or SVG image. (e.g., "stamp.svg"'s sound effect is the sound file "stamp.ogg" in the same directory.)

    - Language Support -

    + Localization Support

    - For sounds for different locales (e.g., if the sound is - someone saying a word, and you want translated versions - of the word said), also create WAV or OGG files with - the locale's label in the filename, in the form: - "STAMP_LOCALE.EXT" -

    + For sounds for different locales (e.g., if the sound is someone saying a word, and you want translated versions of the word said), also create WAV or OGG files with the locale's label in the filename, in the form: "stamp_LOCALE.EXT"

    - "picture.png"'s sound effect, when - Tux Paint is - run in Spanish mode, would be - "picture_es.wav". In French mode, - "picture_fr.wav". In Brazilian Portuguese - mode, "picture_pt_BR.wav". And so on... -

    + "stamp.png"'s sound effect, when Tux Paint is run in Spanish mode, would be "stamp.png". In French mode, "stamp_es.wav". In Brazilian Portuguese mode, "stamp_fr.wav". And so on...

    - If no localized sound effect can be loaded, - Tux Paint - will attempt to load the 'default' sound file. (e.g., - "picture.wav") -

    + If no localized sound effect can be loaded, Tux Paint will attempt to load the 'default' sound file. (e.g., "stamp.wav")

    - Note: For descriptive sounds (not sound effects, like a - bang or a bird chirping), consider using the Descriptive Sounds, - described below. -

    + Note: For descriptive sounds (not sound effects, like a bang or a bird chirping), consider using descriptive sounds; see 'Stamp Descriptive Sound', below.

    Descriptive Sound + id="descriptive_sound">Stamp Descriptive Sound

    - WAVE (".wav") or OGG Vorbis (".ogg") files with the same - name as the PNG or SVG, followed by "_desc" - (e.g., "picture.svg"'s descriptive sound is - the sound file "picture_desc.ogg" in the - same directory.) -

    + Tux Paint can also play a descriptive sound when a stamp is selected. For example, the sound of someone saying the word "duck" when selecting a duck, or the name of a musical instrument when one is chosen. Files may be in "WAVE (".wav")" or "OGG Vorbis (".ogg")" formats, and are given same name as the PNG or SVG image, with "_desc" at the end. (e.g., "stamp.svg"'s descriptive sound is the sound file "stamp_desc.ogg" in the same directory.)

    - Language Support -

    + Localization Support

    - For descriptions in different languages, also create - WAV or OGG files with both "_desc" and the - locale's label in the filename, in the form: - "STAMP_desc_LOCALE.EXT" -

    + For descriptive sounds for different locales, also create WAV or OGG files with both "_desc" and the locale's label in the filename, in the form: "stamp_desc_LOCALE.EXT"

    + "stamp.png"'s descriptive sound, when Tux Paint is run in Spanish mode, would be "stamp_desc_es.wav". In French mode, "stamp_desc_fr.wav". In Brazilian Portuguese mode, "stamp_desc_pt_BR.wav". And so on...

    - "picture.png"'s descriptive sound, when - Tux Paint is - run in Spanish mode, would be - "picture_desc_es.wav". In French mode, - "picture_desc_fr.wav". In Brazilian - Portuguese mode, "picture_desc_br_PT.wav". - And so on... -

    - -

    - If no localized descriptive sound can be loaded, - Tux Paint - will attempt to load the 'default' descriptive sound - file. (e.g., "picture_desc.wav") -

    + If no localized descriptive sound can be loaded, Tux Paint will attempt to load the 'default' sound file. (e.g., "stamp_desc.wav")

    @@ -865,52 +536,30 @@

    - Aside from a graphical shape, a textual description, and - a sound effect, stamps can also be given other - attributes. To do this, you need to create a - 'data file' for - the stamp. -

    + Aside from a graphical shape, a textual description, a sound effect, and a descriptive sound, stamps can also be given other attributes. To do this, you need to create a 'data file' for the stamp.

    - A stamp data file is simply a text file containing the - options. -

    + A stamp's data file is simply a plain ASCII text file containing the options for the stamp.

    - The file has the same name as the PNG or SVG image, but a - ".dat" extension. (e.g., - "picture.png"'s data file is the text file - "picture.dat" in the same directory.) -

    + The file has the same name as the PNG or SVG image, but a ".dat" extension. (e.g., "stamp.png"'s data file is the text file "stamp.dat", found in the same directory.)

    - Colored Stamps -

    + Colored Stamps

    - Stamps can be made to be either "colorable" or - "tintable." -

    + Stamps can be made to be either "colorable" or "tintable."

    - Colorable -
    + Colorable

    - "Colorable" stamps they work much like brushes - you - pick the stamp to get the shape, and then pick the - color you want it to be. (Symbol stamps, like the - mathematical and musical ones, are an example.) -

    + "Colorable" stamps they work much like brushes - you pick the stamp to get the shape, and then pick the color you want it to be. (Symbol stamps, like the mathematical and musical ones, are an example.)

    - Nothing about the original image is used except the - transparency (from "alpha" channel). The color of the - stamp comes out solid. -

    + Nothing about the original image is used except the transparency (from "alpha" channel). The color of the stamp comes out solid.

    - Add a line containing the word - "colorable" to the stamp's data - file. -

    + Add a line containing the word "colorable" to the stamp's data file.

    - Tinted -
    + Tinted

    - "Tinted" stamps are similar to "colorable" ones, - except the details of the original image are kept. - (To put it technically, the original image is used, - but its hue is changed, based on the - currently-selected color.) -

    + "Tinted" stamps are similar to "colorable" ones, except the details of the original image are kept. (To put it technically, the original image is used, but its hue is changed, based on the currently-selected color.)

    - Add a line containing the word - "tintable" to the stamp's data - file. -

    + Add a line containing the word "tintable" to the stamp's data file.

    - Tinting Options: -
    + Tinting Options:

    - Depending on the contents of your stamp, you might - want to have Tux - Paint use one of a number of methods when - tinting it. Add one of the following lines to the - stamp's data file: -

    + Depending on the contents of your stamp, you might want to have Tux Paint use one of a number of methods when tinting it. Add one of the following lines to the stamp's data file:

    - "tinter=normal" (default) -
    + Normal tinter — "tinter=normal" (the default)
    - This is the normal tinting mode. (Hue range is - ±18°, 27 replace.) -
    + This is the normal tinting mode. (Hue range is ±18°, 27 replace.)
    - "tinter=anyhue" + 'Any hue' tinter — "tinter=anyhue"
    - This remaps all hues in the stamp. (Hue range is - ±180°.) -
    + This remaps all hues in the stamp. (Hue range is ±180°.)
    - "tinter=narrow" + Narrow tinter — "tinter=narrow"
    - This like 'anyhue', but a narrower - hue angle. (Hue range is ±6°, 9 replace.) -
    + This like the "anyhue" option, but with a narrower hue angle. (Hue range is ±6°, 9 replace.)
    - "tinter=vector" + Vector tinter — "tinter=vector"
    - This maps 'black through white' to 'black through - destination'. -
    + This maps 'black through white' to 'black through destination'.

    - Unalterable Stamps -

    + Unalterable Stamps

    - By default, a stamp can be flipped upside down, shown - as a mirror image, or both. This is done using the - control buttons below the stamp selector, at the lower - right side of the screen in Tux Paint. -

    + By default, a stamp can be flipped upside down, shown as a mirror image, or both. This is done using the control buttons below the stamp selector, at the lower right side of the screen in Tux Paint.

    - Sometimes, it doesn't make sense for a stamp to be - flippable or mirrored; for example, stamps of letters - or numbers. Sometimes stamps are symmetrical, so - letting the user flip or mirror them isn't useful. -

    + Sometimes, it doesn't make sense for a stamp to be flippable or mirrored; for example, stamps of letters or numbers. Sometimes stamps are symmetrical, so letting the user flip or mirror them isn't useful.

    - To make a stamp un-flippable, add the option - "noflip" to the stamp's data file. -

    + To prevent a stamp from being flipped vertically, add the option "noflip" to the stamp's data file.

    - To keep a stamp from being mirrored, add a line - containing the word "nomirror" to - the stamp's data file. -

    + To prevent a stamp from being mirrored horizontally, add the option "nomirror" to the stamp's data file.

    - Initial Stamp Size -

    + Initial Stamp Size

    - By default, Tux - Paint assumes that your stamp is sized - appropriately for unscaled display on a 608x472 canvas. - This is the original Tux Paint canvas size, - provided by a 640x480 screen. Tux Paint will then - adjust the stamp according to the current canvas size - and, if enabled, the user's stamp size controls. -

    + By default, Tux Paint assumes that your stamp is sized appropriately for unscaled display on a 608x472 canvas. This was the original Tux Paint canvas size, provided by a 640x480 screen. Tux Paint will then adjust the stamp according to the current canvas size and, if enabled, the user's stamp size controls.

    - If your stamp would be too big or too small, you can - specify a scale factor. If your stamp would be 2.5 - times as wide (or tall) as it should be, add the option - "scale - 40%" or "scale 5/2" or - "scale - 2.5" or "scale 2:5" to your - image. You may include an "=" if - you wish, as in "scale=40%". -

    + If your stamp would be too big or too small, you can specify a scale factor. If your stamp would be 2.5 times as wide (or tall) as it should be, add one of the following options, which represent the same adjustment, to the stamp's data file. (An equals sign, "=", may be included after the word "scale".)

    +
      +
    • "scale 40%"
      • +
    • "scale 5/2"
      • +
    • "scale 2.5"
      • +
    • "scale 2:5"
      • +
    -

    - Windows Users -

    +

    Windows Users

    - You can use NotePad or WordPad to create these file. Be - sure to save it as Plain Text, and make sure the - filename has ".dat" at the end, and not - ".txt"... -

    + Use NotePad or WordPad to edit/create these files. Be sure to save them as plain-text, and make sure they have a ".txt" extension at the end of the filename.

    Pre-Mirrored and - Flipped Images + id="pre_mirroed_and_flipped_images">Pre-Mirrored and Flipped Stamps

    - In some cases, you may wish to provide a pre-drawn - version of a stamp's mirror-image, flipped image, or even - both. For example, imagine a picture of a fire truck - with the words "Fire - Department" written across the side. You probably do - not want that text to appear backwards when the image is - flipped! -

    + In some cases, you may wish to provide a pre-drawn version of a stamp's mirror-image, flipped image, or even both. For example, imagine a picture of a fire truck with the words "Fire Department" written across the side. You probably do not want that text to appear backwards when the image is flipped!

    - To create a mirrored version of a stamp that you want - Tux Paint to - use, rather than mirroring one on its own, simply create - a second ".png" or ".svg" - graphics file with the same name, except with - "_mirror" before the filename - extension. -

    + To create a mirrored version of a stamp that you want Tux Paint to use, rather than mirroring one on its own, simply create a second ".png" or ".svg" graphics file with the same name, except with "_mirror" before the filename extension.

    - For example, for the stamp - "truck.png" you would create another - file named "truck_mirror.png", which - will be used when the stamp is mirrored (rather than - using a backwards version of 'truck.png'). -

    + For example, for the stamp "stamp.png" you would create another file named "stamp_mirror.png", which will be used when the stamp is mirrored (rather than using a backwards version of "stamp.png").

    - As of Tux Paint - 0.9.18, you may similarly provide a pre-flipped image - with "_flip" in the name, and/or an - image that is both mirrored and flipped, by naming it - "_mirror_flip". -

    + As of Tux Paint 0.9.18, you may similarly provide a pre-flipped image with "_flip" in the name, and/or an image that is both mirrored and flipped, by naming it "_mirror_flip".

    - Note: If the user flips and mirrors an image, and - a pre-drawn "_mirror_flip" doesn't exist, - but either "_flip" or "_mirror" - does, it will be used, and mirrored or flipped, - respectively. -

    + Note: If the user flips and mirrors an image, and a pre-drawn "_mirror_flip" doesn't exist, but either "_flip" or "_mirror" does, it will be used, and mirrored or flipped, respectively.

    @@ -1152,17 +708,10 @@ alt="" align="right">

    - The fonts used by Tux - Paint are TrueType Fonts (TTF). -

    + The fonts used by Tux Paint are TrueType Fonts (TTF).

    - Simply place them in the "fonts" - directory. Tux - Paint will load the font and provide four different - sizes in the 'Letters' selector when using the 'Text' tool. -

    + Simply place them in the "fonts" directory. Tux Paint will load the font and provide four different sizes in the 'Letters' selector when using the 'Text' and 'Label' tools.


    • @@ -1181,146 +730,51 @@ alt="" align="right">

    - 'Starter' images appear in the 'New' dialog, along with - solid color background choices. (Note: In earlier versions - of Tux Paint, - they appeared in the 'Open' dialog, together with saved - drawings.) -

    + 'Starter' images appear in the 'New' dialog, along with solid color background choices.

    - Unlike pictures drawn in Tux Paint by users and then - opened later, opening a 'starter' creates a new drawing. - When you save, the 'starter' image is not overwritten. - Additionally, as you edit your new picture, the contents of - the original 'starter' affect it. -

    + When you use a 'starter' image, make modifications, and save it, the original 'starter' image is not overwritten. Additionally, as you edit your new picture, the contents of the original 'starter' can affect it.

    Coloring-Book Style + id="coloring_book_style">Coloring-Book Style Starters

    - The most basic kind of 'starter' is similar to a picture - in a coloring book. It's an outline of a shape which you - can then color in and add details to. In Tux Paint, as you draw, - type text, or stamp stamps, the outline remains 'above' - what you draw. You can erase the parts of the drawing you - made, but you can't erase the outline. -

    + The most basic kind of 'starter' is similar to a picture in a coloring book. It's an outline of a shape which you can then color in and add details to. In Tux Paint, as you draw, type text, or stamp stamps, the outline remains 'above' what you draw. You can erase the parts of the drawing you made, but you can't erase the outline.

    - To create this kind of 'starter' image, simply draw an - outlined picture in a paint program, make the rest of the - graphic transparent (that will come out as white in - Tux Paint), and - save it as a PNG format file. -

    - -

    - Note: Previous to Tux Paint 0.9.21, images needed - to be black and transparent. As of 0.9.21, if a Starter - is black and white, with no transparency, white will be - converted to transparent when the Starter is opened. -

    - -

    - Note: Previous to Tux Paint 0.9.22, Starters had - to be in PNG or JPEG (backgrounds only) format. As of - 0.9.22, they may be in SVG (vector graphics) or KPX - (templates from Kid Pix, another childrens' drawing - program; they are special files which simply contain a - JPEG within). -

    + To create this kind of 'starter' image, simply create an outlined black and white picture in a paint program, and save it as a raster PNG file, or vector SVG. If saving as a PNG, you may optionally render the image as black-and-transparent, rather than black-and-white, but (as of Tux Paint 0.9.21) this is not required.

    Scene-Style + id="scene_style">Scene-Style Starters

    - Along with the 'coloring-book' style overlay, you can - also provide a separate background image as part of a - 'starter' picture. The overlay acts the same: it can't be - drawn over, erased, or affected by 'Magic' tools. - However, the background can be! -

    + Along with the 'coloring-book' style overlay, you can also provide a separate background image as part of a 'starter' picture. The overlay acts the same: it can't be drawn over, erased, or affected by 'Magic' tools. However, the background can be!

    - When the 'Eraser' tool is used on a picture based on this - kind of 'starter' image, rather than turning the canvas - to a solid color, such as white, it returns that part of - the canvas to the original background picture from the - 'starter'. -

    + When the 'Eraser' tool is used on a picture based on this kind of 'starter' image, rather than turning the canvas to a solid color, such as white, it returns that part of the canvas to the original background picture from the 'starter' image.

    - By creating both an overlay and a background, you can - create a 'starter' which simulates depth. Imagine a - background that shows the ocean, and an overlay that's a - picture of a reef. You can then draw (or stamp) fish in - the picture. They'll appear in the ocean, but never 'in - front of' the reef. -

    + By creating both an overlay and a background, you can create a 'starter' which simulates depth. Imagine a background that shows the ocean, and an overlay that's a picture of a reef. You can then draw (or stamp) fish in the picture. They'll appear in the ocean, but never 'in front of' the reef.

    - To create this kind of 'starter' picture, simply create - an overlay (with transparency) as described above, and - save it as a PNG. Then create another image (without - transparency), and save it with the same filename, but - with "-back" appended to the name. (e.g., - "reef-back.png" would be the background - ocean picture that corresponds to the - "reef.png" overlay, or foreground.) -

    + To create this kind of 'starter' picture, simply create an overlay (with transparency) and save it as a PNG. Then create another image (without transparency), and save it with the same filename, but with "-back" (short for 'background') appended to the name. (e.g., "starter-back.png" would be the background ocean picture that corresponds to the overlay, or foreground.)

    - The 'starter' images should be the same size as - Tux Paint's - canvas. (See the "Loading Other Pictures into Tux Paint" section of - README for details on sizing.) If - they are not, they will be stretched, without affecting the - shape ("aspect ratio"); however some smudging may be - applied to the edges. -

    + For best results, 'starter' images should be at least the same size as Tux Paint's drawing canvas. (See the "Loading Other Pictures into Tux Paint" section of Tux Paint's main documentation (README) for details on sizing.) If they are not, they will be stretched or scaled. This is done without affecting the shape ("aspect ratio"); however some smudging may be applied to the edges.

    - Place them in the "starters" directory. - When the 'New' dialog is accessed in Tux Paint, the 'starter' - images will appear in the screen that appears, after the - various solid color choices. -

    + Place them in the "starters" directory. When the 'New' dialog is accessed in Tux Paint, the 'starter' images will appear in the screen that appears, after the various solid color choices.

    - Note: 'Starters' can't be saved over from within - Tux Paint, since - loading a 'starter' is really like creating a new image. - (Instead of being blank, though there's already something - there to work with.) The 'Save' command simply creates a - new picture, like it would if the 'New' command had been - used. -

    - -

    - Note: 'Starters' are 'attached' to saved pictures, - via a small text file that has the same name as the saved - file, but with ".dat" as the extension. This - allows the overlay and background, if any, to continue to - affect the drawing even after Tux Paint has been quit, or - another picture loaded or started. (In other words, if you - base a drawing on a 'starter' image, it will always be - affected by it.) -

    + Note: 'Starters' are 'attached' to saved pictures, via a small text file that has the same name as the saved file, but with ".dat" as the extension. This allows it to continue to affect the drawing even after Tux Paint has been quit, or another picture is loaded or a new image is created. (In other words, if you base a drawing on a 'starter' image, it will always be affected by it.)


    @@ -1339,73 +793,25 @@ alt="" align="right">

    - 'Template' images also appear in the 'New' dialog, along - with solid color background choices and 'Starters'. (Note: - Tux Paint prior - to version 0.9.22 did not have the 'Template' feature.) -

    + 'Template' images also appear in the 'New' dialog, along with solid color background choices and 'Starters'. (Note: Tux Paint prior to version 0.9.22 did not have the 'Template' feature.)

    - Unlike pictures drawn in Tux Paint by users and then - opened later, opening a 'template' creates a new drawing. - When you save, the 'template' image is not overwritten. - Unlike 'starters', there is no immutable 'layer' above the - canvas. You may draw over any part of it. -

    + Unlike pictures drawn in Tux Paint by users and then opened later, opening a 'template' creates a new drawing. When you save, the 'template' image is not overwritten. Unlike 'starters', there is no immutable 'layer' above the canvas. You may draw over any part of it.

    - When the 'Eraser' tool is used on a picture based on a - 'template', rather than turning the canvas to a solid - color, such as white, it returns that part of the canvas to - the original picture from the 'template'. -

    + When the 'Eraser' tool is used on a picture based on this kind of 'template' image, rather than turning the canvas to a solid color, such as white, it returns that part of the canvas to the original background picture from the 'template' image.

    - 'Templates' are simply image files (in PNG, JPG, SVG or KPX - format). No preparation or conversion should be required. -

    + 'Templates' are simply image files (in PNG, JPEG, SVG, or KPX (KidPix) format). No preparation or conversion should be required.

    - The 'template' images should be the same size as - Tux Paint's - canvas. (See the "Loading Other Pictures into Tux Paint" section of - README for details on sizing.) If - they are not, they will be stretched, without affecting the - shape ("aspect ratio"); however some smudging may be - applied to the edges. -

    + For best results, 'template' images should be at least the same size as Tux Paint's drawing canvas. (See the "Loading Other Pictures into Tux Paint" section of Tux Paint's main documentation (README) for details on sizing.) If they are not, they will be stretched or scaled. This is done without affecting the shape ("aspect ratio"); however some smudging may be applied to the edges.

    - Place them in the "templates" - directory. When the 'New' dialog is accessed in - Tux Paint, the - 'template' images will appear in the screen that appears, - after the various solid color choices and 'starters'. -

    + Place them in the "templates" directory. When the 'New' dialog is accessed in Tux Paint, the 'template' images will appear in the screen that appears, after the various solid color choices.

    - Note: 'Templates' can't be saved over from within - Tux Paint, since - loading a 'template' is really like creating a new image. - (Instead of being blank, though there's already something - there to work with.) The 'Save' command simply creates a - new picture, like it would if the 'New' command had been - used. -

    - -

    - Note: 'Templates' are 'attached' to saved pictures, - via a small text file that has the same name as the saved - file, but with ".dat" as the extension. This - allows the background to continue to be available to the - drawing (e.g., when using the 'Eraser' tool) even after - Tux Paint has - been quit, or another picture loaded or started. (In other - words, if you base a drawing on a 'template' image, it will - always be affected by it.) -

    + Note: 'Templates' are 'attached' to saved pictures, via a small text file that has the same name as the saved file, but with ".dat" as the extension. This allows it to continue to affect the drawing even after Tux Paint has been quit, or another picture is loaded or a new image is created. (In other words, if you base a drawing on a 'template' image, it will always be affected by it.)


    @@ -1419,43 +825,16 @@

    - Tux Paint - supports numerous languages, thanks to use of the "gettext" - localization library. (See OPTIONS for how to change locales in - Tux Paint.) -

    + Tux Paint supports numerous languages, thanks to use of the "gettext" localization library. (See "Options documentation" for how to change locales in Tux Paint.)

    - To translate Tux - Paint to a new language, copy the translation - template file, "tuxpaint.pot" (found in - Tux Paint's - source code, in the folder "src/po/"). Rename - the copy as a ".po" file, with an appropriate - name for the locale you're translating to (e.g., - "es.po" for Spanish; or - "pt_BR.po" for Brazilian Portuguese, versus - "pt.po" or "pt_PT.po" for - Portuguese spoken in Portugal.) -

    + To translate Tux Paint to a new language, copy the translation template file, "tuxpaint.pot" (found in Tux Paint's source code, in the folder "src/po/"). Rename the copy as a ".po" file, with an appropriate name for the locale you're translating to (e.g., "es.po" for Spanish; or "pt_BR.po" for Brazilian Portuguese, versus "pt.po" or "pt_PT.po" for Portuguese spoken in Portugal.)

    - Open the newly-created ".po" file — you can - edit in a plain text edtior, such as Emacs, Pico or - VI on Linux, or NotePad on Windows. The original English - text used in Tux - Paint is listed in lines starting with - "msgid". Enter your translations of each of - these pieces of text in the empty "msgstr" - lines directly below the corresponding "msgid" - lines. (Note: Do not remove the quotes.) -

    + Open the newly-created ".po" file — you can edit in a plain text edtior, such as Emacs, Pico or VI on Linux, or NotePad on Windows. The original English text used in Tux Paint is listed in lines starting with "msgid". Enter your translations of each of these pieces of text in the empty "msgstr" lines directly below the corresponding "msgid" lines. (Note: Do not remove the quotes.)

    - Example: -

    + Example:

    @@ -1463,68 +842,33 @@ msgstr "Manchar"

    msgid "Click and drag to draw large bricks."
    - msgstr "Haz clic y arrastra para dibujar ladrillos - grandes." + msgstr "Haz clic y arrastra para dibujar ladrillos grandes."

    - A graphical tool, called poEdit (http://www.poedit.net/), is - available for Linux, Windows and macOS. -

    + Various tools exist to manage gettext translation catalogs, so you don't have to edit them by hand in a text editor. Here are a few:

    +

    - Note: It is best to always work off of the - latest Tux - Paint text catalog template - ("tuxpaint.pot"), since new text is added, and - old text is occasionally changed. The text catalog for the - upcoming, unreleased version of Tux Paint can be found in - Tux Paint's Git - repository (see: http://www.tuxpaint.org/download/source/git/), - and on the Tux - Paint website at http://www.tuxpaint.org/help/po/. -

    + Note: It is best to always work off of the latest Tux Paint text catalog template ("tuxpaint.pot"), since new text is added, and old text is occasionally changed. The text catalog for the upcoming, unreleased version of Tux Paint can be found in Tux Paint's Git repository (see: http://www.tuxpaint.org/download/source/git/), and on the Tux Paint website at http://www.tuxpaint.org/help/po/.

    - To edit an existing translation, download the latest - ".po" file for that language, and edit it as - described above. -

    + To edit an existing translation, download the latest ".po" file for that language, and edit it as described above.

    - You may send new or edited translation files to - Bill Kendrick, - lead developer of Tux - Paint, at: bill@newbreedsoftware.com, - or post them to the "tuxpaint-i18n" mailing list (see: - http://www.tuxpaint.org/lists/). -

    + You may send new or edited translation files to Bill Kendrick, lead developer of Tux Paint, at: bill@newbreedsoftware.com, or post them to the "tuxpaint-i18n" mailing list (see: http://www.tuxpaint.org/lists/).

    - Alternatively, if you have an account with SourceForge.net, you can - request to be added to the "tuxpaint" project - and receive write-access to the Git source code repository - so that you may commit your changes directly. -

    + Alternatively, if you have an account with SourceForge.net, you can request to be added to the "tuxpaint" project and receive write-access to the Git source code repository so that you may commit your changes directly.

    - Note: Additional locale support also requires - additions to Tux - Paint's source code (/src/i18n.h and - /src/i18n.c), and requires updates to the - Makefile, to have the ".po" - gettext catalog source files compiled into - ".mo" files, and installed, for use at - runtime. -

    + Note: Support for new locales requires making additions to Tux Paint's source code ("/src/i18n.h" and "/src/i18n.c"), and requires updates to the Makefile, to ensure the ".po" files are compiled into ".mo" files, and available for use at runtime.

    - As of version 0.9.17, Tux Paint's "Text" tool can - provide alternative input methods for some languages. For - example, when Tux - Paint is running with a Japanese locale, the - right [Alt] key can be - pressed to cycle between Latin, Romanized Hiragana and - Romanized Katakana modes. This allows native characters and - words to be entered into the "Text" tool by typing one or - more keys on a keyboard with Latin characters (e.g., a - US QWERTY - keyboard). -

    + Tux Paint's 'Text' and 'Label' tools can provide alternative input methods for some languages. For example, when Tux Paint is running with a Japanese locale, the right [Alt] key can be pressed to cycle between Latin, Romanized Hiragana and Romanized Katakana modes. This allows native characters and words to be entered into the 'Text' and 'Label' tools by typing one or more keys on a keyboard with Latin characters (e.g., a US QWERTY keyboard).

    - To create an input method for a new locale, create a text - file with a name based on the locale (e.g., - "ja" for Japanese), with ".im" as - the extension (e.g., "ja.im"). -

    + To create an input method for a new locale, create a text file with a name based on the locale (e.g., "ja" for Japanese), with ".im" as the extension (e.g., "ja.im").

    - The ".im" file can have multiple character - mapping sections for different character mapping modes. For - example, on a Japanese typing system, typing [K] [A] in - Hiragana mode generates a different Unicode character than - typing [K] - [A] in Katakana mode. -

    + The ".im" file can have multiple character mapping sections for different character mapping modes. For example, on a Japanese typing system, typing [K] [A] in Hiragana mode generates a different Unicode character ("か") than typing [K] [A] in Katakana mode ("カ").

    - List the character mappings in this file, one per line. - Each line should contain (separated by whitespace): -

    + List the character mappings in this file, one per line. Each line should contain (separated by whitespace):

    - Start additional character mapping sections with a line - containign the word "section". -

    + Start additional character mapping sections with a line containign the word "section".

    - Example: -

    + Example:

    @@ -1616,27 +926,13 @@

    - Note: Blank lines within the ".im" file - will be ignored, as will any text following a - "#" (pound/hash) character — it can be used to - denote comments, as seen in the example above. -

    + Note: Blank lines within the ".im" file will be ignored, as will any text following a "#" (pound/hash) character — it can be used to denote comments, as seen in the example above.

    - Note: Meanings of the flags are locale-specific, and - are processed by the language-specific source code in - "src/im.c". For example, "b" is - used in Korean to handle Batchim, which may carry over to - the next character. -

    + Note: Meanings of the flags are locale-specific, and are processed by the language-specific source code in "src/im.c". For example, "b" is used in Korean to handle Batchim, which may carry over to the next character.

    - Note: Additional input method support also requires - additions to Tux - Paint's source code (/src/im.c), and - requires updates to the Makefile, to have the - ".im" files installed, for use at runtime. -

    + Note: Support for new input methods requires making additions to Tux Paint's source code ("/src/im.c"), and requires updates to the Makefile, to ensure the ".im" files are available for use at runtime.

    - As of version 0.9.22, Tux Paint's "Text" and - "Label" tools can present an on-screen keyboard that allows - the pointer (via a mouse, eye-tracking systems, etc.) to be - used to input characters. Files that describe the layout - and available keys are stored in Tux Paint's - "osk" directory. Each keyboard layout is - defined by a number of files (some of which may be shared - by different layouts). We'll use the QWERTY keyboard as an - example: -

    - + As of version 0.9.22, Tux Paint's 'Text' and 'Label' tools can present an on-screen keyboard that allows the pointer (via a mouse, eye-tracking systems, etc.) to be used to input characters. Files that describe the layout and available keys are stored in Tux Paint "osk" directory. Each keyboard layout is defined by a number of files (some of which may be shared by different layouts).

    +

    + We'll use the QWERTY keyboard as an example:

    +

    - Layout overview file ("qwerty.layout") -

    + Layout overview file ("qwerty.layout")

    - This is a text file that specifies the other files used - to describe the layout and key mappings. -

    + This is a text file that specifies the other files used to describe the layout and key mappings.

    layout qwerty.h_layout
    keymap us-intl-altgr-dead-keys.keymap
    - - composemap en_US.UTF-8_Compose
    + composemap en_US.UTF-8_Compose
    keysymdefs keysymdef.h
    keyboardlist qwerty.layout default.layout

    - Note: Blank lines within the - ".layout" file will be ignored, as will any - text following a "#" (pound/hash) character - — it can be used to denote comments, as seen in the - example above. -

    + Note: Blank lines within the ".layout" file will be ignored, as will any text following a "#" (pound/hash) character — it can be used to denote comments, as seen in the example above.

    - The "keyboardlist" line describes which - layouts to switch to, when the user clicks the left and - right buttons on the keyboard. (See below.) -

    + The "keyboardlist" line describes which layouts to switch to, when the user clicks the left and right buttons on the keyboard. (See below.)

    - Keyboard layout file ("qwerty.h_layout") -

    + Keyboard layout file ("qwerty.h_layout")

    - This describes how big the keyboard is (as a W×H grid), - and lists each key with its numeric keycode (see the - "keymap" file, below), the width it should be drawn at - (typically "1.0", to take one space on the - keyboard, but in the example below, notice the - "TAB" and "SPACE" keys are much - wider), the character or text to display on the key, - depending on which modifier keys have been pressed (one - each for: no modifiers, [Shift], [AltGr], - and [Shift]+[AltGr]), and finally whether or not - the key is affected by the [CapsLock] key (use - "1") or [AltGr] (alternate graphics) - key (use "2"), or not at all (use - "0"). -

    + This describes how big the keyboard is (as a "width × height" grid), and lists each key with its numeric keycode (see the "keymap" file, below), the width it should be drawn at (typically "1.0", to take one space on the keyboard, but in the example below, notice the "TAB" and "SPACE" keys are much wider), the character or text to display on the key, depending on which modifier keys have been pressed (one each for: no modifiers, [Shift], [AltGr], and [Shift] + [AltGr]), and finally whether or not the key is affected by the [CapsLock] key (use "1") or [AltGr] (alternate graphics) key (use "2"), or not at all (use "0").

    @@ -1747,14 +1007,12 @@
    NEWLINE

    - # Arrow to left will change to the previous - keyboard
    + # Arrow to left will change to the previous keyboard
    KEY 2 1.0 <- <- <- <- 0

    KEY 133 2.0 Cmp Cmp Cmp Cmp 0

    - # The ALT or ALTGR keys are used in im to switch the - input mode.
    + # The ALT or ALTGR keys are used in im to switch the input mode
    KEY 64 2.0 Alt Alt Alt Alt 0

    # Space
    @@ -1768,57 +1026,35 @@

    - Notice here that alphabetic keys ([Q], [W], - etc.) will be affected by [CapsLock], while - numeric keys ([1], [2], etc.), - [Space], and so on, will not. -

    + Notice here that alphabetic keys ([Q], [W], etc.) will be affected by [CapsLock], while numeric keys ([1], [2], etc.), [Space], and so on, will not.

    - Keycodes up to "8" are reserved for internal - use. The ones currently used are described below. -

    + Keycodes up to "8" are reserved for internal use. The ones currently used are described below.

    • - 0 — empty button -
      • + 0 — + empty button
    • - 1 — next layout (per the layout file's - "keyboardlist" setting) -
      • + 1 — + next layout (per the layout file's "keyboardlist" setting)
    • - 2 — previous layout (per the layout file's - "keyboardlist" setting) -
      • + 2 — + previous layout (per the layout file's "keyboardlist" setting)

    - Keymap file ("us-intl-altgr-dead-keys.keymap") -

    + Keymap file ("us-intl-altgr-dead-keys.keymap")

    - This file defines which numeric keycodes (seen in the - keyboard layout files, such as - "qwerty.h_layout" described above) should be - mapped to which actual characters that an application - such as Tux - Paint expects to receive when keys (e.g., on a - real keyboard) are pressed. -

    + This file defines which numeric keycodes (seen in the keyboard layout files, such as "qwerty.h_layout" described above) should be mapped to which actual characters that an application such as Tux Paint expects to receive when keys (e.g., on a real keyboard) are pressed.

    - If you're using an operating system such as - Linux, which runs X-Window and - has the "xmodmap" command-line tool - available, you can run it with the ("print keymap expressions" - option, "-pke", to generate a keymap file. -

    + If you're using an operating system such as Linux, which runs X-Window and has the "xmodmap" command-line tool available, you can run it with the ("print keymap expressions" option, "-pke", to generate a keymap file.

    @@ -1860,49 +1096,28 @@

    - Composemap file ("en_US.UTF-8_Compose") -

    + Composemap file ("en_US.UTF-8_Compose")

    - This file describes characters that can be composed by - multiple inputs. For example, "[Compose]" followed - by "[A]" and "[E]" can be used to create - the "æ" character. -

    + This file describes single characters that can be composed by multiple inputs. For example, "[Compose]" followed by "[A]" and "[E]" can be used to create the "æ" character.

    - The file that comes with Tux Paint is based on the - US English UTF-8 (Unicode) composemap that comes with - X.Org's X Window - system. The current version from the - Xlib library as a web page at - https://www.x.org/releases/current/doc/libX11/i18n/compose/en_US.UTF-8.html). -

    + The file that comes with Tux Paint is based on the US English UTF-8 (Unicode) composemap that comes with X.Org's X Window system. The current version from the Xlib library has a web located page at https://www.x.org/releases/current/doc/libX11/i18n/compose/en_US.UTF-8.html.

    - Keysym definitions file ("keysymdef.h") -

    + Keysym definitions file ("keysymdef.h")

    - This file (which is a C programming language - header file) is also from the X Window System. It defines - the Unicode values of each keycap (e.g., - "XK_equal" corresponds to - "U+003D", for the character "=" - ("EQUALS - SIGN"). -

    + This file (which is a C programming language header file) is also from the X Window System. It defines the Unicode values of each keycap (e.g., "XK_equal" corresponds to "U+003D", for the character "=" ("EQUALS SIGN").

    - It is unlikely that any modification will be required of - this file. -

    + Note: This file is not compiled into Tux Paint, but is read and parsed at runtime.

    + +

    + It is unlikely that any modification will be required of this file.

    diff --git a/docs/en/html/FAQ.html b/docs/en/html/FAQ.html index 80e80649d..2baa5164e 100644 --- a/docs/en/html/FAQ.html +++ b/docs/en/html/FAQ.html @@ -1,11 +1,8 @@ - - Tux Paint Frequently Asked Questions - + Tux Paint Frequently Asked Questions @@ -19,105 +16,59 @@ Tux Paint
    - version 0.9.26
    - Frequently Asked Questions - + alt="Tux Paint">
    + version 0.9.26 Frequently Asked Questions

    - Copyright (c) 2002-2020 by various contributors; see - AUTHORS.txt
    - http://www.tuxpaint.org/ + Copyright © 2002-2021 by various contributors; see AUTHORS.
    + http://www.tuxpaint.org/

    - September 14, 2002 - December 27, 2020 -

    + 23 January 2021

    - Drawing-related -

    + Drawing-related
    - Fonts I added to Tux Paint only show squares -
    + Fonts I added to Tux Paint only show squares
    - The TrueType Font you're using might have the wrong - encoding. If it's 'custom' encoded, for example, you can - try running it through FontForge (http://fontforge.sourceforge.net/) - to convert it to an ISO-8859 format. (Email us if you need - help with special fonts.) + The TrueType Font you're using might have the wrong encoding. If it's 'custom' encoded, for example, you can try running it through FontForge (http://fontforge.sourceforge.net/) to convert it to an ISO-8859 format. (Email us if you need help with special fonts.)
    + +
    + The Rubber Stamp tool is greyed out!
    + +
    +

    + This means that Tux Paint either couldn't find any stamp images, or was asked not to load them.

    + +

    + If you installed Tux Paint, but did not install the separate, optional "Stamps" collection, quit Tux Paint and install it now. It should be available from the same place you got the main Tux Paint program. (Note: As of version 0.9.14, Tux Paint comes with a small collection of example stamps.)

    + +

    + If you don't want to install the default collection of stamps, you can just create your own. See the "Extending Tux Paint" documentation for more on creating PNG and SVG image files, TXT text description files, Ogg Vorbis, MP3 or WAV sound files, and DAT text data files that make up stamps.

    + +

    + Finally, if you installed stamps, and think they should be loading, check to see that the "nostamps" option isn't being set. (Either via a "--nostamps" option to Tux Paint's command line, or "nostamps=yes" in the configuration file.)

    + +

    + Either change/remove the "nostamps" option, or you can override it with "--stamps" on the command line or either "nostamps=no" or "stamps=yes" in a configuration file.

    - The Rubber Stamp tool is greyed out! -
    + The "Fill" Tool Looks Bad

    - This means that Tux Paint either couldn't find any - stamp images, or was asked not to load them. -

    + Tux Paint is probably comparing exact pixel colors when filling. This is faster, but looks worse. Run the command "tuxpaint --verbose-version" from a command line, and you should see, amongst the other output: "Low Quality Flood Fill enabled".

    - If you installed Tux Paint, but did not install the - separate, optional "Stamps" collection, quit - Tux Paint and install it now. It should be available - from the same place you got the main Tux Paint - program. (Note: As of version 0.9.14, Tux Paint - comes with a small collection of example stamps.) -

    - -

    - If you don't want to install the default collection of - stamps, you can just create your own. See the EXTENDING TUX PAINT documentation - for more on creating PNG and SVG image files, TXT text - description files, Ogg Vorbis, MP3 or WAV sound - files, and DAT text data files that make up stamps. -

    - -

    - Finally, if you installed stamps, and think they should - be loading, check to see that the "nostamps" option isn't - being set. (Either via a "--nostamps" option - to Tux Paint's command line, or - "nostamps=yes" in the configuration file.) -

    - -

    - If so, either change/remove the "nostamps" option, or you - can override it with "--stamps" on the - command line or "nostamps=no" or - "stamps=yes" in a configuration file. -

    -
    - -
    - The Magic "Fill" Tool Looks Bad -
    - -
    -

    - Tux Paint is probably comparing exact pixel colors - when filling. This is faster, but looks worse. Run the - command "tuxpaint --version" from a - command line, and you should see, amongst the other - output: "Low Quality Flood Fill enabled". -

    - -

    - To change this, you must rebuild Tux Paint from - source. Be sure to remove or comment out any line that - says: -

    + To change this, you must rebuild Tux Paint from source. Be sure to remove or comment out any line that says:

    @@ -126,24 +77,18 @@

    - in the "tuxpaint.c" file in the "src" directory. -

    + in the "tuxpaint.c" file in the "src" directory.

    - Stamp outlines are always rectangles -
    + Stamp outlines are always rectangles

    - Tux Paint was built with low-quality (but faster) - stamp outlines. -

    + Tux Paint was built with low-quality (but faster) stamp outlines.

    - Rebuild Tux Paint from source. Be sure to remove or - comment out any line that says: -

    + To change this, you must rebuild Tux Paint from source. Be sure to remove or comment out any line that says:

    @@ -152,36 +97,25 @@

    - in the "tuxpaint.c" file in the "src" directory. -

    + in the "tuxpaint.c" file in the "src" directory.

    - Interface Problems -

    + Interface Problems
    - Stamp thumbnails in the Stamp Selector look bad -
    + Stamp thumbnails in the Stamp Selector look bad

    - Tux Paint was probably compiled with the faster, - lower quality thumbnail code enabled. Run the command: - "tuxpaint --version" from a command - line. If, amongst the other output, you see the text: - "Low Quality Thumbnails enabled", then this is what's - happening. -

    + Tux Paint was probably compiled with the faster, lower quality thumbnail code enabled. Run the command: "tuxpaint --verbose-version" from a command line. If, amongst the other output, you see the text: "Low Quality Thumbnails enabled", then this is what's happening.

    - Rebuild Tux Paint from source. Be sure to remove or - comment out any line that says: -

    + To change this, you must rebuild Tux Paint from source. Be sure to remove or comment out any line that says:

    @@ -190,38 +124,24 @@

    - in the "tuxpaint.c" file in the "src" directory. -

    + in the "tuxpaint.c" file in the "src" directory.

    - Pictures in the 'Open' dialog look bad -
    + Pictures in the 'Open' dialog look bad
    - "Low Quality Thumbnails" is probably enabled. See: "Stamp - thumbnails in the Stamp Selector look bad", above. -
    + "Low Quality Thumbnails" is probably enabled. See: "Stamp thumbnails in the Stamp Selector look bad", above.
    - The color picker buttons are ugly squares, not pretty - buttons! -
    + The color picker buttons are ugly squares, not pretty buttons!

    - Tux Paint was probably compiled with the nice - looking color selector buttons disabled. Run the command: - "tuxpaint --version" from a command - line. If, amongst the other output, you see the text: - "Low Quality Color Selector enabled", then this is what's - happening. -

    + Tux Paint was probably compiled with the nice looking color selector buttons disabled. Run the command: "tuxpaint --verbose-version" from a command line. If, amongst the other output, you see the text: "Low Quality Color Selector enabled", then this is what's happening.

    - Rebuild Tux Paint from source. Be sure to remove or - comment out any line that says: -

    + To change this, you must rebuild Tux Paint from source. Be sure to remove or comment out any line that says:

    @@ -230,130 +150,61 @@

    - in the "tuxpaint.c" file in the "src" directory. -

    + in the "tuxpaint.c" file in the "src" directory.

    - All of the text is in uppercase! -
    + All of the text is in uppercase!

    - The "uppercase" option is on. -

    + The "uppercase" option is on.

    - If you're running Tux Paint from a command-line, - make sure you're not giving it an - "--uppercase" option. -

    - -

    - If you're running Tux Paint by double-clicking an - icon, check the properties of the icon to see if - "--uppercase" is listed as a command-line - argument. -

    - -

    - If "--uppercase" isn't being sent on the - command line, check Tux Paint's configuration file - ("~/.tuxpaintrc" under Linux and Unix, "tuxpaint.cfg" - under Windows) for a line reading: - "uppercase=yes". -

    - -

    - Either remove that line, or simply run Tux Paint - with the command-line argument: - "--mixedcase", which will override the - uppercase setting. -

    - -

    - Or use Tux Paint Config. and make sure "Show - Uppercase Text Only" (under "Languages") is not checked. -

    -
    + Either change/remove the "uppercase" option, or you can override it with "--mixedcase" on the command line or either "uppercase=no" or "mixedcase=yes" in a configuration file.
    - Tux Paint is in a different language! -
    + Tux Paint is in a different language
    - Make sure your locale setting is correct. See - "Tux Paint won't switch to my language", below. -
    + Make sure your locale setting is correct. See "Tux Paint won't switch to my language", below.
    - Tux Paint won't switch to my language -
    + Tux Paint won't switch to my language
    • - Linux and Unix users: Make sure the locale is - available + Linux and Unix users: Make sure the locale is available

      - Make sure the locale you want is available. Check - your "/etc/locale.gen" file. See the OPTIONS documentation for the - locales Tux Paint uses (especially when using - the "--lang" option). -

      + Make sure the locale you want is available. Check your "/etc/locale.gen" file. See the "Options Documentation" for the locales Tux Paint uses (especially when using the "--lang" option).

      - Note: Debian and derivative (e.g., Ubuntu) users can - simply run "dpkg-reconfigure locales" if - the locales are managed by "dpkg." -

      + Note: Debian and derivative (e.g., Ubuntu) users can simply run "dpkg-reconfigure locales" if the locales are managed by "dpkg".

      • -
    • If you're using the "--lang" - command-line option -

      - Try using the "--locale" command-line - option, or your operating system's locale settings - (e.g., the "$LANG" environment - variable), and please e-mail us regarding your - trouble. -

      +
    • If you're using the "--lang" command-line option

      + Try using the "--locale" command-line option, or your operating system's locale settings (e.g., the "$LANG" environment variable), and please e-mail us regarding your trouble.

      • -
    • If you're using the "--locale" - command-line option -

      - If this doesn't work, please e-mail us regarding your - trouble. -

      +
    • If you're using the "--locale" command-line option

      + If this doesn't work, please e-mail us regarding your trouble.

      • -
    • If you're trying to use your Operating System's - locale -

      - If this doesn't work, please e-mail us regarding your - trouble. -

      +
    • If you're trying to use your Operating System's locale

      + If this doesn't work, please e-mail us regarding your trouble.

      • -
    • Make sure you have the necessary font -

      - Some translations require their own font. Chinese and - Korean, for example, need Chinese and Korean TrueType - Fonts installed and placed in the proper location, - respectively. -

      +
    • Make sure you have the necessary font

      + Some translations require their own font. Chinese and Korean, for example, need Chinese and Korean TrueType Fonts installed and placed in the proper location, respectively.

      - The appropriate fonts for such locales can be - downloaded from the Tux Paint website: -

      + The appropriate fonts for such locales can be downloaded from the Tux Paint website:

      http://www.tuxpaint,org/download/fonts/ + "http://www.tuxpaint.org/download/fonts/">http://www.tuxpaint.org/download/fonts/

      • @@ -364,156 +215,85 @@

      - Printing -

      + Printing
      - Tux Paint won't print, gives an error, or prints - garbage (Unix/Linux) -
      + Tux Paint won't print, gives an error, or prints garbage (Unix/Linux)

      - Tux Paint prints by creating a PostScript rendition - of the picture and sending it to an external command. By - default, this command is the "lpr" printing tool. -

      + Tux Paint prints by creating a PostScript rendition of the picture and sending it to an external command. By default, this command is the "lpr" printing tool.

      - If that program is not available (for example, you're - using CUPS, the Common Unix Printing System, and do not - have "cups-lpr" installed), you will need to specify an - appropriate command using the "printcommand" option in - Tux Paint's configuration file. (See the OPTIONS documentation.) -

      + If that program is not available (for example, you're using CUPS, the Common Unix Printing System, and do not have "cups-lpr" installed), you will need to specify an appropriate command using the "printcommand" option in Tux Paint's configuration file. (See the "Options Documentation".)

      - Note: Versions of Tux Paint prior to 0.9.15 - used a different default command for printing, - "pngtopnm | pnmtops | lpr", as - Tux Paint output PNG format, rather than PostScript. -

      + Note: Versions of Tux Paint prior to 0.9.15 used a different default command for printing, "pngtopnm | pnmtops | lpr", as Tux Paint output PNG format, rather than PostScript.

      - If you had changed your "printcommand" option prior to - Tux Paint 0.9.15, you will need to go back and alter - it to accept PostScript. -

      + If you had changed your "printcommand" option prior to Tux Paint 0.9.15, you will need to go back and alter it to accept PostScript.

      - I get the message "You can't print yet!" when I go to - print! -
      + I get the message "You can't print yet!" when I go to print

      - The "print delay" option is on. You can only print once - every X seconds. -

      + The "print delay" option is on. You can only print once every X seconds.

      - If you're running Tux Paint from a command-line, - make sure you're not giving it a - "--printdelay=..." option. -

      + If you're running Tux Paint from a command-line, make sure you're not giving it a "--printdelay=..." option.

      - If you're running Tux Paint by double-clicking an - icon, check the properties of the icon to see if - "--printdelay=..." is listed as a - command-line argument. -

      + If you're running Tux Paint by double-clicking an icon, check the properties of the icon to see if "--printdelay=..." is listed as a command-line argument.

      - If a "--printdelay=..." option isn't being - sent on the command line, check Tux Paint's - configuration file ("~/.tuxpaintrc" under Linux and Unix, - "tuxpaint.cfg" under Windows) for a line reading: - "printdelay=...". -

      + If a "--printdelay=..." option isn't being sent on the command line, check Tux Paint's configuration file for a line reading: "printdelay=...".

      - Either remove that line, set the delay value to 0 (no - delay), or decrease the delay to a value you prefer. (See - the OPTIONS documentation). -

      + Either remove that line, set the delay value to 0 (no delay), or decrease the delay to a value you prefer. (See the "Options Documentation".)

      - Or, you can simply run Tux Paint with the - command-line argument: "--printdelay=0", - which will override the configuration file's setting, and - allow unlimited printing. (You won't have to wait between - prints.) -

      - -

      - Or use Tux Paint Config. and make sure "Print - Delay" (under "Printing") is set to "0 seconds." -

      + Or, you can simply run Tux Paint with the command-line argument: "--printdelay=0", which will override the configuration file's setting, and allow unlimited printing. (You won't have to wait between prints.)

      - I simply can't print! The button is greyed out! -
      + I simply can't print! The button is greyed out!

      - The "no print" option is on. -

      + The "no print" option is on.

      - If you're running Tux Paint from a command-line, - make sure you're not giving it a "--noprint" - option. -

      + If you're running Tux Paint from a command-line, make sure you're not giving it a "--noprint" option.

      - If you're running Tux Paint by double-clicking an - icon, check the properties of the icon to see if - "--noprint" is listed as an argument. -

      + If you're running Tux Paint by double-clicking an icon, check the properties of the icon to see if "--noprint" is listed as a command-line argument.

      - If "--noprint" isn't on the command-line, - check Tux Paint's configuration file - ("~/.tuxpaintrc" under Linux and Unix, "tuxpaint.cfg" - under Windows) for a line reading: - "noprint=yes". -

      + If a "--noprint" option isn't being sent on the command line, check Tux Paint's configuration file for a line reading: "noprint=yes".

      - Either remove that line, or simply run Tux Paint - with the command-line argument: "--print", - which will override the configuration file's setting. -

      + Either remove that line, or simply run Tux Paint with the command-line argument: "--print", which will override the configuration file's setting.

      - Or use Tux Paint Config. and make sure "Allow - Printing" (under "Printing") is checked. -

      + Or use Tux Paint Config. and make sure "Allow Printing" (under "Printing") is checked.

      - Saving -

      + Saving
      - Where does Tux Paint save my drawings? -
      + Where does Tux Paint save my drawings?

      - 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: -

      + 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:

      @@ -521,143 +301,92 @@
      - In the user's "AppData" folder:
      - e.g., - C:\Users\Username\AppData\Roaming\TuxPaint\saved
      -
      + In the user's "AppData" folder:
      e.g., C:\Users\Username\AppData\Roaming\TuxPaint\saved
      Windows 95, 98, ME, 2000, XP
      - In the user's "Application Data" folder:
      - e.g., C:\Documents and - Settings\Username\Application - Data\TuxPaint\saved
      -
      + In the user's "Application Data" folder:
      e.g., C:\Documents and Settings\Username\Application Data\TuxPaint\saved
    macOS
    - In the user's "Application Support" folder:
    - e.g., /Users/Username/Library/Applicaton - Support/TuxPaint/saved/
    -
    + In the user's "Application Support" folder:
    e.g., /Users/Username/Library/Applicaton Support/TuxPaint/saved/
    Linux / Unix
    - In the user's $HOME directory, under a - ".tuxpaint" subfolder:
    - e.g., - /home/username/.tuxpaint/saved/
    -
    + In the user's home directory ("$HOME"), under a ".tuxpaint" subfolder:
    e.g., /home/username/.tuxpaint/saved/

    - The images are stored as PNG bitmaps, which most modern - programs should be able to load (image editors, word - processors, web browsers, etc.) -

    + The images are stored as PNG bitmaps, which most modern programs should be able to load (image editors, word processors, web browsers, etc.)

    - Tux Paint always saves over my old picture! -
    + Tux Paint always saves over my old picture

    - The "save over" option is enabled. (This disables the - prompt that would appear when you click 'Save.') -

    + The "save over" option is enabled. (This disables the prompt that would appear when you click 'Save.')

    - If you're running Tux Paint from a command-line, - make sure you're not giving it a - "--saveover" option. -

    + If you're running Tux Paint from a command-line, make sure you're not giving it a "--saveover" option.

    - If you're running Tux Paint by double-clicking an - icon, check the properties of the icon to see if - "--saveover" is listed as an argument. -

    + If you're running Tux Paint by double-clicking an icon, check the properties of the icon to see if "--saveover" is listed as a command-line argument.

    - If "--saveover" isn't on the command-line, - check Tux Paint's configuration file - ("~/.tuxpaintrc" under Linux and Unix, "tuxpaint.cfg" - under Windows) for a line reading: - "saveover=yes". -

    + If a "--saveover" option isn't being sent on the command line, check Tux Paint's configuration file for a line reading: "saveover=yes".

    - Either remove that line, or simply run Tux Paint - with the command-line argument: - "--saveoverask", which will override the - configuration file's setting. -

    + Either remove that line, or simply run Tux Paint with the command-line argument: "--saveoverask", which will override the configuration file's setting.

    - Or use Tux Paint Config. and make sure "Ask - Before Overwriting" (under "Saving") is checked. -

    + Or use Tux Paint Config. and make sure "Ask Before Overwriting" (under "Saving") is checked.

    - Also, see "Tux Paint always saves a new picture!", - below. -

    + Also, see "Tux Paint always saves a new picture!", below.

    - Tux Paint always saves a new picture! -
    + Tux Paint always saves a new picture!

    - The "never save over" option is enabled. (This disables - the prompt that would appear when you click 'Save.') -

    + The "never save over" option is enabled. (This disables the prompt that would appear when you click 'Save.')

    - If you're running Tux Paint from a command-line, - make sure you're not giving it a - "--saveovernew" option. -

    + If you're running Tux Paint from a command-line, make sure you're not giving it a "--saveovernew" option.

    - If you're running Tux Paint by double-clicking an + If you're running Tux Paint by double-clicking an icon, check the properties of the icon to see if "--saveovernew" is listed as an argument.

    If "--saveovernew" isn't on the - command-line, check Tux Paint's configuration file + command-line, check Tux Paint's configuration file ("~/.tuxpaintrc" under Linux and Unix, "tuxpaint.cfg" under Windows) for a line reading: "saveover=new".

    - Either remove that line, or simply run Tux Paint - with the command-line argument: - "--saveoverask", which will override the - configuration file's setting. -

    + Either remove that line, or simply run Tux Paint with the command-line argument: "--saveoverask", which will override the configuration file's setting.

    - Or use Tux Paint Config. and make sure "Ask - Before Overwriting" (under "Saving") is checked. -

    + Or use Tux Paint Config. and make sure "Ask Before Overwriting" (under "Saving") is checked.

    - Also, see "Tux Paint always saves over my old + Also, see "Tux Paint always saves over my old picture!", above.

    @@ -666,466 +395,262 @@

    - Audio Problems -

    + Audio Problems
    - There's no sound! -
    + There's no sound!
    • First, check the obvious:
        -
      • Are your speakers connected and turned on? -
        • +
      • Are your speakers connected and turned on?
        • -
      • Is the volume turned up on your speakers? -
        • +
      • Is the volume turned up on your speakers?
        • -
      • Is the volume turned up in your Operating - System's "mixer?" -
        • +
      • Is the volume turned up in your Operating System's "mixer?"
        • -
      • Are you certain you're using a computer with a - sound card? -
        • +
      • Are you certain you're using a computer with a sound card?
        • -
      • Are any other programs running that use sound? - (They may be 'blocking' Tux Paint from accessing - your sound device) -
        • +
      • Are any other programs running that use sound? (They may be 'blocking' Tux Paint from accessing your sound device)
        • -
      • (Unix/Linux) Are you using a sound system, such - as aRts, ESD or GStreamer? If so, try setting the - "SDL_AUDIODRIVER" environment variable before running - Tux Paint (e.g., - "export SDL_AUDIODRIVER=arts"). Or, - run Tux Paint through the system's rerouter - (e.g., run "artsdsp tuxpaint" or - "esddsp tuxpaint", instead of - simply "tuxpaint"). -
        • +
      • (Unix/Linux) Are you using a sound system, such as aRts, ESD or GStreamer? If so, try setting the "SDL_AUDIODRIVER" environment variable before running Tux Paint (e.g., "export SDL_AUDIODRIVER=arts"). Or, run Tux Paint through the system's rerouter (e.g., run "artsdsp tuxpaint" or "esddsp tuxpaint", instead of simply "tuxpaint").
    • Is sound disabled in Tux Paint?

      - If sound seems to work otherwise (and you're sure no - other program is "blocking" the sound device), then - Tux Paint may be running with a "no sound" - option. -

      + If sound seems to work otherwise (and you're sure no other program is "blocking" the sound device), then Tux Paint may be running with a "no sound" option.

      - Make sure you're not running Tux Paint with the - "--nosound" option as a command-line - argument. (See the OPTIONS - documentation for details.) -

      + If you're running Tux Paint from a command-line, make sure you're not giving it a "--nosound" option.

      - If it's not, then check the configuration file - ("/etc/tuxpaint/tuxpaint.conf" and "~/.tuxpaintrc" - under Linux and Unix, and "tuxpaint.cfg" under - Windows) for a line reading: - "nosound=yes". -

      + If you're running Tux Paint by double-clicking an icon, check the properties of the icon to see if "--nosound" is listed as a command-line argument.

      + + If a "--nosound" option isn't being sent on the command line, check Tux Paint's configuration file for a line reading: "nosound=yes".

      - Either remove that line, or simply run Tux Paint - with the command-line argument: - "--sound", which will override the - configuration file's setting. -

      + Either remove that line, or simply run Tux Paint with the command-line argument: "--sound", which will override the configuration file's setting.

      - Alternatively, you can use - Tux Paint Config. to change the - configuration file. Make sure "Enable Sound Effects" - (under "Video & Sound") is checked, then click - "Apply". -

      + Or, you can simply run Tux Paint with the command-line argument: "Enable Sound Effects", which will override the configuration file's setting, and allow unlimited printing. (You won't have to wait between prints.)

    • Were sounds temporarily disabled?

      - Even if sounds are enabled in Tux Paint, it is - possible to disable and re-enable them temporarily - using the [Alt] + [S] key - sequence. Try pressing those keys to see if sounds - begin working again. -

      + Even if sounds are enabled in Tux Paint, it is possible to disable and re-enable them temporarily using the [Alt] + [S] key sequence. Try pressing those keys to see if sounds begin working again.

    • Was Tux Paint built without sound support?

      - Tux Paint may have been compiled with sound support - disabled. To test whether sound support was enabled - when Tux Paint was compiled, run Tux Paint - from a command line, like so: -

      + Tux Paint may have been compiled with sound support disabled. To test whether sound support was enabled when Tux Paint was compiled, run Tux Paint from a command line, like so:

      - tuxpaint --version + tuxpaint --verbose-version

      - If, amongst the other information, you see "Sound - disabled", then the version of Tux Paint you're - running has sound disabled. Recompile Tux Paint, - and be sure NOT to build the "nosound" target. (i.e., - don't run "make nosound") Be sure - the SDL_mixer library and its development headers are - available! -

      + If, amongst the other information, you see "Sound disabled", then the version of Tux Paint you're running has sound disabled. Recompile Tux Paint, and be sure NOT to build the "nosound" target. (i.e., don't run "make nosound") Be sure the SDL_mixer library and its development headers are available!

    - Tux Paint makes too much noise! Can I turn them off? -
    + Tux Paint makes too much noise! Can I turn them off?

    - Yes, there are a number of ways to disable sounds in Tux - Paint: -

    + Yes, there are a number of ways to disable sounds in Tux Paint:

      -
    • Press [Alt] + [S] while in - Tux Paint to temporarily disable sounds. (Press that - key sequence again to re-enable sounds.) -
      • +
    • Press [Alt] + [S] while in Tux Paint to temporarily disable sounds. (Press that key sequence again to re-enable sounds.)
      • -
    • Run Tux Paint with the "no sound" option: -
        -
      • Use Tux Paint Config to uncheck the - "Enable Sound Effects" option (under "Video & - Sound"). -
        • +
      • Run Tux Paint with the "no sound" option:
          +
        • Run "tuxpaint --nosound" from the command line or shortcut or desktop icon.
          • -
        • Edit Tux Paint's configuration file (see - OPTIONS for details) and - add a line containing "nosound=yes". -
          • +
        • Edit Tux Paint's configuration file (see "Options Documentation" for details) and add a line containing "nosound=yes".
          • -
        • Run "tuxpaint --nosound" from - the command line or shortcut or desktop icon. -
          • +
        • + Or use Tux Paint Config. and make sure "Enable Sound Effects" (under "Video & Sound") is not checked.
          • -
        • Recompile Tux Paint with sound support - disabled. (See above and INSTALL.txt.) -
          • +
        • + Alternatively, recompile Tux Paint with sound support disabled. (See above, and the 'Install' documentation.
    - The stereo panning of sound effects is bothersome; can - sound effects be monophonic? -
    + The stereo panning of sound effects is bothersome; can sound effects be monophonic?

    - Run Tux Paint with the "no stereo" option: -

    + Run Tux Paint with the "no stereo" option:

      -
    • Use Tux Paint Config to uncheck the "Enable - Stereo Sound" option (under "Video & Sound"). -
      • +
    • Run "tuxpaint --nostereo" from the command line or shortcut or desktop icon.
      • -
    • Edit Tux Paint's configuration file (see - OPTIONS for details) and add - a line containing "nostereo=yes". -
      • +
    • Edit Tux Paint's configuration file (see "Options Documentation" for details) and add a line containing "nostereo=yes".
      • -
    • Run "tuxpaint --nostereo" from the - command line or shortcut or desktop icon. -
      • +
    • + Or use Tux Paint Config. and make sure "Enable Stereo Effects" (under "Video & Sound") is not checked.
    - The sound effects sound strange -
    + The sound effects sound strange

    - This could have to do with how SDL and SDL_mixer were - initialized. (The buffer size chosen.) -

    + This could have to do with how SDL and SDL_mixer were initialized. (The buffer size chosen.)

    - Please e-mail us with details about your computer system. - (Operating system and version, sound card, which version - of Tux Paint you're running (run - "tuxpaint --version" to verify), and so - on.) -

    + Please e-mail us with details about your computer system. (Operating system and version, sound card, which version of Tux Paint you're running (run "tuxpaint --version" to verify), and so on.)

    - Fullscreen Mode Problems -

    + Fullscreen Mode Problems
    - When I run Tux Paint full-screen and ALT-TAB out, the - window turns black! -
    + When I run Tux Paint full-screen and [Alt] + [Tab] out, the window turns black!
    - This is apparently a bug in the SDL library. Sorry. -
    + This is apparently a bug in the SDL library. Sorry.
    - When I run Tux Paint full-screen, it has large borders - around it -
    + When I run Tux Paint full-screen, it has large borders around it

    - Linux users - Your X-Window server is probably not set - with the ability to switch to the desired resolution: - 800×600. (or whatever resolution you have Tux Paint - set to run at.) (This is typically done manually under - the X-Window server by pressing [Ctrl]-[Alt]-[KeyPad - Plus] and -[KeyPad Minus].) -

    + Linux users - Your X-Window server is probably not set with the ability to switch to the desired resolution: 800×600. (or whatever resolution you have Tux Paint set to run at.) (This is typically done manually under the X-Window server by pressing [Ctrl] + [Alt] + [Keypad Plus] and [Ctrl] + [Alt] + [Keypad Minus].)

    - For this to work, your monitor must support that - resolution, and you need to have it listed in your X - server configuration. -

    + For this to work, your monitor must support that resolution, and you need to have it listed in your X server configuration.

    - Check the "Display" subsection of the "Screen" section of - your XFree86 or X.org configuration file (typically - "/etc/X11/XF86Config-4" or "/etc/X11/XF86Config", - depending on the version of XFree86 you're using; 3.x or - 4.x, respectively, or "/etc/X11/xorg.conf" for X.org). -

    + Check the "Display" subsection of the "Screen" section of your XFree86 or X.org configuration file (typically "/etc/X11/XF86Config-4" or "/etc/X11/XF86Config", depending on the version of XFree86 you're using; 3.x or 4.x, respectively, or "/etc/X11/xorg.conf" for X.org).

    - Add "800x600" (or whatever resolution(s) you want) to the - appropriate "Modes" line. (e.g., in the "Display" - subsection that contains 24-bit color depth - ("Depth 24"), which is what Tux Paint tries to - use.) e.g.: -

    + Add "800x600" (or whatever resolution(s) you want) to the appropriate "Modes" line. (e.g., in the "Display" subsection that contains 24-bit color depth ("Depth 24"), which is what Tux Paint tries to use.)

    - Modes "1280x1024" "1024x768" "800x600" - "640x480" + Modes "1280x1024" "1024x768" "800x600" "640x480"

    - Note that some Linux distributions have tools that can - make these changes for you. Debian users can run the - command "dpkg-reconfigure xserver-xfree86" as root, for - example. -

    + Note that some Linux distributions have tools that can make these changes for you. Debian users can run the command "dpkg-reconfigure xserver-xfree86" as root, for example.

    - Tux Paint keeps running in Full Screen mode - I want - it windowed! -
    + Tux Paint keeps running in Full Screen mode - I want it windowed!

    - The "fullscreen" option is set. -

    + The "fullscreen" option is set.

    - If you're running Tux Paint from a command-line, - make sure you're not giving it a - "--fullscreen" option. -

    + If you're running Tux Paint from a command-line, make sure you're not giving it a "--fullscreen" option.

    - If you're running Tux Paint by double-clicking an - icon, check the properties of the icon to see if - "--fullscreen" is listed as an argument. -

    + If you're running Tux Paint by double-clicking an icon, check the properties of the icon to see if "--fullscreen" is listed as a command-line argument.

    - If "--fullscreen" isn't on the command-line, check - Tux Paint's configuration file ("~/.tuxpaintrc" - under Linux and Unix, "tuxpaint.cfg" under Windows) for a - line reading: "fullscreen=yes". -

    + If a "--fullscreen" option isn't being sent on the command line, check Tux Paint's configuration file for a line reading: "fullscreen=yes".

    - Either remove that line, or simply run Tux Paint - with the command-line argument: - "--windowed", which will override the - configuration file's setting. -

    + Either remove that line, or simply run Tux Paint with the command-line argument: "--windowed", which will override the configuration file's setting.

    - Or use Tux Paint Config. and make sure - "Fullscreen" (under "Video & Sound") is not checked. -

    + Or use Tux Paint Config. and make sure "Fullscreen" (under "Video & Sound") is not checked.

    - Other Probelms -

    + Other Probelms
    - Tux Paint won't run -
    + Tux Paint won't run

    - 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 - "stdout.txt" in the same folder where - TuxPaint.exe resides (e.g., in - C:\Program Files\TuxPaint). -

    + 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 "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 ("~/.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 - update the lockfile with the current time. -

    + 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.

    - If multiple users are sharing the directory where this - file is stored (e.g., on a shared network drive), then - you'll need to disable this feature. -

    + If multiple users are sharing the directory where this file is stored (e.g., on a shared network drive), then you'll need to disable this feature.

    - To disable the lockfile, add the - "--nolockfile" argument to Tux Paint's - command-line. -

    + To disable the lockfile, add the "--nolockfile" argument to Tux Paint's command-line, or "nolockfile=yes" to the configuration file.

    - I can't quit Tux Paint -
    + I can't quit Tux Paint

    - The "noquit" option is set. This disables the "Quit" - button in Tux Paint's toolbar (greying it out), and - prevents Tux Paint from being quit using the - [Escape] key. -

    + The "no quit" option is set. This disables the "Quit" button in Tux Paint's toolbar (greying it out), and prevents Tux Paint from being exited via the [Escape] key.

    - If Tux Paint is not in fullscreen mode, simply click - the window close button on Tux Paint's title bar. - (i.e., the "(x)" at the upper right.) -

    + If Tux Paint is not in fullscreen mode, simply click the window close button on Tux Paint's title bar. (i.e., the "ⓧ" at the upper right.)

    - If Tux Paint is in fullscreen mode, you will need to - use the [Shift] + [Control] + [Escape] sequence on - the keyboard to quit Tux Paint. -

    + If Tux Paint is in fullscreen mode, you will need to use the [Shift] + [Control] + [Escape] sequence on the keyboard to quit Tux Paint.

    - (Note: with or without "noquit" set, you can always use - the [Alt] + [F4] combination on your keyboard to - quit Tux Paint.) -

    + (Note: with or without "no quit" set, you can always use the [Alt] + [F4] combination on your keyboard to quit Tux Paint.)

    - I don't want "noquit" mode enabled! -
    + I don't want "no quit" mode enabled!

    - If you're running Tux Paint from a command-line, - make sure you're not giving it a "--noquit" - option. -

    + If you're running Tux Paint from a command-line, make sure you're not giving it a "--noquit" option.

    - If you're running Tux Paint by double-clicking an - icon, check the properties of the icon to see if - "--noquit" is listed as an argument. -

    + If you're running Tux Paint by double-clicking an icon, check the properties of the icon to see if "--noquit" is listed as a command-line argument.

    - If "--noquit" isn't on the command-line, - check Tux Paint's configuration file - ("~/.tuxpaintrc" under Linux and Unix, "tuxpaint.cfg" - under Windows) for a line reading: - "noquit=yes". -

    + If a "--noquit" option isn't being sent on the command line, check Tux Paint's configuration file for a line reading: "noquit=yes".

    - Either remove that line, or simply run Tux Paint - with the command-line argument: "--quit", - which will override the configuration file's setting. -

    + Either remove that line, or simply run Tux Paint with the command-line argument: "--quit", which will override the configuration file's setting.

    - Or use Tux Paint Config. and make sure "Disable - Quit Button and [Escape] Key" (under "Simplification") is - not checked. -

    + Or use Tux Paint Config. and make sure "Disable Quit Button and [Escape] Key" (under "Simplification") is not checked.

    - Tux Paint keeps writing weird messages to the screen / - to a text file -
    + Tux Paint keeps writing weird messages to the screen / to a text file

    - A few messages are normal, but if Tux Paint is being - extremely verbose (like listing the name of every - rubber-stamp image it finds while loading them), then it - was probably compiled with debugging output turned on. -

    + A few messages are normal, but if Tux Paint is being extremely verbose (like listing the name of every rubber-stamp image it finds while loading them), then it was probably compiled with debugging output turned on.

    - Rebuild Tux Paint from source. Be sure to remove or - comment out any line that says: -

    + To change this, you must rebuild Tux Paint from source. Be sure to remove or comment out any line that says:

    @@ -1134,27 +659,21 @@

    - in the "tuxpaint.c" file in the "src" directory. -

    + in the "tuxpaint.c" file in the "src" directory.

    - Tux Paint is using options I didn't specify! -
    + Tux Paint is using options I didn't specify!

    - By default, Tux Paint first looks at configuration - files for options. -

    + By default, Tux Paint first looks at configuration files for options.

    • Unix and Linux

      - Under Unix and Linux, it first examines the - system-wide configuration file, located here: -

      + Under Unix and Linux, it first examines the system-wide configuration file, located here:

      @@ -1163,9 +682,7 @@

      - It then examines the user's personal configuration - file: -

      + It then examines the user's personal configuration file:

      @@ -1174,17 +691,13 @@

      - Finally, any options sent as command-line arguments - are used. -

      + Finally, any options sent as command-line arguments are used.

    • Windows

      - Under Windows, Tux Paint first examines the - configuration file: -

      + Under Windows, Tux Paint first examines the configuration file:

      @@ -1193,23 +706,15 @@

      - Then, any options sent as command-line arguments are - used. -

      + Finally, any options sent as command-line arguments are used.

    - 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. -

    + 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.

    - For example, if "/etc/tuxpaint/tuxpaint.conf" includes an - option to disable sound: -

    + For example, on Linux and Unix, if "/etc/tuxpaint/tuxpaint.conf" includes this option to disable sound...

    @@ -1218,9 +723,7 @@

    - You can reenable sound by either adding this option to - your own ".tuxpainrc" file: -

    + ...then you can reenable sound by either adding this option to your own ".tuxpaintrc" file:

    @@ -1229,8 +732,7 @@

    - Or by using this command-line argument: -

    + ...or by using this command-line argument:

    @@ -1239,10 +741,7 @@

    - Linux and Unix users can also disable the system-wide - configuration file by including the following - command-line argument: -

    + Linux and Unix users can also disable the system-wide configuration file by including the following command-line argument:

    @@ -1251,34 +750,26 @@

    - Tux Paint will then only look at "~/.tuxpaintrc" and - command-line arguments to determine what options should - be set. -

    + Tux Paint will then only look at "~/.tuxpaintrc" and command-line arguments to determine what options should be set.

    - Help / Contact -

    + Help / Contact

    - Any questions you don't see answered? Please let us know! You - can subscribe and post to our "tuxpaint-users" mailing list: -

    + Any questions you don't see answered? Please let us know! You can subscribe and post to our "tuxpaint-users" mailing list:

    - http://www.tuxpaint.org/lists/ + http://www.tuxpaint.org/lists/

    - Or, contact lead developer Bill Kendrick directly: -

    + Or, contact lead developer Bill Kendrick directly:

    diff --git a/docs/en/html/INSTALL.html b/docs/en/html/INSTALL.html new file mode 100644 index 000000000..e2e1a7399 --- /dev/null +++ b/docs/en/html/INSTALL.html @@ -0,0 +1,458 @@ + + + + + Tux Paint Installation Documentation + + + +

    +

    + Tux Paint
    + version 0.9.26
    + Installation Documentation

    + +

    + Copyright © 2002-2021 by various contributors; see AUTHORS.
    + http://www.tuxpaint.org/ +

    + +

    + 30 January 2021

    +
    + +
    + +

    Requirements:

    +
    + +

    libSDL

    +
    +

    + Tux Paint requires the Simple DirectMedia Layer Library (libSDL), an Open Source multimedia programming library available under the GNU Lesser General Public License (LGPL).

    + +

    + 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).

    + +

    Linux/Unix Users:

    +
    +

    + The SDL libraries are available as source-code, or as RPM or Debian packages for various distributions of Linux. They can be downloaded from:

    + + +

    + 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 "apt").

    + +

    + Note: When installing libraries from packages, be sure to ALSO install the development versions of the packages. (For example, install both "SDL-1.2.4.rpm" and "SDL-1.2.4-devel.rpm".)

    +
    +
    + +

    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

    +
    +

    + Tux Paint uses PNG (Portable Network Graphics) format for its data files. SDL_image will require libPNG be installed.

    + +

    + http://www.libpng.org/pub/png/libpng.html +

    +
    + +

    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 gettext library installed.

    + +

    + http://www.gnu.org/software/gettext/ +

    +
    + +

    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, thanks to "libpaper".

    + +

    + https://github.com/naota/libpaper +

    +
    + +

    FriBiDi

    +
    +

    + Tux Paint's "Text" and also "Label" tools support bidirectional languages, thanks to the "FriBiDi" library.

    + +

    + http://fribidi.org/ +

    +
    + +

    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)
    + + +
    Older SVG libraries
    + +
    + +

    Animated GIF Export feature

    +
    +

    + To support export of animated GIFs (slideshows), the "libimagequant" library (from the "pngquant2" project) is required.

    + +

    + https://github.com/ImageOptim/libimagequant +

    +
    + +

    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 into a PostScript using the 'pngtopnm' and 'pnmtops' NetPBM command-line tools.)

    + +

    + http://netpbm.sourceforge.net/ +

    +
    +
    +
    + +

    Compiling and Installation:

    +
    +

    + 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.

    + +

    Windows Users:

    +
    +

    Compiling:

    +
    +

    + As of February 2005 (starting with Tux Paint 0.9.15), the "Makefile" includes support for building on a Windows system using MinGW/MSYS (http://www.mingw.org/).

    + +

    + After configuring the environment and building and installing all the dependencies, use these commands, in MSYS, to build, install and run:

    + +
    Prior to version 0.9.20:
    +
    + + $ make win32
    + $ make install-win32
    + $ tuxpaint +     +
    + +
    Version 0.9.20 and beyond:
    +
    + + $ make
    + $ make install
    + $ tuxpaint +     +
    + +

    + Use the following command to build a version suitable for redistribution with the installer or in a zip-file:

    +
    + + $ make bdist-win32 + +
    + +

    + Or if building for Win9x/ME:

    +
    + + $ BDIST_WIN9X=1 make bdist-win32 + +
    + +

    + Before any of the above will work, you need to configure the environment and build or install the libraries that Tux Paint depends upon. John Popplewell put together some instructions for doing that here:

    +

    + http://www.johnnypops.co.uk/tuxpaint/ +

    + +

    + Read the relevant notes if building for Win9X/ME.

    +
    + +

    Running the Installer:

    +
    +

    + Double-click the Tux Paint installer executable (.EXE file) and follow the instructions. +

    + 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".)

    + +

    + 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.)

    + +

    + 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.

    + +

    + At this point, you can click 'Install' to install Tux Paint!

    +
    + +

    Changing the Settings Using the Shortcut:

    +
    +

    + To change program settings, right-click on the TuxPaint shortcut and select 'Properties' (at the bottom).

    + +

    + Make sure the 'Shortcut' tab is selected in the window that appears, and examine the 'Target:' field. You should see something like this:

    + +
    + + "C:\Program Files\TuxPaint\TuxPaint.exe" + +
    + +

    + You can now add command-line options which will be enabled when you double-click the icon.

    + +

    + 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:

    + +
    + + "C:\Program Files\TuxPaint\TuxPaint.exe" -f -s --lang french + +
    + +

    + (See the main documentation for a full list of available command-line options.)

    + +

    + If you make a mistake or it all disappears use [Ctrl] + [Z] to undo or just hit the [Esc] key and the box will close with no changes made (unless you pushed the "Apply" button!).

    + +

    + When you have finished, click "OK."

    +
    + +

    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 like before, and look for a file called "stderr.txt" in the TuxPaint folder.

    + +

    + 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).

    +
    +
    + +

    Linux/Unix Users:

    +
    +

    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 Tux Paint needs is installed.

    + +

    + To compile the program from source, simply run the following command from a shell prompt (e.g., "$"):

    + +
    + + $ make + +
    +
    + +

    + 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 "SVG_LIB= SVG_CFLAGS= NOSVGFLAG=NOSVG" added: +

    + + $ make SVG_LIB= SVG_CFLAGS= + +
    +
    + +

    + Disabling Pango support (and hence Pango, Cairo, etc. dependencies):

    +
    +

    + Prior to version 0.9.18, Tux Paint used the libSDL_ttf library for rendering text using TrueType Fonts. Since 0.9.18, libSDL_Pango 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 "make" with "SDL_PANGO_LIB=" added:

    +
    + + $ make SDL_PANGO_LIB= + +
    +
    + +

    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 "make" with "SDL_MIXER_LIB=" added:

    +
    + + $ make SDL_MIXER_LIB= + +
    +
    + +

    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 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 "-dev" or "-devel" packages as well, otherwise you won't be able to compile Tux Paint (and other programs) from source!

    +
    + +

    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" user ('superuser'). Switch to "root" by typing the command:

    + +
    + + $ su + +
    + +

    + 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:

    + +
    + + # make install + +
    + +

    + Finally, you can switch back to your regular user by exiting superuser mode:

    + +
    + + # exit + +
    + +

    + Alternatively, you may be able to simply use the "sudo" command (e.g., on Ubuntu Linux):

    + +
    + + $ sudo make install + +
    + +

    + Note: By default, "tuxpaint", the executable program, is placed in "/usr/local/bin/". The data files (images, sounds, etc.) are placed in "/usr/local/share/tuxpaint/".

    + +
    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 creation. "PREFIX" is the basis of where all other files go, and is, by default, set to "/usr/local".

    + +

    + Other variables are:

    +
    +
    BIN_PREFIX
    +
    + Where the "tuxpaint" binary will be installed. (Set to "$(PREFIX)/bin" by default - e.g., "/usr/local/bin")
    + +
    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
    +
    + Where the documentation text files (the "docs" directory) will go. (Set to "$(PREFIX)/share/doc/tuxpaint")
    + +
    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
    +
    + Where the icons and launchers (for GNOME and KDE) will go.
    + +
    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.

    +
    +
    +
    +
    + +

    Debugging:

    +
    + Debugging (to "STDOUT", e.g. to the terminal, or to a "stdout.txt" file, on Windows) can be enabled by setting "DEBUG" (and, if verbose logging is wanted, "VERBOSE") #defines in "src/debug.h".
    + +

    Uninstalling Tux Paint:

    +
    +

    Windows

    +
    +

    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 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.

    + +

    + When it has finished, click on the close button.

    +
    + +

    Using the Control Panel

    +
    +

    + It is also possible to use the entry "TuxPaint (remove only)" in the Control Panel Add/Remove programs section.

    +
    +
    + +

    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 be done by the "root" user ('superuser'), but if you installed Tux Paint somewhere else (e.g., using a "PREFIX=..." setting to "make" and "make install"), you may not, and will want to provide those same settings here. (See the installation instructions above for further information.)

    +
    +
    + + diff --git a/docs/en/html/OPTIONS.html b/docs/en/html/OPTIONS.html index 7ad83b262..3da3edaae 100644 --- a/docs/en/html/OPTIONS.html +++ b/docs/en/html/OPTIONS.html @@ -1,11 +1,8 @@ - - Tux Paint Options Documentation - + Tux Paint Options Documentation @@ -16,97 +13,65 @@ alink="#FF00FF">

    - Tux Paint
    - version 0.9.26 -

    + Tux Paint
    + version 0.9.26

    - Options Documentation -

    + Options Documentation

    - Copyright (c) 2002-2021 by various contributors; see - AUTHORS.txt
    - http://www.tuxpaint.org/ + Copyright © 2002-2021 by various contributors; see AUTHORS.
    + http://www.tuxpaint.org/

    - January 18, 2021 -

    + 22 January 2021

    - Tux Paint Config. -

    + Tux Paint Config.

    - As of Tux Paint version 0.9.14, a graphical tool - is available that allows you to change Tux Paint's - behavior. However, if you'd rather not install and use this - tool, or want a better understanding of the available - options, please continue reading. -

    + A graphical tool is available that allows you to change Tux Paint's behavior. However, if you'd rather not install and use this tool, or want a better understanding of the available options, please continue reading.

    - Configuration File -

    + Configuration File

    - You can create a simple configuration file for - Tux Paint, which it will read each time you start it - up. -

    + You can create a simple configuration file for Tux Paint, which it will read each time you start it up.

    - The file is simply a plain text file containing the options - you want enabled: -

    + The file is simply a plain text file containing the options you want enabled:

    - Linux and Unix Users -

    + Linux and Unix Users

    - The file you should create is called - ".tuxpaintrc" and it should be placed - in your home directory. (a.k.a. - "~/.tuxpaintrc" or - "$HOME/.tuxpaintrc") -

    + The file you should create is called ".tuxpaintrc" and it should be placed in your home directory. (a.k.a. "~/.tuxpaintrc" or "$HOME/.tuxpaintrc")

    - System-Wide Configuration File -

    + System-Wide Configuration File

    - Before this file is read, a system-wide configuration - file is read. (By default, this configuration has no - settings enabled.) It is located at: -

    + Before this file is read, a system-wide configuration file is read. (By default, this configuration has no settings enabled.) It is located at:

    /etc/tuxpaint/tuxpaint.conf

    - You can disable reading of this file altogether, - leaving the settings as defaults (which can then be - overridden by your ".tuxpaintrc" file - and/or command-line arguments) by using the - command-line option: -

    + You can disable reading of this file altogether, leaving the settings as defaults (which can then be overridden by your ".tuxpaintrc" file and/or command-line arguments) by using the command-line option:

    --nosysconfig @@ -115,51 +80,34 @@

    - macOS Users -

    + macOS Users

    - The file you should create is called - "tuxpaint.cfg" and it should be - placed in your home folder, under the sub-folder: - Library/Application Support/TuxPaint -

    + The file you should create is called "tuxpaint.cfg" and it should be placed in your home folder, under the sub-folder: Library/Application Support/TuxPaint

    - System-Wide Configuration File -

    + System-Wide Configuration File

    - Before this file is read, a system-wide configuration - file is read. (By default, this configuration has no - settings enabled.) It is located at: -

    + Before this file is read, a system-wide configuration file is read. (By default, this configuration has no settings enabled.) It is located at:

    - /Library/Application - Support/TuxPaint/tuxpaint.cfg + /Library/Application Support/TuxPaint/tuxpaint.cfg

    - Windows Users -

    + Windows Users

    - The file you should create is called - "tuxpaint.cfg" and it should be - placed in Tux Paint's folder. -

    + The file you should create is called "tuxpaint.cfg" and it should be placed in Tux Paint's folder.

    - You can use NotePad or WordPad to create this file. Be - sure to save it as Plain Text, and make sure the filename - doesn't have ".txt" at the end... -

    + You can use NotePad or WordPad to create this file. Be sure to save it as Plain Text, and make sure the filename doesn't have ".txt" at the end...

    @@ -167,16 +115,11 @@ noshade>

    - Available Options -

    + Available Options

    - The following settings can be set in the configuration - file. (Command-line settings will override these. See the - "Command-Line Options" - section, below.) -

    + The following settings can be set in the configuration file. (Command-line settings will override these. See the "Command-Line Options" section, below.)

    @@ -184,19 +127,14 @@
    - Run the program in full screen mode, rather than in a - window. -
    + Run the program in full screen mode, rather than in a window.
    fullscreen=native
    - Run the program in full screen mode. Additionally, assume - the screen's current resolution (set by the operating - system). -
    + Run the program in full screen mode. Additionally, assume the screen's current resolution (set by the operating system).
    windowsize=SIZE @@ -204,22 +142,13 @@

    - Run the program at a different size (in windowed mode) - or at a different screen resolution (in fullscreen - mode), rather than the default (usually 800x600). -

    + Run the program at a different size (in windowed mode) or at a different screen resolution (in fullscreen mode), rather than the default (usually 800x600).

    - The SIZE value should be presented in pixels, in - 'width-by-height' format, with an "x" - (lowercase X) between the values. The size can be - anything that's at least 640 wide, and at least 480 - tall. -

    + The SIZE value should be presented in pixels, in 'width-by-height' format, with an "x" (lowercase X) between the values. The size can be anything that's at least 640 wide, and at least 480 tall.

    - Some examples: -

    + Some examples:

    • 640x480 @@ -242,10 +171,7 @@

      - Swaps the width/height options given to Tux Paint, - useful for rotating the window on portait displays, - such as a tablet PC that's in tablet orientation. -

      + Swaps the width/height options given to Tux Paint, useful for rotating the window on portait displays, such as a tablet PC that's in tablet orientation.

      @@ -254,11 +180,7 @@

      - When running Tux Paint in fullscreen mode, - this assumes the screen's current resolution - (overriding any "windowsize" option), as - set by the operating system. -

      + When running Tux Paint in fullscreen mode, this assumes the screen's current resolution (overriding any "windowsize" option), as set by the operating system.

      @@ -267,18 +189,10 @@

      - Set the pixel size of buttons in Tux Paint's - user interface (overriding the default of "48"). - Useful when using very high-density displays or coarse input - devices, such as eye gaze trackers. -

      + Set the pixel size of buttons in Tux Paint's user interface (overriding the default of "48"). Useful when using very high-density displays or coarse input devices, such as eye gaze trackers.

      - The SIZE value should be presented in pixels, - and can be anything between 24 and 192, inclusive. - Most buttons are square, and this will affect their - width and height. -

      + The SIZE value should be presented in pixels, and can be anything between 24 and 192, inclusive. Most buttons are square, and this will affect their width and height.

      @@ -287,14 +201,7 @@

      - By default, Tux Paint prevents your - system's screensaver from starting up. You can override - this by using the "allowscreensaver" - option. Note: This requires version 1.2.12 or higher of - the SDL library. (You can also do this by setting the - "SDL_VIDEO_ALLOW_SCREENSAVER" environment - variable on your system to "1".) -

      + By default, Tux Paint prevents your system's screensaver from starting up. You can override this by using the "allowscreensaver" option. Note: This requires version 1.2.12 or higher of the SDL library. (You can also do this by setting the "SDL_VIDEO_ALLOW_SCREENSAVER" environment variable on your system to "1".)

      @@ -302,20 +209,14 @@
      - Disable sound effects. (Note: Pressing - [Alt] + [S] cannot be used to - reenable sounds if they were disabled using this option.) -
      + Disable sound effects. (Note: Pressing [Alt] + [S] cannot be used to reenable sounds if they were disabled using this option.)
    nostereo=yes
    - Disable stereo panning support. (Useful for users with - hearing impairment in one ear, or places where a single - speaker or headphone is being used.) -
    + Disable stereo panning support. (Useful for users with hearing impairment in one ear, or places where a single speaker or headphone is being used.)
    noquit=yes @@ -323,23 +224,13 @@

    - Disable the on-screen "Quit" button and prevent the - [Escape] key from quitting - Tux Paint. -

    + Disable the on-screen "Quit" button and prevent the [Escape] key from quitting Tux Paint.

    - Using the [Alt] + [F4] keyboard - combination or clicking the window's close button - (assuming you're not in fullscreen mode) still works to - quit Tux Paint. -

    + Using the [Alt] + [F4] keyboard combination or clicking the window's close button (assuming you're not in fullscreen mode) still works to quit Tux Paint.

    - You can also use the following keyboard combination to - quit: - [Shift] + [Control] + [Escape]. -

    + You can also use the following keyboard combination to quit: [Shift] + [Control] + [Escape].

    @@ -347,17 +238,14 @@
    - Disable the printing feature. -
    + Disable the printing feature.
    printdelay=SECONDS
    - Restrict printing so that printing can occur only once - every SECONDS seconds. -
    + Restrict printing so that printing can occur only once every SECONDS seconds.
    printcommand=COMMAND @@ -369,29 +257,17 @@

    - Use the command COMMAND to print a PostScript - format file when the 'Print' button is clicked. If this - option is not specifically not set, the default command - is: -

    + Use the command COMMAND to print a PostScript format file when the 'Print' button is clicked. If this option is not specifically not set, the default command is:

    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. -

    + If you set an alternative printcommand in the configuration file prior to version 0.9.15, you will need to change it.

    @@ -404,18 +280,10 @@

    - Use the command COMMAND to print a PostScript - format file when the 'Print' button is clicked while - the [Alt] modifier key is being held. (This is - typically used for providing a print dialog, similar to - when pressing [Alt]+'Print' in Windows and - macOS.) -

    + Use the command COMMAND to print a PostScript format file when the 'Print' button is clicked while the modifier key is being held. (This is typically used for providing a print dialog, similar to when pressing [Alt]+'Print' in Windows and macOS.)

    - If this option is not specifically not set, the default - command is KDE's graphical print dialog: -

    + If this option is not specifically not set, the default command is KDE's graphical print dialog:

    kprinter @@ -432,19 +300,10 @@

    - Tux Paint will use a printer configuration file - when printing. Push the [Alt] key while clicking - the 'Print' button in Tux Paint to cause a Windows - print dialog window to appear. -

    + Tux Paint will use a printer configuration file when 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. -

    + (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.

    @@ -453,12 +312,7 @@

    - This causes Tux Paint to always show the printer - dialog (or, on Linux/Unix, run the "altprintcommand") - when the 'Print' button is clicked. In other words, - it's like clicking 'Print' while holding [Alt], - except you don't need to hold [Alt] every time. -

    + This causes Tux Paint to always show the printer dialog (or, on Linux/Unix, run the "altprintcommand") when the 'Print' button is clicked. In other words, it's like clicking 'Print' while holding [Alt], except you don't need to hold [Alt] every time.

    @@ -467,12 +321,7 @@

    - This prevents Tux Paint from ever showing - the printer dialog (or, on Linux/Unix, run the - "altprintcommand") when the 'Print' button is clicked. - In other words, it makes the [Alt] key have no - effect when clicking the 'Print' button. -

    + This prevents Tux Paint from ever showing the printer dialog (or, on Linux/Unix, run the "altprintcommand") when the 'Print' button is clicked. In other words, it makes the [Alt] key have no effect when clicking the 'Print' button.

    @@ -481,13 +330,7 @@

    - This is the normal, default behavior. Tux Paint - shows a printer dialog (or, on Linux/Unix, runs the - "altprintcommand"), when the [Alt] key is - pressed while the 'Print' button is clicked. Clicking - 'Print' without holding [Alt] prints without - showing a dialog. -

    + This is the normal, default behavior. Tux Paint shows a printer dialog (or, on Linux/Unix, runs the "altprintcommand"), when the [Alt] key is pressed while the 'Print' button is clicked. Clicking 'Print' without holding [Alt] prints without showing a dialog.

    @@ -496,27 +339,14 @@

    - (Platforms that use Tux Paint's internal - PostScript generator — not Windows, macOS, BeOS, or - Haiku.) + (Platforms that use Tux Paint's internal PostScript generator — not Windows, macOS, BeOS, or Haiku.)

    - Tell Tux Paint what size PostScript to generate. - If none is specified, Tux Paint first checks your - $PAPER environment variable, then the file - /etc/papersize, then uses the the - 'libpaper' library's default paper size. -

    + Tell Tux Paint what size PostScript to generate. If none is specified, Tux Paint first checks your $PAPER environment variable, then the file /etc/papersize, then uses the the 'libpaper' library's default paper size.

    - Valid paper sizes include: letter, legal, tabloid, - executive, note, statement, a0, a1, a2, a3, a4, a5, a6, - a7, a8, a9, a10, b0, b1, b2 b3, b4, 10x14, 11x17, - halfletter, halfexecutive, halfnote, folio, quarto, - ledger, archA, archB, archC, archD, archE, flsa, flse, - csheet, dsheet, esheet. -

    + Valid paper sizes include: letter, legal, tabloid, executive, note, statement, a0, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, b0, b1, b2 b3, b4, 10x14, 11x17, halfletter, halfexecutive, halfnote, folio, quarto, ledger, archA, archB, archC, archD, archE, flsa, flse, csheet, dsheet, esheet.

    @@ -525,27 +355,13 @@

    - By default, Tux Paint uses what's known as a - 'lockfile' to prevent it from being launched more than - once in 30 seconds. (This is to avoid accidentally - running multiple copies; for example, by - double-clicking a single-click launcher, or simply - impatiently clicking the icon multiple times.) -

    + By default, Tux Paint uses what's known as a 'lockfile' to prevent it from being launched more than once in 30 seconds. (This is to avoid accidentally running multiple copies; for example, by double-clicking a single-click launcher, or simply impatiently clicking the icon multiple times.)

    - To make Tux Paint ignore the lockfile, allowing it - to run again, even if it was just launched less than - 30 seconds ago, enable this setting in the - configuration file, or run Tux Paint with the - '--nolockfile' option on the command-line. -

    + To make Tux Paint ignore the lockfile, allowing it to run again, even if it was just launched less than 30 seconds ago, enable this setting in the configuration file, or run Tux Paint with the --nolockfile option on the command-line.

    - By default, the lockfile is stored in - "~/.tuxpaint/" under Linux and Unix, and - "userdata\" under Windows. -

    + By default, the lockfile is stored in "~/.tuxpaint/" under Linux and Unix, and "userdata\" under Windows.

    @@ -553,20 +369,14 @@
    - Disable the rotation step of the 'Shape' tool. Click, - drag and release is all that will be needed to draw a - shape. -
    + Disable the rotation step of the 'Shape' tool. Click, drag and release is all that will be needed to draw a shape.
    uppercase=yes
    - All text will be rendered only in uppercase (e.g., - "Brush" will be "BRUSH"). Useful for children who can - read, but who have only learned uppercase letters so far. -
    + All text will be rendered only in uppercase (e.g., "Brush" will be "BRUSH"). Useful for children who can read, but who have only learned uppercase letters so far.
    grab=yes @@ -574,19 +384,10 @@

    - Tux Paint will attempt to 'grab' the mouse and - keyboard, so that the mouse is confined to - Tux Paint's window, and nearly all keyboard input - is passed directly to it. -

    + Tux Paint will attempt to 'grab' the mouse and keyboard, so that the mouse is confined to Tux Paint's window, and nearly all keyboard input is passed directly to it.

    - This is useful to disable operating system actions that - could get the user out of Tux Paint - [Alt]-[Tab] window cycling, - [Ctrl]-[Escape], etc. This is especially useful - in fullscreen mode. -

    + This is useful to disable operating system actions that could get the user out of Tux Paint [Alt]-[Tab] window cycling, [Ctrl]-[Escape], etc. This is especially useful in fullscreen mode.

    @@ -595,16 +396,10 @@

    - This disable keyboard shortcuts (e.g., - [Ctrl]-[S] for save, [Ctrl]-[N] for a new - image, etc.) -

    + This disable keyboard shortcuts (e.g., [Ctrl]-[S] for save, [Ctrl]-[N] for a new image, etc.)

    - This is useful to prevent unwanted commands from being - activated by children who aren't experienced with - keyboards. -

    + This is useful to prevent unwanted commands from being activated by children who aren't experienced with keyboards.

    @@ -612,10 +407,7 @@
    - This disables support for the wheel on mice that have it. - (Normally, the wheel will scroll the selector menu on the - right.) -
    + This disables support for the wheel on mice that have it. (Normally, the wheel will scroll the selector menu on the right.)
    nobuttondistinction=yes @@ -623,19 +415,10 @@

    - Prior to Tux Paint 0.9.15, the middle and right - buttons on a mouse could also be used for clicking. In - version 0.9.15, it was changed so that only the - left mouse button worked, so as to not train children - to use the wrong button. -

    + Prior to Tux Paint 0.9.15, the middle and right buttons on a mouse could also be used for clicking. In version 0.9.15, it was changed so that only the left mouse button worked, so as to not train children to use the wrong button.

    - However, for children who have trouble with the mouse, - this distinction between the two or three buttons on a - mouse can be disabled (returning Tux Paint to its - old behavior) by using this option. -

    + However, for children who have trouble with the mouse, this distinction between the two or three buttons on a mouse can be disabled (returning Tux Paint to its old behavior) by using this option.

    @@ -644,15 +427,10 @@

    - This disables the fancy mouse pointer shapes in - Tux Paint, and uses your environment's normal - mouse pointer. -

    + This disables the fancy mouse pointer shapes in Tux Paint, and uses your environment's normal mouse pointer.

    - In some enviornments, the fancy cursors cause problems. - Use this option to avoid them. -

    + In some enviornments, the fancy cursors cause problems. Use this option to avoid them.

    @@ -661,14 +439,10 @@

    - This completely hides the mouse pointer shapes in - Tux Paint. -

    + This completely hides the mouse pointer shapes in Tux Paint.

    - This is useful for touchscreen devices, such as tablet - PCs. -

    + This is useful for touchscreen devices, such as tablet PCs.

    @@ -677,15 +451,10 @@

    - In this mode, much simpler outlines and 'rubber-band' - lines are displayed when using the Lines, - Shapes, Stamps and Eraser tools. -

    + In this mode, much simpler outlines and 'rubber-band' lines are displayed when using the Lines, Shapes, Stamps and Eraser tools.

    - This can help when Tux Paint is run on very slow - computers, or displayed on a remote X-Window display. -

    + This can help when Tux Paint is run on very slow computers, or displayed on a remote X-Window display.

    @@ -694,11 +463,7 @@

    - This option causes Tux Paint to attempt to load - fonts (for use in the Text tool) from your - operating system. Normally, Tux Paint will only - load the ones that came bundled with Tux Paint. -

    + This option causes Tux Paint to attempt to load fonts (for use in the Text tool) from your operating system. Normally, Tux Paint will only load the ones that came bundled with Tux Paint.

    @@ -707,19 +472,10 @@

    - Prior to version 0.9.21, Tux Paint loaded all - fonts in its own fonts directory, including - locale-specific ones (e.g., the one for Tibetan, which - had no latin characters). As of 0.9.21, the only font - loaded from the locale-specific subdirectory, if any, - is one matching the locale Tux Paint is running - on. -

    + Prior to version 0.9.21, Tux Paint loaded all fonts in its own fonts directory, including locale-specific ones (e.g., the one for Tibetan, which had no latin characters). As of 0.9.21, the only font loaded from the locale-specific subdirectory, if any, is one matching the locale Tux Paint is running on.

    - To load all locale-specific fonts (the old behavior), - set this option. -

    + To load all locale-specific fonts (the old behavior), set this option.

    @@ -728,16 +484,10 @@

    - This option tells Tux Paint to not load any rubber - stamp images, which in turn ends up disabling the - Stamps tool. -

    + This option tells Tux Paint to not load any rubber stamp images, which in turn ends up disabling the Stamps tool.

    - This can speed up Tux Paint when it first loads - up, and reduce memory usage while it's running. Of - course, no stamps will be available at all. -

    + This can speed up Tux Paint when it first loads up, and reduce memory usage while it's running. Of course, no stamps will be available at all.

    @@ -745,52 +495,35 @@
    - Some images in the Stamps tool can be mirrored, - flipped, and/or have their size changed. This option - disables the controls, and only provides the basic - stamps. -
    + Some images in the Stamps tool can be mirrored, flipped, and/or have their size changed. This option disables the controls, and only provides the basic stamps.
    nomagiccontrols=yes
    - Some Magic tools have the option of acting like a - paintbrush, or affecting the entire canvas at once. This - option disables the controls, and only provides the - default functionality (usually paint-mode). -
    + Some Magic tools have the option of acting like a paintbrush, or affecting the entire canvas at once. This option disables the controls, and only provides the default functionality (usually paint-mode).
    noshapecontrols=yes
    - Disable the control buttons shown when using the - Shapes tool that allow changing how shapes are - drawn — centered around the initial mouse click, or with - a corner at the initial mouse click. -
    + Disable the control buttons shown when using the Shapes tool that allow changing how shapes are drawn — centered around the initial mouse click, or with a corner at the initial mouse click.
    nolabel=yes
    - Disables the Label tool: the tool that allows text - entry which can be edited later. -
    + Disables the Label tool: the tool that allows text entry which can be edited later.
    newcolorslast=yes
    - Places the blank color options in the New dialog - at the end, so that any Starters and/or Templates are - shown first. -
    + Places the blank color options in the New dialog at the end, so that any Starters and/or Templates are shown first.
    mirrorstamps=yes @@ -798,14 +531,10 @@

    - For stamps that can be mirrored, this option sets them - to their mirrored shape by default. -

    + For stamps that can be mirrored, this option sets them to their mirrored shape by default.

    - This can be useful for people who prefer things - right-to-left, rather than left-to-right. -

    + This can be useful for people who prefer things right-to-left, rather than left-to-right.

    @@ -813,277 +542,190 @@
    - In this mode, instead of clicking, dragging and releasing - (e.g., to draw), you click, move, and click again to end - the motion. -
    + In this mode, instead of clicking, dragging and releasing (e.g., to draw), you click, move, and click again to end the motion.
    onscreen-keyboard=yes
    - Presents a clickable on-screen keyboard when using the - Text and Label tools. -
    + Presents a clickable on-screen keyboard when using the Text and Label tools.
    onscreen-keyboard-layout=LAYOUTNAME
    - Selects the initial layout for the on-screen keyboard - when using the Text and Label tools.
    - Note: Using this option implies automatically - onscreen-keyboard=yes, so setting both is - redundant. -
    + Selects the initial layout for the on-screen keyboard when using the Text and Label tools.
    Note: Using this option implies automatically onscreen-keyboard=yes, so setting both is redundant.
    onscreen-keyboard-disable-change=yes
    - Disables the possibility for changing the layout of the - on-screen keyboard when using the Text and - Label tools, useful for simplifying things for the - small children.
    - Note: Using this option implies automatically - onscreen-keyboard=yes, so setting both is - redundant. -
    + Disables the possibility for changing the layout of the on-screen keyboard when using the Text and Label tools, useful for simplifying things for the small children.
    + Note: Using this option implies automatically onscreen-keyboard=yes, so setting both is redundant.
    joystick-dev=N
    - Specify which joystick device should be used by Tux - Paint. Default value is 0 (the first joystick). -
    + Specify which joystick device should be used by Tux Paint. Default value is 0 (the first joystick).
    joystick-slowness=SPEED
    - Sets a delay at each axis motion, allowing to slow the - joystick. Allowed values are from 0 to 500. Default value - is 15. -
    + Sets a delay at each axis motion, allowing to slow the joystick. Allowed values are from 0 to 500. Default value is 15.
    joystick-threshold=THRESHOLD
    - Sets the minimum level of axis motion to start moving the - pointer. Allowed values are from 0 to 32766. Default - value is 3200. -
    + Sets the minimum level of axis motion to start moving the pointer. Allowed values are from 0 to 32766. Default value is 3200.
    joystick-maxsteps=STEPS
    - Sets the maximum pixels the pointer will move at once. - Allowed values are from 1 to 7. Default value is 7. -
    + Sets the maximum pixels the pointer will move at once. Allowed values are from 1 to 7. Default value is 7.
    joystick-hat-timeout=MILLISECONDS
    - Sets the delay after wich the pointer will start moving - automatically if the hat is keeped pushed. Allowed values - are from 0 to 3000. Default value is 1000. -
    + Sets the delay after wich the pointer will start moving automatically if the hat is keeped pushed. Allowed values are from 0 to 3000. Default value is 1000.
    joystick-hat-slowness=SPEED
    - Sets a delay at each automatic motion, allowing to slow - the speed of the hat. Allowed values are from 0 to 500. - Default value is 15. -
    + Sets a delay at each automatic motion, allowing to slow the speed of the hat. Allowed values are from 0 to 500. Default value is 15.
    - joystick-btn-escape=BUTTON - NUMBER + joystick-btn-escape=BUTTON NUMBER
    - Selects the joystick button number, as seen by SDL, that - will be used to generate a escape event. Useful to - dismiss dialogs and quit. -
    + Selects the joystick button number, as seen by SDL, that will be used to generate a escape event. Useful to dismiss dialogs and quit.
    - joystick-btn-brush=BUTTON - NUMBER + joystick-btn-brush=BUTTON NUMBER
    - Selects the joystick button number, as seen by SDL, that - will be a shortcurt to select the brush tool. -
    + Selects the joystick button number, as seen by SDL, that will be a shortcut to select the brush tool.
    - joystick-btn-stamp=BUTTON - NUMBER + joystick-btn-stamp=BUTTON NUMBER
    - Selects the joystick button number, as seen by SDL, that - will be a shortcurt to select the stamp tool. -
    + Selects the joystick button number, as seen by SDL, that will be a shortcut to select the stamp tool.
    - joystick-btn-lines=BUTTON - NUMBER + joystick-btn-lines=BUTTON NUMBER
    - Selects the joystick button number, as seen by SDL, that - will be a shortcurt to select the lines tool. -
    + Selects the joystick button number, as seen by SDL, that will be a shortcut to select the lines tool.
    - joystick-btn-shapes=BUTTON - NUMBER + joystick-btn-shapes=BUTTON NUMBER
    - Selects the joystick button number, as seen by SDL, that - will be a shortcurt to select the shapes tool. -
    + Selects the joystick button number, as seen by SDL, that will be a shortcut to select the shapes tool.
    - joystick-btn-text=BUTTON - NUMBER + joystick-btn-text=BUTTON NUMBER
    - Selects the joystick button number, as seen by SDL, that - will be a shortcurt to select the text tool. -
    + Selects the joystick button number, as seen by SDL, that will be a shortcut to select the text tool.
    - joystick-btn-label=BUTTON - NUMBER + joystick-btn-label=BUTTON NUMBER
    - Selects the joystick button number, as seen by SDL, that - will be a shortcurt to select the label tool. -
    + Selects the joystick button number, as seen by SDL, that will be a shortcut to select the label tool.
    - joystick-btn-magic=BUTTON - NUMBER + joystick-btn-magic=BUTTON NUMBER
    - Selects the joystick button number, as seen by SDL, that - will be a shortcurt to select the magic tool. -
    + Selects the joystick button number, as seen by SDL, that will be a shortcut to select the magic tool.
    - joystick-btn-undo=BUTTON - NUMBER + joystick-btn-undo=BUTTON NUMBER
    - Selects the joystick button number, as seen by SDL, that - will be a shortcurt to the undo tool. -
    + Selects the joystick button number, as seen by SDL, that will be a shortcut to invoke the undo tool.
    - joystick-btn-redo=BUTTON - NUMBER + joystick-btn-redo=BUTTON NUMBER
    - Selects the joystick button number, as seen by SDL, that - will be a shortcurt to the redo tool. -
    + Selects the joystick button number, as seen by SDL, that will be a shortcut to select redo tool.
    - joystick-btn-eraser=BUTTON - NUMBER + joystick-btn-eraser=BUTTON NUMBER
    - Selects the joystick button number, as seen by SDL, that - will be a shortcurt for selecting the eraser tool. -
    + Selects the joystick button number, as seen by SDL, that will be a shortcut to select eraser tool.
    joystick-btn-new=BUTTON NUMBER
    - Selects the joystick button number, as seen by SDL, that - will be a shortcurt to launch the dialog for opening a - new draw. -
    + Selects the joystick button number, as seen by SDL, that will be a shortcut to launch the dialog for creating a new drawing.
    - joystick-btn-open=BUTTON - NUMBER + joystick-btn-open=BUTTON NUMBER
    - Selects the joystick button number, as seen by SDL, that - will be a shortcurt to launch the dialog for opening an - existing draw. -
    + Selects the joystick button number, as seen by SDL, that will be a shortcut to launch the dialog for opening an existing drawing.
    - joystick-btn-save=BUTTON - NUMBER + joystick-btn-save=BUTTON NUMBER
    - Selects the joystick button number, as seen by SDL, that - will be a shortcurt for saving the draw. -
    + Selects the joystick button number, as seen by SDL, that will be a shortcut to save the drawing.
    - joystick-btn-pgsetup=BUTTON - NUMBER + joystick-btn-pgsetup=BUTTON NUMBER
    - Selects the joystick button number, as seen by SDL, that - will be a shortcurt to launch the page setup dialog for - printing. -
    + Selects the joystick button number, as seen by SDL, that will be a shortcut to launch the page setup dialog for printing.
    - joystick-btn-print=BUTTON - NUMBER + joystick-btn-print=BUTTON NUMBER
    - Selects the joystick button number, as seen by SDL, that - will be a shortcurt to print. -
    + Selects the joystick button number, as seen by SDL, that will be a shortcut to print.
    joystick-buttons-ignore=BUTTON1,BUTTON2,...
    - A set of joystick button numbers, as seen by SDL, that - should be ignored. Otherwise, unless they are used by one - of the "joystick-btn-" options above, - buttons will be seen as a mouse left-click. -
    + A set of joystick button numbers, as seen by SDL, that should be ignored. Otherwise, unless they are used by one of the "joystick-btn-" options above, buttons will be seen as a mouse left-click.
    stampsize=SIZE @@ -1091,18 +733,10 @@

    - Use this option to force Tux Paint to set the - starting size of all stamps. The SIZE - value should be between 0 (smallest) and 10 (largest). - The size is relative to the available sizes of the - stamp, which depends on the stamp itself, and - Tux Paint's current canvas size. -

    + Use this option to force Tux Paint to set the starting size of all stamps. The SIZE value should be between 0 (smallest) and 10 (largest). The size is relative to the available sizes of the stamp, which depends on the stamp itself, and Tux Paint's current canvas size.

    - Specifc "default" to let Tux Paint - decide (it's standard behavior). -

    + Specify "default" to let Tux Paint decide (its standard behavior).

    @@ -1111,73 +745,40 @@

    - This allows the keyboard arrow keys to be used to - control the mouse pointer. (e.g., for mouseless - environments, or handicapped/accessibility purposes) -

    + This allows the keyboard arrow keys to be used to control the mouse pointer. (e.g., for mouseless environments, or handicapped/accessibility purposes)

    - Features: -

    + Features:

      -
    • Fine movement within canvas, or coarse movement if - [Shift] is held. -
      • +
    • Fine movement within canvas, or coarse movement if default is held.
      • -
    • Coarse movement within tool button areas. -
      • +
    • Coarse movement within tool button areas.
      • -
    • Key controls: -
        -
      • [Left]/[Right]/[Up]/[Down], numpad [1] thru - [9]: Move mouse -
        • +
      • Key controls:
          +
        • [Left]/[Right]/[Up]/[Down], numpad [1] thru [9]: Move mouse
          • -
        • [Space]/[5]: Click mouse (except when using - "Text" or "Label" tools) -
          • +
        • [Space]/[5]: Click mouse (except when using "Text" or "Label" tools)
          • -
        • [Insert]/[F5]: Click mouse (always) -
          • +
        • [Insert]/[F5]: Click mouse (always)
          • -
        • [F4] jump mouse between "Tools", "Colors" and - canvas areas -
          • +
        • [F4] jump mouse between "Tools", "Colors" and canvas areas
          • -
        • If mouse is within "Tools" section on the left, - or "Colors" secton at the bottom: -
            -
          • [F7], [F8]: Move down/up between buttons, - respectively (Tools section, only) -
            • +
          • If mouse is within "Tools" section on the left, or "Colors" secton at the bottom:
              +
            • [F7], [F8]: Move down/up between buttons, respectively (Tools section, only)
              • -
            • [F11], [F12]: Move to previous/next button, - respectively -
              • +
            • [F11], [F12]: Move to previous/next button, 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). -
            • +
          • 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).
            • -
          • 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) -
            • +
          • 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)
    @@ -1187,62 +788,31 @@

    - Use this option to change where Tux Paint's - "saved" directory/folder is located, which - is where Tux Paint saves and opens pictures. -

    + Use this option to change where Tux Paint's "saved" directory/folder is located, which is where Tux Paint saves and opens pictures.

    - If you do not override it, the default - location is: -

    + If you do not override it, the default location is:

      -
    • Linux & Unix — Under a hidden directory named - ".tuxpaint" in your home directory (aka - "~" or "$HOME")
      - Example: - "/home/username/.tuxpaint/saved/"
      +
    • Linux & Unix — Under a hidden directory named ".tuxpaint" in your home directory (aka ".tuxpaint" or "~")
      + Example: /home/username/.tuxpaint/saved/
      • -
      +
    • Windows — Inside a folder named "TuxPaint" in your "Application Data" folder.
      + Example: C:\Documents and Settings\Username\Application Data\TuxPaint\saved\
      • -
    • Windows — Inside a folder named - "TuxPaint" in your - "Application Data" folder.
      - Example: - "C:\Documents and Settings\Username\Application Data\TuxPaint\saved\"
      - -
      -
      • - -
    • macOS — Inside a folder named - "TuxPaint" in your - "Application Support" folder.
      - Example: - "/Users/Username/Library/Application Support/TuxPaint/saved/"
      -
      • +
    • macOS — Inside a folder named "TuxPaint" in your "Application Support" folder.
      + Example: /Users/Username/Library/Application Support/TuxPaint/saved/

    - Note: When specifying a Windows drive (e.g., - "H:\"), you must also specify a - subdirectory. -

    + 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 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 "datadir" option, - below). -

    + 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 "datadir" option, below).

    - Example: savedir=Z:\tuxpaint\ -

    + Example: savedir=Z:\tuxpaint\

    @@ -1251,65 +821,32 @@

    - Use this option to change where Tux Paint exports - files — single images, or animated GIF slideshows — for - external use. -

    + Use this option to change where Tux Paint exports files — single images, or animated GIF slideshows — for external use.

    - If you do not override it, the default - location is determined as follows: -

    + If you do not override it, the default location is:

      -
    • Linux & Unix — If available, wherever your - desktop environment is configured for pictures to be - stored, based on your XDG (X Desktop Group) - configuration. (Try running the command-line - "xdg-user-dir - PICTURES" to find out.)
      -
      - Typically (in an English locale), this will be a - "Pictures/" subdirectory in your home - directory (i.e., "$HOME/Pictures/" aka - "~/Pictures").
      -
      - Tux Paint will fall back to using that typical - directory, of no XDG configuration can be read, or - nothing is set for - "XDG_PICTURES_DIR".
      -
      +
    • Linux & Unix — If available, wherever your desktop environment is configured for pictures to be stored, based on your XDG (X Desktop Group) configuration. (Try running the command-line "xdg-user-dir PICTURES" to find out.)
      + Typically (in an English locale), this will be a "Pictures" subdirectory in your home directory (i.e., "$HOME/Pictures" aka "~/Pictures").
      + Tux Paint will fall back to using that typical directory, of no XDG configuration can be read, or nothing is set for "XDG_PICTURES_DIR".
      • + +
    • Windows — TBD!
      • -
    • Windows — TBD! -
      • - -
    • macOS — TBD! +
    • 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. -

    + The directory itself (e.g., "~/Pictures/TuxPaint") will be created, if it doesn't exist.

    - If the parent directory (e.g., "~/Pictures") - also does not exist, Tux Paint will attempt to create it - as well (but not any directories higher than that). -

    + If the parent directory (e.g., "~/Pictures/TuxPaint") also does not exist, Tux Paint will attempt to create it as well (but not any directories higher than that).

    - Example: - exportdir=/home/penguin/TuxPaintExports -

    + Example: exportdir=/home/penguin/TuxPaintExports

    @@ -1318,68 +855,33 @@

    - Use this option to change where Tux Paint looks - for personal data files (brushes, stamps, starters, - templates, and fonts specific to the current user). -

    + Use this option to change where Tux Paint looks for personal data files (brushes, stamps, starters, templates, and fonts specific to the current user).

    - Tux Paint will search for - subdirectories/subfolders named "brushes", - "stamps", "starters", - "templates", and "fonts" - under the specified data directory. -

    + Tux Paint will search for subdirectories/subfolders named "brushes", "stamps", "3$brushes", "templates", and "fonts" under the specified data directory.

    - If you do not override it, the default - location is: -

    + If you do not override it, the default location is:

      -
    • Linux & Unix — Under a hidden directory named - ".tuxpaint" in your home directory (aka - "~" or "$HOME")
      - Example: - "/home/username/.tuxpaint/brushes/"
      +
    • Linux & Unix — Under a hidden directory named ".tuxpaint" in your home directory (aka ".tuxpaint" or "~")
      + Example: /home/username/.tuxpaint/brushes/
      • -
      - +
    • Windows — Inside a folder named "TuxPaint" in your "Application Data" folder.
      + Example: C:\Documents and Settings\Username\Application Data\TuxPaint\brushes\
      • -
    • Windows — Inside a folder named - "TuxPaint" in your - "Application Data" folder.
      - Example: - "C:\Documents and Settings\Username\Application Data\TuxPaint\brushes\"
      - -
      -
      • - -
    • macOS — Inside a folder named - "TuxPaint" in your - "Application Support" folder.
      - Example: - "/Users/Username/Library/Application Support/TuxPaint/brushes/"
      -
      • +
    • macOS — Inside a folder named "TuxPaint" in your "Application Support" folder.
      + Example: /Users/Username/Library/Application Support/TuxPaint/brushes/

    - 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: 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 also specify a - subdirectory. -

    + Note: When specifying a Windows drive (e.g., "H:\"), you must also specify a subdirectory.

    - Example: - datadir=/home/johnny/tuxpaint-data/ -

    + Example: datadir=/home/johnny/tuxpaint-data/

    @@ -1387,22 +889,14 @@
    - This disables the "Save over the old version...?" - prompt when saving an existing file. With this option, - the older version will always be replaced by the new - version, automatically. -
    + This disables the "Save over the old version...?" prompt when saving an existing file. With this option, the older version will always be replaced by the new version, automatically.
    saveover=new
    - This also disables the "Save over the old - version...?" prompt when saving an existing file. - This option, however, will always save a new file, rather - than overwrite the older version. -
    + This also disables the "Save over the old version...?" prompt when saving an existing file. This option, however, will always save a new file, rather than overwrite the older version.
    saveover=ask @@ -1410,43 +904,30 @@

    - (This option is redundant, since this is the - default.) + (This option is redundant, since this is the default.)

    - When saving an existing drawing, you will be first asked - whether to save over the older version or not. -
    + When saving an existing drawing, you will be first asked whether to save over the older version or not.
    nosave=yes
    - This disables Tux Paint's ability to save files (and - therefore disables the on-screen "Save" button). It can - be used in situations where the program is only being - used for fun, or in a test environment. -
    + This disables Tux Paint's ability to save files (and therefore disables the on-screen "Save" button). It can be used in situations where the program is only being used for fun, or in a test environment.
    autosave=yes
    - This prevents Tux Paint from asking whether you want - to save the current picture when quitting, and assumes - you do. -
    + This prevents Tux Paint from asking whether you want to save the current picture when quitting, and assumes you do.
    startblank=yes
    - This causes Tux Paint to display a blank canvas when - it first starts up, rather than loading the last image - that was being edited. -
    + This causes Tux Paint to display a blank canvas when it first starts up, rather than loading the last image that was being edited.
    colorfile=FILENAME @@ -1454,49 +935,22 @@

    - You may override Tux Paint's default color palette - by creating a plain ASCII text file that describes the - colors you want, and pointing to that file using the - colorfile option. -

    + You may override Tux Paint's default color palette by creating a plain ASCII text file that describes the colors you want, and pointing to that file using the "colorfile" option.

    - The file should list one color per line. Colors are - defined in terms of their Red, Green and Blue values, - each from 0 (off) to 255 (brightest). (For more - information, try Wikipedia's "RGB color model" - article.) -

    + The file should list one color per line. Colors are defined in terms of their Red, Green and Blue values, each from 0 (off) to 255 (brightest). (For more information, try Wikipedia's "RGB color model" article.)

    - Colors may be listed using three decimal numbers (e.g., - "255 68 136") or a 6- or - 3-digit-long hexadecimal 'triplet' (e.g., - "#ff4488" or "#F48"). -

    + Colors may be listed using three decimal numbers (e.g., "255 68 136") or a 6- or 3-digit-long hexadecimal 'triplet' (e.g., "#ff4488" or "#F48").

    - After the color definition (on the same line) you may - enter text to describe the color. Tux will display this - text when the color is clicked. (For example, - "#FFF White as snow.") -

    + After the color definition (on the same line) you may enter text to describe the color. Tux will display this text when the color is clicked. (For example, "#FFF White as snow.")

    - As an example, you can see the default colors currently - used in Tux Paint in: "default_colors.txt". -

    + As an example, you can see the default colors currently used in Tux Paint in: "default_colors.txt".

    - NOTES: You must separate decimal values with spaces, - and begin hexadecimal values with a pound/number-sign - character ("#"). In 3-digit hexadecimal, - each digit is used for both the high and low halves of - the byte, so "#FFF" is the same as - "#FFFFFF", not "#F0F0F0". -

    + NOTES: You must separate decimal values with spaces, and begin hexadecimal values with a pound/number-sign character ("#"). In 3-digit hexadecimal, each digit is used for both the high and low halves of the byte, so "#FFF" is the same as "#FFFFFF", not "#F0F0F0".

    @@ -1505,10 +959,9 @@

    - Run Tux Paint in one of the supported languages. - Possible choice for LANGUAGE currently include: -

    + Run Tux Paint in one of the supported languages. Possible choice for LANGUAGE currently include:

    +
    american-english @@ -1535,7 +988,7 @@ acoli @@ -1544,10 +997,10 @@ afrikaans @@ -1559,7 +1012,7 @@ twi-fante @@ -1568,10 +1021,10 @@ albanian @@ -1580,10 +1033,10 @@ amharic @@ -1592,10 +1045,10 @@ arabic @@ -1604,10 +1057,10 @@ aragones @@ -1619,7 +1072,7 @@ hayeren @@ -1628,10 +1081,10 @@ assamese @@ -1640,10 +1093,10 @@ asturian @@ -1652,10 +1105,10 @@ australian-english @@ -1664,10 +1117,10 @@ azerbaijani @@ -1676,10 +1129,10 @@ bambara @@ -1691,7 +1144,7 @@ euskara @@ -1703,7 +1156,7 @@ bielaruskaja @@ -1712,10 +1165,10 @@ bengali @@ -1724,10 +1177,10 @@ bodo @@ -1736,10 +1189,10 @@ bokmal @@ -1748,10 +1201,10 @@ bosnian @@ -1775,7 +1228,7 @@ brezhoneg @@ -1787,7 +1240,7 @@ british @@ -1796,10 +1249,10 @@ bulgarian @@ -1808,10 +1261,10 @@ canadian-english @@ -1823,7 +1276,7 @@ catala @@ -1835,7 +1288,7 @@ simplified-chinese @@ -1847,7 +1300,7 @@ hrvatski @@ -1859,7 +1312,7 @@ cesky @@ -1871,19 +1324,19 @@ dansk @@ -1895,7 +1348,7 @@ nederlands @@ -1904,10 +1357,10 @@ esperanto @@ -1916,10 +1369,10 @@ estonian @@ -1928,10 +1381,10 @@ faroese @@ -1943,7 +1396,7 @@ suomi @@ -1955,7 +1408,7 @@ francais @@ -1991,7 +1444,7 @@ galego @@ -2000,10 +1453,10 @@ georgian @@ -2015,7 +1468,7 @@ deutsch @@ -2024,10 +1477,10 @@ greek @@ -2039,7 +1492,7 @@ zudelk-veenkelonioals @@ -2048,10 +1501,10 @@ gujarati @@ -2060,10 +1513,10 @@ hebrew @@ -2072,10 +1525,10 @@ hindi @@ -2087,7 +1540,7 @@ magyar @@ -2099,7 +1552,7 @@ islenska @@ -2111,7 +1564,7 @@ bahasa-indonesia @@ -2120,10 +1573,10 @@ inuktitut @@ -2135,7 +1588,7 @@ italiano @@ -2144,10 +1597,10 @@ japanese @@ -2156,7 +1609,7 @@ kabyle @@ -2180,10 +1633,10 @@ kashmiri-devanagari @@ -2192,10 +1645,10 @@ kashmiri-perso-arabic @@ -2204,10 +1657,10 @@ khmer @@ -2219,7 +1672,7 @@ chiga @@ -2228,10 +1681,10 @@ kinyarwanda @@ -2243,7 +1696,7 @@ tlhIngan @@ -2252,10 +1705,10 @@ konkani-devanagari @@ -2264,10 +1717,10 @@ konkani-roman @@ -2276,10 +1729,10 @@ korean @@ -2288,10 +1741,10 @@ kurdish @@ -2300,10 +1753,10 @@ latvian @@ -2315,7 +1768,7 @@ lietuviu @@ -2324,10 +1777,10 @@ luganda @@ -2339,7 +1792,7 @@ letzebuergesch @@ -2348,10 +1801,10 @@ macedonian @@ -2360,10 +1813,10 @@ maithili @@ -2372,10 +1825,10 @@ malay @@ -2384,10 +1837,10 @@ malayalam @@ -2396,10 +1849,10 @@ manipuri-bengali @@ -2408,10 +1861,10 @@ manipuri-meitei-mayek @@ -2420,10 +1873,10 @@ marathi @@ -2444,10 +1897,10 @@ mongolian @@ -2456,10 +1909,10 @@ ndebele @@ -2468,10 +1921,10 @@ nepali @@ -2483,7 +1936,7 @@ sesotho-sa-leboa @@ -2504,10 +1957,10 @@ occitan @@ -2519,7 +1972,7 @@ oriya @@ -2531,7 +1984,7 @@ ojibway @@ -2540,10 +1993,10 @@ persian @@ -2555,7 +2008,7 @@ polski @@ -2567,7 +2020,7 @@ portugues @@ -2579,7 +2032,7 @@ panjabi @@ -2588,10 +2041,10 @@ romanian @@ -2603,7 +2056,7 @@ russkiy @@ -2612,10 +2065,10 @@ sanskrit @@ -2624,10 +2077,10 @@ santali-devanagari @@ -2636,10 +2089,10 @@ santali-ol-chiki @@ -2660,10 +2113,10 @@ serbian @@ -2672,10 +2125,10 @@ serbian-latin @@ -2687,7 +2140,7 @@ secwepemctin @@ -2696,10 +2149,10 @@ sindhi-devanagari @@ -2708,10 +2161,10 @@ sindhi-perso-arabic @@ -2720,10 +2173,10 @@ slovak @@ -2735,7 +2188,7 @@ slovensko @@ -2744,10 +2197,10 @@ songhay @@ -2756,10 +2209,10 @@ southafrican-english @@ -2771,7 +2224,7 @@ espanol @@ -2780,10 +2233,10 @@ sundanese @@ -2792,10 +2245,10 @@ swahili @@ -2807,7 +2260,7 @@ svenska @@ -2816,10 +2269,10 @@ tagalog @@ -2828,10 +2281,10 @@ tamil @@ -2840,10 +2293,10 @@ telugu @@ -2852,10 +2305,10 @@ thai @@ -2864,10 +2317,10 @@ tibetan @@ -2876,10 +2329,10 @@ traditional-chinese @@ -2888,10 +2341,10 @@ turkish @@ -2900,10 +2353,10 @@ twi @@ -2912,10 +2365,10 @@ ukrainian @@ -2924,10 +2377,10 @@ urdu @@ -2936,10 +2389,10 @@ venda @@ -2951,7 +2404,7 @@ veneto @@ -2960,10 +2413,10 @@ vietnamese @@ -2975,7 +2428,7 @@ walon @@ -2987,7 +2440,7 @@ cymraeg @@ -2996,10 +2449,10 @@ wolof @@ -3008,10 +2461,10 @@ xhosa @@ -3020,7 +2473,7 @@ miahuatlan-zapotec + Table of Contents @@ -114,105 +105,61 @@

    About + id="about">About Tux Paint

    - What Is 'Tux Paint?' -

    + What Is "Tux Paint"?

    - Tux Paint is a free drawing program designed for young - children (kids ages 3 and up). It has a simple, - easy-to-use interface, fun sound effects, and an - encouraging cartoon mascot who helps guide children as - they use the program. It provides a blank canvas and a - variety of drawing tools to help your child be creative. -

    + Tux Paint is a free drawing program designed for young children (kids ages 3 and up). It has a simple, easy-to-use interface, fun sound effects, and an encouraging cartoon mascot who helps guide children as they use the program. It provides a blank canvas and a variety of drawing tools to help your child be creative.

    - License: -

    + License:

    - Tux Paint is an Open Source project, - Free Software released under the GNU General Public - License (GPL). It is free, and the 'source code' - behind the program is available. (This allows others to - add features, fix bugs, and use parts of the program in - their own GPL'd software.) -

    + Tux Paint is an Open Source project, Free Software released under the GNU General Public License (GPL). It is free, and the 'source code' behind the program is available. (This allows others to add features, fix bugs, and use parts of the program in their own GPL'd software.)

    - See COPYING.txt for the full - text of the GPL license. -

    + See COPYING.txt for the full text of the GPL license.

    - Objectives: -

    + Objectives:
    - Easy and Fun + Easy and Fun
    - Tux Paint is meant to be a simple drawing program - for young children. It is not meant as a - general-purpose drawing tool. It is meant to be - fun and easy to use. Sound effects and a cartoon - character help let the user know what's going on, and - keeps them entertained. There are also extra-large - cartoon-style mouse pointer shapes. -
    + Tux Paint is meant to be a simple drawing program for young children. It is not meant as a general-purpose drawing tool. It is meant to be fun and easy to use. Sound effects and a cartoon character help let the user know what's going on, and keeps them entertained. There are also extra-large cartoon-style mouse pointer shapes.
    - Extensibility + Extensibility
    - Tux Paint is extensible. Brushes and "rubber - stamp" shapes can be dropped in and pulled out. For - example, a teacher can drop in a collection of animal - shapes and ask their students to draw an ecosystem. - Each shape can have a sound which is played, and - textual facts which are displayed, when the child - selects the shape. -
    + Tux Paint is extensible. Brushes and 'rubber stamp' shapes can be dropped in and pulled out. For example, a teacher can drop in a collection of animal shapes and ask their students to draw an ecosystem. Each shape can have a sound which is played, and textual facts which are displayed, when the child selects the shape.
    - Portability + Portability
    - Tux Paint is portable among various computer - platforms: Windows, Macintosh, Linux, etc. The - interface looks the same among them all. Tux Paint - runs suitably well on older systems (like a - Pentium 133), and can be built to run better on - slow systems. -
    + Tux Paint is portable among various computer platforms: Windows, Macintosh, Linux, etc. The interface looks the same among them all. Tux Paint runs suitably well on older systems, and can be built to run better on slow systems.
    - Simplicity + Simplicity
    - There is no direct access to the computer's underlying - intricacies. The current image is kept when the program - quits, and reappears when it is restarted. Saving - images requires no need to create filenames or use the - keyboard. Opening an image is done by selecting it from - a collection of thumbnails. Access to other files on - the computer is restricted. -
    + There is no direct access to the computer's underlying intricacies. The current image is kept when the program quits, and reappears when it is restarted. Saving images requires no need to create filenames or use the keyboard. Opening an image is done by selecting it from a collection of thumbnails. Access to other files on the computer is restricted.
    @@ -222,47 +169,39 @@

    Using Tux Paint + id="using">Using Tux Paint

    Loading Tux Paint + id="using_loading">Launching Tux Paint

    - Linux/Unix Users -

    + Linux/Unix Users

    - Tux Paint should have placed a laucher icon in your KDE - and/or GNOME menus, under 'Graphics.' -

    + Tux Paint should have placed a laucher icon in your KDE and/or GNOME menus, under 'Graphics.'

    - Alternatively, you can run the following command at a - shell prompt (e.g., "$"): -

    + Alternatively, you can run the following command at a shell prompt (e.g., "$"):

    $ tuxpaint

    - If any errors occur, they will be displayed on the - terminal (to "stderr"). -

    + If any errors occur, they will be displayed on the terminal (to STDERR).

    - Windows Users -

    + Windows Users
    -   +
    -   +
    -   + -   +
    -   +
    -   + -   +
    -   + -   +
    -   + -   +
    -   + -   +
    -   +
    -   + -   +
    -   + -   +
    -   + -   +
    -   + -   +
    -   + -   +
    -   +
    -   +
    -   + -   +
    -   + -   +
    -   + -   +
    -   + -   +
    -   +
    -   +
    -   + -   +
    -   + -   +
    -   +
    -   +
    -   +
    -   +
    -   +
    -   + dogri -   +
    -   +
    -   + -   +
    -   + -   +
    -   + -   +
    -   +
    -   +
    -   +
    -   + -   +
    -   +
    -   + -   +
    -   +
    -   + -   +
    -   + -   +
    -   + -   +
    -   +
    -   +
    -   +
    -   + -   +
    -   +
    -   + -   +
    -   + kabylian @@ -2168,10 +1621,10 @@ kannada -   + -   +
    -   + -   +
    -   + -   +
    -   + -   +
    -   +
    -   + -   +
    -   +
    -   + -   +
    -   + -   +
    -   + -   +
    -   + -   +
    -   + -   +
    -   +
    -   + -   +
    -   +
    -   + -   +
    -   + -   +
    -   + -   +
    -   + -   +
    -   + -   +
    -   + -   +
    -   + -   +
    -   + -   +
    -   + -   +
    -   + -   +
    -   +
    -   + -   +
    -   +
    -   +
    -   + -   +
    -   +
    -   +
    -   +
    -   + -   +
    -   +
    -   + -   +
    -   + -   +
    -   + -   +
    -   + -   +
    -   + -   +
    -   +
    -   + -   +
    -   + -   +
    -   + -   +
    -   +
    -   + -   +
    -   + -   +
    -   +
    -   + -   +
    -   + -   +
    -   +
    -   + -   +
    -   + -   +
    -   + -   +
    -   + -   +
    -   + -   +
    -   + -   +
    -   + -   +
    -   + -   +
    -   + -   +
    -   + -   +
    -   + -   +
    -   +
    -   + -   +
    -   +
    -   +
    -   + -   +
    -   + -   +
    -   + zapotec @@ -3032,7 +2485,7 @@ zulu -   + zulu @@ -3048,9 +2501,7 @@ noshade>

    - Overriding System Config. Options using - .tuxpaintrc -

    + Overriding System Config. Options

    @@ -3058,17 +2509,10 @@

    - If any of the above options are set in - "/etc/tuxpaint/tuxpaint.config", you can - override them in your own "~/.tuxpaintrc" - file. -

    + If any of the above options are set in "/etc/tuxpaint/tuxpaint.config", you can override them in your own "~/.tuxpaintrc" file.

    - For true/false options, like "noprint" and - "grab", you can simply say they equal 'no' in - your "~/.tuxpaintrc" file: -

    + For true/false options, like "noprint" and "grab", you can simply say they equal 'no' in your "~/.tuxpaintrc" file:

    noprint=no
    @@ -3076,9 +2520,7 @@

    - Or, you can use options similar to the command-line - override options described below. For example: -

    + Or, you can use options similar to the command-line override options described below. For example:

    print=yes
    @@ -3095,9 +2537,7 @@
    - Options can also be issued on the command-line when you start - Tux Paint. -
    + Options can also be issued on the command-line when you start Tux Paint.
    --fullscreen
    @@ -3163,21 +2603,19 @@ --mirrorstamps
    --stampsize=SIZE
    --keyboard
    - --savedir DIRECTORY
    - --datadir DIRECTORY
    - --exportdir DIRECTORY
    + --savedir DIRECTORY
    + --datadir DIRECTORY
    + --exportdir DIRECTORY
    --saveover
    --saveovernew
    --nosave
    --autosave
    - --lang LANGUAGE
    - --colorfile FILE
     + --lang LANGUAGE
    + --colorfile FILE
    - These enable or correspond to the configuration file - options described above. - + These enable or correspond to the configuration file options described above.
    @@ -3223,11 +2661,7 @@
    - These options can be used to override any settings made - in the configuration file. (If the option isn't set in - the configuration file(s), no overriding option is - necessary.) - + These options can be used to override any settings made in the configuration file. (If the option isn't set in the configuration file(s), no overriding option is necessary.)
    @@ -3240,19 +2674,10 @@

    - Run Tux Paint in one of the support languages. - See the "Choosing a - Different Language" section below for the - locale strings (e.g., "de_DE" for - German) to use. -

    + Run Tux Paint in one of the support languages. See the "Choosing a Different Language" section below for the locale strings (e.g., "de_DE" for German) to use.

    - (If your locale is already set, e.g. with the - "$LANG" environment variable, this - option is not necessary, since Tux Paint honors - your environment's setting, if possible.) -

    + (If your locale is already set, e.g. with the "$LANG" environment variable, this option is not necessary, since Tux Paint honors your environment's setting, if possible.)

    @@ -3261,17 +2686,10 @@

    - Under Linux and Unix, this prevents the system-wide - configuration file, - "/etc/tuxpaint/tuxpaint.conf", from - being read. -

    + Under Linux and Unix, this prevents the system-wide configuration file, "/etc/tuxpaint/tuxpaint.conf", from being read.

    - Only your own configuration file, - "~/.tuxpaintrc", if it exists, will be - used. -

    + Only your own configuration file, "~/.tuxpaintrc", if it exists, will be used.

    @@ -3280,15 +2698,11 @@ noshade>

    - Command-Line Informational Options -

    + Command-Line Informational Options

    - The following options display some informative text on - the screen. Tux Paint doesn't actually start up and - run afterwards, however. -

    + The following options display some informative text on the screen. Tux Paint doesn't actually start up and run afterwards, however.

    @@ -3298,54 +2712,42 @@
    - Display the version number and date of the copy of - Tux Paint you are running. The - "--verbose-version" also lists what compile-time - options were set. (See INSTALL.txt and FAQ.txt). -
    + Display the version number and date of the copy of Tux Paint you are running. The "--verbose-version" also lists what compile-time options were set. (See INSTALL and FAQ).
    --copying
    - Show brief license information about copying - Tux Paint. -
    + Show brief license information about copying Tux Paint.
    --usage
    - Display the list of available command-line options. -
    + Display the list of available command-line options.
    --help
    - Display brief help on using Tux Paint. -
    + Display brief help on using Tux Paint.
    --lang help
    - Display a list of available languages in - Tux Paint. -
    + Display a list of available languages in Tux Paint.
    --joystick-dev list
    - Display list of attached joysticks available to - Tux Paint. -
    + Display list of attached joysticks available to Tux Paint.
    @@ -3361,30 +2763,18 @@

    - Tux Paint has been translated into a number of - languages. To access the translations, you can use the - "--lang" option on the command-line to set the - language (e.g. "--lang spanish") or use - the "lang=" setting in the configuration file - (e.g., "lang=spanish"). -

    + Tux Paint has been translated into a number of languages. To access the translations, you can use the "--lang" option on the command-line to set the language (e.g. "--lang spanish") or use the "lang=" setting in the configuration file (e.g., "lang=spanish").

    - Tux Paint also honors your environment's current - locale. (You can override it on the command-line using the - "--locale" option; see above.) -

    + Tux Paint also honors your environment's current locale. (You can override it on the command-line using the "--locale" option; see above.)

    - Use the option "--lang help" to list the - available language options available. -

    + Use the option "--lang help" to list the available language options available.

    - Available Languages -

    + Available Languages +
    + Locale Code + Language
    (native name) + Language
    (English name) + Input Method Cycle Key Combination @@ -3413,13 +2797,13 @@ C @@ -3434,7 +2818,7 @@ Acholi @@ -3443,13 +2827,13 @@ af_ZA @@ -3458,13 +2842,13 @@ ak_GH @@ -3473,13 +2857,13 @@ am_ET @@ -3488,13 +2872,13 @@ an_ES @@ -3503,13 +2887,13 @@ ar_SA @@ -3518,13 +2902,13 @@ as_IN @@ -3533,13 +2917,13 @@ ast_ES @@ -3548,13 +2932,13 @@ az_AZ @@ -3563,13 +2947,13 @@ bm_ML @@ -3578,13 +2962,13 @@ bn_IN @@ -3599,7 +2983,7 @@ Belarusian @@ -3608,13 +2992,13 @@ bg_BG @@ -3623,13 +3007,13 @@ bo_CN (*) @@ -3644,7 +3028,7 @@ Breton @@ -3653,13 +3037,13 @@ brx_IN @@ -3668,13 +3052,13 @@ bs_BA @@ -3689,7 +3073,7 @@ Catalan @@ -3704,7 +3088,7 @@ Valencian @@ -3719,7 +3103,7 @@ Kiga @@ -3734,7 +3118,7 @@ Czech @@ -3749,7 +3133,7 @@ Welsh @@ -3764,7 +3148,7 @@ Danish @@ -3779,7 +3163,7 @@ German @@ -3788,13 +3172,13 @@ doi_IN @@ -3803,13 +3187,13 @@ et_EE @@ -3818,13 +3202,13 @@ el_GR (*) @@ -3833,13 +3217,13 @@ en_AU @@ -3848,13 +3232,13 @@ en_CA @@ -3863,13 +3247,13 @@ en_GB @@ -3878,13 +3262,13 @@ en_ZA @@ -3893,13 +3277,13 @@ eo @@ -3914,7 +3298,7 @@ Spanish @@ -3929,7 +3313,7 @@ Mexican Spanish @@ -3944,7 +3328,7 @@ Basque @@ -3953,13 +3337,13 @@ fa_IR @@ -3974,7 +3358,7 @@ Fula @@ -3989,7 +3373,7 @@ Finnish @@ -3998,13 +3382,13 @@ fo_FO @@ -4019,7 +3403,7 @@ French @@ -4034,7 +3418,7 @@ Irish Gaelic @@ -4049,7 +3433,7 @@ Scottish Gaelic @@ -4064,7 +3448,7 @@ Galician @@ -4079,7 +3463,7 @@ Gronings @@ -4088,13 +3472,13 @@ gu_IN @@ -4103,13 +3487,13 @@ he_IL (*) @@ -4118,13 +3502,13 @@ hi_IN (*) @@ -4139,7 +3523,7 @@ Croatian @@ -4154,7 +3538,7 @@ Hungarian @@ -4169,7 +3553,7 @@ Armenian @@ -4184,7 +3568,7 @@ Indonesian @@ -4199,7 +3583,7 @@ Icelandic @@ -4214,7 +3598,7 @@ Italian @@ -4223,13 +3607,13 @@ iu_CA @@ -4238,7 +3622,7 @@ ja_JP (*) @@ -4268,13 +3652,13 @@ kab @@ -4283,13 +3667,13 @@ km_KH @@ -4298,13 +3682,13 @@ kn_IN @@ -4313,7 +3697,7 @@ ko_KR (*) @@ -4343,13 +3727,13 @@ kok@roman @@ -4358,13 +3742,13 @@ ks_IN@devanagari @@ -4373,13 +3757,13 @@ ks_IN @@ -4388,13 +3772,13 @@ ku_TR @@ -4409,7 +3793,7 @@ Luxembourgish @@ -4418,13 +3802,13 @@ lg_UG @@ -4439,7 +3823,7 @@ Lithuanian @@ -4448,13 +3832,13 @@ lv_LV @@ -4463,13 +3847,13 @@ mk_MK @@ -4478,13 +3862,13 @@ mai_IN @@ -4493,13 +3877,13 @@ ml_IN @@ -4508,13 +3892,13 @@ mn_MN @@ -4523,13 +3907,13 @@ mni_IN @@ -4538,13 +3922,13 @@ mni@meiteimayek @@ -4553,13 +3937,13 @@ mr_IN @@ -4568,13 +3952,13 @@ ms_MY @@ -4589,7 +3973,7 @@ Norwegian Bokmål @@ -4601,10 +3985,10 @@ Nepali @@ -4613,13 +3997,13 @@ nl_NL @@ -4634,7 +4018,7 @@ Norwegian Nynorsk @@ -4643,13 +4027,13 @@ nr_ZA @@ -4664,7 +4048,7 @@ Northern Sotho @@ -4673,13 +4057,13 @@ oc_FR @@ -4688,7 +4072,7 @@ oj_CA @@ -4718,7 +4102,7 @@ or_IN @@ -4754,7 +4138,7 @@ Brazilian Portuguese @@ -4769,7 +4153,7 @@ Portuguese @@ -4778,13 +4162,13 @@ ro_RO @@ -4799,7 +4183,7 @@ Russian @@ -4808,13 +4192,13 @@ rw_RW @@ -4823,13 +4207,13 @@ sa_IN @@ -4838,13 +4222,13 @@ sat_IN @@ -4853,13 +4237,13 @@ sat@olchiki @@ -4874,7 +4258,7 @@ Shuswap @@ -4883,13 +4267,13 @@ si_LK @@ -4898,13 +4282,13 @@ sd_IN@devanagari @@ -4913,13 +4297,13 @@ sd_IN @@ -4928,13 +4312,13 @@ sk_SK @@ -4943,13 +4327,13 @@ sl_SI @@ -4958,13 +4342,13 @@ son @@ -4973,13 +4357,13 @@ sq_AL @@ -4988,13 +4372,13 @@ sr_YU @@ -5003,13 +4387,13 @@ sr_RS@latin @@ -5018,13 +4402,13 @@ su_ID @@ -5039,7 +4423,7 @@ Swedish @@ -5048,13 +4432,13 @@ sw_TZ @@ -5063,13 +4447,13 @@ ta_IN (*) @@ -5078,13 +4462,13 @@ te_IN (*) @@ -5093,13 +4477,13 @@ th_TH (*) @@ -5108,13 +4492,13 @@ tl_PH (*) @@ -5129,7 +4513,7 @@ Klingon @@ -5138,13 +4522,13 @@ tr_TR @@ -5153,13 +4537,13 @@ tw_GH @@ -5168,13 +4552,13 @@ uk_UA @@ -5183,13 +4567,13 @@ ur_IN @@ -5198,13 +4582,13 @@ ve_ZA @@ -5219,7 +4603,7 @@ Venetian @@ -5228,13 +4612,13 @@ vi_VN @@ -5243,13 +4627,13 @@ wa_BE @@ -5258,13 +4642,13 @@ wo_SN @@ -5273,13 +4657,13 @@ xh_ZA @@ -5288,13 +4672,13 @@ zh_CN (*) @@ -5303,13 +4687,13 @@ zh_TW (*) @@ -5318,13 +4702,13 @@ zam @@ -5333,107 +4717,63 @@ zu_ZA
    - Locale Code - - Language
    - (native name) -     		- Language
    - (English name) -     		- Input Method Cycle Key Combination -
    -   + English -   +
    -   +
    -   + Afrikaans -   +
    -   + Akan -   +
    -   + Amharic -   +
    -   + Aragones -   +
    -   + Arabic -   +
    -   + Assamese -   +
    -   + Asturian -   +
    -   + Azerbaijani -   +
    -   + Bambara -   +
    -   + Bengali -   +
    -   +
    -   + Bulgarian -   +
    -   + Tibetan -   +
    -   +
    -   + Bodo -   +
    -   + Bosnian -   +
    -   +
    -   +
    -   +
    -   +
    -   +
    -   +
    -   +
    -   + Dogri -   +
    -   + Estonian -   +
    -   + Greek -   +
    -   + Australian English -   +
    -   + Canadian English -   +
    -   + British English -   +
    -   + South African English -   +
    -   + Esperanto -   +
    -   +
    -   +
    -   +
    -   + Persian -   +
    -   +
    -   +
    -   + Faroese -   +
    -   +
    -   +
    -   +
    -   +
    -   +
    -   + Gujarati -   +
    -   + Hebrew -   +
    -   + Hindi -   +
    -   +
    -   +
    -   +
    -   +
    -   +
    -   +
    -   + Inuktitut -   +
    -   + Japanese @@ -4253,13 +3637,13 @@ ka_GE -   + Georgian -   +
    -   + Kabyle -   +
    -   + Khmer -   +
    -   + Kannada -   +
    -   + Korean @@ -4328,13 +3712,13 @@ kok_IN -   + Konkani (Devanagari) -   +
    -   + Konkani (Roman) -   +
    -   + Kashmiri (Devanagari) -   +
    -   + Kashmiri (Perso-Arabic) -   +
    -   + Kurdish -   +
    -   +
    -   + Luganda -   +
    -   +
    -   + Latvian -   +
    -   + Macedonian -   +
    -   + Maithili -   +
    -   + Malayalam -   +
    -   + Mongolian -   +
    -   + Manipuri (Bengali) -   +
    -   + Manipuri (Meitei Mayek) -   +
    -   + Marathi -   +
    -   + Malay -   +
    -   +
    -   + -   +
    -   + Dutch -   +
    -   +
    -   + Ndebele -   +
    -   +
    -   + Occitan -   +
    -   + Ojibwe @@ -4703,13 +4087,13 @@ pa_IN -   + Punjabi -   +
    -   + Odia @@ -4739,7 +4123,7 @@ Polish -   +
    -   +
    -   +
    -   + Romanian -   +
    -   +
    -   + Kinyarwanda -   +
    -   + Sanskrit -   +
    -   + Santali (Devanagari) -   +
    -   + Santali (Ol-Chikii) -   +
    -   +
    -   + Sinhala -   +
    -   + Sindhi (Devanagari) -   +
    -   + Sindhi -   +
    -   + Slovak -   +
    -   + Slovenian -   +
    -   + Songhay -   +
    -   + Albanian -   +
    -   + Serbian (cyrillic) -   +
    -   + Serbian (latin) -   +
    -   + Sundanese -   +
    -   +
    -   + Swahili -   +
    -   + Tamil -   +
    -   + Telugu -   +
    -   + Thai -   +
    -   + Tagalog -   +
    -   +
    -   + Turkish -   +
    -   + Twi -   +
    -   + Ukrainian -   +
    -   + Urdu -   +
    -   + Venda -   +
    -   +
    -   + Vietnamese -   +
    -   + Walloon -   +
    -   + Wolof -   +
    -   + Xhosa -   +
    -   + Chinese (Simplified) -   +
    -   + Chinese (Traditional) -   +
    -   + Zapotec (Miahuatlan) -   +
    -   + Zulu -   +

    - (*) - These languages require their own fonts, - since they are not represented using a Latin character - set, like the others. See the "Special Fonts" section, - below. -

    + (*) - These languages require their own fonts, since they are not 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 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. -

    + 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.

    - Setting Your Environment's Locale -

    + Setting Your Environment's Locale

    - Changing your locale will affect much of your - environment. -

    + Changing your locale will affect much of your environment.

    - As stated above, along with letting you choose the - language at runtime using command-line options - ("--lang" and "--locale"), - Tux Paint honors the global locale setting in your - environment. -

    + As stated above, along with letting you choose the language at runtime using command-line options ("--lang" and "--locale"), Tux Paint honors the global locale setting in your environment.

    - If you haven't already set your environment's locale, the - following will briefly explain how: -

    + If you haven't already set your environment's locale, the following will briefly explain how:

    - Linux/Unix Users -

    + Linux/Unix Users

    - First, be sure the locale you want to use is enabled by - editing the file "/etc/locale.gen" on your - system and then running the program - "locale-gen" as root. -

    + First, be sure the locale you want to use is enabled by editing the file "/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 "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 may need to edit the file - "/var/lib/locales/supported.d/local" - first, and add locales they want, from the list found - in "/usr/share/i18n/SUPPORTED". -

    + 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 edit the file "dpkg-reconfigure locales" first, and add locales they want, from the list found in "/var/lib/locales/supported.d/local".

    - Then, before running Tux Paint, set your - "$LANG" environment variable to one of the - locales listed above. (If you want all programs that - can be translated to be, you may wish to place the - following in your login script; e.g. - ~/.profile, ~/.bashrc, - ~/.cshrc, etc.) -

    + Then, before running Tux Paint, set your "$LANG" environment variable to one of the locales listed above. (If you want all programs that can be translated to be, you may wish to place the following in your login script; e.g. "~/.profile", "~/.bashrc", "~/.cshrc", etc.)

    - For example, in a Bourne Shell (like BASH): -

    + For example, in a Bourne Shell (like BASH):

    - export LANG=es_ES ; \
    + export LANG=es_ES ; \
    tuxpaint

    - And in a C Shell (like TCSH): -

    + And in a C Shell (like TCSH):

    - setenv LANG es_ES ; \
    + setenv LANG es_ES ; \
    tuxpaint
    @@ -5442,95 +4782,25 @@ noshade>

    - Windows Users -

    + Windows Users

    - Tux Paint will recognize the current locale and - use the appropriate files by default. So this section - is only for people trying different languages. -

    + Tux Paint will recognize the current locale and use the appropriate files by default. So this section is only for people trying different languages.

    - The simplest thing to do is to use the - '--lang' switch in the shortcut (see - "INSTALL.txt"). However, by using an MSDOS Prompt - window, it is also possible to issue a command like - this: -

    + The simplest thing to do is to use the "--lang" switch in the shortcut (see "INSTALL"). However, by using an MSDOS Prompt window, it is also possible to issue a command like this:

    set LANG=es_ES

    - ...which will set the language for the lifetime of that - DOS window. -

    + ...which will set the language for the lifetime of that DOS window.

    - For something more permanent, try editing your - computer's 'autoexec.bat' file using - Windows' "sysedit" tool: -

    + For something more permanent, try editing your computer's "autoexec.bat" file using Windows' "sysedit" tool:

    -
    - Windows 95/98 -
    - -
      -
    1. Click on the 'Start' button, and select 'Run...'. -
      2. - -
    2. Type "sysedit" into the 'Open:' box (with or - without quotes). -
      3. - -
    3. Click 'OK'. -
      4. - -
    4. Locate the AUTOEXEC.BAT window in the System - Configuration Editor. -
      5. - -
    5. Add the following at the bottom of the file: -
      - set LANG=es_ES -
      -
      6. - -
    6. Close the System Configuration Editor, answering - yes to save the changes. -
      7. - -
    7. Restart your machine. -
      8. -
    - -
    - To affect the entire machine, and all - applications, it is possible to use the "Regional - Settings" control panel: -
    - -
      -
    1. Click on the 'Start' button, and select - 'Settings | Control Panel'. -
      2. - -
    2. Double click on the "Regional Settings" globe. -
      3. - -
    3. Select a language/region from the drop down list. -
      4. - -
    4. Click 'OK'. -
      5. - -
    5. Restart your machine when prompted. -
      6. -
    @@ -5541,40 +4811,16 @@

    - Some languages require special fonts be installed. These - font files (which are in TrueType format (TTF)), are much - too large to include with the Tux Paint download, - and are available separately. (See the table above, under - the "Choosing a - Different Language" section.) -

    + Some languages require special fonts be installed. These font files (which are in TrueType format (TTF)), are much too large to include with 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, 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 necessary. -

    + 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 necessary.

    - When running Tux Paint in a language that requires - its own font, Tux Paint will try to load the font - file from its system-wide "fonts" - directory (under a "locale" - subdirectory). The name of the file corresponds to the - first two letters in the 'locale' code of the language - (e.g., "ko" for Korean, "ja" for Japanese, "zh_tw" for - Traditional Chinese). -

    + When running Tux Paint in a language that requires its own font, Tux Paint will try to load the font file from its system-wide "fonts" directory (under a "locale" subdirectory). The name of the file corresponds to the first two letters in the 'locale' code of the language (e.g., "ko" for Korean, "ja" for Japanese, "zh_tw" for Traditional Chinese).

    - For example, under Linux or Unix, when Tux Paint is - run in Korean (e.g., with the option - "--lang korean"), Tux Paint will - attempt to load the following font file: -

    + For example, under Linux or Unix, when Tux Paint is run in Korean (e.g., with the option "--lang korean"), Tux Paint will attempt to load the following font file:

    @@ -5583,17 +4829,10 @@

    - You can download fonts for supported languages from - Tux Paint's website, http://www.tuxpaint.org/. - (Look in the 'Fonts' section under 'Download.') -

    + You can download fonts for supported languages from Tux Paint's website, http://www.tuxpaint.org/. (Look in the 'Fonts' section under 'Download.')

    - Under Unix and Linux, you can use the - Makefile that comes with the font to install - the font in the appropriate location. -

    + Under Unix and Linux, you can use the Makefile that comes with the font to install the font in the appropriate location.

    diff --git a/docs/en/html/PNG.html b/docs/en/html/PNG.html new file mode 100644 index 000000000..14c94a713 --- /dev/null +++ b/docs/en/html/PNG.html @@ -0,0 +1,117 @@ + + + + + Tux Paint PNG Documentation + + + +
    +

    + Tux Paint
    + version 0.9.26
    + PNG Documentation

    + +

    + Copyright © 2007-2021 by various contributors; see AUTHORS.
    + http://www.tuxpaint.org/ +

    + +

    + 30 January 2021

    +
    + +
    + +

    About PNGs

    + +

    + PNG is the Portable Network Graphic format. It is an open standard, not burdened by patents (like GIFs). It is a highly compressed format (though not "lossy" like JPEGs - lossiness allows files to be much smaller, but introduces 'mistakes' in the image when saved), and supports 24-bit color (16.7 million colors) as well as a full "alpha channel" - that is, each pixel can have a varying degree of transparency.

    + +

    + For more information, visit: http://www.libpng.org/

    + +

    + These features (openness, losslessness, compression, transparency/alpha) make it the best choice for Tux Paint. (Tux Paint's support for the PNG format comes from the Open Source SDL_Image library, which in turn gets it from the libPNG library.)

    + +

    + Support for many colors allows photo-quality "rubber stamp" images to be used in Tux Paint, and alpha transparency allows for high-quality brushes.

    + +

    How To Make PNGs

    + +

    The following is a very brief list of ways to create PNGs or convert existing images into PNGs. +

    GIMP & Krita

    +

    + Excellent tools with which to create PNG images for use in Tux Paint are GIMP and Krita, both high-quality Open Source interactive drawing and photo editing programs.

    + +

    + It is likely that one or both are already installed on your system. If not, they should be readily available from your Linux distribution's software repository. If not, or to learn more, visit http://www.gimp.org/ and http://www.krita.org/, respectively.

    + +

    Command-line Tools

    + +

    NetPBM

    +

    + The Portable Bitmap tools (collectively known as "NetPBM") is a collection of Open Source command-line tools which convert to and from various formats, including GIF, TIFF, BMP, PNG, and many more.

    + +

    + It is possible that it's already installed on your system. If not, they it be readily available from your Linux distribution's software repository. If not, or to learn more, visit http://netpbm.sourceforge.net/.

    + +

    cjpeg/djpeg

    +

    + The "cjpeg" and "djpeg" command-line programs convert between the NetPBM Portable Any Map (PNM) format and JPEGs. + It is possible that it's already installed on your system. If not, they it be readily available from your Linux distribution's software repository. If not, or to learn more, visit https://jpegclub.org/.

    + +

    Windows Users

    + + +

    Macintosh Users

    + + + + diff --git a/docs/en/html/README.html b/docs/en/html/README.html index 53de40a40..c37ea11d1 100644 --- a/docs/en/html/README.html +++ b/docs/en/html/README.html @@ -1,11 +1,8 @@ - - Tux Paint README - + Tux Paint Documentation ("README") @@ -19,24 +16,19 @@ Tux Paint
    - version 0.9.26 - + alt="Tux Paint">
    + version 0.9.26

    - A simple drawing program for children -

    + A simple drawing program for children

    - Copyright 2002-2021 by various contributors; see - AUTHORS.txt
    - http://www.tuxpaint.org/ + Copyright © 2002-2021 by various contributors; see AUTHORS.
    + http://www.tuxpaint.org/

    - June 14, 2002 - January 13, 2021 -

    + 2 February 2021

    - Table of Contents -

    - Tux Paint + alt="[Tux Paint Icon]">
    + Tux Paint

    - If you installed Tux Paint on your computer using - the 'Tux Paint Installer,' it will have asked - you whether you wanted a 'Start' menu short-cut, and/or - a desktop shortcut. If you agreed, you can simply run - Tux Paint from the 'Tux Paint' section of - your 'Start' menu (e.g., under "All Programs" on - Windows XP), or by double-clicking the - "Tux Paint" icon on your desktop. -

    + If you installed Tux Paint on your computer using the 'Tux Paint Installer,' it will have asked you whether you wanted a 'Start' menu short-cut, and/or a desktop shortcut. If you agreed, you can simply run Tux Paint from the 'Tux Paint' section of your 'Start' menu (e.g., under 'All Programs'), or by double-clicking the 'Tux Paint' icon on your desktop, if you had the installer place one there.

    - If you installed Tux Paint using the 'ZIP-file' - download, or if you used 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. -

    + 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 "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 the installer ran. -

    + 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.

    - If you used the 'ZIP-file' download, Tux Paint's - folder will be wherever you put it when you unzipped - the ZIP file. -

    + If you used the 'ZIP-file' download, Tux Paint's folder will be wherever you extracted the contents of the ZIP file.


    @@ -321,13 +239,11 @@ noshade>

    - macOS Users -

    + macOS Users

    - Simply double-click the "Tux Paint" icon. -

    + Simply double-click the "Tux Paint" icon.

    @@ -341,22 +257,17 @@

    - When Tux Paint first loads, a title/credits screen - will appear. -

    + When Tux Paint first loads, a title/credits screen will appear.

    [Title Screenshot] + alt="[Title screen]">

    - Once loading is complete, press a key or click on the - mouse to continue. (Or, after about 30 seconds, the - title screen will go away automatically.) -

    + Once loading is complete, press a key or click or tap in the Tux Paint window to continue. (Or, after about 5 seconds, the title screen will go away automatically.)

    - The main screen is divided into the following sections: -
    + The main screen is divided into the following sections:
    - Left Side: Toolbar + Left Side: Toolbar

    - The toolbar contains the drawing and editing - controls. -

    + The toolbar contains the drawing and editing controls.

    @@ -391,45 +299,31 @@

    - Middle: Drawing Canvas + Middle: Drawing Canvas

    - The largest part of the screen, in the center, is the - drawing canvas. This is, obviously, where you draw! -

    + The largest part of the screen, in the center, is the drawing canvas. This is, obviously, where you draw!

    [(Canvas)] + alt="[Canvas]">

    - Note: The size of the drawing canvas depends - on the size of Tux Paint. You can change the - size of Tux Paint using the - Tux Paint Config. configuration - tool, or by other means. See the OPTIONS documentation for more - details. -

    + Note: The size of the drawing canvas depends on the size of Tux Paint. You can change the size of Tux Paint using the Tux Paint Config. configuration tool, or by other means. See the Options documentation for more details.

    - Right Side: Selector + Right Side: Selector

    - Depending on the current tool, the selector shows - different things. e.g., when the Paint Brush - tool is selected, it shows the various brushes - available. When the Rubber Stamp tool is - selected, it shows the different shapes you can use. -

    + Depending on the current tool, the selector shows different things. e.g., when the Paint Brush or Line tool is selected, it shows the various brushes available. When the Rubber Stamp tool is selected, it shows the different shapes you can use. When the Text or Label tool is selected, it shows various fonts.

    - Lower: Colors + Lower: Colors

    - A palette of available colors are shown near the - bottom of the screen. -

    + A palette of available colors are shown near the bottom of the screen.

    - On the far right are two special color options, the - "color picker", which has an outline of an - eye-dropper, and allows you to pick a color found - within your drawing, and the rainbow palette, which - allows you to pick a color from within a box - containing thousands of colors. -

    + On the far right are two special color options, the "color picker", which has an outline of an eye-dropper, and allows you to pick a color found within your drawing, and the rainbow palette, which allows you to pick a color from within a box containing thousands of colors.

    - (NOTE: You can define your own colors for - Tux Paint. See the "Options" documentation.) -

    + (Note: You can define your own colors for Tux Paint. See the "Options" documentation.)

    - Bottom: Help Area + Bottom: Help Area

    - At the very bottom of the screen, Tux, the Linux - Penguin, provides tips and other information while - you draw. -

    + At the very bottom of the screen, Tux, the Linux Penguin, provides tips and other information while you use Tux Paint.

    - + "(Example tip: 'Pick a shape. Click to pick the center, drag, then let go when it is the size you want. Move around to rotate it, and click to draw it.')">

    @@ -513,7 +393,7 @@
    - Paint (Brush) + "Paint" Tool (Brush)
    @@ -523,21 +403,13 @@ alt="" align="right">

    - The Paint Brush tool lets you draw freehand, - using various brushes (chosen in the Selector on - the right) and colors (chosen in the Color palette - towards the bottom). -

    + The Paint Brush tool lets you draw freehand, using various brushes (chosen in the Selector on the right) and colors (chosen in the Color palette towards the bottom).

    - If you hold the mouse button down, and move the - mouse, it will draw as you move. -

    + If you hold the mouse button down, and move the mouse, it will draw as you move.

    - As you draw, a sound is played. The bigger the - brush, the lower the pitch. -

    + As you draw, a sound is played. The bigger the brush, the lower the pitch.


    @@ -551,7 +423,7 @@

    - Stamp (Rubber Stamp) + "Stamp" Tool (Rubber Stamps)
    @@ -561,17 +433,10 @@ alt="" align="right">

    - The Stamp tool is like a set of rubber stamps or - stickers. It lets you paste pre-drawn or - photographic images (like a picture of a horse, or - a tree, or the moon) in your picture. -

    + The Stamp tool is like a set of rubber stamps or stickers. It lets you paste pre-drawn or photographic images (like a picture of a horse, or a tree, or the moon) in your picture.

    - As you move the mouse around the canvas, an outline - follows the mouse, showing where the stamp will be - placed, and how big it will be. -

    + As you move the mouse around the canvas, an outline follows the mouse, showing where the stamp will be placed, and how big it will be. Click to place the stamp.

    - There can be numerous categories of stamps (e.g., - animals, plants, outer space, vehicles, people, - etc.). Use the Left and Right arrows to cycle - through the collections. -

    + There can be numerous categories of stamps (e.g., animals, plants, outer space, vehicles, people, etc.). Use the Left and Right arrows near the bottom of the Selector to cycle through the collections.

    - Prior to 'stamping' an image onto your drawing, - various effects can sometimes be applied (depending - on the stamp): -

    + Prior to 'stamping' an image onto your drawing, various effects can sometimes be applied (depending on the stamp):

      -
    • Some stamps can be colored or tinted. If the - color palette below the canvas is activated, you - can click the colors to change the tint or color of - the stamp before placing it in the picture. -
      • +
    • Some stamps can be colored or tinted. If the color palette below the canvas is activated, you can click the colors to change the tint or color of the stamp before placing it in the picture.
      • -
    • Stamps can be shrunk and expanded, by clicking - within the triangular-shaped series of bars at the - bottom right; the larger the bar, the larger the - stamp will appear in your picture. -
      • +
    • Stamps can be shrunk and expanded, by clicking within the triangular-shaped series of bars at the bottom right; the larger the bar, the larger the stamp will appear in your picture.
      • -
    • Many stamps may be flipped vertically, or - displayed as a mirror-image, using the control - buttons at the bottom right. -
      • +
    • Many stamps may be flipped vertically, or displayed as a mirror-image, using the control buttons at the bottom right.

    @@ -630,26 +477,16 @@ alt="" align="right">

    - Different stamps can have different sound effects - and/or descriptive (spoken) sounds. Buttons at the - lower left (near Tux, the Linux penguin) allow you - to re-play the sound effects and descriptive sounds - for the currently-selected stamp. -

    + Different stamps can have different sound effects and/or descriptive (spoken) sounds. Buttons in the Help Area at the lower left (near Tux, the Linux penguin) allow you to re-play the sound effects and descriptive sounds for the currently-selected stamp.

    - (NOTE: If the "nostampcontrols" option - is set, Tux Paint won't display the Mirror, - Flip, Shrink and Grow controls for stamps. See the - "Options" - documentation.) -

    + (Note: If the "nostampcontrols" option is set, Tux Paint won't display the Mirror, Flip, Shrink and Grow controls for stamps. See the "Options" documentation.)

    - Lines + "Lines" Tool
    @@ -659,22 +496,13 @@ alt="" align="right">

    - This tool lets you draw straight lines using the - various brushes and colors you normally use with - the Paint Brush. -

    + This tool lets you draw straight lines using the various brushes and colors you normally use with the Paint Brush.

    - Click the mouse and hold it to choose the starting - point of the line. As you move the mouse around, a - thin 'rubber-band' line will show where the line - will be drawn. -

    + Click the mouse and hold it to choose the starting point of the line. As you move the mouse around, a thin 'rubber-band' line will show where the line will be drawn.

    - Let go of the mouse to complete the line. A - "sproing!" sound will play. -

    + Let go of the mouse to complete the line. A "sproing!" sound will play.


    @@ -688,7 +516,7 @@

    - Shapes + "Shapes" Tool
    @@ -698,91 +526,58 @@ alt="" align="right">

    - This tool lets you draw some simple filled, and - un-filled shapes. -

    + This tool lets you draw some simple filled, and un-filled shapes.

    - Select a shape from the selector on the right - (circle, square, oval, etc.). -

    + Select a shape from the selector on the right (circle, square, oval, etc.).

    - Use the options at the bottom right to choose the - shape tool's behavior: -

    + Use the options at the bottom right to choose the shape tool's behavior:

    - Shapes from center + Shapes from center
    - The shape will expand from where you initially - clicked, and will be centered around that - position. (This was Tux Paint's only - behavior through version 0.9.24.) -
    + The shape will expand from where you initially clicked, and will be centered around that position. (This was Tux Paint's only behavior through version 0.9.24.)
    - Shapes from corner + Shapes from corner
    - The shape will extend with one corner starting - from where you initially clicked. This is the - default method of most other traditional drawing - software. (This option was added starting with - Tux Paint version 0.9.25.) -
    + The shape will extend with one corner starting from where you initially clicked. This is the default method of most other traditional drawing software. (This option was added starting with Tux Paint version 0.9.25.)

    - Note: If shape controls are disabled (e.g., with - the "--noshapecontrols" option), the - controls will not be presented, and the "shapes - from center" method will be used. -

    + Note: If shape controls are disabled (e.g., with the "noshapecontrols" option), the controls will not be presented, and the "shapes from center" method will be used.

    - In the canvas, click the mouse and hold it to - stretch the shape out from where you clicked. Some - shapes can change proportion (e.g., rectangle and - oval may be wider than tall, or taller than wide), - others cannot (e.g., square and circle). -

    + In the canvas, click the mouse and hold it to stretch the shape out from where you clicked. Some shapes can change proportion (e.g., rectangle and oval may be wider than tall, or taller than wide), others cannot (e.g., square and circle).

    - Let go of the mouse when you're done stretching. -

    + Let go of the mouse when you're done stretching.

    - Normal Mode + Normal Shapes Mode

    - Now you can move the mouse around the canvas to - rotate the shape. -

    + Now you can move the mouse around the canvas to rotate the shape.

    - Click the mouse button again and the shape will - be drawn in the current color. -

    + Click the mouse button again and the shape will be drawn in the current color.

    - Simple Shapes Mode + Simple Shapes Mode
    - If simple shapes are enabled (e.g., with the - "--simpleshapes" option), the shape - will be drawn on the canvas when you let go of - the mouse button. (There's no rotation step.) -
    + If simple shapes are enabled (e.g., with the "simpleshapes" option), the shape will be drawn on the canvas when you let go of the mouse button. (There's no rotation step.)

    @@ -797,7 +592,7 @@
    - Text and Label + "Text" and "Label" Tools
    @@ -807,35 +602,16 @@ alt="" align="right">

    - Choose a font (from the 'Letters' available on the - right) and a color (from the color palette near the - bottom). Click on the screen and a cursor will - appear. Type text and it will show up on the - screen. -

    + Choose a font (from the 'Letters' available on the right) and a color (from the color palette near the bottom). Click on the screen and a cursor will appear. Type text and it will show up on the screen.

    - Press [Enter] or [Return] and the - text will be drawn onto the picture and the cursor - will move down one line. -

    + Press [Enter] or [Return] and the text will be drawn onto the picture and the cursor will move down one line.

    - Alternatively, press [Tab] and the text will - be drawn onto the picture, but the cursor will move - to the right of the text, rather than down a line, - and to the left. (This can be useful to create a - line of text with mixed colors, fonts, styles and - sizes: Like this.) -

    + Alternatively, press [Tab] and the text will be drawn onto the picture, but the cursor will move to the right of the text, rather than down a line, and to the left. (This can be useful to create a line of text with mixed colors, fonts, styles and sizes.)

    - Clicking elsewhere in the picture while the text - entry is still active causes the current line of - text to move to that location (where you can - continue editing it). -

    + Clicking elsewhere in the picture while the text entry is still active causes the current line of text to move to that location (where you can continue editing it).

    - Text versus Label + "Text" versus "Label"

    - The Text tool is the original text-entry - tool in Tux Paint. Text entered using this - tool can't be modified or moved later, since it - becomes part of the drawing. However, because - the text becomes part of the picture, it can be - drawn over or modified using Magic tool - effects (e.g., smudged, tinted, embossed, etc.) -

    + The Text tool is the original text-entry tool in Tux Paint. Text entered using this tool can't be modified or moved later, since it becomes part of the drawing. However, because the text becomes part of the picture, it can be drawn over or modified using Magic tool effects (e.g., smudged, tinted, embossed, etc.)

    - When using the Label tool (which was - added to Tux Paint in version 0.9.22), the - text 'floats' over the image, and the details - of the label (the text, the position of the - label, the font choice and the color) get - stored separately. This allows the label to be - repositioned or edited later. -

    + When using the Label tool (which was added to Tux Paint in version 0.9.22), the text 'floats' over the image, and the details of the label (the text, the position of the label, the font choice and the color) get stored separately. This allows the label to be repositioned or edited later.

    - The Label tool can be disabled (e.g., by - selecting "Disable 'Label' Tool" in - Tux Paint Config. or running - Tux Paint with the - "--nolabel" command-line option). -

    + The Label tool can be disabled (e.g., by selecting "Disable 'Label' Tool" in Tux Paint Config. or running Tux Paint with the "nolabel" option).

    - International Character Input + International Character Input

    - Tux Paint allows inputting characters in - different languages. Most Latin characters - (A-Z, ñ, è, etc.) - can by entered directly. Some languages require - that Tux Paint be switched into an - alternate input mode before entering, and some - characters must be composed using numerous - keypresses. -

    + Tux Paint allows inputting characters in different languages. Most Latin characters (A-Z, ñ, è, etc.) can by entered directly. Some languages require that Tux Paint be switched into an alternate input mode before entering, and some characters must be composed using numerous keypresses.

    - When Tux Paint's locale is set to one of the - languages that provide alternate input modes, a - key is used to cycle through normal (Latin - character) and locale-specific mode or modes. -

    + When Tux Paint's locale is set to one of the languages that provide alternate input modes, a key is used to cycle through normal (Latin character) and locale-specific mode or modes.

    - Currently supported locales, the input methods - available, and the key to toggle or cycle - modes, are listed below. Note: Many - fonts do not include all characters for all - languages, so sometimes you'll need to change - fonts to see the characters you're trying to - type. -

    + Currently supported locales, the input methods available, and the key to toggle or cycle modes, are listed below. Note: Many fonts do not include all characters for all languages, so sometimes you'll need to change fonts to see the characters you're trying to type.

      -
    • Japanese — Romanized Hiragana and Romanized - Katakana — right [Alt] -
      • +
    • Japanese — Romanized Hiragana and Romanized Katakana — right [Alt] key
      • -
    • Korean — Hangul 2-Bul — - right [Alt] or - left [Alt] -
      • +
    • Korean — Hangul 2-Bul — right [Alt] key or left [Alt] key
      • -
    • Traditional Chinese — - right [Alt] or - left [Alt] -
      • +
    • Traditional Chinese — right [Alt] key or left [Alt] key
      • -
    • Thai — right [Alt] -
      • +
    • Thai — right [Alt] key
    + +
    + On-screen Keyboard +
    + +
    +

    + An optional on-screen keyboard is available for the Text and Label tools, which can provide a variety of layouts and character composition (e.g., composing "a" and "e" into "æ"). See the "Options" and "Extending Tux Paint" documentation for more information.

    +
    @@ -939,7 +677,7 @@
    - Fill + "Fill" Tool
    @@ -949,20 +687,16 @@ alt="" align="right">

    - The 'Fill' tool 'flood-fills' a contiguous area of - your drawing with a solid color of your choice. -

    + The 'Fill' tool 'flood-fills' a contiguous area of your drawing with a solid color of your choice.

    - Note: Prior to Tux Paint 0.9.24, this was a - "Magic" tool (see below). -

    + Note: Prior to Tux Paint 0.9.24, this was a Magic tool (see below).

    - Magic (Special Effects) + "Magic" Tool (Special Effects)
    @@ -972,35 +706,20 @@ alt="" align="right">

    - The 'Magic' tool is actually a set of special - tools. Select one of the "magic" effects from the - selector on the right. Then, depending on the tool, - you can either click and drag around the picture, - and/or simply click the picture once, to apply the - effect. -

    + The Magic tool is actually a set of special tools. Select one of the 'magic' effects from the selector on the right. Then, depending on the tool, you can either click and drag around the picture, and/or simply click the picture once, to apply the effect.

    - If the tool can be used by clicking and dragging, a - 'painting' button will be available on the left, - below the list of "magic" tools on the right side - of the screen. If the tool can affect the entire - picture at once, an 'entire picture' button - will be available on the right. -

    + If the tool can be used by clicking and dragging, a 'painting' button will be available on the left, below the list of Magic tools on the right side of the screen. If the tool can affect the entire picture at once, an 'entire picture' button will be available on the right.


    - See the instructions for - each Magic tool (in the 'magic-docs' folder). -

    + See the instructions for each Magic tool (in the 'magic-docs' folder).

    - Eraser + "Eraser" Tool
    @@ -1010,27 +729,16 @@ alt="" align="right">

    - This tool is similar to the Paint Brush. Wherever - you click (or click and drag), the picture will be - erased. (This may be white, some other color, or to - a background picture, depending on the picture.) -

    + This tool is similar to the Paint Brush. Wherever you click (or click and drag), the picture will be erased. (This may be white, some other color, or to a background picture, depending on the picture.)

    - A number of eraser sizes are available, both round - and square.. -

    + A number of eraser sizes are available, both round and square.

    - As you move the mouse around, a square outline - follows the pointer, showing what part of the - picture will be erased to white. -

    + As you move the mouse around, a square outline follows the pointer, showing what part of the picture will be erased to white.

    - As you erase, a "squeaky clean" eraser/wiping sound - is played. -

    + As you erase, a 'squeaky clean' eraser wiping sound is played.


    @@ -1047,7 +755,7 @@
    - Undo + "Undo" Command
    @@ -1057,21 +765,17 @@ alt="" align="right">

    - Clicking this tool will undo the last drawing - action. You can even undo more than once! -

    + Clicking this tool will undo the last drawing action. You can even undo more than once!

    - Note: You can also press [Control]-[Z] on - the keyboard to undo. -

    + Note: You can also press [Control] + [Z] on the keyboard to Undo.


    - Redo + "Redo" Command
    @@ -1081,26 +785,20 @@ alt="" align="right">

    - Clicking this tool will redo the drawing action you - just "undid" with the 'Undo' button. -

    + Clicking this tool will redo the drawing action you just un-did with the 'Undo' button.

    - As long as you don't draw again, you can redo as - many times as you had "undone!" -

    + As long as you don't draw again, you can redo as many times as you had undone!

    - Note: You can also press [Control]-[R] on - the keyboard to redo. -

    + Note: You can also press [Control] + [R] on the keyboard to Redo.


    - New + "New" Command
    @@ -1110,51 +808,23 @@ alt="" align="right">

    - Clicking the "New" button will start a new drawing. - A dialog will appear where you may choose to start - a new picture using a solid background color, or - using a 'Starter' or 'Template' image (see below). - You will first be asked whether you really want to - do this. -

    + Clicking the 'New' button will start a new drawing. A dialog will appear where you may choose to start a new picture using a solid background color, or using a 'Starter' or 'Template' image (see below). You will first be asked whether you really want to do this.

    - Note: You can also press [Control]-[N] on - the keyboard to start a new drawing. -

    - 'Starter' & Template Images + Note: You can also press [Control] + [N] on the keyboard to start a new drawing.

    + 'Starter' & Template Images

    - 'Starters' can behave like a page from a coloring - book — a black-and-white outline of a picture, - which you can then color in, and the black - outline remains intact — or like a 3D photograph, - where you draw in between a foreground and - background layer. -

    + 'Starters' can behave like a page from a coloring book — a black-and-white outline of a picture, which you can then color in, and the black outline remains intact — or like a 3D photograph, where you draw in between a foreground and background layer.

    - 'Templates' are similar, but simply provide a - background drawing to work off of. Unlike - 'Starters', there is no layer that remains in the - foreground of anything you draw in the picture. -

    + 'Templates' are similar, but simply provide a background drawing to work off of. Unlike 'Starters', there is no layer that remains in the foreground of anything you draw in the picture.

    - When using the 'Eraser' tool, the original image - from the 'Starter' or 'Template' will reappear. - The 'Flip' and 'Mirror' Magic tools affect the - orientation of the 'Starter' or 'Template', as - well. -

    + When using the 'Eraser' tool, the original image from the 'Starter' or 'Template' will reappear. The 'Flip' and 'Mirror' Magic tools affect the orientation of the 'Starter' or 'Template', as well.

    - When you load a 'Starter' or 'Template', draw on - it, and then click 'Save,' it creates a new - picture file — it doesn't overwrite the original, - so you can use it again later (by accessing it - from the 'New' dialoge).. -

    + When you load a 'Starter' or 'Template', draw on it, and then click 'Save,' it creates a new picture file — it doesn't overwrite the original, so you can use it again later (by accessing it from the 'New' dialog).


    @@ -1162,7 +832,7 @@
    - Open + "Open" Command
    @@ -1172,12 +842,7 @@ alt="" align="right">

    - This shows you a list of all of the pictures you've - saved. If there are more than can fit on the - screen, use the "Up" and "Down" arrows at the top - and bottom of the list to scroll through the list - of pictures. -

    + This shows you a list of all of the pictures you've saved. If there are more than can fit on the screen, use the up and down arrows at the top and bottom of the list to scroll through the list of pictures.


    @@ -1188,8 +853,7 @@

    - Click a picture to select it, then... -

    + Click a picture to select it, and then...

      @@ -1200,15 +864,10 @@ alt="" align="right">

      - Click the green "Open" button at the lower - left of the list to load the selected - picture. -

      + Click the green 'Open' button at the lower left of the list to load the selected picture.

      - (Alternatively, you can double-click a - picture's icon to load it.) -

      + (Alternatively, you can double-click a picture's icon to load it.)


      @@ -1219,17 +878,10 @@ alt="" align="right">

      - Click the brown "Erase" (trash can) button at - the lower right of the list to erase the - selected picture. (You will be asked to - confirm.) -

      + Click the brown 'Erase' (trash can) button at the lower right of the list to erase the selected picture. (You will be asked to confirm.)

      - Note: As of version 0.9.22, the - picture will be placed in your desktop's - trash can, on Linux only. -

      + Note: As of version 0.9.22, the picture will be placed in your desktop's trash can, on Linux only.


      @@ -1240,11 +892,7 @@ alt="" align="right">

      - Click the "Export" button near the lower - right to export the image to your export - folder. (e.g., - "~/Pictures/TuxPaint/") -

      + Click the 'Export' button near the lower right to export the image to your export folder. (e.g., "~/Pictures/TuxPaint/")


      @@ -1255,11 +903,7 @@ alt="" align="right">

      - Click the blue "Slides" (slide projector) - button at the lower left to go to slideshow - mode. See "Slides", - below, for details. -

      + Click the blue 'Slides' (slide projector) button at the lower left to go to slideshow mode. See "Slides", below, for details.


      @@ -1270,34 +914,25 @@ alt="" align="right">

      - Or click the red "Back" arrow button at the - lower right of the list to cancel and return - to the picture you were drawing. -

      + Click the red 'Back' arrow button at the lower right of the list to cancel and return to the picture you were drawing.


    - If choose to open a picture, and your current - drawing hasn't been saved, you will be prompted as - to whether you want to save it or not. (See - "Save," below.) -

    + If choose to open a picture, and your current drawing hasn't been saved, you will be prompted as to whether you want to save it or not. (See "Save," below.)

    - Note: You can also press [Control]-[O] on - the keyboard to get the 'Open' dialog. -

    + Note: You can also press [Control] + [N] on the keyboard to bring up the 'Open' dialog.


    - Save + "Save" Command
    @@ -1307,28 +942,16 @@ alt="" align="right">

    - This saves your current picture. -

    + This saves your current picture.

    - If you haven't saved it before, it will create a - new entry in the list of saved images. (i.e., it - will create a new file) -

    + If you haven't saved it before, it will create a new entry in the list of saved images. (i.e., it will create a new file)

    - Note: It won't ask you anything (e.g., for a - filename). It will simply save the picture, and - play a "camera shutter" sound effect. -

    + Note: It won't ask you anything (e.g., for a filename). It will simply save the picture, and play a "camera shutter" sound effect.

    - If you HAVE saved the picture before, or this is a - picture you just loaded using the "Open" command, - you will first be asked whether you want to save - over the old version, or create a new entry (a new - file). -

    + If you have saved the picture before, or this is a picture you just loaded using the "Open" command, you will first be asked whether you want to save over the old version, or create a new entry (a new file).

    - (NOTE: If either the "saveover" or - "saveovernew" options are set, it - won't ask before saving over. See the "Options" documentation.) -

    + Note: If either the "saveover" or "saveovernew" options are set, it won't ask before saving over. See the "Options" documentation.

    - Note: You can also press [Control]-[S] on - the keyboard to save. -

    + Note: You can also press [Control] + [S] on the keyboard to save.


    - Print + "Print" Command
    @@ -1364,195 +981,110 @@ alt="" align="right">

    - Click this button and your picture will be printed! -

    + Click this button and your picture will be printed!

    - On most platforms, you can also hold the - [Alt] key (called [Option] on Macs) - while clicking the 'Print' button to get a printer - dialog. Note that this may not work if you're - running Tux Paint in fullscreen mode. See - below. -

    + On most platforms, you can also hold the [Alt] key (called [Option] on Macs) while clicking the 'Print' button to get a printer dialog. Note that this may not work if you're running Tux Paint in fullscreen mode. See below.

    - Disabling Printing + Disabling Printing

    - If the "noprint" option was set (either with - "noprint=yes" in Tux Paint's - configuration file, or using - "--noprint" on the command-line), - the "Print" button will be disabled. -

    + The "noprint" option can be set, which will disable Tux Paint's 'Print' button.

    - See the "Options" - documentation.) -

    + See the "Options" documentation.

    - Restricting Printing + Restricting Printing

    - If the "printdelay" option was used (either - with "printdelay=SECONDS" - in the configuration file, or using - "--printdelay=SECONDS" on - the command-line), you can only print once - every SECONDS seconds. -

    + The "printdelay" option can be set, which will only allow occasional printing — once every so many seconds, as configured by you.

    - For example, with "printdelay=60", - you can print only once a minute. -

    + For example, with "printdelay=60" in Tux Paint's configuration file, printing can only occur once per minute (60 seconds).

    - See the "Options" - documentation.) -

    + See the "Options" documentation.

    - Printing Commands + Printing Commands

    - (Linux and Unix only) + (Linux and Unix only)

    - Tux Paint prints by generating a - PostScript representation of the drawing and - sending it to an external program. By default, - the program is: -

    + Tux Paint prints by generating a PostScript representation of the drawing and sending it to an external program. By default, the program is:

    lpr

    - This command can be changed by setting the - "printcommand" value in Tux Paint's - configuration file. -

    + This command can be changed by setting a "printcommand" option in Tux Paint's configuration file.

    - If the [Alt] key on the keyboard is - being pushed while clicking the 'Print' button, - as long as you're not in fullscreen mode, an - alternative program is run. By default, the - program is KDE's graphical print dialog: -

    + An alternative print command can be invoked by holding the "[Alt]" key on the keyboard while clicking clicking the 'Print' button, as long as you're not in fullscreen mode, an alternative program is run. By default, the program is KDE's graphical print dialog:

    kprinter

    - This command can be changed by setting the - "altprintcommand" value in Tux Paint's - configuration file. -

    + This command can be changed by setting a "altprintcommand" option in Tux Paint's configuration file.

    - For information on how to change the printing - commands, see the "Options" - documentation. -

    + See the "Options" documentation.

    - Printer Settings + Printer Settings

    - (Windows and macOS) + (Windows and macOS)

    - By default, Tux Paint simply prints to the - default printer with default settings when the - 'Print' button is pushed. -

    + By default, Tux Paint simply prints to the default printer with default settings when the 'Print' button is pushed.

    - However, if you hold the [Alt] (or - [Option]) key on the keyboard while - pushing the button, as long as you're not in - fullscreen mode, your operating system's - printer dialog will appear, where you can - change the settings. -

    + However, if you hold the [Alt] (or [Option]) key on the keyboard while clicking the 'Print' button, as long as you're not in fullscreen mode, your operating system's printer dialog will appear, where you can change the settings.

    - You can have the printer configuration changes - stored by using the "printcfg" option, either - by using "--printcfg" on the - command-line, or "printcfg=yes" in - Tux Paint's own configuration file - ("tuxpaint.cfg"). -

    + You can have the printer configuration changes stored between Tux Paint sessions by setting the "printcfg" option.

    - If the "printcfg" option is used, printer - settings will be loaded from the file - "print.cfg" in your personal - folder (see below). Any changes will be saved - there as well. -

    + If the "printcfg" option is used, printer settings will be loaded from the file "printcfg.cfg" in your personal folder (see below). Any changes will be saved there as well.

    - See the "Options" - documentation.) -

    + See the "Options" documentation.

    - Printer Dialog Options + Printer Dialog Options

    - By default, Tux Paint only shows the - printer dialog (or, on Linux/Unix, runs the - "altprintcommand", e.g., "kprinter" instead of - "lpr") if the [Alt] (or [Option]) - key is held while clicking the 'Print' button. -

    + By default, Tux Paint only shows the printer dialog (or, on Linux/Unix, runs the "altprintcommand"; e.g., "altprintcommand" instead of "kprinter") if the [Alt] (or [Option]) key is held while clicking the 'Print' button.

    - However, this behavior can be changed. You can - have the printer dialog always appear by using - "--altprintalways" on the - command-line, or "altprint=always" - in Tux Paint's configuration file. Or, you - can prevent the [Alt]/[Option] - key from having any effect by using - "--altprintnever", or - "altprint=never". -

    + However, this behavior can be changed. You can have the printer dialog always appear by using "--altprintalways" on the command-line, or "altprint=always" in Tux Paint's configuration file. Conversely, you can prevent the [Alt]/[Option] key from having any effect by using "--altprintnever", or "altprint=never".

    - See the "Options" - documentation.) -

    + See the "Options" documentation.


    @@ -1562,7 +1094,7 @@
    Slides (under "Open") + id="slides">"Slides" Command (under "Open")
    @@ -1572,95 +1104,53 @@ alt="" align="right">

    - The "Slides" button is available in the "Open" - dialog. It can be used to play a simple animation - within Tux Paint, or a slideshow of pictures. - It can also export an animated GIF based on the - chosen images. -

    + The 'Slides' button is available in the 'Open' dialog. It can be used to play a simple animation within Tux Paint, or a slideshow of pictures. It can also export an animated GIF based on the chosen images.

    - Chosing pictures + Chosing pictures

    - When you enter the "Slides" section of - Tux Paint, it displays a list of your - saved files, just like the "Open" dialog. -

    + When you enter the 'Slides' section of Tux Paint, it displays a list of your saved files, just like the 'Open' dialog.

    - Click each of the images you wish to display in - a slideshow-style presentation, one by one. A - digit will appear over each image, letting you - know in which order they will be displayed. -

    + Click each of the images you wish to display in a slideshow-style presentation, one by one. A digit will appear over each image, letting you know in which order they will be displayed.

    - You can click a selected image to unselect it - (take it out of your slideshow). Click it again - if you wish to add it to the end of the list. -

    + You can click a selected image to unselect it (take it out of your slideshow). Click it again if you wish to add it to the end of the list.

    - Set playback speed + Set playback speed

    - A sliding scale at the lower left of the screen - (next to the "Play" button) can be used to - adjust the speed of the slideshow or animated - GIF, from slowest to fastest. Choose the - leftmost setting to disable automatic - advancement during playback within - Tux Paint — you will need to press a key - or click to go to the next slide (see below). -

    + A sliding scale at the lower left of the screen (next to the 'Play' button) can be used to adjust the speed of the slideshow or animated GIF, from slowest to fastest. Choose the leftmost setting to disable automatic advancement during playback within Tux Paint — you will need to press a key or click to go to the next slide (see below).

    - Note: The slowest setting does not - automatically advance through the slides. Use - it for when you want to step through them - manually. (This does not apply to an exported - animated GIF.) -

    + Note: The slowest setting does not automatically advance through the slides. Use it for when you want to step through them manually. (This does not apply to an exported animated GIF.)

    - Playback in Tux Paint + Playback in Tux Paint

    - To play a slideshow within Tux Paint, - click the "Play" button. (Note: If you hadn't - selected ANY images, then ALL of your saved - images will be played in the slideshow!) -

    + To play a slideshow within Tux Paint, click the 'Play' button. (Note: If you hadn't selected ANY images, then ALL of your saved images will be played in the slideshow!)

    - During the slideshow, press [Space], - [Enter] or [Return], or the - [Right Arrow] — or click the "Next" - button at the lower left — to manually advance - to the next slide. Press [Left] to go - back to the previous slide. -

    + During the slideshow, press [Space], [Enter] or [Return], or the [Right arrow] — or click the 'Next' button at the lower left — to manually advance to the next slide. Press [Left arrow] to go back to the previous slide.

    - Press [Escape], or click the "Back" - button at the lower right, to exit the - slideshow and return to the slideshow image - selection screen. -

    + Press [Escape], or click the 'Back' button at the lower right, to exit the slideshow and return to the slideshow image selection screen.

    - Exporting an animated GIF + Exporting an animated GIF
    @@ -1670,41 +1160,27 @@ width="48" height="48" alt="" - align="right"> Click the "GIF Export" button - near the lower right to have Tux Paint - generate an animated GIF file based on the - selected images. -

    + align="right"> + Click the 'GIF Export' button near the lower right to have Tux Paint generate an animated GIF file based on the selected images.

    - Note: At least two images must be - selected. (To export a single image, use the - "Export" option from the "Open" dialog.) If no - images are selected, Tux Paint will NOT - attempt to generate a GIF based on all saved - images. -

    + Note: At least two images must be selected. (To export a single image, use the 'Export' option from the main 'Open' dialog.) If no images are selected, Tux Paint will NOT attempt to generate a GIF based on all saved images.

    - Pressing [Escape] during export will abort the - process, and return you to the "Slideshow" - dialog. -

    + Pressing [Escape] during the export process will abort the process, and return you to the 'Slideshow' dialog.


    - Click "Back" in the slideshow image selection - screen to return to the "Open" dialog. -

    + Click 'Back' in the slideshow image selection screen to return to the 'Open' dialog.


    - Quit + "Quit" Command
    @@ -1714,83 +1190,43 @@ alt="" align="right">

    - Clicking the "Quit" button, closing the - Tux Paint window, or pushing the - [Escape] key will quit Tux Paint. -

    + Clicking the 'Quit' button, closing the Tux Paint window, or pushing the [Escape] key will quit Tux Paint.

    - You will first be prompted as to whether you really - want to quit. -

    + You will first be prompted as to whether you really want to quit.

    - If you choose to quit, and you haven't saved the - current picture, you will first be asked if wish to - save it. If it's not a new image, you will then be - asked if you want to save over the old version, or - create a new entry. (See "Save" - above.) -

    + If you choose to quit, and you haven't saved the current picture, you will first be asked if wish to save it. If it's not a new image, you will then be asked if you want to save over the old version, or create a new entry. (See "Save" above.)

    - NOTE: If the image is saved, it will be reloaded - automatically the next time you run Tux Paint! -

    + Note: If the image is saved, it will be reloaded automatically the next time you run Tux Paint -- unless the "startblank" option is set.

    - NOTE: The "Quit" button and [Escape] - key can be disabled (e.g., by selecting - "Disable 'Quit' Button" in - Tux Paint Config. or running - Tux Paint with the - "--noquit" command-line option). -

    + Note: The 'Quit' button within Tux Paint, and quitting via the [Escape] key, may be disabled, via the "noquit" option.

    - In that case, the "window close" button on - Tux Paint's title bar (if not in - fullscreen mode) or the - [Alt] + [F4] key sequence - may be used to quit. -

    + In that case, the "window close" button on Tux Paint's title bar (if not in fullscreen mode) or the [Alt] + [F4] key sequence may be used to quit.

    - If neither of those are possible, the key sequence - of - [Shift] + [Control] + [Escape] - may be used to quit. (See the "Options" documentation.) -

    + If neither of those are possible, the key sequence of [Shift] + [Control] + [Escape] may be used to quit.

    + +

    + See the "Options" documentation.


    - Sound Muting + Sound Muting

    - There is no on-screen control button at this time, - but by pressing - [Alt] + [S], sound effects - can be disabled and re-enabled (muted and unmuted) - while the program is running. -

    + There is no on-screen control button at this time, but by using the [Alt] + [S] keyboard sequence, sound effects can be disabled and re-enabled (muted and unmuted) while the program is running.

    - Note that if sounds are completely disabled (e.g., - by unselecting "Enable Sound Effects" in - Tux Paint Config or running - Tux Paint with the - "--nosound" command-line option), the - [Alt] + [S] key sequence - has no effect. (i.e., it cannot be used to turn on - sounds when the parent/teacher wants them - disabled.) -

    + Note that if sounds are completely disabled via the "nosound" option, the [Alt] + [S] key combination has no effect. (i.e., it cannot be used to turn on sounds when the parent/teacher wants them disabled.)

    @@ -1802,280 +1238,130 @@

    Loading Other Pictures into - Tux Paint + id="loading_into">Loading Other Pictures into Tux Paint

    - Since Tux Paint's 'Open' dialog only displays pictures - you created with Tux Paint, what if you want to load - some other picture or photograph into Tux Paint to - edit? -

    + Tux Paint's 'Open' dialog only displays pictures you created with Tux Paint. So what do you do if you want to load some other drawinng or even a photograph into Tux Paint, so you can edit or draw on it?

    - To do so, you simply need to convert the picture into a PNG - (Portable Network Graphic) image file, and place it in - Tux Paint's "saved" directory: -

    + You can simply convert the picture to the format Tux Paint uses — PNG (Portable Network Graphic) — and place it in Tux Paint's "saved" directory/folder. Here is where to find it (by default):

    - Windows Vista + Windows 10, 8, 7, Vista
    - Inside the user's "AppData" folder, e.g.: - "C:\Users\(user name)\AppData\Roaming\TuxPaint\saved\" -
    + Inside the user's "AppData" folder, e.g.: "C:\Users\username\AppData\Roaming\TuxPaint\saved\".
    - Windows 95, 98, ME, 2000, XP + Windows 2000, XP
    - Inside the user's "Application Data" - folder, e.g.: "C:\Documents and - Settings\(user name)\Application - Data\TuxPaint\saved\" -
    + Inside the user's "Application Data" folder, e.g.: "C:\Documents and Settings\username\Application Data\TuxPaint\saved\".
    - macOS + macOS
    - Inside the user's "Library" folder: - "/Users/(user name)/Library/Application - Support/Tux Paint/saved/" -
    + Inside the user's "Library" folder, e.g.: "/Users/username/Library/Application Support/Tux Paint/saved/".
    - Linux/Unix + Linux/Unix
    - Inside a hidden ".tuxpaint" directory, in - the user's home directory: - "$(HOME)/.tuxpaint/saved/" -
    + Inside a hidden ".tuxpaint" directory, in the user's home directory ("$HOME"), e.g. "/home/username/.tuxpaint/saved/".

    - Note: It is from this folder that you can copy or - open pictures drawn in Tux Paint using other - applications. -

    + Note: It is also from this folder that you can copy or open pictures drawn in Tux Paint using other 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.

    - Using 'tuxpaint-import' -

    + Using the import script, "tuxpaint-import"

    - Linux and Unix users can use the - "tuxpaint-import" shell script which - gets installed when you install Tux Paint. It uses - some NetPBM tools to convert the image - ("anytopnm"), resize it so that it will fit - in Tux Paint's canvas ("pnmscale"), and - convert it to a PNG ("pnmtopng"). -

    + Linux and Unix users can use the "tuxpaint-import" shell script which gets installed when you install Tux Paint. It uses some NetPBM tools to convert the image ("anytopnm"), resize it so that it will fit in Tux Paint's canvas ("pnmscale"), and convert it to a PNG ("pnmtopng").

    - It also uses the "date" command to get the - current time and date, which is the file-naming - convention Tux Paint uses for saved files. - (Remember, you are never asked for a 'filename' when you - go to Save or Open pictures!) -

    + It also uses the "date" command to get the current time and date, which is the file-naming convention Tux Paint uses for saved files. (Remember, you are never asked for a 'filename' when you go to save or open pictures!)

    - To use 'tuxpaint-import', simply run the - command from a command-line prompt and provide it the - name(s) of the file(s) you wish to convert. -

    + To use this script, simply run it from a command-line prompt, and provide it the name(s) of the file(s) you wish to convert.

    - They will be converted and placed in your Tux Paint - 'saved' directory. (Note: If you're doing this for a - different user - e.g., your child, you'll need to make - sure to run the command under their account.) -

    + They will be converted and placed in your Tux Paint "saved" directory. (Note: If you're doing this for a different user (e.g., your child) you'll need to make sure to run the command under their account.)

    - Example: -

    + Example:

    - $ tuxpaint-import grandma.jpg
    + $ tuxpaint-import grandma.jpg
    grandma.jpg -> - /home/username/.tuxpaint/saved/20020921123456.png
    + /home/username/.tuxpaint/saved/20210205001249.png
    jpegtopnm: WRITING A PPM FILE

    - The first line - ("tuxpaint-import grandma.jpg") is the - command to run. The following two lines are output from - the program while it's working. -

    + The first line ("tuxpaint-import grandma.jpg") is the command to run. The following two lines are output from the program while it's working.

    - Now you can load Tux Paint, and a version of that - original picture will be available under the 'Open' - dialog. Just double-click its icon! -

    + Now you can load Tux Paint, and a version of that original picture will be available under the 'Open' dialog. Just double-click its icon!

    - Doing it Manually -

    + Importing Pictures Manually

    - Windows, macOS, BeOS, and Haiku users must currently do - the conversion manually. -

    + Windows, macOS, and Haiku users who wish to import arbitrary images into Tux Paint must do so via a manual process.

    - Load a graphics program that is capable of both loading - your picture and saving a PNG format file. (See the - documentation file "PNG.txt" for - a list of suggested software, and other references.) -

    + Load a graphics program that is capable of both loading your picture and saving a PNG format file. (See the documentation file "PNG.html" for a list of suggested software, and other references.)

    - When Tux Paint loads an image that's not the same size as - its drawing canvas, it scales (and sometimes smears the - edges of) the image so that it fits within the canvas. -

    + When Tux Paint loads an image that's not the same size as its drawing canvas, it scales (and sometimes smears the edges of) the image so that it fits within the canvas.

    - To avoid having the image stretched or smeared, you can - resize it to Tux Paint's canvas size. This size - depends on the size of the Tux Paint window, or - resolution at which Tux Paint is run, if in - fullscreen. (Note: The default resolution is - 800x600.) See "Calculating Image Dimensions", below. -

    + To avoid having the image stretched or smeared, you can resize it to Tux Paint's canvas size. This size depends on the size of the Tux Paint window, or resolution at which Tux Paint is run, if in fullscreen. (Note: The default resolution is 800x600.) See "Calculating Image Dimensions", below.

    - Save the picture in PNG format. It is highly + Save the picture in PNG format. It is highly recommended that you name the filename using the current - date and time, since that's the convention Tux Paint + date and time, since that's the convention Tux Paint uses:

    - YYYYMMDDhhmmss.png + YYYYMMDDhhmmss.png
      -
    • YYYY = Year -
      • - -
    • MM = Month (01-12) -
      • - -
    • DD = Day (01-31) -
      • - -
    • HH = Hour, in 24-hour format (00-23) -
      • - -
    • mm = Minute (00-59) -
      • - -
    • ss = Second (00-59) -
      • +
    • YYYY = Year
      • +
    • MM = Month (two digits, "01"-"12")
      • +
    • DD = Day of month (two digits, "01"-"31")
      • +
    • HH = Hour (two digits, in 24-hour format, "00"-"23")
      • +
    • mm = Minute (two digits, "00"-"59")
      • +
    • ss = Seconds (two digits, "00"-"59")

    - e.g.: -

    - -
    - 20020921130500 - for September 21, 2002, - 1:05:00pm -
    + Example: "20210205001249.png", for 5 February 2021 at 00:12:49.

    - Place this PNG file in your Tux Paint - 'saved' directory. (See above.) -

    + Place this PNG file in your Tux Paint "saved" directory/folder. (See above.)

    - Calculating Image Dimensions -

    + Calculating Image Dimensions

    - The width of Tux Paint's canvas is simply the - width of the window (e.g., 640, 800 or 1024 pixels), - minus 192. -

    - -

    - Calculating the height of Tux Paint's canvas - requires multiple steps: -

    - -
      -
    1. Take the height of the window (e.g, 480, 600 or 768 - pixels) and subtract 144 -
      2. - -
    2. Take the result of Step 1 and divide it by 48 -
      3. - -
    3. Take the result of Step 2 and round it down - (e.g., 9.5 becomes simply 9) -
      4. - -
    4. Take the result of Step 3 and multiply it by - 48 -
      5. - -
    5. Finally, take the result of Step 4 and add 40 -
      6. -
    - -

    - Example: Tux Paint running at fullscreen on - a 1440x900 display. -

    - -
      -
    • The canvas width is simply 1440 - 192, or - 1248. -
      • - -
    • The canvas height is calculated as: -
        -
      1. 900 - 144, or 756 -
        2. - -
      2. 756 / 48, or 15.75 -
        3. - -
      3. 15.75 rounded down, or 15 -
        4. - -
      4. 15 * 48, or 720 -
        5. - -
      5. 720 + 40, or 760 -
        6. -
      -
      • -
    - -

    - So the canvas within a 1440x900 Tux Paint window - is 1248x760. -

    + This part of the documentation needs to be rewritten, since the new "buttonsize" option was added. For now, try drawing and saving an image within Tux Paint, then determine what size (pixel width and height) it came out to, and try to match that when scaling the picture(s) you're importing into Tux Paint.

    @@ -2089,66 +1375,46 @@
    - Other documentation included with Tux Paint (in the - "docs" folder/directory) include: -
      + Other documentation included with Tux Paint (found in the "docs" folder/directory) includes:
      • - "Magic" Tool Documentation - ("magic-docs")
        - Documentation for each of the currently-installed "Magic" - tools. -
        • + 'Magic' Tool Documentation ("magic-docs")
        + Documentation for each of the currently-installed 'Magic' tools.
      • AUTHORS.txt
        - List of authors and contributors. -
        • + List of authors and contributors.
      • CHANGES.txt
        - Summary of changed between releases. -
        • + Summary of what has changed between releases of Tux Paint.
      • COPYING.txt
        - Copying license (The GNU General Public License). -
        • + Tux Paint's software license, the GNU General Public License (GPL)
      • - INSTALL.txt
        - Instructions for compiling/installing, when applicable. -
        • + INSTALL.html
        + Instructions for compiling and installing Tux Paint, when applicable.
      • EXTENDING.html
        - Detailed instructions on creating brushes, stamps and - starters, and adding fonts, to extend Tux Paint. -
        • + Detailed instructions on extending Tux Paint: creating brushes, stamps, starters, and templates; adding fonts; and creating new on-screen keyboard layouts and input methods.
      • OPTIONS.html
        - Detailed instructions on command-line and - configuration-file options, for those who don't want to - use Tux Paint Config. -
        • + Detailed instructions on command-line and configuration-file options, for those who don't want to use the Tux Paint Config. tool to manage Tux Paint's configuration.
      • - PNG.txt
        - Notes on creating PNG format bitmapped images for use in - Tux Paint. -
        • + PNG.html
        + Notes on creating PNG format bitmapped (raster) images for use in Tux Paint.
      • - SVG.txt
        - Notes on creating SVG format vector images for use in - Tux Paint. -
        • + SVG.html
        + Notes on creating SVG format vector images for use in Tux Paint.
      • - SIGNALS.txt
        - Information about POSIX signals Tux Paint responds - to. -
        • + SIGNALS.html
        + Information about the POSIX signals that Tux Paint responds to.
    @@ -2162,23 +1428,41 @@

    - If you need help, feel free to contact New Breed Software: -

    - -
    - http://www.newbreedsoftware.com/ -
    + If you need help, there are numerous ways to interact with Tux Paint developers and other users.

    +
      +
    • Report bugs or request new features via the project's bug-tracking system
      • +
    • Participate in the various project mailing lists
      • +
    • Chat with developers and other users over IRC
      • +
    • Contact the developers directly
      • +

    - You may also wish to participate in the numerous - Tux Paint mailing lists: -

    + To learn more, visit the "Contact" page of the official Tux Paint website: http://tuxpaint.org/contact/

    +
    -
    - http://www.tuxpaint.org/lists/ -
    +
    + +

    + How to Participate +

    + +
    +

    + Tux Paint is a volunteer-driven project, and we're happy to accept your help in a variety of ways.

    + +
      +
    • Translate Tux Paint to another language
      • +
    • Improve existing translations
      • +
    • Create artwork (stamps, starters, templates, brushes)
      • +
    • Add or improve features or magic tools
      • +
    • Create classroom curriculum
      • +
    • Promote or help support others using Tux Paint
      • +
    + +

    + To learn more, visit the "Help Us" page of the official Tux Paint website: http://tuxpaint.org/help/

    diff --git a/docs/en/html/SIGNALS.html b/docs/en/html/SIGNALS.html new file mode 100644 index 000000000..db01dcf13 --- /dev/null +++ b/docs/en/html/SIGNALS.html @@ -0,0 +1,75 @@ + + + + + Tux Paint Signals Documentation + + + +
    +

    + Tux Paint
    + version 0.9.26
    + Signals Documentation

    + +

    + Copyright © 2019-2021 by various contributors; see AUTHORS.
    + http://www.tuxpaint.org/ +

    + +

    + 30 January 2021

    +
    + +
    + +

    + Tux Paint responds to the following signals (which can be sent to the program's process via `kill` or `killall`, for example).

    + +
    +
    + SIGTERM + (also, [Ctrl] + [C] from a terminal running `tuxpaint`)
    + +
    +

    + Tux Paint responds as if the "Quit" button were pressed, or the desktop environment was told to close Tux Paint (e.g., by clicking a window close button, or pressing [Alt] + [F4] on most systems).

    + +

    + From the main interface, Tux Paint will prompt whether or not you wish to quit, and (unless overridden by the auto-save option, e.g. "--autosave") if you'd like to save the current drawing (if unsaved), and if so, and it's a modified version of an existing drawing (unless overridden by the options to save over old images, or always save new images; e.g. "--saveover" and "--saveovernew", respectively), whether or not to overwrite the existing drawing, or save to a new file.

    + +

    + Note: From other parts of the interface, the signal is currently interpreted as a request to go back (e.g., from the "New" dialog back to the main interface), as if a "Back" button in Tux Paint were clicked, or the [Esc] was key pressed.

    + +

    + Example: killall tuxpaint

    +
    + +
    + SIGUSR1 & SIGUSR2 +
    + +
    +

    + Tux Paint responds by setting its auto-save option (as if it had been launched with "--autosave"), as well as either the option to always save new images (as if launched with "--saveovernew") in the case of receiving a SIGUSR1 signal, or to always save over the existing image (as if launched with "--saveover") in the case of receiving SIGUSR2. Then Tux Paint sends itself a SIGTERM signal, in an attempt to quit. (See above.)

    + +

    + So, from the main interface, Tux Paint should quit almost immediately, with no questions asked.

    + +

    + Note: From other parts of the interface, unfortunately, Tux Paint will go back one level in the interface. Therefore, at this time, it may be necessary to send this signal to Tux Paint a few times, for it to quit completely.

    + +

    + Example: killall -s SIGUSR1 tuxpaint

    +
    +
    + + diff --git a/docs/en/html/SVG.html b/docs/en/html/SVG.html new file mode 100644 index 000000000..55da31f3e --- /dev/null +++ b/docs/en/html/SVG.html @@ -0,0 +1,63 @@ + + + + + Tux Paint SVG Documentation + + + +
    +

    + Tux Paint
    + version 0.9.26
    + SVG Documentation

    + +

    + Copyright © 2007-2021 by various contributors; see AUTHORS.
    + http://www.tuxpaint.org/ +

    + +

    + 30 January 2021

    +
    + +
    + +

    About SVGs

    + +

    + SVG (Scalable Vector Graphics) is an open standard used to describe two-dimensional vector graphics. It is great for diagrams and shapes, while PNGs are better for photographs. SVG files are a bit like instructions on how to make an image. This means that they can be resized without looking pixelated or blocky.

    + +

    + For more information, visit: https://www.w3.org/Graphics/SVG/

    + +

    How to make SVGs

    + +

    + An excellent tool with which to create SVG images for use in Tux Paint is Inkscape, a high-quality Open Source interactive drawing program.

    + +

    + It is likely that is already installed on your system. If not, it should be readily available from your Linux distribution's software repository. If not, or to learn more, visit http://www.inkscape.org/, respectively.

    + +

    Mac and Windows users

    + + + +