PySolFC/docs/pysol.6

.\" Automatically generated by Pod::Man v1.34, Pod::Parser v1.13
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  | will give a
.\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
.\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
.\" expand to `' in nroff, nothing in troff, for use with C<>.
.tr \(*W-|\(bv\*(Tr
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.\"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "PYSOL 6"
.TH PYSOL 6 "20 Aug 2003" "Version 4.82" " "
.SH "NAME"
PySol \- a collection of more than 200 solitaire games
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\fBpysol\fR [\fIfilename\fR]
.PP
The only option available is the file name of a saved game.
All other options are ignored \- PySol is fully
configurable within the game.
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fBPySol\fR is an exciting solitaire card game collection. Its features include
support for more than 200 distinct games, very nice look and feel, unlimited
undo & redo, load & save games, player statistics, hint system,
demo games, support for user written plug-ins, samples and background
music, integrated help browser and lots of documentation.
.PP
\&\fBPySol\fR comes with an integrated help browser. Just press <F1> after
the program has started.
.PP
\&\fBPySol\fR is written in 100% pure Python and runs out-of-the-box
on Unix (X11), Windows 95/98/ME/2000/NT/XP and Macintosh platforms.
.SH "FILES"
.IX Header "FILES"
\&\fBPySol\fR searches its data files in a number of directories including:
.PP
.Vb 7
\&    the current directory
\&    /usr/share/pysol
\&    /usr/lib/pysol
\&    /usr/share/games/pysol
\&    /usr/lib/games/pysol
\&    /usr/games/share/pysol
\&    /usr/games/lib/pysol
.Ve
.PP
Options are saved in \fB~/.pysol/options.dat\fR
.PP
Statistics and logs are saved in \fB~/.pysol/statistics.dat\fR
.PP
Additional plugins are searched in \fB~/.pysol/plugins/\fR
.PP
Additional cardsets are searched in \fB~/.pysol/cardset\-*/\fR
.PP
Additional table tiles are searched in \fB~/.pysol/tiles/\fR
.PP
Additional music songs are searched in \fB~/.pysol/music/\fR
.SH "ENVIRONMENT"
.IX Header "ENVIRONMENT"
\&\fB\s-1HOME\s0\fR is used for finding the users home directory.
.PP
\&\fB\s-1USER\s0\fR and \fB\s-1LOGNAME\s0\fR are used for getting the initial name of the player.
.PP
Additional cardsets are searched according to the path variable
\&\fB\s-1PYSOL_CARDSETS\s0\fR. You can specify multiple directories.
.PP
Additional table tiles are searched according to the path variable
\&\fB\s-1PYSOL_TILES\s0\fR. You can specify multiple directories.
.PP
Additional music songs are searched according to the path variable
\&\fB\s-1PYSOL_MUSIC\s0\fR. You can specify multiple directories.
.SH "DIAGNOSTICS"
.IX Header "DIAGNOSTICS"
Exit status is normally 0.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBpython\fR(1)
.PP
\&\fBace_solitaire\fR, \fBfreecell\fR, \fBgnome-freecell\fR,
\&\fBkabale\fR, \fBklondike\fR, \fBkpat\fR, \fBseahaven\fR, \fBsol\fR,
\&\fBspider\fR, \fBtksol\fR, \fBxfreecell\fR, \fBxpat2\fR, \fBxsol\fR
.SH "BUGS"
.IX Header "BUGS"
Please report all bugs immediately to the author.
.SH "AUTHOR"
.IX Header "AUTHOR"
Markus F.X.J. Oberhumer <markus@oberhumer.com>
.PP
http://www.oberhumer.com/pysol
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
PySol is Copyright (C) 1998, 1999, 2000, 2001, 2002 by Markus F.X.J. Oberhumer
.PP
All Rights Reserved.
.PP
PySol is distributed under the terms of the
\&\s-1GNU\s0 General Public License (\s-1GPL\s0)