Cleanup before trying to merge signal code.

diff --git a/Makefile b/Makefile
index 8eb9ec6eb1fe2928acfa7400f78f508c087a9afa..6a17305d901f9017bee36df75cef3774aa1774df 100644 (file)
--- a/Makefile
+++ b/Makefile
@@ -34,8 +34,6 @@ DEVICE = OSS
 # For alternate random number generator, add either -DUSELRAND for lrand48(),
 #   or -DUSERAND for (ugh) rand(). Default is -DUSERANDOM for random().
 #
-# Define SIGRET to be your signal handler return type if not "void".
-#
 # Define BSDSIGS or POSIXSIGS, depending on what kind of signals you
 #   have. "Old-style" signals are not currently supported. Default is BSDSIGS.
 #
@@ -134,6 +132,9 @@ clean:
        rm -f *.o morse QSO morseSun morseHP morseX11 morseIndigo morseLinux morseAdLib morseOSS
        cd qso; make clean
 
+pristine: clean
+       rm -f morse.1 QSO.1
+
 morse.o:       beep.h Makefile
 beepSun.o:     beep.h
 beepHP.o:      beep.h alarm.h
@@ -143,3 +144,6 @@ beepLinux.o:        beep.h alarm.h
 beepAdLib.o:   beep.h alarm.h
 beepOSS.o:     beep.h
 alarm.o:       alarm.h
+
+morse.1: morse.xml
+       xmlto man morse.xml

diff --git a/README b/README
index fc3f1e2948b5928ff76cc02824c551daf2181498..70b499c83a4148059235c5762f0aac74747d6c18 100644 (file)
--- a/README
+++ b/README
@@ -10,7 +10,8 @@ Currently supported devices:
  Linux:  The IBM PC console speaker.
  AdLib:  AdLib/SoundBlaster FM chip. (See comments in beepAdLib.c about
          caveats and limitations.)
- OSS:    Open Sound System /dev/dsp device.
+ OSS:    Open Sound System /dev/dsp device.  Also works with the newer 
+         ALSA Linux sound system.
 
 Adding a new device is as simple as creating a new implementation of the
 beep.h interface. See beep*.[ch] for examples and documentation.
@@ -34,7 +35,7 @@ A modified version of the program "QSO" by Paul J. Drongowski is also included.
         L  .-..        Y  -.--        +  .-.-.
         M  --          Z  --..        =  -...-
 
-The following characters are included if one defines ALLPUNCTUATION :
+The following characters are included if one uses the -B option:
 
         )  -.--.-      "  .-..-.      _  ..--.-      '  .----.
         :  ---...      ;  -.-.-.      $  ...-..-     !  -.-.--
@@ -52,14 +53,14 @@ R           all received OK
 <SK>    "%" end of contact (sent before call) ("...-.-", known also as <VA>)
 
 The following Procedural Signals (Prosigns) are included if one
-defines ALLPROSIGNS :
+uses the -S option:
 
 <AA>    "^" new line (".-.-", the same as :a, ae)
 <BK>    "#" invite receiving station to transmit ("-...-.-")
 <KA>    "&" attention ("-.-.-")
 <SN>    "@" understood ("...-.")
 
-The following characters are included if one defines ALLINTERNATIONAL :
+The following characters are included if one uses the -A option:
 
         :a  .-.-   (also for ae, the same as <AA>)
         `a  .--.-  (also oa, danish a with ring over it)
@@ -95,6 +96,9 @@ Written by:
   jdellinger@trc.amoco.com
   joe@soest.hawaii.edu
 
-This version dated:
-       Wed Jan 17 09:43:16 CET 2001
+Since January 2005, maintained by:
+  Eric S. Raymond <esr@thyrsus.com>
+  * Turned the old compile-time options for expanding the test set into
+    runtime options -A, -B, -S, -X, -x.
+  * Updated all code to use ANSI prototypes.
 

diff --git a/morse.c b/morse.c
index 1a663965e513ea69e0b82b00f7d971f1fa2b856b..7962b41c36f74f62ee9f251f5d4f9aa02cf63a30 100644 (file)
--- a/morse.c
+++ b/morse.c
@@ -52,6 +52,15 @@
  *           One should rewrite the openterminal function to provide the
  *           enter_standout_mode "smso/so" and exit_standout_mode "rmso/se"
  *           terminfo/termcap terminal string capabilities.
+ *
+ * Eric S. Raymond <esr@thyrsus.com> January 2005.
+ *     Dusted it off, cleaned it up to modern C standards. 
+ *     Changed ALLINTERNATIONAL to runtime -A option.
+ *     Changed ALLPROSIGNS to runtime -S option.
+ *     Changed ALLPUNCTUATION to runtime -B option.
+ *     Changed ERROR_FREQUENCY to runtime -x option.
+ *     Changed ERROR_VOLUME to runtime -X option.
+ *     Wrote the manual page.
  */
 
 /*
@@ -1862,9 +1871,8 @@ openterminal (void)
     termopen = 1;
 }
 
-int
-readterminal (string)
-    char          **string;
+static int
+readterminal (char **string)
 {
 /* This must be declared static! */
 static char     line[TESTBUFSZ];
@@ -1890,7 +1898,7 @@ int             n;
 }
 
 static void
-closeterminal ()
+closeterminal (void)
 {
 #ifdef USG
     ioctl (termfd, TCSETAW, &oldtermgtty);
@@ -1901,14 +1909,14 @@ closeterminal ()
 }
 
 static void
-die ()
+die (void)
 {
     cleanup ();
     exit (1);
 }
 
 static void
-cleanup ()
+cleanup (void)
 {
     if (termopen)
        closeterminal ();
@@ -1916,7 +1924,7 @@ cleanup ()
 }
 
 static void
-suspend ()
+suspend (int sig)
 {
     signal (SIGTSTP, suspend);
     cleanup ();
@@ -1935,7 +1943,6 @@ randomletter (void)
 int             ii;
 int             sum, sum2;
 long            ranspot;
-extern time_t   time ();
 static int      lasttime = -1;
 static long     norepeat;
 
@@ -1991,13 +1998,31 @@ static long     norepeat;
     return ii;
 }
 
-void
-report ()
+static int
+rancomp (const void *elem1, const void *elem2)
 {
-int             ii, jj, count;
-float           sum;
-int             randomstr[TWOFIFTYSIX];
-extern int      rancomp ();
+    register int *e1 = (int *)elem1;
+    register int *e2 = (int *)elem2;
+    float           a, b;
+
+
+    a = (randomfactor[(*e1)] + (randomripe[(*e1)] / (float) RIPECOUNT));
+    b = (randomfactor[(*e2)] + (randomripe[(*e2)] / (float) RIPECOUNT));
+
+    if (a == b)
+       return 0;
+    else if (a > b)
+       return -1;
+    else
+       return 1;
+}
+
+static void
+report (void)
+{
+    int ii, jj, count;
+    float sum; 
+    int randomstr[TWOFIFTYSIX];
 
     printf ("\nCurrent words per minute: %.1f\n", words_per_minute);
 
@@ -2060,20 +2085,3 @@ extern int      rancomp ();
 
     fflush (stdout);
 }
-
-int
-rancomp (elem1, elem2)
-    int            *elem1, *elem2;
-{
-float           a, b;
-
-    a = (randomfactor[(*elem1)] + (randomripe[(*elem1)] / (float) RIPECOUNT));
-    b = (randomfactor[(*elem2)] + (randomripe[(*elem2)] / (float) RIPECOUNT));
-
-    if (a == b)
-       return 0;
-    else if (a > b)
-       return -1;
-    else
-       return 1;
-}

diff --git a/morse.xml b/morse.xml
new file mode 100644 (file)
index 0000000..6046534
--- /dev/null
+++ b/morse.xml
@@ -0,0 +1,330 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!DOCTYPE refentry PUBLIC 
+   "-//OASIS//DTD DocBook XML V4.1.2//EN"
+   "docbook/docbookx.dtd">
+<refentry id='morse.1'>
+<refmeta>
+<refentrytitle>morse</refentrytitle>
+<manvolnum>1</manvolnum>
+<refmiscinfo class='date'>January 2005</refmiscinfo>
+</refmeta>
+<refnamediv id='name'>
+<refname>morse</refname>
+<refname>QSO</refname>
+<refpurpose>Morse-code trainer and QSO generator for aspiring radio hams</refpurpose>
+</refnamediv>
+<refsynopsisdiv id='synopsis'>
+
+<cmdsynopsis>
+  <command>morse</command>  
+    <arg choice='opt'>-i </arg>
+    <arg choice='opt'>-I </arg>
+    <arg choice='opt'>-r </arg>
+    <arg choice='opt'>-n <replaceable>num</replaceable></arg>
+    <arg choice='opt'>-R <replaceable>num</replaceable></arg>
+    <arg choice='opt'>-N <replaceable>num</replaceable></arg>
+    <arg choice='opt'>-C <replaceable>charset</replaceable></arg>
+    <arg choice='opt'>-w <replaceable>num</replaceable></arg>
+    <arg choice='opt'>-f <replaceable>num</replaceable></arg>
+    <arg choice='opt'>-v <replaceable>num</replaceable></arg>
+    <arg choice='opt'>-g <replaceable>num</replaceable></arg>
+    <arg choice='opt'>-f <replaceable>num</replaceable></arg>
+    <arg choice='opt'>-e </arg>
+    <arg choice='opt'>-c </arg>
+    <arg choice='opt'>-b </arg>
+    <arg choice='opt'>-a </arg>
+    <arg choice='opt'>-l </arg>
+    <arg choice='opt'>-m </arg>
+    <arg choice='opt'>-t </arg>
+    <arg choice='opt'>-T </arg>
+    <arg choice='opt'>-s </arg>
+    <arg choice='opt'>-q </arg>
+    <arg choice='opt'>-p <replaceable>num</replaceable></arg>
+    <arg choice='opt'>-E <replaceable>num</replaceable></arg>
+    <arg choice='opt'>-M <replaceable>num</replaceable></arg>
+    <arg choice='opt'>-d </arg>
+    <arg choice='opt'>-A </arg>
+    <arg choice='opt'>-B </arg>
+    <arg choice='opt'>-S </arg>
+    <arg choice='opt'>-x <replaceable>num</replaceable></arg>
+    <arg choice='opt'>-X <replaceable>num</replaceable></arg>
+    <arg choice='opt'><replaceable>word</replaceable></arg>
+</cmdsynopsis>
+
+</refsynopsisdiv>
+
+<refsect1 id='description'><title>DESCRIPTION</title>
+
+<para>The <command>morse</command> program is a Morse-code trainer
+intended to help aspiring radio hams pass the 5-word-per-minute
+Element 1 test.  It can take test text from a text file on standard
+input, or test words from its command-line arguments, or generate
+random text (-r) or play back what you type (-i).</para>
+
+<para>A helper program, <command>QSO</command>, generates plausible
+QSOs that can be fed to the standard input of <command>morse</command>.</para>
+
+<para>The following options control the behavior of
+<command>morse</command>:</para>
+
+<variablelist>
+<varlistentry>
+<term>-i</term>
+<listitem>
+    <para>Play what you type.</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>-I</term>
+<listitem>
+    <para>Like -i but don't turn off keyboard echoing.</para>
+</listitem>
+</varlistentry> 
+<varlistentry>
+<term>-r</term>
+<listitem>
+    <para>Generate random text. Starts out slanted towards easy
+    letters, then slants towards ones you get wrong.</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>-n NUM</term>
+<listitem>
+    <para>Make words (groups) NUM characters long.
+    Valid values are between 1 and 20.</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>-R NUM</term>
+<listitem>
+    <para>Set the total time (in minutes) to generate text.</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>-N NUM (default 0 means unlimited)</term>
+<listitem>
+    <para>Set the total number of words (groups) to generate.</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>-C 'STRING' (default all available characters)</term>
+<listitem>
+    <para>Select characters to send from this STRING only.</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>-w </term>
+<listitem>
+    <para>words_per_minute</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>-f</term>
+<listitem>
+    <para>frequency_in_hertz</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>-v</term>
+<listitem>
+    <para>volume (zero to one, rather nonlinear)</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>-g</term>
+<listitem>
+    <para>alternate_frequency (toggles via control-G in input FILE 
+    at a word break)</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>-F</term>
+<listitem>
+    <para>Farnsworth_character_words_per_minute</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>-e</term>
+<listitem>
+    <para>leave off the &lt;SK&gt; sound at the end</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>-c</term>
+<listitem>
+    <para>complain about illegal characters instead of just ignoring
+    them</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>-b</term>
+<listitem>
+    <para>print each word before doing it</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>-a</term>
+<listitem>
+    <para>print each word after doing it</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>-l</term>
+<listitem>
+    <para>print each letter just before doing it</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>-m</term>
+<listitem>
+    <para>print morse dots and dashes as they sound
+    (this printing-intensive option slows the wpm down!)</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>-t</term>
+<listitem>
+    <para>Type along with the morse, but don't see what
+    you're typing (unless you make a mistake).
+    You are allowed to get ahead as much as you want.
+    If you get too far behind it will stop and resync with you.
+    You can force it to resync at the next word end by hitting
+    control-H.
+    Hit ESC to see how you are doing, control-D to end.
+    (The rightmost space in the printout marks where the average is.
+    Farther left spaces separate off blocks of letters that are
+    about twice as probable as the average to occur, three times, etc.)</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>-T</term>
+<listitem>
+    <para>Like -t but see your characters (after they are played).</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>-s</term>
+<listitem>
+    <para>Stop after each character and make sure you get it
+ right. (implies -t)</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>-q</term>
+<listitem>
+    <para>Quietly resyncs with your input (after you make a
+    mistake).</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>-p NUM</term>
+<listitem>
+    <para>Make you get it right NUM times, for penance. (implies -s).</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>-E NUM</term>
+<listitem>
+    <para>If your count of wrong answers minus right answers for a
+    given character exceeds this, the program will start prompting
+    you.  If above the maximum error prompt it will never
+    prompt (implies -t).</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>-M NUM</term>
+<listitem>
+    <para>If you get more than this number of characters behind, pause until you
+    do your next letter. 1 behind is normal, 0 behind means never pause.
+    This option mplies -t.</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>-d</term>
+<listitem>
+    <para>Dynamically speed up or slow down depending on how you are doing.
+    (if also-s, then -d <emphasis>only speeds up</emphasis>!)</para>
+</listitem>
+</varlistentry> 
+<varlistentry>
+<term>-A</term>
+<listitem>
+    <para>Add ISO 8859-1 (Latin-1) signs to test set.</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>-B</term>
+<listitem>
+    <para>Add uncommon punctuation to test set.</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>-S</term>
+<listitem>
+    <para>Add uncommon prosigns to test set.</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>-X</term>
+<listitem>
+    <para>Set error volume. Error volume 0 means use console
+    speaker.</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>-x</term>
+<listitem>
+    <para>Set frequency of error tone.</para>
+</listitem>
+</varlistentry>
+</variablelist>
+
+<para>For the raw beginner trying to learn morse code, we recommend
+the following sequence:</para>
+
+<procedure>
+<step>
+<para>Start learning the alphabet:</para>
+<programlisting>
+morse -r -s -T -d -w 5 -F 15 -p 5 -E -10
+</programlisting>
+</step>
+<step>
+<para>Then drill drill drill:</para>
+<programlisting>
+morse -r -s -T -d -w 5 -F 15 -p 5 -E 0
+</programlisting>
+</step>
+<step>
+<para>Real-time drill, with hints if you really need it:</para>
+<programlisting>
+morse -r -T -d -w 5 -F 15 -M 2 -E 4
+</programlisting>
+</step>
+<step>
+<para>Simulated test:</para>
+<programlisting>
+QSO | morse -e -T -d -w 5 -F 15
+</programlisting>
+</step>
+<step>
+<para>The dreaded random-letter test:</para>
+<programlisting>
+morse -r -T -d -w 5 -F 15
+</programlisting>
+</step>
+<step>
+<para>Finally try for greater and greater speed:</para>
+<programlisting>
+morse -r -T -d -w 13 -F 24
+</programlisting>
+</step>
+</procedure>
+</refsect1>
+
+<refsect1 id='author'><title>AUTHORS</title> 
+<para>Joe Dellinger <email>joe@montebello.soest.hawaii.edu</email>.</para>
+<para>Updated 2005 by Eric S. Raymond <email>esr@thyrsus.com</email>.</para>
+<para>Other contributions by Jacek M. Holeczek and Marc Unangst.</para> 
+</refsect1> 
+</refentry>