Skip to content

Man pages #1858

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
thomas-zahner merged 18 commits into from
Oct 17, 2025
Merged

Man pages #1858

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
4ac5a6e
Man page generation working
thomas-zahner Sep 19, 2025
f78d99a
Remove empty default value from documentation
thomas-zahner Sep 19, 2025
837ea2d
Update docs
thomas-zahner Sep 19, 2025
c396847
Test for alphabetically sorted command line arguments
thomas-zahner Sep 20, 2025
b26a88b
Sort argument order with clap's next_display_order
thomas-zahner Sep 25, 2025
5d43b43
Add --generate flag to generate man page
thomas-zahner Oct 2, 2025
cf3e6cb
Update parameter order in README.md
thomas-zahner Oct 2, 2025
3ceceb9
Include documentation with man page in releases
thomas-zahner Oct 2, 2025
1ce4c23
Add authors to man page & include myself as author
thomas-zahner Oct 3, 2025
f26589a
Add exit codes to man page
thomas-zahner Oct 3, 2025
fa31e33
Update README.md
thomas-zahner Oct 9, 2025
1e62ee3
Apply suggestions from code review
thomas-zahner Oct 9, 2025
1ffb2eb
Add example & bug report sections
thomas-zahner Oct 10, 2025
6f87a42
Update lychee-bin/src/commands/generate.rs
thomas-zahner Oct 16, 2025
23dc8a1
Sync README with help message & update test_readme_usage_up_to_date t…
thomas-zahner Oct 16, 2025
cc5494e
Update test
thomas-zahner Oct 16, 2025
3f74b10
Extract functions into test-utils
thomas-zahner Oct 16, 2025
d8afe2c
Test commands in EXAMPLES section of the man page
thomas-zahner Oct 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Include documentation with man page in releases
  • Loading branch information
@thomas-zahner
thomas-zahner committed Oct 16, 2025
commit 3ceceb92acb4c7a2868a9b2454a7585de07e8bc0
5 changes: 4 additions & 1 deletion .github/workflows/release-binary.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,10 @@ jobs:
cd target/${{ matrix.target }}/release
${GNU_PREFIX}strip lychee
chmod +x lychee
tar -c lychee | gzip > lychee.tar.gz
mkdir docs
cp ../../../{README.md, docs/TROUBLESHOOTING.md} docs
./lychee --generate man > docs/lychee.1
tar -c lychee docs/ | gzip > lychee.tar.gz

- name: Upload binary
uses: actions/upload-release-asset@v1
Expand Down
0 PRE_COMMIT.md → docs/PRE_COMMIT.md
View file
Open in desktop
File renamed without changes.