-
Notifications
You must be signed in to change notification settings - Fork 9
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
Design: how should we display subcommands? #8
Comments
Right now I'm thinking separate man pages is the right way to go. It's the way |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
I'm not sure how we should be handling subcommands. Should we create separate man pages? Should we create a single man page? It'd be super useful to gather prior art so we can figure out some of the options we have!
Ideally we could find a default that works for most people, and start by implementing that.
Let's start by looking at how
git(1)
does it.Example: Git
Git create separate man pages for its subcommands. The
git
man page hasGIT COMMANDS
andHIGH LEVEL COMMANDS
sections listing these commands.Each subcommand has its own page, like you'd expect from any other man page.
Screenshots
git(1)
commands sectiongit-add(1)
man pageThe text was updated successfully, but these errors were encountered: