~ubuntu-branches/ubuntu/precise/typespeed/precise

« back to all changes in this revision

Viewing changes to man/typespeed.6

  • Committer: Bazaar Package Importer
  • Author(s): Dafydd Harries
  • Date: 2007-12-07 05:14:13 UTC
  • mto: (4.1.2 sid)
  • mto: This revision was merged to the branch mainline in revision 5.
  • Revision ID: james.westby@ubuntu.com-20071207051413-x6wtxujyiabvyuwu
Tags: upstream-0.6.4
ImportĀ upstreamĀ versionĀ 0.6.4

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.TH typespeed "6" "December 2007" "typespeed v0.6.4" "Games"
 
2
.SH NAME
 
3
typespeed \- Test your typing speed and get your fingers' CPS.
 
4
.SH SYNOPSIS
 
5
.B typespeed [OPTION]
 
6
.SH DESCRIPTION
 
7
Typespeed gives your fingers' cps (total and correct), typoratio and
 
8
some points to compare with your friends.
 
9
.P
 
10
Typespeed's idea is ripped from ztspeed (a dos game made by Zorlim).
 
11
Idea of the game should be clear to anyone, just type and type it fast
 
12
or be a loser.
 
13
.SH USAGE
 
14
The basics are simple: words, which are extracted out of a specified
 
15
word list, fly from the left to the right. Your task is in any case to
 
16
write them down before they reach the right side and disappear, in
 
17
which case your miss counter will be increased. Should you have missed
 
18
10 words, the game will end. Each correct input will increase your high
 
19
score, where one character of the word is exactly one point, i.e. a
 
20
longer word results in more points. Your total CPS and your correct CPS
 
21
are displayed during game play. Total CPS means all your input, whereas
 
22
correct CPS only counts characters, that you have entered to write a
 
23
correct word. To enter the words, you can also use emacs-like control
 
24
sequences (^A jumps to the beginning of the string, ^B goes back one
 
25
character, ^E jumps to the end of string, ^F moves cursor one position
 
26
to the left (except cursor is at end of string), ^K deletes all
 
27
characters behind cursor, ^U clears input field). Should you have
 
28
enabled cheat mode (you can see CHE in status line then), you don't
 
29
have to complete your input by pressing ENTER or SPACE.
 
30
.P
 
31
If you have played typespeed with these default rules far too long and
 
32
you want something new, you can create your own rule sets! There are
 
33
three rule sets supplied since 0.6.1:
 
34
.P
 
35
The first rule contains default settings. You can play this mode when you
 
36
don't supply any options and just start the game. In this mode, speed
 
37
will increase whenever you enter a correct word. At the end of the game,
 
38
you can get a rank in your top 10 list for the specified word list.
 
39
.P
 
40
Settings have changed in 0.6.0. If you want to play with old rules
 
41
(typespeed 0.4.4 - 0.5.3), you can choose classic.
 
42
.P
 
43
The third rule set is training - speed won't increase.
 
44
.P
 
45
If you have other ideas, you can supply your own rule set or change
 
46
the settings in menu "Game Rules". Feel free to send in some fancy
 
47
rules.
 
48
.P
 
49
Also, you can play typespeed in multiplayer. In this
 
50
mode you can play against one opponent over TCP/IPv4. Both sides can
 
51
choose a word list, should you type in a correct word and your opponent
 
52
can handle more words (based upon his current stat), there is a
 
53
possibility that your typed word will be thrown into his game. But
 
54
remember, the same goes for you! In this mode, no rank can be achieved
 
55
in your (or opponent's) top 10 list. During multiplayer, you cannot
 
56
press CURSOR UP to pause the game, instead CURSOR UP will immediately
 
57
result in a game over. You cannot play custom rule sets in multiplayer.
 
58
.SH OPTIONS
 
59
.TP
 
60
.B \--cheat
 
61
This will enable the cheat, which wraps words instantly when they are
 
62
written correctly. You don't need to press space/enter. It is another
 
63
question if this "cheat" actually helps...
 
64
.TP
 
65
.B \--client=addr
 
66
Start typespeed in client mode (where addr is network address of server)
 
67
Typespeed will try to connect to the given address and start network
 
68
play.
 
69
.TP
 
70
.B \--netlog=file
 
71
For debugging purposes. The whole network data is written into file. If
 
72
you have issues with network gaming, attach this file to a bug report
 
73
mail.
 
74
.TP
 
75
.B \--nocolors
 
76
Turns off the curses colors. It can be a more clear way to play the
 
77
game in some situations.
 
78
.TP
 
79
.B \--port=port
 
80
Tells what TCP/IPv4 port will typespeed be using in the network play. The
 
81
default port is 6025.
 
82
.TP
 
83
.B \--server
 
84
Start typespeed in server mode. Typespeed will wait for other player to
 
85
connect.
 
86
.TP
 
87
.B \--help
 
88
Little explanation of the parameters.
 
89
.SH CONFIGURATION FILES
 
90
.B /etc/typespeedrc
 
91
.TP
 
92
.B $HOME/.typespeed/config
 
93
.P
 
94
In these files, you can specify the location of directories for
 
95
game rules and word lists. You can also activate cheat mode in these
 
96
files if you write "cheat = yes". If you create a configuration file
 
97
in your home directory, you must also create a file called
 
98
$HOME/.typespeed/score. All your personal high scores are stored in
 
99
this file, not anymore in system wide high score file. This is needed
 
100
to prevent malicious users to pretend to have 1000 points in e.g.
 
101
words.eng whereby directory for word lists has been changed. In order
 
102
to compete with system-wide users, you have to remove your personal
 
103
configuration file.
 
104
.SH WORD LISTS
 
105
.br
 
106
If you would like to create your own word list, you have to follow these
 
107
simple rules:
 
108
.P
 
109
The first line contains the description that will be listed in word list
 
110
selection menu. You cannot use more than 60 characters.
 
111
.P
 
112
A word list must consist of at least 22 different words, i.e. no
 
113
duplicated words. The words must not be longer than 19 characters.
 
114
Should they be longer, they won't be parsed; instead they are silently
 
115
dropped. Words must not contain escape sequences, tabs or spaces. These
 
116
words will be dropped, too.
 
117
.P
 
118
Blank lines will be ignored.
 
119
.P
 
120
If you would like to see your created word list included into next
 
121
release, please send me an e-mail (tobias@bugol.de).
 
122
.SH NOTES
 
123
Do not use typespeed version 0.5.2 or higher with a version < 0.5.2.
 
124
The usage of network control words has been changed, so you could not
 
125
end games.
 
126
.P
 
127
If you have used typespeed < 0.6.0 and you wish to use your high scores
 
128
in newer versions, you have to convert them into new format.
 
129
.BR convert
 
130
can be used for this task.
 
131
.BR convert
 
132
takes two arguments: the old high score directory and the new high score
 
133
file. Due to changed high score file format, it is expected that converted
 
134
scores (especially cps) differ.
 
135
.SH AUTHORS
 
136
Written by Jani Ollikainen <bestis@iki.fi>,
 
137
Jaakko Manelius <jman@iki.fi>, and Tobias Stoeckmann <tobias@bugol.de>.
 
138
.SH REPORTING BUGS
 
139
Report bugs to <tobias@bugol.de>.
 
140
.SH COPYRIGHT
 
141
Copyright (C) 1999-2003   Jani Ollikainen  <bestis@iki.fi>
 
142
                          Jaakko Manelius  <jman@iki.fi>
 
143
.P
 
144
Copyright (C) 2006-2007   Tobias Stoeckmann  <tobias@bugol.de>
 
145
.P
 
146
Copying and distribution of this file, with or without modification,
 
147
are permitted in any medium without royalty provided the copyright
 
148
notice and this notice are preserved.
 
149