annotate man/man1/hdr.1 @ 0:5242703e91d3 tip

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

.TH HDR 1 "1 September 1993"

.SH NAME
hdr \- Operations on AIM header.

.SH SYNTAX 
hdr [options] [file]

.SH DESCRIPTION
Read an AIM output file. If no filename is given then input is expected
on the stdin. The input from AIM is expected to consist of an AIM header
followed by some data.
The header operations are: stripping, querying, or modifying.

.SH OPTIONS
Options take the form:  <name>=<value>
and abbreviated option names are recognised provided they are unambiguous
wrt other names in the input header.

.nf

1. Stripping. If no options are given, then strip the header
   and write the data which follows the header on the stdout.
   Eg:
	gensai output=stdout ... | hdr | ...

2. Querying. An empty value field (ie. <name>=) is interpreted
   as a query, and the corresponding option value found in the
   header is printed on the stderr.
   Eg., to query the value of option pwidth_aid:

	hdr pwid=  file

   Special option names are:

	"all"       causes all option values to be printed.
	"format"    causes the format of the AIM output file to be printed.

3. Modifying. Each option of the form <name>=<value> is
   substituted for the corresponding option found in the input
   header. A new header is constructed using the input header
   and all given substitutions, and the new header is written
   on the stdout, followed by the data which follows the input
   header.
   Eg., to change the value of pwidth_aid to 32ms:

	hdr pwid=32ms  file >  file2

.fi

.SH "SEE ALSO"
edframe, fbank

.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.