2015-06-08 13:48:20 -04:00
|
|
|
Docker Documentation
|
|
|
|
====================
|
|
|
|
|
2016-06-09 11:33:28 -04:00
|
|
|
This directory contains scripts for generating the man pages. Many of the man
|
|
|
|
pages are generated directly from the `spf13/cobra` `Command` definition. Some
|
|
|
|
legacy pages are still generated from the markdown files in this directory.
|
|
|
|
Do *not* edit the man pages in the man1 directory. Instead, update the
|
|
|
|
Cobra command or amend the Markdown files for legacy pages.
|
2015-06-08 13:48:20 -04:00
|
|
|
|
|
|
|
|
2016-07-22 04:43:08 -04:00
|
|
|
## Generate the man pages
|
2015-06-08 13:48:20 -04:00
|
|
|
|
2016-06-09 11:33:28 -04:00
|
|
|
From within the project root directory run:
|
2015-06-08 13:48:20 -04:00
|
|
|
|
2022-02-25 11:05:35 -05:00
|
|
|
```shell
|
|
|
|
$ make -f docker.Makefile manpages
|
|
|
|
```
|