Skip to content

Commit

Permalink
add generated html documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
ghewgill committed Aug 23, 2010
1 parent 40e5588 commit a48b0fc
Show file tree
Hide file tree
Showing 9 changed files with 550 additions and 0 deletions.
68 changes: 68 additions & 0 deletions capture.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
<HTML>
<HEAD>
<TITLE>capture.1 manual page</TITLE>
</HEAD>
<BODY>
<H1>capture.1 manual page</H1>
<HR>
<PRE>
<!-- Manpage converted by man2html 3.0.1 -->

</PRE>
<H2>NAME</H2><PRE>
capture - capture EAS alerts from audio


</PRE>
<H2>SYNOPSIS</H2><PRE>
<B>capture</B> <B>[-d</B> <I>dir</I> <B>]</B> <B>[-l</B> <I>log-file</I> <B>]</B> <B>[-s</B> <I>script</I> <B>]</B> <I>file</I>


</PRE>
<H2>DESCRIPTION</H2><PRE>
<B>capture</B> reads audio data from <I>file</I> (or stdin if <I>file</I> 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
<B><A HREF="lame.html">lame(1)</A></B> 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 <I>script</I>
specified in the command line.


</PRE>
<H2>OPTIONS</H2><PRE>
-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.


</PRE>
<H2>AUTHOR</H2><PRE>
Greg Hewgill <a href="mailto:[email protected]">&lt;[email protected]&gt;</a>
<a href="http://hewgill.com">http://hewgill.com</a>


</PRE>
<H2>SEE ALSO</H2><PRE>
<B><A HREF="lame.html">lame(1)</A></B>, <B><A HREF="streamer.html">streamer(1)</A></B>

</PRE>
<HR>
<ADDRESS>
Man(1) output converted with
<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
</ADDRESS>
<!--#include virtual="/google-analytics.inc"-->
</BODY>
</HTML>
58 changes: 58 additions & 0 deletions demux.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
<HTML>
<HEAD>
<TITLE>demux.1 manual page</TITLE>
</HEAD>
<BODY>
<H1>demux.1 manual page</H1>
<HR>
<PRE>
<!-- Manpage converted by man2html 3.0.1 -->

</PRE>
<H2>NAME</H2><PRE>
demux - split a stereo input stream into two mono output
streams


</PRE>
<H2>SYNOPSIS</H2><PRE>
<B>demux</B> <I>leftcommand</I> <I>rightcommand</I>


</PRE>
<H2>DESCRIPTION</H2><PRE>
<B>demux</B> reads a stereo stream from its stdin, and writes the
left channel to the stdin of <I>leftcommand</I>, and the right
channel to the stdin of <I>rightcommand</I>.


</PRE>
<H2>OPTIONS</H2><PRE>
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.


</PRE>
<H2>AUTHOR</H2><PRE>
Greg Hewgill <a href="mailto:[email protected]">&lt;[email protected]&gt;</a>
<a href="http://hewgill.com">http://hewgill.com</a>


</PRE>
<H2>SEE ALSO</H2><PRE>
<B><A HREF="splitter.html">splitter(1)</A></B>

</PRE>
<HR>
<ADDRESS>
Man(1) output converted with
<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
</ADDRESS>
<!--#include virtual="/google-analytics.inc"-->
</BODY>
</HTML>
63 changes: 63 additions & 0 deletions emailer.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
<HTML>
<HEAD>
<TITLE>emailer.1 manual page</TITLE>
</HEAD>
<BODY>
<H1>emailer.1 manual page</H1>
<HR>
<PRE>
<!-- Manpage converted by man2html 3.0.1 -->

</PRE>
<H2>NAME</H2><PRE>
emailer - email EAS alerts


</PRE>
<H2>SYNOPSIS</H2><PRE>
<B>emailer</B> <B>[-f</B> <I>from-address</I> <B>]</B> <B>[-n</B> <I>notify-file</I> <B>]</B> <I>code</I> <I>filename</I>


</PRE>
<H2>DESCRIPTION</H2><PRE>
<B>emailer</B> prepares a formatted email message from a given
EAS code and MP3 file, and sends it to a list of addresses
specified in <I>notify-file</I>.


</PRE>
<H2>OPTIONS</H2><PRE>
-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.


</PRE>
<H2>AUTHOR</H2><PRE>
Greg Hewgill <a href="mailto:[email protected]">&lt;[email protected]&gt;</a>
<a href="http://hewgill.com">http://hewgill.com</a>


</PRE>
<H2>SEE ALSO</H2><PRE>
<B><A HREF="capture.html">capture(1)</A></B>

</PRE>
<HR>
<ADDRESS>
Man(1) output converted with
<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
</ADDRESS>
<!--#include virtual="/google-analytics.inc"-->
</BODY>
</HTML>
58 changes: 58 additions & 0 deletions insertdb.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
<HTML>
<HEAD>
<TITLE>insertdb.1 manual page</TITLE>
</HEAD>
<BODY>
<H1>insertdb.1 manual page</H1>
<HR>
<PRE>
<!-- Manpage converted by man2html 3.0.1 -->

</PRE>
<H2>NAME</H2><PRE>
insertdb - insert EAS alerts into database


</PRE>
<H2>SYNOPSIS</H2><PRE>
<B>insertdb</B> <B>[-s</B> <I>station</I> <B>]</B> <I>code</I> <I>filename</I>


</PRE>
<H2>DESCRIPTION</H2><PRE>
<B>insertdb</B> inserts a record into a database containing the
information from the EAS alert message.


</PRE>
<H2>OPTIONS</H2><PRE>
-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.


</PRE>
<H2>AUTHOR</H2><PRE>
Greg Hewgill <a href="mailto:[email protected]">&lt;[email protected]&gt;</a>
<a href="http://hewgill.com">http://hewgill.com</a>


</PRE>
<H2>SEE ALSO</H2><PRE>
<B><A HREF="capture.html">capture(1)</A></B>

</PRE>
<HR>
<ADDRESS>
Man(1) output converted with
<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
</ADDRESS>
<!--#include virtual="/google-analytics.inc"-->
</BODY>
</HTML>
56 changes: 56 additions & 0 deletions log.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
<HTML>
<HEAD>
<TITLE>log.1 manual page</TITLE>
</HEAD>
<BODY>
<H1>log.1 manual page</H1>
<HR>
<PRE>
<!-- Manpage converted by man2html 3.0.1 -->

</PRE>
<H2>NAME</H2><PRE>
log - write a stream to a rotating log file


</PRE>
<H2>SYNOPSIS</H2><PRE>
<B>log</B> <I>dir</I>


</PRE>
<H2>DESCRIPTION</H2><PRE>
<B>log</B> reads a stream from its stdin, and writes the stream
to a file in the specified <I>dir</I>.

Every hour, the current log file is closed, a new one is
opened, and an older log file is deleted.


</PRE>
<H2>OPTIONS</H2><PRE>
dir The directory to which the log files will be writ-
ten.


</PRE>
<H2>BUGS</H2><PRE>
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).


</PRE>
<H2>AUTHOR</H2><PRE>
Greg Hewgill <a href="mailto:[email protected]">&lt;[email protected]&gt;</a>
<a href="http://hewgill.com">http://hewgill.com</a>

</PRE>
<HR>
<ADDRESS>
Man(1) output converted with
<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
</ADDRESS>
<!--#include virtual="/google-analytics.inc"-->
</BODY>
</HTML>
62 changes: 62 additions & 0 deletions rec.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
<HTML>
<HEAD>
<TITLE>rec.1 manual page</TITLE>
</HEAD>
<BODY>
<H1>rec.1 manual page</H1>
<HR>
<PRE>
<!-- Manpage converted by man2html 3.0.1 -->

</PRE>
<H2>NAME</H2><PRE>
rec - record from audio device


</PRE>
<H2>SYNOPSIS</H2><PRE>
<B>rec</B> <B>[-s]</B> <I>file</I>


</PRE>
<H2>DESCRIPTION</H2><PRE>
<B>rec</B> opens an audio device and writes sample data to <I>file</I>.
If <I>file</I> is -, then write to stdout.


</PRE>
<H2>OPTIONS</H2><PRE>
-s Record both left and right stereo channels.


</PRE>
<H2>FILES</H2><PRE>
<I>/dev/dsp</I>
The audio device from which input data is read.


</PRE>
<H2>BUGS</H2><PRE>
There is no way to choose which audio device to use, or to
change the sampling parameters.


</PRE>
<H2>AUTHOR</H2><PRE>
Greg Hewgill <a href="mailto:[email protected]">&lt;[email protected]&gt;</a>
<a href="http://hewgill.com">http://hewgill.com</a>


</PRE>
<H2>SEE ALSO</H2><PRE>
<B><A HREF="play.html">play(1)</A></B>

</PRE>
<HR>
<ADDRESS>
Man(1) output converted with
<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
</ADDRESS>
<!--#include virtual="/google-analytics.inc"-->
</BODY>
</HTML>
Loading

0 comments on commit a48b0fc

Please sign in to comment.