Man pages #1858
Merged
Man pages #1858
Conversation
This file contains hidden or 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
This was referenced Sep 24, 2025
thomas-zahner
force-pushed
the
man-pages
branch
3 times, most recently
from
cc3b5af to
5de2bf2
Compare
thomas-zahner
commented
Oct 3, 2025
thomas-zahner
force-pushed
the
man-pages
branch
from
3b87e6a to
346ac64
Compare
mre
reviewed
Oct 9, 2025
mre
reviewed
Oct 9, 2025
thomas-zahner
force-pushed
the
man-pages
branch
2 times, most recently
from
fad19db to
6a0e752
Compare
mre
reviewed
Oct 16, 2025
mre
reviewed
Oct 16, 2025
mre
reviewed
Oct 16, 2025
mre
reviewed
Oct 16, 2025
mre
reviewed
Oct 16, 2025
mre
reviewed
Oct 16, 2025
mre
reviewed
Oct 16, 2025
thomas-zahner
force-pushed
the
man-pages
branch
2 times, most recently
from
a6e27f0 to
ad2ab4c
Compare
mre
approved these changes
Oct 16, 2025
Co-authored-by: Matthias Endler <[email protected]>
Update lychee-bin/src/options.rs Co-authored-by: Matthias Endler <[email protected]>
…o cover the change from now on
thomas-zahner
force-pushed
the
man-pages
branch
from
14d5f4b to
ce8f104
Compare
thomas-zahner
force-pushed
the
man-pages
branch
from
ce8f104 to
3f74b10
Compare
This was referenced Oct 15, 2025
Closed
Closed
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Man page generation now works. This closes #1789 and closes #1505. I've added a
--generateflag to generate the man page. This makes the generation nicely contained in lychee itself. This is exactly how ripgrep does it and that's where I got the idea from. We can use--generatefor shell completions as well, see #1564You can inspect the man pages as follows:
cargo run - --generate man | man -l -where of courselycheewill be used in place ofcargo runonce it is released. Generation is also done as part of the pipeline, where I now also include documentation as part of the release, again inspired by ripgrep. Until now we only shipped the binary with releases no documentation at all. I haven't yet tested the pipeline on GitHub as I couldn't run it on my branch.One thing to note is that the man page does not yet list OPTIONS in alphabetical order. This is asymmetrical to
--helpwhich is why I've worked on clap-rs/clap#6142. But this issue is independent of this PR. Once it is fixed in clap_mangen we just need await a release and bump the dependencies to get that to work.@mre what do you think?