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 June 7, 2005
  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 c Ar speed
  48 .Op Fl f Ar frequency
  49 .Op Ar string ...
  50 .Sh DESCRIPTION
  51 The
  52 .Nm
  53 command reads the given input and reformats it in the form of morse code.
  54 Acceptable input are command line arguments or the standard input.
  55 .Pp
  56 Available options:
  57 .Bl -tag -width indent
  58 .It Fl l
  59 The
  60 .Fl l
  61 option produces output suitable for
  62 .Xr led 4
  63 devices.
  64 .It Fl s
  65 The
  66 .Fl s
  67 option produces dots and dashes rather than words.
  68 .It Fl p
  69 Send morse the real way.
  70 This only works if your system has
  71 .Xr speaker 4
  72 support.
  73 .It Fl w Ar speed
  74 Set the sending speed in words per minute.
  75 If not specified, the default
  76 speed of 20 WPM is used.
  77 .It Fl c Ar speed
  78 Farnsworth support.
  79 Set the spacing between characters in words per minute.
  80 This is independent of the speed
  81 that the individual characters are sent.
  82 If not specified, defaults to the effective value of the
  83 .Fl w
  84 option.
  85 .It Fl f Ar frequency
  86 Set the sidetone frequency to something other than the default 600 Hz.
  87 .It Fl d Ar device
  88 Similar to
  89 .Fl p ,
  90 but use the RTS line of
  91 .Ar device
  92 (which must by a TTY device)
  93 in order to emit the morse code.
  94 .It Fl e
  95 Echo each character before it is sent, used together with either
  96 .Fl p
  97 or
  98 .Fl d .
  99 .El
 100 .Pp
 101 The
 102 .Fl w , c
 103 and
 104 .Fl f
 105 flags only work in conjunction with either the
 106 .Fl p
 107 or the
 108 .Fl d
 109 flag.
 110 .Pp
 111 Not all prosigns have corresponding characters.
 112 Use
 113 .Ql #
 114 for
 115 .Em AS ,
 116 .Ql &
 117 for
 118 .Em SK ,
 119 .Ql *
 120 for
 121 .Em VE
 122 and
 123 .Ql %
 124 for
 125 .Em BK .
 126 The more common prosigns are
 127 .Ql =
 128 for
 129 .Em BT ,
 130 .Ql \&(
 131 for
 132 .Em KN
 133 and
 134 .Ql +
 135 for
 136 .Em AR .
 137 .Pp
 138 Using the
 139 .Fl d
 140 flag,
 141 it is possible to key an external device, like a sidetone generator with
 142 a headset for training purposes, or even your ham radio transceiver.
 143 For
 144 the latter, simply connect an NPN transistor to the serial port
 145 .Ar device ,
 146 emitter connected to ground, base connected through a resistor
 147 (few kiloohms) to RTS, collector to the key line of your transceiver
 148 (assuming the transceiver has a positive key supply voltage and is keyed
 149 by grounding the key input line).
 150 A capacitor (some nanofarads) between
 151 base and ground is advisable to keep stray RF away,
 152 and to suppress the
 153 minor glitch that is generated during program startup.
 154 .Sh ENVIRONMENT
 155 Your
 156 .Ev LC_CTYPE
 157 locale codeset determines how
 158 characters with the high-order bit set
 159 are interpreted.
 160 .Pp
 161 .Bl -tag -width ".Li ISO8859-15" -compact
 162 .It Li ISO8859-1
 163 .It Li ISO8859-15
 164 Interpret characters with the high-order bit set as Western European characters.
 165 .Pp
 166 .It Li KOI8-R
 167 Interpret characters with the high-order bit set as Cyrillic characters.
 168 .Pp
 169 .It Li ISO8859-7
 170 Interpret characters with the high-order bit set as Greek characters.
 171 .El
 172 .Sh FILES
 173 .Bl -tag -width ".Pa /dev/speaker" -compact
 174 .It Pa /dev/speaker
 175 .Xr speaker 4
 176 device file
 177 .El
 178 .Sh SEE ALSO
 179 .Xr speaker 4
 180 .Sh HISTORY
 181 Sound support for
 182 .Nm
 183 added by
 184 .An Lyndon Nerenberg (VE6BBM) Aq lyndon@orthanc.ca .
 185 .Pp
 186 Ability to key an external device added by
 187 .An J\(:org Wunsch
 188 (DL8DTL).
 189 .Pp
 190 Farnsworth support for
 191 .Nm
 192 added by
 193 .An Stephen Cravey (N5UUU).
 194 .Sh BUGS
 195 Only understands a few European characters
 196 (German and French),
 197 no Asian characters,
 198 and no continental landline code.
 199 .Pp
 200 Sends a bit slower than it should due to system overhead.
 201 Some people would call this a feature.