~ubuntu-branches/ubuntu/edgy/morse/edgy

« back to all changes in this revision

Viewing changes to morse.xml

  • Committer: Bazaar Package Importer
  • Author(s): Joop Stakenborg
  • Date: 2006-03-18 09:47:15 UTC
  • Revision ID: james.westby@ubuntu.com-20060318094715-h2sjf5b7iufaz9ov
Tags: upstream-2.1
ImportĀ upstreamĀ versionĀ 2.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<?xml version="1.0" encoding="ISO-8859-1"?>
 
2
<!DOCTYPE refentry PUBLIC 
 
3
   "-//OASIS//DTD DocBook XML V4.1.2//EN"
 
4
   "docbook/docbookx.dtd">
 
5
<refentry id='morse.1'>
 
6
<refmeta>
 
7
<refentrytitle>morse</refentrytitle>
 
8
<manvolnum>1</manvolnum>
 
9
<refmiscinfo class='date'>January 2005</refmiscinfo>
 
10
</refmeta>
 
11
<refnamediv id='name'>
 
12
<refname>morse</refname>
 
13
<refname>QSO</refname>
 
14
<refpurpose>Morse-code trainer and QSO generator for aspiring radio hams</refpurpose>
 
15
</refnamediv>
 
16
<refsynopsisdiv id='synopsis'>
 
17
 
 
18
<cmdsynopsis>
 
19
  <command>morse</command>  
 
20
    <arg choice='opt'>-i </arg>
 
21
    <arg choice='opt'>-I </arg>
 
22
    <arg choice='opt'>-r </arg>
 
23
    <arg choice='opt'>-n <replaceable>num</replaceable></arg>
 
24
    <arg choice='opt'>-R <replaceable>num</replaceable></arg>
 
25
    <arg choice='opt'>-N <replaceable>num</replaceable></arg>
 
26
    <arg choice='opt'>-C <replaceable>charset</replaceable></arg>
 
27
    <arg choice='opt'>-w <replaceable>num</replaceable></arg>
 
28
    <arg choice='opt'>-f <replaceable>num</replaceable></arg>
 
29
    <arg choice='opt'>-v <replaceable>num</replaceable></arg>
 
30
    <arg choice='opt'>-g <replaceable>num</replaceable></arg>
 
31
    <arg choice='opt'>-f <replaceable>num</replaceable></arg>
 
32
    <arg choice='opt'>-e </arg>
 
33
    <arg choice='opt'>-c </arg>
 
34
    <arg choice='opt'>-b </arg>
 
35
    <arg choice='opt'>-a </arg>
 
36
    <arg choice='opt'>-l </arg>
 
37
    <arg choice='opt'>-m </arg>
 
38
    <arg choice='opt'>-t </arg>
 
39
    <arg choice='opt'>-T </arg>
 
40
    <arg choice='opt'>-s </arg>
 
41
    <arg choice='opt'>-q </arg>
 
42
    <arg choice='opt'>-p <replaceable>num</replaceable></arg>
 
43
    <arg choice='opt'>-E <replaceable>num</replaceable></arg>
 
44
    <arg choice='opt'>-M <replaceable>num</replaceable></arg>
 
45
    <arg choice='opt'>-d </arg>
 
46
    <arg choice='opt'>-A </arg>
 
47
    <arg choice='opt'>-B </arg>
 
48
    <arg choice='opt'>-S </arg>
 
49
    <arg choice='opt'>-x <replaceable>num</replaceable></arg>
 
50
    <arg choice='opt'>-X <replaceable>num</replaceable></arg>
 
51
    <arg rep='repeat' choice='opt'><replaceable>word</replaceable></arg>
 
52
</cmdsynopsis>
 
53
 
 
54
</refsynopsisdiv>
 
55
 
 
56
<refsect1 id='description'><title>DESCRIPTION</title>
 
57
 
 
58
<para>The <command>morse</command> program is a Morse-code trainer
 
59
intended to help aspiring radio hams pass the 5-word-per-minute
 
60
Element 1 test.  It can take test text from a text file on standard
 
61
input, or test words from its command-line arguments, or generate
 
62
random text (-r) or play back what you type (-i).</para>
 
63
 
 
64
<para>A helper program, <command>QSO</command>, generates plausible
 
65
QSOs that can be fed to the standard input of <command>morse</command>.</para>
 
66
 
 
67
<para>The following options control the behavior of
 
68
<command>morse</command>:</para>
 
69
 
 
70
<variablelist>
 
71
<varlistentry>
 
72
<term>-i</term>
 
73
<listitem>
 
74
    <para>Play what you type.</para>
 
75
</listitem>
 
76
</varlistentry>
 
77
<varlistentry>
 
78
<term>-I</term>
 
79
<listitem>
 
80
    <para>Like -i but don't turn off keyboard echoing.</para>
 
81
</listitem>
 
82
</varlistentry> 
 
83
<varlistentry>
 
84
<term>-r</term>
 
85
<listitem>
 
86
    <para>Generate random text. Starts out slanted towards easy
 
87
    letters, then slants towards ones you get wrong.</para>
 
88
</listitem>
 
89
</varlistentry>
 
90
<varlistentry>
 
91
<term>-n NUM</term>
 
92
<listitem>
 
93
    <para>Make words (groups) NUM characters long.
 
94
    Valid values are between 1 and 20.</para>
 
95
</listitem>
 
96
</varlistentry>
 
97
<varlistentry>
 
98
<term>-R NUM</term>
 
99
<listitem>
 
100
    <para>Set the total time (in minutes) to generate text.</para>
 
101
</listitem>
 
102
</varlistentry>
 
103
<varlistentry>
 
104
<term>-N NUM (default 0 means unlimited)</term>
 
105
<listitem>
 
106
    <para>Set the total number of words (groups) to generate.</para>
 
107
</listitem>
 
108
</varlistentry>
 
109
<varlistentry>
 
110
<term>-C 'STRING' (default all available characters)</term>
 
111
<listitem>
 
112
    <para>Select characters to send from this STRING only.</para>
 
113
</listitem>
 
114
</varlistentry>
 
115
<varlistentry>
 
116
<term>-w </term>
 
117
<listitem>
 
118
    <para>words_per_minute</para>
 
119
</listitem>
 
120
</varlistentry>
 
121
<varlistentry>
 
122
<term>-f</term>
 
123
<listitem>
 
124
    <para>frequency_in_hertz</para>
 
125
</listitem>
 
126
</varlistentry>
 
127
<varlistentry>
 
128
<term>-v</term>
 
129
<listitem>
 
130
    <para>volume (zero to one, rather nonlinear)</para>
 
131
</listitem>
 
132
</varlistentry>
 
133
<varlistentry>
 
134
<term>-g</term>
 
135
<listitem>
 
136
    <para>alternate_frequency (toggles via control-G in input FILE 
 
137
    at a word break)</para>
 
138
</listitem>
 
139
</varlistentry>
 
140
<varlistentry>
 
141
<term>-F</term>
 
142
<listitem>
 
143
    <para>Farnsworth_character_words_per_minute</para>
 
144
</listitem>
 
145
</varlistentry>
 
146
<varlistentry>
 
147
<term>-e</term>
 
148
<listitem>
 
149
    <para>leave off the &lt;SK&gt; sound at the end</para>
 
150
</listitem>
 
151
</varlistentry>
 
152
<varlistentry>
 
153
<term>-c</term>
 
154
<listitem>
 
155
    <para>complain about illegal characters instead of just ignoring
 
156
    them</para>
 
157
</listitem>
 
158
</varlistentry>
 
159
<varlistentry>
 
160
<term>-b</term>
 
161
<listitem>
 
162
    <para>print each word before doing it</para>
 
163
</listitem>
 
164
</varlistentry>
 
165
<varlistentry>
 
166
<term>-a</term>
 
167
<listitem>
 
168
    <para>print each word after doing it</para>
 
169
</listitem>
 
170
</varlistentry>
 
171
<varlistentry>
 
172
<term>-l</term>
 
173
<listitem>
 
174
    <para>print each letter just before doing it</para>
 
175
</listitem>
 
176
</varlistentry>
 
177
<varlistentry>
 
178
<term>-m</term>
 
179
<listitem>
 
180
    <para>print morse dots and dashes as they sound
 
181
    (this printing-intensive option slows the wpm down!)</para>
 
182
</listitem>
 
183
</varlistentry>
 
184
<varlistentry>
 
185
<term>-t</term>
 
186
<listitem>
 
187
    <para>Type along with the morse, but don't see what
 
188
    you're typing (unless you make a mistake).
 
189
    You are allowed to get ahead as much as you want.
 
190
    If you get too far behind it will stop and resync with you.
 
191
    You can force it to resync at the next word end by hitting
 
192
    control-H.
 
193
    Hit ESC to see how you are doing, control-D to end.
 
194
    (The rightmost space in the printout marks where the average is.
 
195
    Farther left spaces separate off blocks of letters that are
 
196
    about twice as probable as the average to occur, three times, etc.)</para>
 
197
</listitem>
 
198
</varlistentry>
 
199
<varlistentry>
 
200
<term>-T</term>
 
201
<listitem>
 
202
    <para>Like -t but see your characters (after they are played).</para>
 
203
</listitem>
 
204
</varlistentry>
 
205
<varlistentry>
 
206
<term>-s</term>
 
207
<listitem>
 
208
    <para>Stop after each character and make sure you get it
 
209
 right. (implies -t)</para>
 
210
</listitem>
 
211
</varlistentry>
 
212
<varlistentry>
 
213
<term>-q</term>
 
214
<listitem>
 
215
    <para>Quietly resyncs with your input (after you make a
 
216
    mistake).</para>
 
217
</listitem>
 
218
</varlistentry>
 
219
<varlistentry>
 
220
<term>-p NUM</term>
 
221
<listitem>
 
222
    <para>Make you get it right NUM times, for penance. (implies -s).</para>
 
223
</listitem>
 
224
</varlistentry>
 
225
<varlistentry>
 
226
<term>-E NUM</term>
 
227
<listitem>
 
228
    <para>If your count of wrong answers minus right answers for a
 
229
    given character exceeds this, the program will start prompting
 
230
    you.  If above the maximum error prompt it will never
 
231
    prompt (implies -t).</para>
 
232
</listitem>
 
233
</varlistentry>
 
234
<varlistentry>
 
235
<term>-M NUM</term>
 
236
<listitem>
 
237
    <para>If you get more than this number of characters behind, pause until you
 
238
    do your next letter. 1 behind is normal, 0 behind means never pause.
 
239
    This option mplies -t.</para>
 
240
</listitem>
 
241
</varlistentry>
 
242
<varlistentry>
 
243
<term>-d</term>
 
244
<listitem>
 
245
    <para>Dynamically speed up or slow down depending on how you are doing.
 
246
    (if also-s, then -d <emphasis>only speeds up</emphasis>!)</para>
 
247
</listitem>
 
248
</varlistentry> 
 
249
<varlistentry>
 
250
<term>-A</term>
 
251
<listitem>
 
252
    <para>Add ISO 8859-1 (Latin-1) signs to test set.</para>
 
253
</listitem>
 
254
</varlistentry>
 
255
<varlistentry>
 
256
<term>-B</term>
 
257
<listitem>
 
258
    <para>Add uncommon punctuation to test set.</para>
 
259
</listitem>
 
260
</varlistentry>
 
261
<varlistentry>
 
262
<term>-S</term>
 
263
<listitem>
 
264
    <para>Add uncommon prosigns to test set.</para>
 
265
</listitem>
 
266
</varlistentry>
 
267
<varlistentry>
 
268
<term>-X</term>
 
269
<listitem>
 
270
    <para>Set error volume. Error volume 0 means use console
 
271
    speaker.</para>
 
272
</listitem>
 
273
</varlistentry>
 
274
<varlistentry>
 
275
<term>-x</term>
 
276
<listitem>
 
277
    <para>Set frequency of error tone.</para>
 
278
</listitem>
 
279
</varlistentry>
 
280
</variablelist>
 
281
 
 
282
<para>Here is the basic International Morse codest that the program
 
283
will train you in:</para>
 
284
 
 
285
<screen>
 
286
        A  .-          N  -.          1  .----       .  .-.-.-
 
287
        B  -...        O  ---         2  ..---       ,  --..--
 
288
        C  -.-.        P  .--.        3  ...--       ?  ..--..
 
289
        D  -..         Q  --.-        4  ....-       (  -.--.
 
290
        E  .           R  .-.         5  .....       -  -....-
 
291
        F  ..-.        S  ...         6  -....
 
292
        G  --.         T  -           7  --...
 
293
        H  ....        U  ..-         8  ---..
 
294
        I  ..          V  ...-        9  ----.
 
295
        J  .---        W  .--         0  -----
 
296
        K  -.-         X  -..-        /  -..-.
 
297
        L  .-..        Y  -.--        +  .-.-.
 
298
        M  --          Z  --..        =  -...-
 
299
</screen>
 
300
 
 
301
<para>The following characters are included if one uses the -B option:</para>
 
302
 
 
303
<screen>
 
304
        )  -.--.-      "  .-..-.      _  ..--.-      '  .----.
 
305
        :  ---...      ;  -.-.-.      $  ...-..-     !  -.-.--
 
306
</screen>
 
307
 
 
308
<para>The following procedural signals (prosigns) are also included if
 
309
one uses -B:</para>
 
310
 
 
311
<screen>
 
312
&lt;AR&gt;    "+" over, end of message
 
313
&lt;AS&gt;    "*" please stand by (&lt;AS&gt; 5  Wait 5 Minutes) (".-...")
 
314
&lt;BT&gt;    "=" (double dash) pause, break for text
 
315
CL          going off the air (clear)
 
316
CQ          calling any station
 
317
K           go, invite any station to transmit
 
318
&lt;KN&gt;    "(" go only, invite a specific station to transmit
 
319
R           all received OK
 
320
&lt;SK&gt;    "%" end of contact (sent before call) ("...-.-", known also as &lt;VA&gt;)
 
321
</screen>
 
322
 
 
323
<para>The following less-used prosigns are included if one
 
324
uses the -S option:</para>
 
325
 
 
326
<screen>
 
327
&lt;AA&gt;    "^" new line (".-.-", the same as :a, ae)
 
328
&lt;BK&gt;    "#" invite receiving station to transmit ("-...-.-")
 
329
&lt;KA&gt;    "&amp;" attention ("-.-.-")
 
330
&lt;SN&gt;    "@" understood ("...-.")
 
331
</screen>
 
332
 
 
333
<para>The following characters are included if one uses the -A option:</para>
 
334
 
 
335
<screen>
 
336
        :a  .-.-   (also for ae, the same as &lt;AA&gt;)
 
337
        `a  .--.-  (also oa, danish a with ring over it)
 
338
        ch  ----   (bar-ch ?, bar-h ?, ISO 8859-1 code 199 and 231 ?)
 
339
        -d  ..--.  (eth, overstrike d with -, ISO 8859-1 code 208 and 240)
 
340
        `e  ..-..
 
341
        ~n  --.--
 
342
        :o  ---.   (also for oe)
 
343
        :u  ..--   (also for ue)
 
344
        ]p  .--..  (thorn, overstrike ] with p, ISO 8859-1 code 222 and 254)
 
345
        paragraph  .-.-..  (ISO 8859-1 code 167 ?)
 
346
</screen>
 
347
 
 
348
<para>For the raw beginner trying to learn morse code, we recommend
 
349
the following sequence:</para>
 
350
 
 
351
<procedure>
 
352
<step>
 
353
<para>Start learning the alphabet:</para>
 
354
<programlisting>
 
355
morse -r -s -T -d -w 5 -F 15 -p 5 -E -10
 
356
</programlisting>
 
357
</step>
 
358
<step>
 
359
<para>Then drill drill drill:</para>
 
360
<programlisting>
 
361
morse -r -s -T -d -w 5 -F 15 -p 5 -E 0
 
362
</programlisting>
 
363
</step>
 
364
<step>
 
365
<para>Real-time drill, with hints if you really need it:</para>
 
366
<programlisting>
 
367
morse -r -T -d -w 5 -F 15 -M 2 -E 4
 
368
</programlisting>
 
369
</step>
 
370
<step>
 
371
<para>Simulated test:</para>
 
372
<programlisting>
 
373
QSO | morse -e -T -d -w 5 -F 15
 
374
</programlisting>
 
375
</step>
 
376
<step>
 
377
<para>The dreaded random-letter test:</para>
 
378
<programlisting>
 
379
morse -r -T -d -w 5 -F 15
 
380
</programlisting>
 
381
</step>
 
382
<step>
 
383
<para>Finally try for greater and greater speed:</para>
 
384
<programlisting>
 
385
morse -r -T -d -w 13 -F 24
 
386
</programlisting>
 
387
</step>
 
388
</procedure>
 
389
</refsect1>
 
390
 
 
391
<refsect1 id='author'><title>AUTHORS</title> 
 
392
<para>Joe Dellinger <email>joe@montebello.soest.hawaii.edu</email>.</para>
 
393
<para>Updated 2005 by Eric S. Raymond <email>esr@thyrsus.com</email>.</para>
 
394
<para>Other contributions by Jacek M. Holeczek and Marc Unangst.</para> 
 
395
</refsect1> 
 
396
</refentry>