search

tuna-f1sh / cyme

List system USB buses and devices. A modern cross-platform lsusb that attempts to maintain compatibility with, but also add new features
GNU General Public License v3.0
690 stars 13 forks source link

[feature request] man page and tab completion files #42

Open alexanderkjall opened 1 month ago

alexanderkjall commented 1 month ago

Hi

I started to work on packaging this for Debian here: https://salsa.debian.org/rust-team/debcargo-conf/-/tree/master/src/cyme/debian

But it would be really nice to also have a man page for the project and tab completion rules.

I could write the man page myself based on the information in the README, but maybe you have some thoughts about it?

tuna-f1sh commented 1 month ago

Thanks for helping with the packaging! There is actually a man page and shell completions generated for each release in .doc.

They are generated using the clap feature and cyme -F=cli_generate; cargo run -F=cli_generate -- --gen which calls this function. They are used in the build action to create the tarballs: https://github.com/tuna-f1sh/cyme/blob/a7fdf783cb25c158d75502b95236a4cafcd22e46/.github/workflows/build.yml#L141

Unless you were suggesting something else?