.\"=============================================================================
.\" Header
.\"
.\" Copyright (c) 2018-2019 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-hfp 1 2019-01-31 Unix "canlock-hp 3.1.0 manual"
.\"
.\"
.\"=============================================================================
.\" NAME section
.\"
.SH NAME
canlock-hfp \- CLI frontend for libcanlock library
.\"
.\"
.\"=============================================================================
.\" SYNOPSIS section
.\"
.SH SYNOPSIS
.B canlock-hfp
-h | -v
.PP
.B canlock-hfp
[-d] [-n]
.\"
.\"
.\"=============================================================================
.\" DESCRIPTION section
.\"
.SH DESCRIPTION
Header Field Parser (hfp) for RFC 8315 conformant header fields.
.PP
The header field is read from stdin.
.PP
The input data must be an unfolded "Cancel-Lock" or "Cancel-Key" header field
without line break at the end. The utility
.BR canlock-mhp (1)
can be used to extract the field from an article.
.PP
If such a header field is found, it is parsed according to the syntax defined in
RFC 8315. If valid c-lock or c-key (respectively) elements are found, they are
printed to stdout with SP (Space) as delimiter.
.PP
Note: Additional formatting output is printed on stderr to make the output more
human readable on a terminal. Redirect stderr to /dev/null if this is not
wanted.
.\"
.\"
.\"=============================================================================
.\" OPTIONS section
.\"
.SH OPTIONS
The following options are supported:
.TP 25
.BI -d
Enable debug mode (messages are printed to stderr).
.TP
.BI -h
Print help message, then exit.
.TP
.BI -n
Prepend the data on stdout with the header field name (including the colon)
and a SP (Space) delimiter.
.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-hfp
tries to comply with the following standards:
.PP
RFC8315
.\"
.\"
.\"=============================================================================
.\" SEE ALSO section
.\"
.SH SEE ALSO
.BR canlock-mhp (1),
.BR canlock (1)
.\"
.\"
.\" EOF