wp help: update man page

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index c90ed7c..7389047 100644 (file)
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -16,11 +16,7 @@ The compiled man page is placed in the `man` directory.
 
 To (re)generate one or more man pages, you first need to have the [ronn](https://rubygems.org/gems/ronn) ruby gem installed.
 
-Then, you can run one of the following:
-
-* `wp --man` - regenerates all man pages
-* `wp core --man` - regenerates man pages for the `core` command
-* `wp core download --man` - regenerates man page only for the `core download` subcommand
+Then, you can use the `wp help --gen` command.
 
 Running the tests
 -----------------

diff --git a/man-src/help.txt b/man-src/help.txt
index e69de29..69ac8e6 100644 (file)
--- a/man-src/help.txt
+++ b/man-src/help.txt
@@ -0,0 +1,10 @@
+## EXAMPLES
+
+       # (re)generates all man pages
+       wp help --gen
+
+       # (re)generate man pages for the `core` command
+       wp help --gen core
+
+       # (re)generate man page only for the `core download` subcommand
+       wp help --gen core download

diff --git a/man/help.1 b/man/help.1
index 707ebcc..9b70745 100644 (file)
--- a/man/help.1
+++ b/man/help.1
@@ -7,4 +7,20 @@
 \fBwp\-help\fR \- Get help on a certain topic\.
 .
 .SH "SYNOPSIS"
-wp help [\fIcommand\fR]
+wp help [\fIcommand\fR] [\-\-gen]
+.
+.SH "EXAMPLES"
+.
+.nf
+
+# (re)generates all man pages
+wp help \-\-gen
+
+# (re)generate man pages for the `core` command
+wp help \-\-gen core
+
+# (re)generate man page only for the `core download` subcommand
+wp help \-\-gen core download
+.
+.fi
+