diff options
author | Bryan Newbold <bnewbold@archive.org> | 2020-06-13 21:25:03 -0700 |
---|---|---|
committer | Bryan Newbold <bnewbold@archive.org> | 2020-06-13 21:25:03 -0700 |
commit | 7f87663dafae89b9e24795f1b8c880e3fda06134 (patch) | |
tree | 7ea01ea481f55b8b36dc628ff2eed9f4cba94825 /rust | |
parent | 9f7347245bce20886eb485ce7910d6610316f563 (diff) | |
download | fatcat-cli-7f87663dafae89b9e24795f1b8c880e3fda06134.tar.gz fatcat-cli-7f87663dafae89b9e24795f1b8c880e3fda06134.zip |
a bit more manpage (still sparse)
Diffstat (limited to 'rust')
-rw-r--r-- | rust/fatcat-cli/fatcat-cli.1 | 39 | ||||
-rw-r--r-- | rust/fatcat-cli/fatcat-cli.1.scdoc | 31 |
2 files changed, 70 insertions, 0 deletions
diff --git a/rust/fatcat-cli/fatcat-cli.1 b/rust/fatcat-cli/fatcat-cli.1 index 7223deb..0831773 100644 --- a/rust/fatcat-cli/fatcat-cli.1 +++ b/rust/fatcat-cli/fatcat-cli.1 @@ -12,14 +12,53 @@ fatcat-cli - something something .P .SH SYNOPSIS .P +fatcat-cli [FLAGS] [OPTIONS] <SUBCOMMAND> +.P +Subcommands: +.P +.RS 4 +create +delete +edit +editgroup +get +help +search +status +update +.P +.RE .SH DESCRIPTION .P .SH OPTIONS .P +\fB-h, --help\fR +.RS 4 +Prints help information +.P +.RE +\fB-V, --version\fR +.RS 4 +Prints version information +.P +.RE +\fB-v, --verbose\fR +.RS 4 +Pass many times for more log output +By default, it'll only report errors. Passing `-v` one time also prints warnings, `-vv` enables info logging, `-vvv` debug, and `-vvvv` trace. +.P +.RE +\fB--api-host <api-host>\fR [env: FATCAT_API_HOST] [default: https://api.fatcat.wiki] +.P +\fB--api-token <api-token>\fR [env: FATCAT_API_AUTH_TOKEN] +.P +\fB--search-host <search-host>\fR [env: FATCAT_SEARCH_HOST] [default: https://search.fatcat.wiki] +.P .SH EXAMPLES .P Some examples of usage will go here, like: .P .RS 4 fatcat-cli get thing +.P .RE diff --git a/rust/fatcat-cli/fatcat-cli.1.scdoc b/rust/fatcat-cli/fatcat-cli.1.scdoc index 32a155d..6a176aa 100644 --- a/rust/fatcat-cli/fatcat-cli.1.scdoc +++ b/rust/fatcat-cli/fatcat-cli.1.scdoc @@ -6,12 +6,43 @@ fatcat-cli - something something # SYNOPSIS +fatcat-cli [FLAGS] [OPTIONS] <SUBCOMMAND> + +Subcommands: + + create + delete + edit + editgroup + get + help + search + status + update + # DESCRIPTION # OPTIONS +*-h, --help* + Prints help information + +*-V, --version* + Prints version information + +*-v, --verbose* + Pass many times for more log output + By default, it'll only report errors. Passing `-v` one time also prints warnings, `-vv` enables info logging, `-vvv` debug, and `-vvvv` trace. + +*--api-host <api-host>* [env: FATCAT_API_HOST] [default: https://api.fatcat.wiki] + +*--api-token <api-token>* [env: FATCAT_API_AUTH_TOKEN] + +*--search-host <search-host>* [env: FATCAT_SEARCH_HOST] [default: https://search.fatcat.wiki] + # EXAMPLES Some examples of usage will go here, like: fatcat-cli get thing + |