~ubuntu-branches/ubuntu/quantal/morse/quantal

« back to all changes in this revision

Viewing changes to .pc/03makefileALSA/morse.xml

  • Committer: Package Import Robot
  • Author(s): Bhavani Shankar
  • Date: 2011-11-13 20:49:00 UTC
  • mfrom: (7.1.1 sid)
  • Revision ID: package-import@ubuntu.com-20111113204900-u1p6ze9eu4bwrfxx
Tags: 2.4-2ubuntu1
* Merge from debian testing. Remaining changes:
  - 02asneeded: new patch, fixes FTBFS Thanks to John Nogatch.
    (Forwarded as debian bug no 632436) 

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