.TH READHEADER 1carl CARL
.SH NAME
readheader \- read a header on a floatsam stream
.SH SYNOPSIS
.B readheader 
< floatsams > header
.br
or
.br
.B rdheader -e
< floatsams > floatsams, and >& header
.SH DESCRIPTION
In the first usage,
.B readheader 
reads samples from the
.I stdin, 
and prints any header it finds on the
.I stdout
in human-readable form.
It throws away any input samples.
.PP
If the -e flag is given, 
.B readheader
writes the input floatsams to 
.I stdout
(the header will remain on the data)
and the human-readable header is written to
.I stderr.
Thus, with the -e flag, 
.B readheader
can be inserted as a ``test probe''
in a cascade of pipes to print out the header
at that point, and to pass along the floatsams and the header
untouched.
.SH DIAGNOSTICS
If no header is present on the data, it says ``readheader: no header''.
.SH AUTHOR
Gareth Loy
.SH SEE ALSO
stripheader(1carl)
