urfave-cli/testdata/expected-doc-full.man

.nh
.TH greet 8

.SH NAME
.PP
greet \- Some app


.SH SYNOPSIS
.PP
greet

.PP
.RS

.nf
[\-\-another\-flag|\-b]
[\-\-flag|\-\-fl|\-f]=[value]
[\-\-socket|\-s]=[value]

.fi
.RE


.SH DESCRIPTION
.PP
Description of the application.

.PP
\fBUsage\fP:

.PP
.RS

.nf
app [first\_arg] [second\_arg]

.fi
.RE


.SH GLOBAL OPTIONS
.PP
\fB\-\-another\-flag, \-b\fP: another usage text

.PP
\fB\-\-flag, \-\-fl, \-f\fP="":

.PP
\fB\-\-socket, \-s\fP="": some 'usage' text (default: value)


.SH COMMANDS
.SH config, c
.PP
another usage test

.PP
\fB\-\-another\-flag, \-b\fP: another usage text

.PP
\fB\-\-flag, \-\-fl, \-f\fP="":

.SS sub\-config, s, ss
.PP
another usage test

.PP
\fB\-\-sub\-command\-flag, \-s\fP: some usage text

.PP
\fB\-\-sub\-flag, \-\-sub\-fl, \-s\fP="":

.SH info, i, in
.PP
retrieve generic information

.SH some\-command
.SH usage, u
.PP
standard usage text

.PP
.RS

.nf
Usage for the usage text
\- formatted:  Based on the specified ConfigMap and summon secrets.yml
\- list:       Inspect the environment for a specific process running on a Pod
\- for\_effect: Compare 'namespace' environment with 'local'

```
func() { ... }
```

Should be a part of the same code block

.fi
.RE

.PP
\fB\-\-another\-flag, \-b\fP: another usage text

.PP
\fB\-\-flag, \-\-fl, \-f\fP="":

.SS sub\-usage, su
.PP
standard usage text

.PP
.RS

.PP
Single line of UsageText

.RE

.PP
\fB\-\-sub\-command\-flag, \-s\fP: some usage text
Add markdown and man page docs generation methods 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> 2019-08-03 10:41:50 +00:00			`.nh`
Fix man page heading formatting Closes #1040 Signed-off-by: Sascha Grunert <sgrunert@suse.com> 2020-01-14 14:17:18 +00:00			`.TH greet 8`
Add markdown and man page docs generation methods 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> 2019-08-03 10:41:50 +00:00
			`.SH NAME`
			`.PP`
			`greet \- Some app`


			`.SH SYNOPSIS`
			`.PP`
			`greet`

			`.PP`
			`.RS`

			`.nf`
			`[\-\-another\-flag\|\-b]`
			`[\-\-flag\|\-\-fl\|\-f]=[value]`
			`[\-\-socket\|\-s]=[value]`

			`.fi`
			`.RE`


			`.SH DESCRIPTION`
			`.PP`
feat(docs): Include Description and UsageText in docs output (#1287) Include Description as part of the DESCRIPTION section, and put UsageText (if it is non-zero) into the Usage subsection. 2021-07-07 00:20:47 +00:00			`Description of the application.`
Add markdown and man page docs generation methods 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> 2019-08-03 10:41:50 +00:00
			`.PP`
			`\fBUsage\fP:`

			`.PP`
			`.RS`

			`.nf`
feat(docs): Include Description and UsageText in docs output (#1287) Include Description as part of the DESCRIPTION section, and put UsageText (if it is non-zero) into the Usage subsection. 2021-07-07 00:20:47 +00:00			`app [first\_arg] [second\_arg]`
Add markdown and man page docs generation methods 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> 2019-08-03 10:41:50 +00:00
			`.fi`
			`.RE`


			`.SH GLOBAL OPTIONS`
			`.PP`
			`\fB\-\-another\-flag, \-b\fP: another usage text`

			`.PP`
			`\fB\-\-flag, \-\-fl, \-f\fP="":`

			`.PP`
Escape single quotes in fish shell completion Single quotes can break the generated fish shell completion and should be escaped correctly. Signed-off-by: Sascha Grunert <sgrunert@suse.com> 2019-08-29 12:45:32 +00:00			`\fB\-\-socket, \-s\fP="": some 'usage' text (default: value)`
Add markdown and man page docs generation methods 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> 2019-08-03 10:41:50 +00:00

			`.SH COMMANDS`
			`.SH config, c`
			`.PP`
			`another usage test`

			`.PP`
			`\fB\-\-another\-flag, \-b\fP: another usage text`

			`.PP`
			`\fB\-\-flag, \-\-fl, \-f\fP="":`

			`.SS sub\-config, s, ss`
			`.PP`
			`another usage test`

			`.PP`
			`\fB\-\-sub\-command\-flag, \-s\fP: some usage text`

			`.PP`
			`\fB\-\-sub\-flag, \-\-sub\-fl, \-s\fP="":`

			`.SH info, i, in`
			`.PP`
			`retrieve generic information`

feat(docs): add UsageText to docs output for markdown and man page generation (#1171) * feat(docs): add UsageText to docs output for markdown and man page generation * feat(docs): updated tests, DRYd up code, cleaned up string logic * fix(lint): fixed go1.15 lint errors 2021-05-21 01:04:51 +00:00			`.SH some\-command`
			`.SH usage, u`
			`.PP`
			`standard usage text`

			`.PP`
			`.RS`

			`.nf`
			`Usage for the usage text`
			`\- formatted: Based on the specified ConfigMap and summon secrets.yml`
			`\- list: Inspect the environment for a specific process running on a Pod`
			`\- for\_effect: Compare 'namespace' environment with 'local'`

			```
			`func() { ... }`
			```

			`Should be a part of the same code block`

			`.fi`
			`.RE`

			`.PP`
			`\fB\-\-another\-flag, \-b\fP: another usage text`

			`.PP`
			`\fB\-\-flag, \-\-fl, \-f\fP="":`

			`.SS sub\-usage, su`
			`.PP`
			`standard usage text`

			`.PP`
			`.RS`

			`.PP`
			`Single line of UsageText`

			`.RE`

			`.PP`
			`\fB\-\-sub\-command\-flag, \-s\fP: some usage text`