40d4a25a01
This adds two new methods to the `App` struct: - `ToMarkdown`: creates a markdown documentation string - `ToMan`: creates a man page string Signed-off-by: Sascha Grunert <mail@saschagrunert.de>
63 lines
725 B
Markdown
63 lines
725 B
Markdown
% greet(8)
|
|
|
|
% Harrison
|
|
|
|
# NAME
|
|
|
|
greet - Some app
|
|
|
|
# SYNOPSIS
|
|
|
|
greet
|
|
|
|
```
|
|
[--another-flag|-b]
|
|
[--flag|--fl|-f]=[value]
|
|
[--socket|-s]=[value]
|
|
```
|
|
|
|
# DESCRIPTION
|
|
|
|
app [first_arg] [second_arg]
|
|
|
|
**Usage**:
|
|
|
|
```
|
|
greet [GLOBAL OPTIONS] command [COMMAND OPTIONS] [ARGUMENTS...]
|
|
```
|
|
|
|
# GLOBAL OPTIONS
|
|
|
|
**--another-flag, -b**: another usage text
|
|
|
|
**--flag, --fl, -f**="":
|
|
|
|
**--socket, -s**="": some usage text (default: value)
|
|
|
|
|
|
# COMMANDS
|
|
|
|
## config, c
|
|
|
|
another usage test
|
|
|
|
**--another-flag, -b**: another usage text
|
|
|
|
**--flag, --fl, -f**="":
|
|
|
|
### sub-config, s, ss
|
|
|
|
another usage test
|
|
|
|
**--sub-command-flag, -s**: some usage text
|
|
|
|
**--sub-flag, --sub-fl, -s**="":
|
|
|
|
## info, i, in
|
|
|
|
retrieve generic information
|
|
|
|
## some-command
|
|
|
|
|