1
0
mirror of https://github.com/taigrr/wtf synced 2025-01-18 04:03:14 -08:00

Close 78. Add documentation for --module option

This commit is contained in:
Chris Cummer 2018-05-31 05:26:25 -07:00
parent d9d1a82c89
commit 1772ceadf6
2 changed files with 12 additions and 10 deletions

View File

@ -23,18 +23,19 @@ more details.
## Command-line Options ## Command-line Options
`--config` <br /> `--config, -c` <br />
Allows you to define a custom config file to use. See <a href="/posts/configuration/">Configuration</a> for more details. Allows you to define a custom config file to use. See <a href="/posts/configuration/">Configuration</a> for more details.
`-h` <br /> `--help, -h` <br />
Shows help information for the command-line arguments that WTF Shows help information for the command-line arguments that WTF
takes. takes.
`--help [module name]` <br /> `--module, -m` <br />
Shows help information for the specific named module, if that module Shows help information for the specific named module, if that module
supports help text. Ex: `wtf --help git`. supports help text. <br />
Example: `wtf --module=todo`.
`--version` <br /> `--version, -v` <br />
Shows version info. Shows version info.
## Keyboard Commands ## Keyboard Commands

View File

@ -130,18 +130,19 @@ more details.</p>
<h2 id="command-line-options">Command-line Options</h2> <h2 id="command-line-options">Command-line Options</h2>
<p><code>--config</code> <br /> <p><code>--config, -c</code> <br />
Allows you to define a custom config file to use. See <a href="/posts/configuration/">Configuration</a> for more details.</p> Allows you to define a custom config file to use. See <a href="/posts/configuration/">Configuration</a> for more details.</p>
<p><code>-h</code> <br /> <p><code>--help, -h</code> <br />
Shows help information for the command-line arguments that WTF Shows help information for the command-line arguments that WTF
takes.</p> takes.</p>
<p><code>--help [module name]</code> <br /> <p><code>--module, -m</code> <br />
Shows help information for the specific named module, if that module Shows help information for the specific named module, if that module
supports help text. Ex: <code>wtf --help git</code>.</p> supports help text. <br />
Example: <code>wtf --module=todo</code>.</p>
<p><code>--version</code> <br /> <p><code>--version, -v</code> <br />
Shows version info.</p> Shows version info.</p>
<h2 id="keyboard-commands">Keyboard Commands</h2> <h2 id="keyboard-commands">Keyboard Commands</h2>