.\"=============================================================================
.\" Header
.\"
.\" Copyright (c) 2018 Michael Baeuerle
.\"
.\" All rights reserved.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining
.\" a copy of this software and associated documentation files (the
.\" "Software"), to deal in the Software without restriction, including
.\" without limitation the rights to use, copy, modify, merge, publish,
.\" distribute, and/or sell copies of the Software, and to permit persons
.\" to whom the Software is furnished to do so, provided that the above
.\" copyright notice(s) and this permission notice appear in all copies of
.\" the Software and that both the above copyright notice(s) and this
.\" permission notice appear in supporting documentation.
.\"
.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
.\" EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
.\" OF THIRD PARTY RIGHTS. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
.\"  HOLDERS INCLUDED IN THIS NOTICE BE LIABLE FOR ANY CLAIM, OR 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.
.\"
.\" Except as contained in this notice, the name of a copyright holder
.\" shall not be used in advertising or otherwise to promote the sale, use
.\" or other dealings in this Software without prior written authorization
.\" of the copyright holder.
.\"
.TH canlock-mhp 1 2019-01-31 Unix "canlock-hp 3.1.0 manual"
.\"
.\"
.\"=============================================================================
.\" NAME section
.\"
.SH NAME
canlock-mhp \- CLI frontend for libcanlock library
.\"
.\"
.\"=============================================================================
.\" SYNOPSIS section
.\"
.SH SYNOPSIS
.B canlock-mhp
-h | -v
.PP
.B canlock-mhp
-f fieldname
.\"
.\"
.\"=============================================================================
.\" DESCRIPTION section
.\"
.SH DESCRIPTION
Message Header Parser (mhp) for RFC5536 conformant Netnews articles.
.PP
The name of a single header field must be specified with the -f option.
.PP
The message in canonical format (with US-ASCII encoded CRLF line breaks) is
read from stdin. If the message is in some local format (e.g. EBCDIC encoded
or with LF line breaks), ist must be converted to canonical format before it
can be used as input.
.PP
The input data may be a naked header without message body, but the empty line
separater after the header must always be present.
The syntax of the extracted header field is not checked beyond the folding.
The rest of the message need not be fully RFC5536 conformant too, as long as
all header fields start on new lines (and are correctly folded, so that there
is no ambiguity). Common syntax errors (like 8bit characters in the header)
are ignored.
.PP
If the specified header field is found, it is extracted, unfolded and printed
to stdout (without trailing line break).
.\"
.\"
.\"=============================================================================
.\" OPTIONS section
.\"
.SH OPTIONS
The following options are supported:
.TP 25
.BI -f " fieldname
Specify the header field name to search for (without the colon).
.TP
.BI -h
Print help message, then exit.
.TP
.BI -v
Print version and compile time options, then exit.
.\"
.\"
.\"=============================================================================
.\" EXIT STATUS section
.\"
.SH EXIT STATUS
Zero on success or regular exit respectively.
.br
All other values indicate an error.
.\"
.\"
.\"=============================================================================
.\" AUTHORS section
.\"
.SH AUTHORS
Michael Baeuerle
.\"
.\"
.\"=============================================================================
.\" REPORTING BUGS section
.\"
.SH REPORTING BUGS
Report bugs to <mailto:michael.baeuerle@gmx.net>.
.\"
.\"
.\"=============================================================================
.\" STANDARDS section
.\"
.SH STANDARDS
.B canlock-mhp
tries to comply with the following standards:
.PP
RFC5536
.\"
.\"
.\"=============================================================================
.\" SEE ALSO section
.\"
.SH SEE ALSO
.BR canlock-hfp (1),
.BR canlock (1)
.\"
.\"
.\" EOF