man pages

git-svn-id: file:///home/svn/nwr/trunk@27 103c2249-d0a5-da11-ade6-0050bffea3d9

Makefile.am

@@ -4,6 +4,13 @@ LDADD = @SIGC_LIBS@
 
 bin_PROGRAMS = rec play squelch encode decode plot log streamer splitter monitor
 
+htmldir = $(prefix)/html
+html_DATA = rec.html squelch.html decode.html log.html streamer.html splitter.html
+
+man_MANS = rec.1 squelch.1 decode.1 log.1 streamer.1 splitter.1
+
+EXTRA_DIST = $(man_MANS)
+
 rec_SOURCES = rec.cpp
 
 play_SOURCES = play.cpp
@@ -28,3 +35,6 @@ eas_decode.cpp: fips.inc
 
 fips.inc: ../emwin/data/county.dump fips2inc.pl
 	perl fips2inc.pl ../emwin/data/county.dump >$@
+
+.1.html:
+	rman -f html $< >$@

decode.1

@@ -0,0 +1,36 @@
+.TH decode 1 "March 2003"
+.SH NAME
+decode \- decode SAME signal from audio
+.SH SYNOPSIS
+.B decode
+.I file
+.SH DESCRIPTION
+.B decode
+reads audio data from
+.I file
+(or stdin if
+.I file
+is \-),
+decodes any SAME (Specific Area Message Encoding) digital data,
+and writes the resulting audio clips to disk and email.
+
+The audio clips are written to disk in WAV and MP3 format.
+The
+.IR lame (1)
+audio compressor is used to create the MP3 files.
+.SH OPTIONS
+.IP file
+The file that contains audio data. If \- is specified,
+read from stdin.
+.SH FILES
+.I notify
+.RS
+A text file that contains a list of email addresses
+that the audio clips will be mailed to.
+.SH AUTHOR
+Greg Hewgill <[email protected]>
+.br
+http://www.hewgill.com
+.SH "SEE ALSO"
+.BR lame (1),
+.BR streamer (1)

log.1

@@ -0,0 +1,26 @@
+.TH log 1 "March 2003"
+.SH NAME
+log \- write a stream to a rotating log file
+.SH SYNOPSIS
+.B log
+.I dir
+.SH DESCRIPTION
+.B log
+reads a stream from its stdin,
+and writes the stream to a file in the specified
+.IR dir .
+
+Every hour, the current log file is closed,
+a new one is opened,
+and an older log file is deleted.
+.SH OPTIONS
+.IP dir
+The directory to which the log files will be written.
+.SH 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).
+.SH AUTHOR
+Greg Hewgill <[email protected]>
+.br
+http://www.hewgill.com

rec.1

@@ -0,0 +1,26 @@
+.TH rec 1 "March 2003"
+.SH NAME
+rec \- record from audio device
+.SH SYNOPSIS
+.B rec
+.I file
+.SH DESCRIPTION
+.B rec
+opens an audio device and writes sample data to
+.IR file .
+If
+.I file
+is \-, then write to stdout.
+.SH FILES
+.I /dev/dsp
+.RS
+The audio device from which input data is read.
+.SH BUGS
+There is no way to choose which audio device to use,
+or to change the sampling parameters.
+.SH AUTHOR
+Greg Hewgill <[email protected]>
+.br
+http://www.hewgill.com
+.SH "SEE ALSO"
+.BR play (1)

splitter.1

@@ -0,0 +1,22 @@
+.TH splitter 1 "March 2003"
+.SH NAME
+splitter \- split a single input stream into multiple output streams
+.SH SYNOPSIS
+.B splitter
+.I command ...
+.SH DESCRIPTION
+.B splitter
+reads a stream from its stdin,
+and writes the same stream to the stdin of one or more
+.IR command s.
+.SH OPTIONS
+.IP command
+A shell command to run that will receive its stdin from
+.IR splitter 's
+stdin.
+.SH AUTHOR
+Greg Hewgill <[email protected]>
+.br
+http://www.hewgill.com
+.SH "SEE ALSO"
+.BR tee (1)

squelch.1

@@ -0,0 +1,27 @@
+.TH squelch 1 "March 2003"
+.SH NAME
+squelch \- apply squelch to an audio signal
+.SH SYNOPSIS
+.B squelch
+.I level
+.SH DESCRIPTION
+.B 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 suppressed if its energy level falls
+below a certain threshold
+.IR level .
+A properly adjusted squelch setting suppresses
+background noise but not any of the interesting signal.
+.SH OPTIONS
+.IP level
+The audio level below which the signal will be suppressed.
+.SH AUTHOR
+Greg Hewgill <[email protected]>
+.br
+http://www.hewgill.com
+.SH "SEE ALSO"
+.BR rec (1)

streamer.1

@@ -0,0 +1,38 @@
+.TH streamer 1 "March 2003" hewgill.com "NOAA Weather Radio"
+.SH NAME
+streamer \- serve streaming audio
+.SH SYNOPSIS
+.B streamer
+.SH DESCRIPTION
+.B streamer
+reads audio data from stdin,
+and streams it in MP3 format to clients that connect via HTTP.
+The
+.IR lame (1)
+audio compressor is used to create the MP3 stream.
+
+A station description entry is also maintained on shoutcast.com.
+.SH BUGS
+The following aspects are not configurable:
+options to
+.IR 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.
+.SH FILES
+.I streamer.log
+.RS
+Client connections are logged to this file.
+.SH AUTHOR
+Greg Hewgill <[email protected]>
+.br
+http://www.hewgill.com
+.SH "SEE ALSO"
+.BR decode (1),
+.BR lame (1)