Add man page #151
Merged
Add man page #151
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
sorairolake
force-pushed
the
doc/man
branch
3 times, most recently
from
562d0d1
to
6d62021
Compare
|
Awesome. Thank you very much for working on this. I would prefer the pandoc Markdown => man page way because I am familiar with this from other projects. And I don't know AsciiDoc. |
sorairolake
force-pushed
the
doc/man
branch
4 times, most recently
from
20131fd
to
292455f
Compare
|
@sharkdp OK. Added the conversion process from Pandoc's Markdown in the CI. Also, I wrote the conversion method in the README. |
sharkdp
reviewed
Mar 25, 2022
doc/hexyl.1.md
Outdated
Comment on lines
69
to
73
| Sets the block size to 1024 bytes: | ||
| : $ **hexyl \--block-size=1024** | ||
|
|
||
| Sets the block size to 4 kilobytes: | ||
| : $ **hexyl \--block-size=4kB** |
There was a problem hiding this comment.
Setting block size alone is not really that interesting. It's only relevant if you use it in one of the other command-line options. As in:
hexyl --block-size=1024 --length=5block …
sharkdp
reviewed
Mar 25, 2022
sharkdp
reviewed
Mar 25, 2022
doc/hexyl.1.md
Outdated
| : $ **hexyl \--block-size=1024 \--length=5block** | ||
|
|
||
| Sets the block size to 4 kilobytes: | ||
| : $ **hexyl \--block-size=4kB \--length=20blocks** |
There was a problem hiding this comment.
Sorry. One more thing. blocks doesn't work, unfortunately. We should either make that work (I'd think it would be relatively easy) or change the man page here once more.
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 is written in
AsciiDoc orPandoc’s Markdown.These can be converted by:
asciidoctor -b manpage doc/hexyl.1.adocpandoc -s -f markdown -t man -o doc/hexyl.1 doc/hexyl.1.mdI will fix to add a conversion process to the CI, add a troff file as well, keep only it, or other. Which one is better?