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. Neither the name of the University nor the names of its contributors
  14 .\"    may be used to endorse or promote products derived from this software
  15 .\"    without specific prior written permission.
  16 .\"
  17 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  18 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  21 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  23 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  24 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  25 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  26 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27 .\" SUCH DAMAGE.
  28 .\"
  29 .\"     @(#)bcd.6       8.1 (Berkeley) 5/31/93
  30 .\" $FreeBSD: src/games/morse/morse.6,v 1.4.2.7 2003/01/26 02:57:27 keramida Exp $
  31 .\"
  32 .Dd May 30, 2008
  33 .Dt MORSE 6
  34 .Os
  35 .Sh NAME
  36 .Nm morse
  37 .Nd reformat input as morse code
  38 .Sh SYNOPSIS
  39 .Nm
  40 .Op Fl o
  41 .Op Fl p
  42 .Op Fl P Ar dspdevice
  43 .Op Fl d Ar device
  44 .Op Fl e
  45 .Op Fl w Ar speed
  46 .Op Fl W Ar speed
  47 .Op Fl f Ar frequency
  48 .Op Fl s
  49 .Op Ar string ...
  50 .Sh DESCRIPTION
  51 The command
  52 .Nm
  53 read the given input and reformat 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 flag
  58 .It Fl s
  59 The
  60 .Fl s
  61 option produces dots and dashes rather than words.
  62 .It Fl o
  63 Write 16bit signed, 44.1kHz native endian sound data
  64 to the file specified by
  65 .Fl P ,
  66 or, if not specified, to standard out.
  67 .It Fl p
  68 Send morse the real way. This only works if your system has
  69 .Xr sound 4
  70 support.
  71 .It Fl P Ar dspdevice
  72 Select a different dsp device from the default
  73 .Pa /dev/dsp .
  74 .It Fl w Ar speed
  75 Set the sending speed in words per minute. If not specified the default
  76 speed of 20 WPM is used.
  77 .It Fl W Ar speed
  78 Enable Farnsworth keying.
  79 The argument to
  80 .Fl w
  81 will set the character keying speed and the argument to
  82 .Fl W
  83 will set the spacing between character and words.
  84 .It Fl f Ar frequency
  85 Set the sidetone frequency to something other than the default 600 Hz.
  86 .It Fl d Ar device
  87 Similar to
  88 .Fl p ,
  89 but use the RTS line of
  90 .Ar device
  91 (which must by a tty device)
  92 in order to emit the morse code.
  93 .It Fl e
  94 echo each character before it is sent, used together with either
  95 .Fl p
  96 or
  97 .Fl d .
  98 .El
  99 .Pp
 100 The
 101 .Fl w ,
 102 .Fl W ,
 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. Use
 112 angle brackets to create a ligature, like
 113 .Ql <KA> .
 114 The more common prosigns are
 115 .Ql =
 116 for
 117 .Em BT ,
 118 .Ql \&(
 119 for
 120 .Em KN
 121 and
 122 .Ql +
 123 for
 124 .Em AR .
 125 .Pp
 126 Using flag
 127 .Fl d Ar device
 128 it is possible to key an external device, like a sidetone generator with
 129 a headset for training purposes, or even your ham radio transceiver.  For
 130 the latter, simply connect an NPN transistor to the serial port
 131 .Ar device ,
 132 emitter connected to ground, base connected through a resistor
 133 (few kiloohms) to RTS, collector to the key line of your transceiver
 134 (assuming the transceiver has a positive key supply voltage and is keyed
 135 by grounding the key input line).  A capacitor (some nanofarads) between
 136 base and ground is advisable to keep stray RF away,
 137 and to suppress the
 138 minor glitch that is generated during program startup.
 139 .Sh ENVIRONMENT
 140 If your
 141 .Ev LC_CTYPE
 142 locale codeset is
 143 .Ql KOI8-R ,
 144 characters with the high-order bit set are interpreted as
 145 Cyrillic characters.  If your
 146 .Ev LC_CTYPE
 147 locale codeset is
 148 .Ql ISO8859-1
 149 compatible,
 150 they are interpreted
 151 as belonging to the
 152 .Ql ISO-8859-1
 153 character set.
 154 .Sh SEE ALSO
 155 .Xr sound 4
 156 .Sh HISTORY
 157 Sound support for
 158 .Nm
 159 added by
 160 .An Lyndon Nerenberg (VE7TCP/VE6BBM) Aq Mt lyndon@orthanc.com
 161 and later converted to use
 162 .Xr sound 4
 163 by
 164 .An Simon 'corecode' Schubert Aq Mt corecode@fs.ei.tum.de .
 165 .Pp
 166 Ability to key an external device added by
 167 .An J\(:org Wunsch
 168 (DL8DTL).
 169 .Sh BUGS
 170 Only understands a few European characters
 171 (German and French),
 172 no Asian characters,
 173 and no continental landline code.
 174 .Pp
 175 Sends a bit slower than it should due to system overhead. Some people
 176 would call this a feature.