diff options
author | Matthew Holt <[email protected]> | 2022-08-30 19:15:52 -0600 |
---|---|---|
committer | Matthew Holt <[email protected]> | 2022-08-30 19:15:52 -0600 |
commit | 687a4b9e81c7b0b08c760ec33808c721d6775e0e (patch) | |
tree | 182eec979dbb39b15d765ba016eb7333d9eab88f /cmd/commands.go | |
parent | d605ebe75a2043199ba53022adaa20be680cf051 (diff) | |
download | caddy-687a4b9e81c7b0b08c760ec33808c721d6775e0e.tar.gz caddy-687a4b9e81c7b0b08c760ec33808c721d6775e0e.zip |
cmd: Enhance CLI docs
Diffstat (limited to 'cmd/commands.go')
-rw-r--r-- | cmd/commands.go | 11 |
1 files changed, 4 insertions, 7 deletions
diff --git a/cmd/commands.go b/cmd/commands.go index e71923cfa..4ae3a5b37 100644 --- a/cmd/commands.go +++ b/cmd/commands.go @@ -358,25 +358,22 @@ EXPERIMENTAL: May be changed or removed. } if err := doc.GenManTree(rootCmd, &doc.GenManHeader{ Title: "Caddy", - Section: "8", + Section: "8", // https://en.wikipedia.org/wiki/Man_page#Manual_sections }, dir); err != nil { return caddy.ExitCodeFailedQuit, err } return caddy.ExitCodeSuccess, nil }, - Usage: "--directory <directory path>", - Short: "Generates the manual pages of Caddy commands", + Usage: "--directory <path>", + Short: "Generates the manual pages for Caddy commands", Long: ` -Generates the manual pages of Caddy commands into the designated directory tagged into the specified section. +Generates the manual pages for Caddy commands into the designated directory tagged into section 8 (System Administration). The manual page files are generated into the directory specified by the argument of --directory. If the directory does not exist, it will be created. - -The manual pages are sorted into the section specified by the argument of --section. `, Flags: func() *flag.FlagSet { fs := flag.NewFlagSet("manpage", flag.ExitOnError) fs.String("directory", "", "The output directory where the manpages are generated") - fs.String("section", "", "The section number of the generated manual pages") return fs }(), }) |