From a48b0fcec568855760321d6e33569ae3657998df Mon Sep 17 00:00:00 2001 From: Greg Hewgill Date: Mon, 23 Aug 2010 20:49:23 +1200 Subject: [PATCH] add generated html documentation --- capture.html | 68 +++++++++++++++++++++++++++++++++++++++++++++ demux.html | 58 +++++++++++++++++++++++++++++++++++++++ emailer.html | 63 ++++++++++++++++++++++++++++++++++++++++++ insertdb.html | 58 +++++++++++++++++++++++++++++++++++++++ log.html | 56 +++++++++++++++++++++++++++++++++++++ rec.html | 62 +++++++++++++++++++++++++++++++++++++++++ splitter.html | 53 +++++++++++++++++++++++++++++++++++ squelch.html | 56 +++++++++++++++++++++++++++++++++++++ streamer.html | 76 +++++++++++++++++++++++++++++++++++++++++++++++++++ 9 files changed, 550 insertions(+) create mode 100644 capture.html create mode 100644 demux.html create mode 100644 emailer.html create mode 100644 insertdb.html create mode 100644 log.html create mode 100644 rec.html create mode 100644 splitter.html create mode 100644 squelch.html create mode 100644 streamer.html diff --git a/capture.html b/capture.html new file mode 100644 index 0000000..27975a0 --- /dev/null +++ b/capture.html @@ -0,0 +1,68 @@ + + +capture.1 manual page + + +

capture.1 manual page

+
+
+
+
+
+

NAME

+       capture - capture EAS alerts from audio
+
+
+
+

SYNOPSIS

+       capture [-d dir ] [-l log-file ] [-s script ] file
+
+
+
+

DESCRIPTION

+       capture  reads  audio  data from file (or stdin if file is
+       -), decodes any SAME (Specific Area Message Encoding) dig-
+       ital  data,  and writes the resulting alert audio clips to
+       disk.
+
+       The audio clips are written to disk in  MP3  format.   The
+       lame(1)  audio compressor is used to create the MP3 files.
+
+       After creating the audio clip, capture sets  the  environ-
+       ment variables EAS_MESSAGE and EAS_MP3 and runs the script
+       specified in the command line.
+
+
+
+

OPTIONS

+       -d dir The directory where MP3 files will be created.
+
+       -l log-file
+              The log file to which EAS events will be written.
+
+       -s script
+              The command to run after capturing an MP3 file.
+
+       file   The file that contains audio data. If -  is  speci-
+              fied, read from stdin.
+
+
+
+

AUTHOR

+       Greg Hewgill <greg@hewgill.com>
+       http://hewgill.com
+
+
+
+

SEE ALSO

+       lame(1), streamer(1)
+
+
+
+
+Man(1) output converted with +man2html +
+ + + diff --git a/demux.html b/demux.html new file mode 100644 index 0000000..3b6003a --- /dev/null +++ b/demux.html @@ -0,0 +1,58 @@ + + +demux.1 manual page + + +

demux.1 manual page

+
+
+
+
+
+

NAME

+       demux  -  split a stereo input stream into two mono output
+       streams
+
+
+
+

SYNOPSIS

+       demux leftcommand rightcommand
+
+
+
+

DESCRIPTION

+       demux reads a stereo stream from its stdin, and writes the
+       left  channel  to  the stdin of leftcommand, and the right
+       channel to the stdin of rightcommand.
+
+
+
+

OPTIONS

+       leftcommand
+              A shell command to run that will receive its  stdin
+              from the left channel.
+
+       rightcommand
+              A  shell command to run that will receive its stdin
+              from the right channel.
+
+
+
+

AUTHOR

+       Greg Hewgill <greg@hewgill.com>
+       http://hewgill.com
+
+
+
+

SEE ALSO

+       splitter(1)
+
+
+
+
+Man(1) output converted with +man2html +
+ + + diff --git a/emailer.html b/emailer.html new file mode 100644 index 0000000..ddeefe4 --- /dev/null +++ b/emailer.html @@ -0,0 +1,63 @@ + + +emailer.1 manual page + + +

emailer.1 manual page

+
+
+
+
+
+

NAME

+       emailer - email EAS alerts
+
+
+
+

SYNOPSIS

+       emailer [-f from-address ] [-n notify-file ] code filename
+
+
+
+

DESCRIPTION

+       emailer prepares a formatted email message  from  a  given
+       EAS code and MP3 file, and sends it to a list of addresses
+       specified in notify-file.
+
+
+
+

OPTIONS

+       -f from-address
+              The email address used in  the  From:  line.   This
+              address is also used in the To: line.
+
+       -n notify-file
+              A  file  containing  a  list of email addresses, or
+              shell commands preceded by |.
+
+       code   The EAS header code for this message.
+
+       filename
+              The name of the MP3 file containing the alert  mes-
+              sage.
+
+
+
+

AUTHOR

+       Greg Hewgill <greg@hewgill.com>
+       http://hewgill.com
+
+
+
+

SEE ALSO

+       capture(1)
+
+
+
+
+Man(1) output converted with +man2html +
+ + + diff --git a/insertdb.html b/insertdb.html new file mode 100644 index 0000000..4efa54e --- /dev/null +++ b/insertdb.html @@ -0,0 +1,58 @@ + + +insertdb.1 manual page + + +

insertdb.1 manual page

+
+
+
+
+
+

NAME

+       insertdb - insert EAS alerts into database
+
+
+
+

SYNOPSIS

+       insertdb [-s station ] code filename
+
+
+
+

DESCRIPTION

+       insertdb  inserts  a record into a database containing the
+       information from the EAS alert message.
+
+
+
+

OPTIONS

+       -s station
+              This is the station  from  which  the  message  was
+              received.
+
+       code   The EAS header code for this message.
+
+       filename
+              The  name of the MP3 file containing the alert mes-
+              sage.
+
+
+
+

AUTHOR

+       Greg Hewgill <greg@hewgill.com>
+       http://hewgill.com
+
+
+
+

SEE ALSO

+       capture(1)
+
+
+
+
+Man(1) output converted with +man2html +
+ + + diff --git a/log.html b/log.html new file mode 100644 index 0000000..9968a72 --- /dev/null +++ b/log.html @@ -0,0 +1,56 @@ + + +log.1 manual page + + +

log.1 manual page

+
+
+
+
+
+

NAME

+       log - write a stream to a rotating log file
+
+
+
+

SYNOPSIS

+       log dir
+
+
+
+

DESCRIPTION

+       log  reads  a stream from its stdin, and writes the stream
+       to a file in the specified dir.
+
+       Every hour, the current log file is closed, a new  one  is
+       opened, and an older log file is deleted.
+
+
+
+

OPTIONS

+       dir    The  directory to which the log files will be writ-
+              ten.
+
+
+
+

BUGS

+       There is no way  to  change  the  rotation  interval  (one
+       hour),  the  number of log files that are kept (3), or the
+       log filenames used (NWR-*.raw).
+
+
+
+

AUTHOR

+       Greg Hewgill <greg@hewgill.com>
+       http://hewgill.com
+
+
+
+
+Man(1) output converted with +man2html +
+ + + diff --git a/rec.html b/rec.html new file mode 100644 index 0000000..fe8c97b --- /dev/null +++ b/rec.html @@ -0,0 +1,62 @@ + + +rec.1 manual page + + +

rec.1 manual page

+
+
+
+
+
+

NAME

+       rec - record from audio device
+
+
+
+

SYNOPSIS

+       rec [-s] file
+
+
+
+

DESCRIPTION

+       rec  opens an audio device and writes sample data to file.
+       If file is -, then write to stdout.
+
+
+
+

OPTIONS

+       -s     Record both left and right stereo channels.
+
+
+
+

FILES

+       /dev/dsp
+              The audio device from which input data is read.
+
+
+
+

BUGS

+       There is no way to choose which audio device to use, or to
+       change the sampling parameters.
+
+
+
+

AUTHOR

+       Greg Hewgill <greg@hewgill.com>
+       http://hewgill.com
+
+
+
+

SEE ALSO

+       play(1)
+
+
+
+
+Man(1) output converted with +man2html +
+ + + diff --git a/splitter.html b/splitter.html new file mode 100644 index 0000000..4c4ad16 --- /dev/null +++ b/splitter.html @@ -0,0 +1,53 @@ + + +splitter.1 manual page + + +

splitter.1 manual page

+
+
+
+
+
+

NAME

+       splitter  - split a single input stream into multiple out-
+       put streams
+
+
+
+

SYNOPSIS

+       splitter command ...
+
+
+
+

DESCRIPTION

+       splitter reads a stream from its  stdin,  and  writes  the
+       same stream to the stdin of one or more commands.
+
+
+
+

OPTIONS

+       command
+              A  shell command to run that will receive its stdin
+              from splitter's stdin.
+
+
+
+

AUTHOR

+       Greg Hewgill <greg@hewgill.com>
+       http://hewgill.com
+
+
+
+

SEE ALSO

+       tee(1)
+
+
+
+
+Man(1) output converted with +man2html +
+ + + diff --git a/squelch.html b/squelch.html new file mode 100644 index 0000000..11c080c --- /dev/null +++ b/squelch.html @@ -0,0 +1,56 @@ + + +squelch.1 manual page + + +

squelch.1 manual page

+
+
+
+
+
+

NAME

+       squelch - apply squelch to an audio signal
+
+
+
+

SYNOPSIS

+       squelch level
+
+
+
+

DESCRIPTION

+       squelch  reads audio data from stdin, applies a squelching
+       algorithm, and writes the squelched audio to stdout.
+
+       Squelching a signal means that the output signal  is  sup-
+       pressed  if its energy level falls below a certain thresh-
+       old level.  A properly adjusted squelch setting suppresses
+       background noise but not any of the interesting signal.
+
+
+
+

OPTIONS

+       level  The audio level below which the signal will be sup-
+              pressed.
+
+
+
+

AUTHOR

+       Greg Hewgill <greg@hewgill.com>
+       http://hewgill.com
+
+
+
+

SEE ALSO

+       rec(1)
+
+
+
+
+Man(1) output converted with +man2html +
+ + + diff --git a/streamer.html b/streamer.html new file mode 100644 index 0000000..af235bc --- /dev/null +++ b/streamer.html @@ -0,0 +1,76 @@ + + +streamer.1 manual page + + +

streamer.1 manual page

+
+
+
+
+
+

NAME

+       streamer - serve streaming audio
+
+
+
+

SYNOPSIS

+       streamer [-c config-file ]
+
+
+
+

DESCRIPTION

+       streamer  reads  audio  data from stdin, and streams it in
+       MP3 format to clients that connect via HTTP.  The  lame(1)
+       audio compressor is used to create the MP3 stream.
+
+       A  station  description entry is also maintained on shout-
+       cast.com.
+
+
+
+

OPTIONS

+       -c config-file
+              Read the configuration from config-file instead  of
+              from "streamer.conf".
+
+
+
+

BUGS

+       The  following  aspects  are  not configurable: options to
+       lame(1) including the bit rate and quality; the port which
+       listens  for  HTTP  connections;  the  maximum  number  of
+       clients; the address of the shoutcast directory server(s);
+       the  station name shown on shoutcast; other shoutcast info
+       such as urls.
+
+       No attempt is made to adjust the streaming rate  to  match
+       the  MP3  bit rate.  Input data should be supplied in real
+       time.
+
+
+
+

FILES

+       streamer.log
+              Client connections are logged to this file.
+
+
+
+

AUTHOR

+       Greg Hewgill <greg@hewgill.com>
+       http://hewgill.com
+
+
+
+

SEE ALSO

+       capture(1), lame(1)
+
+
+
+
+Man(1) output converted with +man2html +
+ + +