| 1 |
|
| 2 |
canlock-hp |
| 3 |
========== |
| 4 |
Header parsers for libcanlock (a library for creating and verifying RFC 8315 |
| 5 |
Netnews Cancel-Locks). |
| 6 |
|
| 7 |
|
| 8 |
1) General |
| 9 |
libcanlock contains no header parser because some programs already have one. |
| 10 |
If your program uses libcanlock (e.g. via canlock frontend in a script) and has |
| 11 |
no header parser, the utilities in this package can be used to fill the gap. |
| 12 |
|
| 13 |
|
| 14 |
2) System requirements |
| 15 |
- POSIX.1-2001 conformant operating system |
| 16 |
- POSIX C-Language Development Utilities (c99, lex, yacc) |
| 17 |
|
| 18 |
flex and bison are automatically detected as replacements for lex and yacc. |
| 19 |
|
| 20 |
|
| 21 |
3) Versioning scheme |
| 22 |
Formerly canlock-hp was a separate package with own version number. |
| 23 |
The canlock-hp utilities are merged into the libcanlock package since 3.1.0 and |
| 24 |
now use the same version number. |
| 25 |
|
| 26 |
|
| 27 |
canlock-mhp |
| 28 |
=========== |
| 29 |
Message Header Parser (mhp) for RFC 5536 conformant Netnews articles. |
| 30 |
|
| 31 |
The name of a single header field must be specified with the -f option. |
| 32 |
The message in canonical format (with US-ASCII encoded CRLF line breaks) is |
| 33 |
read from stdin. If the message is in some local format (e.g. EBCDIC encoded |
| 34 |
or with LF line breaks), it must be converted to canonical format before it |
| 35 |
can be used as input. |
| 36 |
If the specified header field is found, it is extracted, unfolded and printed |
| 37 |
to stdout. |
| 38 |
|
| 39 |
Note: |
| 40 |
The input data may be a naked header without message body, but the empty line |
| 41 |
separator after the header must always be present. |
| 42 |
The syntax of the extracted header field is not checked beyond the folding. |
| 43 |
The rest of the message need not be fully RFC 5536 conformant too, as long as |
| 44 |
all header fields start on new lines (and are correctly folded, so that there |
| 45 |
is no ambiguity). Common syntax errors (like 8bit characters in the header) |
| 46 |
are ignored. |
| 47 |
|
| 48 |
|
| 49 |
canlock-hfp |
| 50 |
=========== |
| 51 |
Header Field Parser (hfp) for RFC 8315 conformant header fields. |
| 52 |
|
| 53 |
The complete unfolded header field (with its name at the beginning and without |
| 54 |
line break at the end) is read from stdin and strictly parsed for the syntax |
| 55 |
defined in RFC 8315 for the Cancel-Lock and Cancel-Key header fields. |
| 56 |
The c-lock or c-key elements (respectively) are printed to stdout, separated |
| 57 |
with spaces (usable as list of "word"s in the "for" loop of a POSIX shell). |
| 58 |
|
| 59 |
Note: |
| 60 |
Additional notes, line breaks between the elements and potential comments from |
| 61 |
the header field are printed to stderr to make the output more human readable |
| 62 |
on a terminal. |
| 63 |
|
| 64 |
|
| 65 |
libcanlock-hp |
| 66 |
============= |
| 67 |
Since version 3.3.0 the library libcanlock-hp is available. |
| 68 |
It contains header parser API functions for C programs. |
| 69 |
|
| 70 |
The subdirectory "examples" contains programs with demonstration code. |
| 71 |
|
| 72 |
|
| 73 |
EOF |