tuxpaint-pencil-sharpener/src/manpage/tuxpaint.1
2005-11-21 00:40:16 +00:00

626 lines
14 KiB
Groff

.\" tuxpaint.1 - 2005.11.20
.TH TUXPAINT 1 "20 Nov 2005" "0.9.15" "Tux Paint"
.SH NAME
tuxpaint -- A drawing program for young children.
.SH SYNOPSYS
.B tuxpaint
[\-\-help \-\-version \-\-usage \-\-copying]
.TP 9
.B tuxpaint
[\-\-fullscreen]
[\-\-800x600 | \-\-1024x768 | \-\-1280x1024 | \-\-1400x1050 | \-\-1600x1200]
[\-\-nosound]
[\-\-noquit]
[\-\-noprint]
[\-\-printdelay=\fISECONDS\fP]
[\-\-printcfg]
[\-\-simpleshapes]
[\-\-uppercase]
[\-\-grab]
[\-\-noshortcuts]
[\-\-nowheelmouse]
[\-\-nofancycursors]
[\-\-nooutlines]
[\-\-nostamps]
[\-\-nostampcontrols]
[\-\-mirrorstamps]
[\-\-keyboard]
[\-\-nosysfonts]
[\-\-savedir \fIDIR\fP]
[\-\-saveover]
[\-\-saveovernew]
[\-\-nosave]
.TP 9
.B tuxpaint
[\-\-windowed]
[\-\-640x480]
[\-\-sound]
[\-\-quit]
[\-\-print]
[\-\-printdelay=0]
[\-\-noprintcfg]
[\-\-complexshapes]
[\-\-mixedcase]
[\-\-dontgrab]
[\-\-shortcuts]
[\-\-wheelmouse]
[\-\-fancycursors]
[\-\-outlines]
[\-\-stamps]
[\-\-stampcontrols]
[\-\-dontmirrorstamps]
[\-\-mouse]
[\-\-sysfonts]
[\-\-saveoverask]
[\-\-save]
.TP 9
.B tuxpaint
[\-\-locale \fILOCALE\fP]
.TP 9
.B tuxpaint
[\-\-lang \fILANGUAGE\fP | \-\-lang help]
.TP 9
.B tuxpaint
[\-\-nosysconfig] [\-\-nolockfile]
.SH DESCRIPTION
.PP
\fITux Paint\fP is a drawing program for young children. It is meant to be
easy and fun to use. It provides a simple interface and fixed canvas size,
and provides access to previous images using a thumbnail browser
(i.e., no access to the underlying filesystem).
Unlike popular drawing programs like "\fIThe GIMP\fP," it has a very limited
toolset. However, it provides a much simpler interface, and has entertaining,
child-oriented additions such as sound effects.
.SH OPTIONS - INFORMATIONAL
.TP 8
.B \-\-help
Display short, helpful information about Tux Paint.
.TP 8
.B \-\-version
Output the version info.
.TP 8
.B \-\-usage
Display a list of all commandline options.
.TP 8
.B \-\-copying
Show the license (GNU GPL) under which Tux Paint is released.
.SH OPTIONS - INTERFACE
.l
\fItuxpaint\fP accepts the following options to alter the interface.
They can be used along with, instead of, or to override options set in
configuration files. (See below.)
.TP 8
.B \-\-fullscreen \-\-windowed
Run \fITux Paint\fP in full-screen mode, or in a window (default).
.TP 8
.B \-\-800x600 \-\-1024x768 \-\- 1280x1024 \-\-1400x1050 \-\-1600x1200 \-\-640x480
Run \fITux Paint\fP at higher resolution, or 640x480 resolution (default).
.TP 8
.B \-\-nosound \-\-sound
Disable or enable (default) sound.
.TP 8
.B \-\-noquit \-\-quit
Disable or enable (default) the on-screen \fIQuit\fP button and \fIEscape\fP
key sequence for quitting \fITux Paint\fP. Instead, use the window close
button in the titlebar, the \fIAlt+F4\fP key sequence, or the
\fIShift+Control+Escape\fP key sequence.
.TP 8
.B \-\-noprint \-\-print
Disable or enable (default) the \fIPrint\fP command within \fITux Paint\fP.
.TP 8
.B \-\-printdelay=\fISECONDS\fP \-\-printdelay=0
Only allow printing (via the \fIPrint\fP command) once every \fISECONDS\fP
seconds. Default is 0 (no limitation).
.TP 8
.B \-\-printcfg \-\-noprintcfg
(Windows only.) Enable or disable loading and saving of printer settings.
By default, \fITux Paint\fP will print to the default printer with default
settings. Pressing \fI[ALT]\fP while pushing the \fIPrint\fP button
will cause a Windows printer dialog to appear (as long as you're not in
fullscreen mode.) If \-\-printcfg is used, your previous settings will
be loaded when \fITux Paint\fP starts up, and setting changes will be saved
for next time.
.TP 8
.B \-\-simpleshapes \-\-complexshapes
Disable or enable (default) the \fIrotation\fP step when using the
\fIShape\fP tool within \fITux Paint\fP. When disabled, shapes cannot be
rotated; however, the interface is easier (click, drag, release), which can
be useful for younger or disabled children.
.TP 8
.B \-\-uppercase \-\-mixedcase
In \fIuppercase\fP mode, all text prompts and the \fIText\fP drawing tool
will display only uppercase letters. This is useful for children who are not
yet comfortable with the lowercase characterset. Default mode is
\fImixed case\fP.
.TP 8
.B \-\-grab \-\-nograb
Grab the mouse and keyboard input (if possible), so that the mouse is
confined to the \fITux Paint\fP window. Default is to not grab.
.TP 8
.B \-\-noshortcuts \-\-shortcuts
If \fInoshortcuts\fP mode, keyboard shortcuts (e.g., Ctrl+S for Save)
will be disabled. Default mode is \fIshortcuts enabled\fP.
.TP 8
.B \-\-nowheelmouse \-\-wheelmouse
By default, the wheel (jog dial) on a mouse will be used to scroll the
\fIselector\fP on the right of the screen. This can be disabled, and the
wheel completely ignored, with the \fI\-\-nowheelmouse\fP option.
This is useful for children who aren't yet comfortable with the mouse.
Default is to support the wheel.
.TP 8
.B \-\-nofancycursors \-\-fancycursors
Disable or enable (default) the 'fancy' mouse pointer shapes in \fITux Paint\fP.
While the shapes are larger, and context sensitive, some environments have
trouble displaying the mouse pointer, and/or leave 'trails' on the screen.
.TP 8
.B \-\-nooutlines \-\-outlines
In \fInooutlines\fP mode, much simpler outlines and 'rubber-band' lines are
displayed when using the \fILines\fP, \fIShapes\fP, \fIStamps\fP and
\fIEraser\fP tools. (This can help when \fITux Paint\fP is run on slower
computers, or displayed on a remote X display.)
.TP 8
.B \-\-nostamps \-\-stamps
With \fInostamps\fP set, Rubber Stamp images are not loaded, so the
\fIStamps\fP tool will not be available. This option can be used to reduce
the time Tux Paint takes to load, and reduce the amount of RAM it requires.
.TP 8
.B \-\-nostampcontrols \-\-stampcontrols
Disable or enable (default) buttons to control stamps. Controls include
mirror, flip, shrink and grow. (Note: Not all stamps will be controllable
in all ways.)
.TP 8
.B \-\-mirrorstamps \-\-dontmirrorstamps
With \fImirrorstamps\fP set, stamps which can be mirrored will appear
mirrored by default. This can be useful when used by people who prefer
things right-to-left over left-to-right.
.TP 8
.B \-\-keyboard \-\-mouse
The \fIkeyboard\fP option lets the mouse pointer in \fITux Paint\fP be
controlled with the keyboard. The \fIarrow keys\fP move the pointer.
\fISpacebar\fP acts as the mouse button.
.TP 8
.B \-\-nosysfonts \-\-sysfonts
\fITux Paint\fP normally attempts to search for additional TrueType Fonts
installed in common places on your system. If this causes trouble, or you'd
prefer to only make fonts installed in \fITux Paint\fP's directory available,
use the \fInosysfonts\fP option to disable this feature.
.TP 8
.B \-\-savedir \fIDIR\fP
Specify where \fITux Paint\fP should save files. By default, this is
"~/.tuxpaint/saved" under Linux and Unix, and "userdata\\" under Windows.
.TP 8
.B \-\-saveover \-\-saveovernew \-\-saveoverask
If, when saving a picture, an older version of the file will be overwritten,
\fITux Paint\fP will, by default, ask for confirmation: either
\fIsave over\fP the old file, or \fIcreate\fP a new file. This prompt
can be disabled with \fI\-\-saveover\fP (which always saves over older versions
of pictures) or \fI\-\-saveovernew\fP (which always saves a new file).
The default is to prompt (\fI\-\-saveoverask\fP).
.TP 8
.B \-\-nosave \-\-save
The \fInosave\fP option disables \fITux Paint's\fP ability to save files.
This can be used in situations where the program is only being used for
fun, or in a test environment.
.SH OPTIONS - LANGUAGE
.l
Various parts of \fITux Paint\fP have been translated into numerous languages.
\fITux Paint\fP will try its best to honor your \fIlocale\fP setting
(i.e., the \fILANG\fP environment variable), if possible.
You can also specifically set the language using options on the command-line
or in a configuration file.
.TP 8
.B \-\-locale \fILOCALE\fP
Specify the language to use, based on locale name (which is typically of the
form \fIlanguage\fP[_\fIterritory\fP][.\fIcodeset\fP][@\fImodifier\fP],
where \fIlanguage\fP is an ISO 639 language code,
\fIterritory\fP is an ISO 3166 country code, and
\fIcodeset\fP is a character set or encoding identifier like ISO-8859-1 or
UTF-8.)
.PP
.RS
For example, \fIde_DE@euro\fP for German, or \fIpt_BR\fP
for Brazilian Portuguese.
.RE
.TP 8
.B \-\-lang \fILANGUAGE\fP
Specify the language to use, based on the language's name
(as recognized by \fITux Paint\fP). Choose one of the language names
listed below:
.PP
.RS
.PD 0
.TP 2
-
english | american-english
.TP 2
-
afrikaans
.TP 2
-
albanian
.TP 2
-
basque | euskara
.TP 2
-
belarusian | bielaruskaja
.TP 2
-
bokmal
.TP 2
-
brazilian-portuguese | portuges-brazilian | brazilian
.TP 2
-
breton | brezhoneg
.TP 2
-
british | british-english
.TP 2
-
bulgarian
.TP 2
-
catalan | catala
.TP 2
-
chinese | simplified-chinese
.TP 2
-
croatian | hrvatski
.TP 2
-
czech | cesky
.TP 2
-
danish | dansk
.TP 2
-
dutch
.TP 2
-
estonian
.TP 2
-
finnish | suomi
.TP 2
-
french | francais
.TP 2
-
gaelic | gaidhlig
.TP 2
-
galician | galego
.TP 2
-
german | deutsch
.TP 2
-
greek
.TP 2
-
gronings | zudelk-veenkelonioals
.TP 2
-
hebrew
.TP 2
-
hindi
.TP 2
-
hungarian | magyar
.TP 2
-
icelandic | islenska
.TP 2
-
indonesian | bahasa-indonesia
.TP 2
-
italian | italiano
.TP 2
-
japanese
.TP 2
-
kinyarwanda
.TP 2
-
klingon | tlhIngan
.TP 2
-
korean
.TP 2
-
lithuanian | lietuviu
.TP 2
-
malay
.TP 2
-
mexican-spanish | espanol-mejicano | mexican
.TP 2
-
norwegian | nynorsk
.TP 2
-
polish | polski
.TP 2
-
portuguese | portugues
.TP 2
-
romanian
.TP 2
-
russian | russkiy
.TP 2
-
serbian
.TP 2
-
slovak
.TP 2
-
slovenian | slovensko
.TP 2
-
spanish | espanol
.TP 2
-
swahili
.TP 2
-
swedish | svenska
.TP 2
-
tamil
.TP 2
-
thai
.TP 2
-
traditional-chinese
.TP 2
-
turkish
.TP 2
-
ukranian
.TP 2
-
vietnamese
.TP 2
-
walloon
.TP 2
-
welsh | cymraeg
.RE
.PD
.TP 8
.B \-\- lang help
Display a lists of all supported languages.
.SH OPTIONS - MISCELLANEOUS
.TP 8
.B \-\-nosysconfig
With this option, \fITux Paint\fP will not attempt to read the
system-wide configuration file (typically \fI/etc/tuxpaint/tuxpaint.conf\fP).
.TP 8
.B \-\-nolockfile
By default, \fITux Paint\fP uses a lockfile (stored in the user's
local Tux Paint directory) which prevents it from being launched more than
once in 30 seconds. (Sometimes children get too eager, or user interfaces
only require one click, but users think they need to double-click.)
This option makes \fITux Paint\fP ignore the current lockfile.
.SH ENVIRONMENT
.l
While \fITux Paint\fP may refer to a number of environment variables indirectly
(e.g., via \fISDL(3)\fP), it only directly accesses the following:
.PP
.TP 8
.B HOME
to determine where picture files go when using the \fISave\fP and \fIOpen\fP
commands within \fITux Paint\fP, to keep track of the current image,
when quitting and restarting \fITux Paint\fP, and to get the user's
configuration file.
.TP 8
.B LANG
to determine langauge to use, if \fIsetlocale(3)\fP refers to 'LC_MESSAGES'.
.SH FILES
.TP 8
.B /etc/tuxpaint/tuxpaint.conf
System-wide configuration file. It is read first
(unless the \fI\-\-nosysconfig\fP option was given on the command-line).
.RS
.PP
(Created during installation.)
.RE
.TP 8
.B $HOME/.tuxpaintrc
User's configuration file. It can be used to set default options
(rather than setting them on the command-line every time), and/or to
override any settings in the system-wide configuration file.
.RS
.PP
(Not created or edited automatically; must be created manually.
You can do this by hand, or use '\fITux Paint Config.\fP.')
.RE
.TP 8
.B $HOME/.tuxpaint/saved/
A directory of previously-saved images (and thumbnails). Only files in this
directory will be made available using the \fIOpen\fP command within
\fITux Paint\fP. (See \fItuxpaint-import(1)\fP.)
.RS
.PP
(Created when \fISave\fP command is used.)
.RE
.TP 8
.B $HOME/.tuxpaint/current_id.txt
A reference to the image which was being edited when \fITux Paint\fP was
last quit. (This image is automatically loaded the next time \fITux Paint\fP
is re-run.)
.RS
.PP
(Created when \fITux Paint\fP is \fIQuit\fP.)
.RE
.TP 8
.B $HOME/.tuxpaint/lockfile.dat
A lockfile that prevents \fITux Paint\fP from being launched more than once
every 30 seconds. Disable checking the lockfile by using the
'\-\-nolockfile' command-line argument.
.RS
.PP
(There's no reason to delete the lockfile, as it contains a timestamp
inside which causes it to expire after 30 seconds.)
.RE
.SH COPYRIGHT
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
.SH OTHER INFO
The canonical place to find \fITux Paint\fP information is at
http://www.newbreedsoftware.com/tuxpaint/.
.SH AUTHORS
Bill Kendrick. <bill@newbreedsoftware.com>
With patches, fixes, extensions, translation, documentation and more from
lots of people, including, but not limited to:
Daniel Andersson,
Ben Armstrong,
Martin Benjamin,
Denis Bodor,
Herman Bruyninckx,
Lucie Burianova,
Laurentiu Buzdugan,
Albert Cahalan,
Pere Pujal Carabantes,
Ouychai Chaita,
Jacques Chion,
Urska Colner,
Helder Correia,
Ricardo Cruz,
Laurent Dhima,
Yavor Doganov,
Kevin Donnelly,
Alberto Escudero-Pascual,
Doruk Fisek,
Dovix,
Korvigellou An Drouizig (Philippe),
Fabian Franz,
Gabriel Gazzan,
The Greek Linux i18n Team,
Robert Glowczynski,
Sam "Criswell" Hart,
Tedi Heriyanto,
Pjetur G. Hjaltason,
Knut Erik Hollund,
Song Huang,
Karl Ove Hufthammer,
Roland Illig,
Juan Irigoien,
Dmitriy Ivanov,
Mogens Jaeger,
Nedjeljko Jedvaj,
Aleksandar Jelenak,
Rasmus Erik Voel Jensen,
Wang Jian,
Petri Jooste,
Andrej Kacian,
Kazuhiko,
Mark Kim,
Thomas Klausner,
Koby,
Marcin 'Shard' Konicki,
Ines Kovacevic,
Mantas Kriauciunas,
Arkadiusz Lipiec,
Dag H. Loras,
Burkhard Luck,
Ankit Malik,
Martin,
Marco Milanesi,
Mugunth,
Steve Murphy,
Gareth Owen,
Flavio Pastor,
Patrick,
Primoz Peterlin,
Le Quang Phan,
Henrik Pihl,
Milan Plzik,
John Popplewell,
Leandro Regueiro,
Ilir Rugova,
Kevin Patrick Scannell,
Gia Shervashidze,
Clytie Siddall,
Geert Stams,
Peter Sterba,
Tomasz 'karave' Tarach,
Tarmo Toikkanen,
TOYAMA Shin-ichi,
Matej Urban,
Rita Verbauskaite,
Daniel Jose Viana,
Charles Vidal,
Damian Yerrick,
Muhammad Najmi Ahmad Zabidi,
Eugene Zelenko,
and
Martin Zhekov.
.SH "SEE ALSO"
.BR tuxpaint-import (1),
.BR tuxpaint-config (1),
.BR xpaint (1),
.BR gpaint (1),
.BR gimp (1)
.PP
And documentation within /usr/[local/]share/doc/tuxpaint/.