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

man pages for detailed documentation #13

Open
UmanShahzad opened this issue Mar 18, 2021 · 1 comment
Open

man pages for detailed documentation #13

UmanShahzad opened this issue Mar 18, 2021 · 1 comment
Milestone

Comments

@UmanShahzad
Copy link
Contributor

UmanShahzad commented Mar 18, 2021

There's actually so many features in the CLI so far for different commands that it's not reasonable to lay everything out in the README or in the inlined -h/--help output.

We should create man pages for individual commands which go into full details of what's possible and which can be accessible in these two ways:

$ man 1 ipinfo-<subcommand>
$ ipinfo <subcommand> --help

This is similar to what git does, e.g.:

$ man 1 git-init
$ git init --help

Need to also figure out how this works in a PowerShell (windows) environment.

@UmanShahzad UmanShahzad added this to the v2 milestone Mar 26, 2021
@UmanShahzad
Copy link
Contributor Author

Tagging this as something we can do for v2.

@UmanShahzad UmanShahzad modified the milestones: v2, v3 May 19, 2021
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

No branches or pull requests

1 participant