~ubuntu-branches/ubuntu/trusty/xshisen/trusty-proposed

« back to all changes in this revision

Viewing changes to man/xshisen.6

  • Committer: Bazaar Package Importer
  • Author(s): Steve Kemp
  • Date: 2003-10-28 13:49:29 UTC
  • Revision ID: james.westby@ubuntu.com-20031028134929-mbcy7vcl9z5gg9t3
Tags: 1.51-1-1
* Non-maintainer upload with consent from Grzegorz.
* Fix a locally exploitable buffer overflow allowing GID(games).
  (Closes: #213957)

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.TH xshisen 6 "Oct 6, 1995" "X Version 11"
 
2
.SH NAME
 
3
xshisen \- Shisen-sho puzzle game for X11
 
4
.SH SYNOPSIS
 
5
.B xshisen [ options ]
 
6
.SH DESCRIPTION
 
7
.IR xshisen
 
8
is a puzzle game for X11.  Similar to the famous "Shang-hai", your 
 
9
objective is to remove all the pieces on the board.
 
10
.IR xshisen
 
11
requires a pointing device like mouse.  It cannot be controlled
 
12
with only keyboard.
 
13
 
 
14
.SH RULES
 
15
The game will over when you remove all the pieces on the board.
 
16
The pieces can be removed only when both of the following
 
17
conditions are true.
 
18
 
 
19
.TP 4
 
20
.B (1)
 
21
The 2 pieces have the same picture
 
22
.TP 4
 
23
.B (2)
 
24
The 2 pieces can be connected with up to 3 lines which do not go
 
25
over other pieces.
 
26
 
 
27
.TP 0
 
28
It may seem difficult rule, but is easier than describing in
 
29
words.  "Auto-demo" mode must be very useful for you to understand 
 
30
the rule.
 
31
 
 
32
.SS Score
 
33
The best scores will be recorded at
 
34
\fIxshisen\-scores\fP
 
35
file under the directory specified by
 
36
\fIXSHISENLIB\fP
 
37
environment variable.  X resources "libDirectory" will be valid if 
 
38
the environment variable is not set.
 
39
Note that the score will not be recorded if you use even one of "Back", 
 
40
"Search", or "Restart".
 
41
 
 
42
.SH OPTIONS
 
43
The following command line options are available.
 
44
.TP 8
 
45
.B standard Xt options
 
46
.IR xshisen
 
47
accepts standard toolkit options like \fB-display\fR, or \fB-iconic\fR.
 
48
.TP 8
 
49
.B -demo
 
50
Auto-demo mode.  You cannot play game with this mode, but the game 
 
51
will proceed by computer automated algorithm.  This mode is quite
 
52
useful for you to understand rules.
 
53
.TP 8
 
54
.B -score
 
55
Just displays the best score dialog and exits.
 
56
.TP 8
 
57
.B \-mag number
 
58
Magnify main window by \fBnumber\fR times.  The standard window
 
59
will be 640x400.  \fBNumber\fR may be a decimal, but the range is
 
60
limited from 0.5 to the display size.
 
61
.TP 8
 
62
.B \-fn fontlist
 
63
Use \fBfontlist\fR for menubar and times.
 
64
.TP 8
 
65
.B \-large
 
66
Play double sized game.  Game size can be changed with menubar
 
67
after you started \fIxshisen\fP.  Each game size has independent
 
68
best time records.
 
69
.TP 8
 
70
.B \-huge
 
71
Play quadruple sized game.  Game size can be changed with menubar
 
72
after you started \fIxshisen\fP.  Each game size has independent
 
73
best time records.
 
74
.TP 8
 
75
.B \-trial
 
76
Play as "Click Trial" mode.  You can measure your mouse operation
 
77
speed with this feature.
 
78
.TP 8
 
79
.B \-gravity
 
80
Enable gravity effect.  All the pieces above the removed pieces
 
81
will fall down.
 
82
 
 
83
.SH RESOURCE
 
84
The following resources are available.
 
85
.TP 8
 
86
.B XShisen*fitPixmap
 
87
If this value is \fBTrue\fR, the initial window size will be
 
88
automatically calculated with the pixmap data size.
 
89
When this value is \fBFalse\fR, the initial window size is
 
90
determined by the \fBwidth\fR and \fBheight\fR resources.  The
 
91
pixmap data will be resized in this case.  Default value is
 
92
\fBTrue\fR.
 
93
.TP 8
 
94
.B XShisen*width
 
95
Width of the initial window.  This resource is ignored when
 
96
\fBfitPixmap\fR
 
97
resource is set to
 
98
\fBTrue\fR.
 
99
Default value is 640.
 
100
.TP 8
 
101
.B XShisen*height
 
102
Height of the initial window.  This resource is ignored when
 
103
\fBfitPixmap\fR
 
104
resource is set to
 
105
\fBTrue\fR.
 
106
Default value is 400.
 
107
.TP 8
 
108
.B XShisen*scoreFile
 
109
This resource specifies the score file name.  This file name must
 
110
not contain the directory name.  Default value is "xshisen-scores".
 
111
.TP 8
 
112
.B XShisen*connectLineTime
 
113
The delay time in mili-second between you clicke the pair and the
 
114
pair is actually removed from screen.  This value should be enough 
 
115
big for beginners, but experts may want this value smaller in
 
116
order to play quickly.  Default value is 1000 mili-seconds.
 
117
.TP 8
 
118
.B XShisen*connectLineColor
 
119
This specifies the connection line color which appears when pieces 
 
120
are being removed.
 
121
Default value is "blue".
 
122
.TP 8
 
123
.B XShisen*connectLineWidth
 
124
This specifies the connection line width in pixel. Default value
 
125
is 6.
 
126
.TP 8
 
127
.B XShisen*background
 
128
Background color. Default value is #004000.
 
129
.TP 8
 
130
.B XShisen*libraryDirectory
 
131
The directory where the pixmap data and the best score file is
 
132
located.  This resource is ignored when you specify the
 
133
.IR XSHISENLIB
 
134
environment variable.
 
135
.TP 8
 
136
.B XShisen*drawing.translations
 
137
Button binding setting for your mouse.  Default is
 
138
.NF
 
139
 
 
140
      <Btn1Down>: #replace PickupPiece() \n <Btn3Down>: CancelPiece()
 
141
 
 
142
.FI
 
143
 
 
144
.SH MENU BAR AND KEYBOARD
 
145
.TP 8
 
146
.B Start (Control + D)
 
147
Starts new game. The pieces are located at random position.
 
148
.TP 8
 
149
.B Restart (Control + R)
 
150
Restarts the current game. The time of restarted game will not be
 
151
recorded as the best score.
 
152
.TP 8
 
153
.B Pause (Control + P)
 
154
Pauses the game. The time count will be stopped, but also the
 
155
pieces picture will be hidden.  You can resume your game to do
 
156
"Pause" again.
 
157
.TP 8
 
158
.B Exit
 
159
Exits the Shisen-sho.
 
160
.TP 8
 
161
.B Search (F1)
 
162
Teaches the pair you can remove now.  You can use "Search"
 
163
anytime, but the time will not be recorded as the best score if
 
164
you use "Search" even once.
 
165
.TP
 
166
.B Back (F5)
 
167
Backs one step.  The time will not be recorded if you use "Back".
 
168
 
 
169
.SH MOUSE CONTROL
 
170
The following mouse control is available.  You can change mouse
 
171
button bindings with
 
172
\fBXShisen*drawing.translations\fR resource.
 
173
.TP 8
 
174
.B Button 1
 
175
Specifies the piece to remove.  You can cencel the selection when
 
176
you click the selected piece again.
 
177
.TP 8
 
178
.B Button 3
 
179
Cancels the selected piece.  You can use button 3 after "Search",
 
180
which cancels the search result.
 
181
 
 
182
.SH AUTHORS
 
183
Shisen-sho for X11: Masaoki Kobayashi
 
184
.RE
 
185
Picture: Takayuki Akiyama
 
186
 
 
187
.SH COPYRIGHT
 
188
XShisen Copyright 1995,1996,1999,2002 by Masaoki Kobayashi <masaoki@techfirm.co.jp>.
 
189
Picture#1 Copyright by Takayuki Akiyama <taco3@ybb.ne.jp>.
 
190
Picture#2 Copyright by Mario Weilguni <mweilguni@sime.com>.
 
191
See LICENSE file for detail.