games/morse/morse.6

   1 .\" Copyright (c) 2000 Alexey Zelkin.  All rights reserved.
   2 .\" Copyright (c) 1988, 1991, 1993
   3 .\"     The Regents of the University of California.  All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\" 3. All advertising materials mentioning features or use of this software
  14 .\"    must display the following acknowledgement:
  15 .\"     This product includes software developed by the University of
  16 .\"     California, Berkeley and its contributors.
  17 .\" 4. Neither the name of the University nor the names of its contributors
  18 .\"    may be used to endorse or promote products derived from this software
  19 .\"    without specific prior written permission.
  20 .\"
  21 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  22 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  25 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  27 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31 .\" SUCH DAMAGE.
  32 .\"
  33 .\"     @(#)bcd.6       8.1 (Berkeley) 5/31/93
  34 .\" $FreeBSD$
  35 .\"
  36 .Dd May 11, 2004
  37 .Dt MORSE 6
  38 .Os
  39 .Sh NAME
  40 .Nm morse
  41 .Nd reformat input as morse code
  42 .Sh SYNOPSIS
  43 .Nm
  44 .Op Fl elps
  45 .Op Fl d Ar device
  46 .Op Fl w Ar speed
  47 .Op Fl f Ar frequency
  48 .Op Ar string ...
  49 .Sh DESCRIPTION
  50 The
  51 .Nm
  52 command reads the given input and reformats it in the form of morse code.
  53 Acceptable input are command line arguments or the standard input.
  54 .Pp
  55 Available options:
  56 .Bl -tag -width indent
  57 .It Fl l
  58 The
  59 .Fl l
  60 option produces output suitable for
  61 .Xr led 4
  62 devices.
  63 .It Fl s
  64 The
  65 .Fl s
  66 option produces dots and dashes rather than words.
  67 .It Fl p
  68 Send morse the real way.
  69 This only works if your system has
  70 .Xr speaker 4
  71 support.
  72 .It Fl w Ar speed
  73 Set the sending speed in words per minute.
  74 If not specified, the default
  75 speed of 20 WPM is used.
  76 .It Fl f Ar frequency
  77 Set the sidetone frequency to something other than the default 600 Hz.
  78 .It Fl d Ar device
  79 Similar to
  80 .Fl p ,
  81 but use the RTS line of
  82 .Ar device
  83 (which must by a TTY device)
  84 in order to emit the morse code.
  85 .It Fl e
  86 Echo each character before it is sent, used together with either
  87 .Fl p
  88 or
  89 .Fl d .
  90 .El
  91 .Pp
  92 The
  93 .Fl w
  94 and
  95 .Fl f
  96 flags only work in conjunction with either the
  97 .Fl p
  98 or the
  99 .Fl d
 100 flag.
 101 .Pp
 102 Not all prosigns have corresponding characters.
 103 Use
 104 .Ql #
 105 for
 106 .Em AS ,
 107 .Ql &
 108 for
 109 .Em SK ,
 110 .Ql *
 111 for
 112 .Em VE
 113 and
 114 .Ql %
 115 for
 116 .Em BK .
 117 The more common prosigns are
 118 .Ql =
 119 for
 120 .Em BT ,
 121 .Ql \&(
 122 for
 123 .Em KN
 124 and
 125 .Ql +
 126 for
 127 .Em AR .
 128 .Pp
 129 Using the
 130 .Fl d
 131 flag,
 132 it is possible to key an external device, like a sidetone generator with
 133 a headset for training purposes, or even your ham radio transceiver.
 134 For
 135 the latter, simply connect an NPN transistor to the serial port
 136 .Ar device ,
 137 emitter connected to ground, base connected through a resistor
 138 (few kiloohms) to RTS, collector to the key line of your transceiver
 139 (assuming the transceiver has a positive key supply voltage and is keyed
 140 by grounding the key input line).
 141 A capacitor (some nanofarads) between
 142 base and ground is advisable to keep stray RF away,
 143 and to suppress the
 144 minor glitch that is generated during program startup.
 145 .Sh FILES
 146 .Bl -tag -width ".Pa /dev/speaker" -compact
 147 .It Pa /dev/speaker
 148 speaker device file
 149 .El
 150 .Sh ENVIRONMENT
 151 Your
 152 .Ev LC_CTYPE
 153 locale codeset determines how
 154 characters with the high-order bit set
 155 are interpreted.
 156 .Pp
 157 .Bl -tag -width ".Li ISO8859-15" -compact
 158 .It Li ISO8859-1
 159 .It Li ISO8859-15
 160 Interpret characters with the high-order bit set as Western European characters.
 161 .Pp
 162 .It Li KOI8-R
 163 Interpret characters with the high-order bit set as Cyrillic characters.
 164 .Pp
 165 .It Li ISO8859-7
 166 Interpret characters with the high-order bit set as Greek characters.
 167 .El
 168 .Sh SEE ALSO
 169 .Xr speaker 4
 170 .Sh HISTORY
 171 Sound support for
 172 .Nm
 173 added by
 174 .An Lyndon Nerenberg (VE7TCP/VE6BBM) Aq lyndon@orthanc.com .
 175 .Pp
 176 Ability to key an external device added by
 177 .An J\(:org Wunsch
 178 (DL8DTL).
 179 .Sh BUGS
 180 Only understands a few European characters
 181 (German and French),
 182 no Asian characters,
 183 and no continental landline code.
 184 .Pp
 185 Sends a bit slower than it should due to system overhead.
 186 Some people would call this a feature.