Skip to content

feat: add man pages and shell completions#27

Merged
sts10 merged 1 commit intosts10:mainfrom
donovanglover:feat/man-pages-shell-completions
Jul 30, 2024
Merged

feat: add man pages and shell completions#27
sts10 merged 1 commit intosts10:mainfrom
donovanglover:feat/man-pages-shell-completions

Conversation

@donovanglover
Copy link
Copy Markdown
Contributor

Auto-generated with clap.

@sts10
Copy link
Copy Markdown
Owner

sts10 commented Jul 30, 2024

Thanks so much for this. Moving all the Clap stuff out of main.rs feels great!

I do have some basic questions. I would have thought that, after cargo installing this version, I could then run man phraze and get a man page of documentation. However, I get back No manual entry for phraze. I am doing something silly?

@donovanglover
Copy link
Copy Markdown
Contributor Author

You can test the man pages with man --local-file target/man/phraze.1 and the shell completions with source ./target/completions/<your_shell>.

Don't think it's possible to make this work with cargo install but package maintainers will be able to add it to their phraze packages.

@sts10 sts10 merged commit f5d0e84 into sts10:main Jul 30, 2024
@sts10
Copy link
Copy Markdown
Owner

sts10 commented Jul 30, 2024

Don't think it's possible to make this work with cargo install but package maintainers will be able to add it to their phraze packages.

Got it -- makes sense. But anything to make life easier for package maintainers I'm all for. Thanks again -- merged, and a new release (v0.3.13) on the way!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants