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