update README text

This commit is contained in:
Kamal Mostafa 2012-10-05 20:07:23 -07:00
parent 65493fa12a
commit 1a60f1c12d
3 changed files with 34 additions and 21 deletions

14
README
View File

@ -1,10 +1,14 @@
minimodem - software audio Bell-type or RTTY FSK modem minimodem - general-purpose software audio FSK modem
Copyright (C) 2011-2012 Kamal Mostafa <kamal@whence.com> Copyright (C) 2011-2012 Kamal Mostafa <kamal@whence.com>
Minimodem is a command-line program which generates (or decodes) audio Minimodem is a command-line program which decodes (or generates) audio
modem tones at any specified baud rate, emulating an old Bell-type or modem tones at any specified baud rate, using various framing protocols.
radio-teletype FSK modem. The tones can be played to (or recorded from) It acts a general-purpose software FSK modem, and includes support for
the system audio (PulseAudio or ALSA) or to an audio file. various standard FSK protocols such as Bell103, Bell202, RTTY, NOAA SAME,
and Caller-ID.
Minimodem can play and capture audio modem tones in real-time via the
system audio device, or in batched mode via audio files.
Minimodem can be used to transfer data between nearby computers using an Minimodem can be used to transfer data between nearby computers using an
audio cable (or just via sound waves), or between remote computers using audio cable (or just via sound waves), or between remote computers using

14
debian/control vendored
View File

@ -12,11 +12,15 @@ Package: minimodem
Architecture: any Architecture: any
Depends: ${shlibs:Depends}, ${misc:Depends} Depends: ${shlibs:Depends}, ${misc:Depends}
Suggests: pulseaudio Suggests: pulseaudio
Description: software audio Bell-type or RTTY FSK modem Description: general-purpose software audio FSK modem
Minimodem is a command-line program which generates (or decodes) audio Minimodem is a command-line program which decodes (or generates) audio
modem tones at any specified baud rate, emulating an old Bell-type or modem tones at any specified baud rate, using various framing protocols.
radio-teletype FSK modem. The tones can be played to (or recorded from) It acts a general-purpose software FSK modem, and includes support for
the system audio (PulseAudio or ALSA) or to an audio file. various standard FSK protocols such as Bell103, Bell202, RTTY, NOAA SAME,
and Caller-ID.
.
Minimodem can play and capture audio modem tones in real-time via the
system audio device, or in batched mode via audio files.
. .
Minimodem can be used to transfer data between nearby computers using an Minimodem can be used to transfer data between nearby computers using an
audio cable (or just via sound waves), or between remote computers using audio cable (or just via sound waves), or between remote computers using

View File

@ -2,7 +2,7 @@
.\" First parameter, NAME, should be all caps .\" First parameter, NAME, should be all caps
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
.\" other parameters are allowed: see man(7), man(1) .\" other parameters are allowed: see man(7), man(1)
.TH MINIMODEM 1 "August 19, 2012" .TH MINIMODEM 1 "October 5, 2012"
.\" Please adjust this date whenever revising the manpage. .\" Please adjust this date whenever revising the manpage.
.\" .\"
.\" Some roff macros, for reference: .\" Some roff macros, for reference:
@ -16,7 +16,7 @@
.\" .sp <n> insert n+1 empty lines .\" .sp <n> insert n+1 empty lines
.\" for manpage-specific macros, see man(7) .\" for manpage-specific macros, see man(7)
.SH NAME .SH NAME
minimodem \- software audio Bell-type or RTTY FSK modem minimodem \- general-purpose software audio FSK modem
.SH SYNOPSIS .SH SYNOPSIS
.B minimodem --tx .B minimodem --tx
.RI [ options ] .RI [ options ]
@ -26,16 +26,21 @@ minimodem \- software audio Bell-type or RTTY FSK modem
.RI [ options ] .RI [ options ]
.I {baudmode} .I {baudmode}
.SH DESCRIPTION .SH DESCRIPTION
.B minimodem .B Minimodem
is a command-line program which generates (or decodes) audio is a command-line program which decodes (or generates) audio
modem tones at any specified baud rate, emulating an old Bell-type or modem tones at any specified baud rate, using various framing protocols.
radio-teletype FSK modem. The tones can be played to (or recorded from) It acts a general-purpose software FSK modem, and includes support for
the system audio (PulseAudio or ALSA) or to an audio file. various standard FSK protocols such as Bell103, Bell202, RTTY, NOAA SAME,
and Caller-ID.
.PP .PP
.B minimodem .B Minimodem
can be used to transfer data between nearby computers using an audio can play and capture audio modem tones in real-time via the system
cable (or just via sound waves), or between remote computers using radio, audio device, or in batched mode via audio files.
telephone, or another audio communications medium. .PP
.B Minimodem
can be used to transfer data between nearby computers using an
audio cable (or just via sound waves), or between remote computers using
radio, telephone, or another audio communications medium.
.SH "TX/RX MODE" .SH "TX/RX MODE"
.TP .TP
.B \-t, \-\-tx, \-\-transmit, \-\-write .B \-t, \-\-tx, \-\-transmit, \-\-write