source: tuxpaint-config/trunk/fuentes/docs/README.txt @ 220

Last change on this file since 220 was 220, checked in by mabarracus, 3 years ago

added tuxpaint-config sources from trusty

File size: 18.4 KB
Line 
1                               Tux Paint Config.
2                                 version 0.0.12
3
4  Configuration tool for Tux Paint
5
6                Copyright 2002-2008 by Bill Kendrick and others
7                               New Breed Software
8
9                           bill@newbreedsoftware.com
10                            http://www.tuxpaint.org/
11
12                       September 22, 2004 - July 14, 2008
13
14     ----------------------------------------------------------------------
15
16                                     About
17
18     "Tux Paint Config." is a graphical configuration tool for "Tux Paint."
19     It provides a point-and-click interface that allows parents and teachers
20     to alter Tux Paint's behavior -- disable sound effects, run in
21     full-screen mode, etc. - without needing to manipulate a text-based
22     configuration file.
23
24     ----------------------------------------------------------------------
25
26                                    License
27
28     Tux Paint Config. is an Open Source project, Free Software released
29     under the GNU General Public License (GPL). It is free, and the
30     'source code' behind the program is available. (This allows others to
31     add features, fix bugs, and use parts of the program in their own GPL'd
32     software.)
33
34     See COPYING.txt for the full text of the GPL license.
35
36     ----------------------------------------------------------------------
37
38                              Other Documentation
39
40     Other documentation included with Tux Paint Config. (in the "docs"
41     folder/directory) include:
42       * AUTHORS
43         List of authors and contributors
44       * CHANGES
45         Summary of changed between releases
46       * INSTALL
47         Instructions on how to compile and install
48       * COPYING
49         Copying license (The GPL)
50       * README
51         (This file)
52       * TODO
53         A list of pending features or bugs needing fixed
54
55     ----------------------------------------------------------------------
56
57                            Using Tux Paint Config.
58
59     Tux Paint Config.'s interface is divided into seven (7) tabs, each
60     containing a different category of options that you can change in
61     Tux Paint. (For full details on Tux Paint's options, we recommend
62     reading Tux Paint's own documentation.)
63
64     At the bottom of the screen are three buttons:
65
66       * Defaults - This sets the options shown on the current tab to their
67         default settings. (In other words, how Tux Paint would operate if
68         you didn't make any changes to the options.)
69       * Apply - This saves settings of all the options, on all the tabs, to
70         your Tux Paint configuration file. (On Linux and Unix, this is
71         "~/.tuxpaintrc". On Windows, this is "tuxpaint.cfg". On Mac OS X, it
72         is " ~/Library/Application Support/TuxPaint/tuxpaint.cfg".)
73       * Reset - This discards all unsaved changes on all the tabs. It loads
74         whatever settings are currently stored in your Tux Paint
75         configuration file.
76
77     Also at the bottom are two additional options:
78
79       * Settings for: - This lets you change which configuration file
80         Tux Paitn Config. tries to save to when you click "Apply": either
81         the Current User's, or All Users' (the system-wide config. file).
82       * Use "All Users" Settings - Checking this option causes all
83         configuration options in Tux Paint Config. to be greyed out. When
84         you click "Apply", the current user's config. file will be deleted,
85         causing them to use only the system-wide ("All users") config. file!
86
87     The various tabs, and the options found within, are described below:
88
89About
90
91       This tab simply contains some information about Tux Paint Config.
92
93Video & Sound
94
95         * Fullscreen - This causes Tux Paint to (attempt to) run in
96           fullscreen mode, rather than in a window on your desktop. It
97           causes Tux Paint to display across your entire screen (or as much
98           as it can, with a border around the outside), in essense turning
99           your monitor into a Tux Paint-only display.
100              * Native - This causes Tux Paint to run using your current
101                desktop resolution when you run in fullscreen mode. Example:
102                If you have Tux Paint set to run in a 800x600 window on your
103                1280x800 laptop, but you have this option enabled, it will
104                run at 1280x800 when you launch Tux Paint in fullscreen mode
105                (rather than dropping your laptop's LCD display down to
106                800x600, which might not look right).
107         * Window Size - By default, Tux Paint creates a relatively small
108           window (800 pixels across by 600 pixels high). Since many people
109           prefer a larger drawing canvas, or have screens at different
110           aspect ratios or larger sizes, Tux Paint can be told to create a
111           larger window, instead. If running in fullscreen, this also
112           determines the monitor resolution Tux Paint will try to switch
113           into, unless the "Native" option is set.
114         * Rotate Orientation - This option swaps the width and height values
115           given in the "Window Size" setting, which can be useful for
116           displays with portrait aspect ratios (e.g., a tablet PC in the
117           tablet orientation, vs. the laptop orientation).
118         * Allow Screensaver - By default, the underlying system that
119           Tux Paint uses for graphics disables your screensaver. You can set
120           this option to allow your screensaver to appear, even while
121           Tux Paint is running.
122         * Enable Sound Effects - By default, Tux Paint plays sounds for
123           practically every action that takes place... drawing with the
124           brush, displaying a pop-up dialog, painting a rainbow. By
125           un-checking this option, you can turn sounds off.
126         * Use Alternative Color Palette - This allows you to specify a file
127           containing colors that Tux Paint should provide to the user. (See
128           Tux Paint's documentation for details on the format.)
129
130Mouse & Keyboard
131
132         * Fancy Cursor Shapes - Normally, Tux Paint changes the shape of
133           your mouse pointer when the mouse is inside the Tux Paint window.
134           It turns into a large brush when painting, and a cross-hair when
135           drawing lines, for example. However, the large brushes can cause
136           problems on some systems, so you can disable this option if the
137           brushes don't work right for you.
138         * Hide Cursor - Completely hides the mouse pointer in Tux Paint.
139           Useful when using a touchscreen (such as a tablet PC or handheld
140           device), rather than a mouse or drawing tablet.
141         * Enable Keyboard Shortcuts - Tux Paint supports some keyboard
142           shortcuts ('accelerators'), like Control + S to Save and
143           Control + Z to Undo. If your child hits the keyboard accidentally,
144           you can disable these shortcuts to prevent them from being used
145           accidentally.
146         * Grab Mouse Pointer - If you'd rather not run Tux Paint in
147           fullscreen mode, but you want to keep children from getting at
148           your desktop files or other applications, you can have Tux Paint
149           'grab' the mouse pointer, which prevents it from leaving the
150           Tux Paint window.
151         * Mouse Wheel Support - If your mouse has a scroll wheel, Tux Paint
152           will let you use it to scroll up and down through the selection
153           menu on the right (e.g., the brush or stamp collections). However,
154           if your child still lacks dexterity with the mouse, they may hit
155           the scroll wheel accidentally, and get frustrated. You can tell
156           Tux Paint to ignore the mouse wheel, if that is the case.
157         * No Button Distinction - Tux Paint notices if the user is
158           accidentally clicking with the middle or right button on a mouse,
159           and after a number of clicks, pops up a window explaining which
160           button should be used. If this option is enabled, the pop-up does
161           not appear, and the middle and right mouse button can be used
162           (they act the same as the left button).
163
164Simplification
165
166       If your child is very young, or is handicapped, the 'Simplification'
167       options can help make Tux Paint even easier to use.
168
169         * Disable Shape Rotation - Tux Paint's 'Shape' tool works in three
170           steps: (1) click where you want the center of your shape to be,
171           (2) drag out from the center to determine the size of the shape,
172           and (3) move the mouse to rotate the shape, and click once more to
173           finalize it. The third step (rotation) can be tricky to get the
174           hang of, and very young children are more interested in the shapes
175           themselves, not the angles they can be drawn at. Hence, you can
176           disable shape rotation by selecting this option.
177         * Simple Stamp Outlines - If your computer is very slow, or you're
178           using Tux Paint on a thin client (displaying over a network), you
179           can simplify the outlines drawn around stamps to help speed up the
180           display.
181         * Show Uppercase Text Only - If your child is just learning to read,
182           and hasn't yet mastered the lowercase alphabet, you can tell
183           Tux Paint to display everything in uppercase. (LIKE THIS.)
184         * Disable Quit Button - This greys out the 'Quit' button in
185           Tux Paint. The Escape key and the close button in the window's
186           toolbar still work (though the latter can be made inaccessible by
187           running Tux Paint in fullscreen mode, or in mouse-grab mode.)
188         * Disable Stamps Tool - This prevents Tux Paint from loading any
189           stamps at start-up, this speeding up the load process and, of
190           course, causing the 'Stamps' tool button to be greyed out.
191         * Disable Stamp Controls - Tux Paint allows stamps to be shrunk and
192           grown, and many stamps can be flipped and/or mirrored. These
193           options add four buttons to the Stamp tool's selector, however,
194           which can confuse the younger users. Disable those controls with
195           this option.
196         * Disable Magic Controls - Some of Tux Paint's Magic tools work as a
197           painting tool, some apply their effect to the entire canvas, and
198           some can do both. This option removes the button that selects
199           which mode Magic tools run in. (If this option is set, tools will
200           default to painting mode, unless they do not support it.)
201         * Initial Stamp Size - This lets you set a default size for all
202           Stamps in Tux Paint. Normally, it picks a size based on the
203           stamp's size, your canvas size, and/or settings provided
204           specifically for the stamp.
205
206Languages
207
208         * Language - Tux Paint has been translated into dozens of languages.
209           While it can use your system's global language preference, you may
210           prefer to run your desktop in one language, and have your children
211           use Tux Paint in another. Select the language you want Tux Paint
212           to run in from the pull-down menu. (Select "Use system's setting"
213           to use your system's global language preference.)
214         * Mirror Stamps - Some people are used to things going
215           right-to-left, rather than left-to-right. (Hebrew is written
216           right-to-left, for example.) Most stamps are oriented
217           left-to-right, and many can be mirrored using the 'Mirror' stamp
218           control. You can tell Tux Paint to mirror all such stamps, by
219           default, when it starts up.
220         * Load System Fonts - This causes Tux Paint to look around typical
221           locations on your hard drive for fonts, and adds ones that seem
222           useful to the fonts available in the "Text" tool.
223
224Printing
225
226         * Allow Printing - If you wish to disable the 'Print' button in
227           Tux Paint, un-check this option.
228         * Print Delay - If you wish to allow printing in Tux Paint, but
229           limit it to, say, only once every 5 minutes, you can enter a delay
230           value (in seconds). After printing, Tux Paint will wait that long
231           before the 'Print' button works again.
232         * Show Printer Dialog - Tux Paint can bring up a system printer
233           dialog if the [Alt] key ([Option] on Macs) is held while the
234           "Print" button is clicked. These options allow you to disable this
235           feature (never show a dialog), or to always show a dialog, even
236           when [Alt] isn't being held.
237         * Use Alternative Print Command / Alternative Print Command -
238           (Advanced! Unix/Linux only!) By default, Tux Paint under Linux and
239           Unix uses the external program 'lpr' for printing pictures. You
240           can specify a different command here. The command you specify must
241           accept PostScript format on it's standard input (STDIN).
242         * Use Alternative Print Dialog - (Advanced! Unix/Linux only!) By
243           default, Tux Paint under Linux and Unix uses the extnernal program
244           'kprinter' (KDE, the K Desktop Environment's printer tool). You
245           can specify a different command here. The command you specify must
246           accept PostScript format on it's standard input (STDIN).
247         * Paper Size - This lets you choose the size of paper that you're
248           using with Tux Paint. You can use your system's default, or
249           override it with a specific paper size (e.g., "A4" or
250           "US Letter").
251
252Saving
253
254  Save Over Earlier Work
255
256         Tux Paint has one 'Save' command, which works with one click. If
257         you're done drawing a picture, click 'Save' and it is saved, no
258         questions asked!
259
260         However, if you're re-saving a picture that you loaded using the
261         'Open' command, Tux Paint needs to know whether you want to save
262         over the original, or save a new image. (In most other programs,
263         this would be 'Save' versus 'Save As...', respectively.)
264
265         By default, Tux Paint will pop up a prompt asking whether to 'save
266         over the older version of [the] picture.' Choosing 'Yes' will wipe
267         out the old version, replacing it with the updated drawing. Choosing
268         'No' will preserve the old version, and save a completely new file.
269
270         To simplify the 'Save' process by never asking the 'save over?'
271         question, you can tell Tux Paint what to do ahead of time:
272
273           * Ask Before Overwriting - This is the default behavior, described
274             above. (Ask whether to save over, or not.)
275           * Always Overwrite Older Version - This will always wipe out the
276             old version, replacing it with any updates to the drawing. (It's
277             like 'Save' in other desktop applications.)
278           * Always Save New Picture - This will never wipe out older work,
279             this preserving every single change that's ever been saved.
280             (It's like always using 'Save As...' in other desktop
281             applications.) Warning: Using this option obviously creates the
282             potential for many files being stored in Tux Paint! You may want
283             to go in and manually remove files for your child. (Tux Paint's
284             'Open' dialog uses thumbnails to show the saved pictures, and
285             includes an 'Erase' button, so you can do this from within
286             Tux Paint.)
287
288  Start Blank
289
290         This option tells Tux Paint to always start with a blank (white)
291         drawing canvas, rather than re-loading the last-saved picture (its
292         default behavior).
293
294  Save Directory
295
296         Since Tux Paint never asks where to save pictures (or what filename
297         to use when creating the files), it keeps all of its pictures in its
298         own special directory.
299
300         If you wish to change where Tux Paint saves pictures (and, of
301         course, where it looks for them when the 'Open' command is used),
302         you can do so here.
303
304         This can be useful in a school lab where all of the computers are
305         shared by students, and students must log into a special network
306         drive to save their files. You can tell Tux Paint to save on the
307         mapped network drive, rather than on the local hard drive.
308
309         See Tux Paint's own documentation for more on the subject.
310
311  Disable 'Save' Button
312
313         If you wish for Tux Paint to be used only as a 'scratch pad' for
314         drawing, you may disable the 'Save' button. Obviously, this makes it
315         impossible to save any drawings, so most people will have no use for
316         this option.
317
318  Auto-save on Quit
319
320         This tells Tux Paint not to ask whether you wish to save the current
321         picture (if unsaved) when you quit. It will assume you always do.
322         (If it needs to ask about saving over an old copy, it will still do
323         so.)
324
325Data
326
327         * Don't use lockfile - Normally, when Tux Paint is launched it
328           creates a small data file called a 'lockfile.' If this file
329           exists, and Tux Paint is launched again, the second copy will quit
330           immediately. This was done to prevent multiple copies of Tux Paint
331           from loading when children over-eagerly and/or impatiently click
332           the launcher icon. However, if you're using Tux Paint on a
333           networked filesystem, and all users share the same folder, this
334           may prevent more than one computer from running Tux Paint. Enable
335           this setting to ask Tux Paint to not use lockfiles, and ignore any
336           that may be there.
337         * Use Alternative Data Directory - Similar to "Use Alternative Save
338           Directory," above, this option lets you specify a different
339           location for Tux Paint to look for its data files: brushes,
340           stamps, etc. (This can be good if you have school-specific data
341           for Tux Paint stored on a network drive that you'd like all your
342           students to use, rather than Tux Paint's default data files,
343           located on the local hard disk.)
344
345     ----------------------------------------------------------------------
346
347                                More Information
348
349     For more information, see the other documentation files that come with
350     Tux Paint.
351
352     If you need help, feel free to contact New Breed Software:
353
354       http://www.newbreedsoftware.com/
355
356     You may also wish to participate in the numerous Tux Paint mailing
357     lists:
358
359       http://www.tuxpaint.org/lists/
Note: See TracBrowser for help on using the repository browser.