doc: Add man page #764
Open
doc: Add man page #764
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
wader
reviewed
Sep 8, 2023
| .RE | ||
| .RE | ||
| .SS Supported Formats | ||
| Use \fBfq --help formats\fR to get a list of supported formats |
There was a problem hiding this comment.
If we're not going to auto generate this man page maybe this could instead give example how to list supported formats?
There was a problem hiding this comment.
I'm not sure I understand this question, isn't fq --help formats the way to list supported formats?
There was a problem hiding this comment.
Ah sorry i totally missed that, only saw the list of formats :) and what i was wondering was if we should include the list in the man page or not as it will have to be manually kept up to date if we don't update/generate it with make doc etc.
wader
reviewed
Sep 8, 2023
| fq \- jq for binary formats | ||
|
|
||
| .SH SYNOPSIS | ||
| \fBfq\fR [\fI\,OPTION\/\fR]... [--] \fI\,EXPR [\fI\,FILE\/\fR]... |
There was a problem hiding this comment.
It would be nice to have some usage examples here i think. maybe same as shown for fq -h?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.1formatted as atrofffile 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.1The 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