diff man/man1/bufwave.1 @ 0:5242703e91d3 tip

Initial checkin for AIM92 aimR8.2 (last updated May 1997).

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/man/man1/bufwave.1	Fri May 20 15:19:45 2011 +0100
@@ -0,0 +1,98 @@
+.TH BUFWAVE 1 "1 September 1993"
+
+.SH NAME
+bufwave \-   a shifting waveform buffer.
+
+.SH SYNTAX 
+bufwave [options] [file]
+
+.SH DESCRIPTION
+A buffer (or window) is shifted along the input, and the
+contents of the buffer are written to the stdout on each shift.
+
+.SH OPTIONS
+
+1. width, frstep.
+
+Input is buffered in frames of size `width' samples, and the buffer is
+shifted along the input in steps of `frstep' samples.
+Both `width' and `frstep' may be given with time units (s or ms), in which
+case the they are converted to a number of samples using the given
+`samplerate' option.
+
+2. type.
+
+The `type' option sets the size of a binary sample in bytes.
+Standard type names are recognised (char, short, int, float, double).
+For example, type=1 is synonymous with type=char, both specifying a
+binary sample of 1 byte.
+
+The special case of type=ASCII sets a sample to be a line of ASCII text
+(delimited by a CR), of size up to a maximum number of characters set by
+the `length' option.
+
+3. frame.
+
+The `frame' option selects a sequence of contiguous frames for output by:
+
+.nf
+	      frame=a[-b]
+.fi
+
+where `a' and `b' are frame numbers: 1,2,3,...
+The upper limit `b' is optional, and when it is missing then the frame
+sequence is a single frame, otherwise `a' and `b' are inclusive limits.
+The strings "min" and "max" are recognised as extreme limits.
+
+4. start.
+
+The `start' option is an offset to the start of the first frame in samples.
+If given with time units, the start is converted to samples using the
+given `samplerate' option.
+
+5. reverse.
+
+The `reverse' option causes each buffer to be written out in reverse order
+of its samples.
+
+.SH EXAMPLES
+
+1. A half-frame overlapping rectangular window of size 10ms.
+
+.nf
+	bufwave width=10ms frstep=5ms file
+.fi
+
+2. Reverse the contents of each frame of a given sequence of 75-sample frames.
+
+.nf
+	bufwave rev=on width=75 frstep=75 file
+.fi
+
+.SH "SEE ALSO"
+options edwave
+
+.SH COPYRIGHT
+.LP
+Copyright (c) Applied Psychology Unit, Medical Research Council, 1995
+.LP
+Permission to use, copy, modify, and distribute this software without fee 
+is hereby granted for research purposes, provided that this copyright 
+notice appears in all copies and in all supporting documentation, and that 
+the software is not redistributed for any fee (except for a nominal 
+shipping charge). Anyone wanting to incorporate all or part of this 
+software in a commercial product must obtain a license from the Medical 
+Research Council.
+.LP
+The MRC makes no representations about the suitability of this 
+software for any purpose.  It is provided "as is" without express or 
+implied warranty.
+.LP
+THE MRC DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING 
+ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL 
+THE A.P.U. BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES 
+OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, 
+WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, 
+ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS 
+SOFTWARE.
+