Skip to content

Design: how should we display subcommands? #8

Description

@yoshuawuyts

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 has GIT COMMANDS and HIGH 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 section

2018-07-19-202102_1920x1080

git-add(1) man page

2018-07-19-202457_1920x1080

Activity

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions