Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This implements a man page as in #697
The man page file is
doc/fq.1
formatted as atroff
file using the man-pages project default man page template.You can get a look at how the final man page will run by using
man -l doc/fq.1
The structure of the man page is as follows -
NAME
SYNOPSIS
DESCRIPTION
INVOKING FQ
Command Line Arguments
* Decoding/Encoding Options (-o options)
Supported Formats
CONFIGURATION
THE FQ LANGUAGE
TYPES SPECIFIC TO FQ
Decoded Values
Binary
Binary Array
FUNCTIONS
Functions Added in fq
Naming Inconsistencies
ENCODING, SERIALIZATIONS, HASHES
USE AS SCRIPT INTERPRETER
BUGS (+ KNOWN ISSUES)
AUTHOR
SEE ALSO
Some notes -
"Use representation of a format" not added to examples -- not sure how I could fit it in
Have not included the details of each format (
formats.md
)The section "Display Output" has been merged into "Functions"
The examples for each of the types in "types specific to fq" were not added -- not sure how I should format them
Only the first paragraph of "Encodings, Serializations, Hashes" was added; I couldn't figure out how to structure them
"Own decoders and use as library" section is TODO in usage.md and was not included