Skip to content
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.

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

Please provide a man page for obs-cli #27

Open
bdrung opened this issue Nov 25, 2021 · 2 comments
Open

Please provide a man page for obs-cli #27

bdrung opened this issue Nov 25, 2021 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@bdrung
Copy link
Contributor

bdrung commented Nov 25, 2021

I am packaging obs-cli for Debian (see Debian bug #1000489). According to Debian, each binary in /usr/bin should have a manual page. See https://lintian.debian.org/tags/no-manual-page for more reasoning.

Please provide a man page for obs-cli. The man page should list which command and subcommand exists and what parameters they take. You can write the man page in Markdown and convert it to nroff. See https://github.com/bdrung/ionit/blob/master/ionit.1.md for an example.

@muesli
Copy link
Owner

muesli commented Nov 26, 2021

Indeed, we should provide one. Since we're using Cobra, we can use it to automatically generate a man page from the command structure within obs-cli.

@muesli
Copy link
Owner

muesli commented Dec 12, 2021

See progress in #33.

@muesli muesli added the documentation Improvements or additions to documentation label Dec 12, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants