mirror of
https://github.com/taigrr/wtf
synced 2025-01-18 04:03:14 -08:00
Add Configuration and Keyboard Commands to Overview documentation.
This commit is contained in:
parent
ff49ecb082
commit
641dce9333
@ -18,3 +18,31 @@ modules you want to run.
|
||||
|
||||
Configuration instructions for each module can be found in the module
|
||||
pages, listed at left.
|
||||
|
||||
## Command-line Options
|
||||
|
||||
`--config` <br />
|
||||
Allows you to define a custom config file to use. See <a href="/posts/configuration/">Configuration</a> for more details.
|
||||
|
||||
`-h` <br />
|
||||
Shows help information for the command-line arguments that WTF
|
||||
takes.
|
||||
|
||||
`--help [module name]` <br />
|
||||
Shows help information for the specific named module, if that module
|
||||
supports help text. Ex: `wtf --help git`.
|
||||
|
||||
`--version` <br />
|
||||
Shows version info.
|
||||
|
||||
## Keyboard Commands
|
||||
|
||||
<span class="caption">Key:</span> `Ctrl-R` <br />
|
||||
<span class="caption">Action:</span> Force-rrefresh the data for all modules.
|
||||
|
||||
<span class="caption">Key:</span> `Esc` <br />
|
||||
<span class="caption">Action:</span> Unfocus the currently-focused
|
||||
widget.
|
||||
|
||||
<span class="caption">Key:</span> `Tab` <br />
|
||||
<span class="caption">Action:</span> Move between focusable modules (`Shift-Tab` to move backwards).
|
||||
|
@ -19,8 +19,7 @@
|
||||
<guid>http://wtfutil.com/posts/overview/</guid>
|
||||
<description>WTF is a personal information dashboard for your terminal, developed for those who spend most of their day in the command line.
|
||||
It allows you to monitor services and systems that you otherwise might keep browser tabs open for, the kinds of things you don&rsquo;t always need visible, but might check in on every now and then.
|
||||
Download it as a stand-alone, compiled binary, or install it from source.
|
||||
Once installed, edit your configuration file and define the modules you want to run.</description>
|
||||
Download it as a stand-alone, compiled binary, or install it from source.</description>
|
||||
</item>
|
||||
|
||||
<item>
|
||||
|
@ -19,8 +19,7 @@
|
||||
<guid>http://wtfutil.com/posts/overview/</guid>
|
||||
<description>WTF is a personal information dashboard for your terminal, developed for those who spend most of their day in the command line.
|
||||
It allows you to monitor services and systems that you otherwise might keep browser tabs open for, the kinds of things you don&rsquo;t always need visible, but might check in on every now and then.
|
||||
Download it as a stand-alone, compiled binary, or install it from source.
|
||||
Once installed, edit your configuration file and define the modules you want to run.</description>
|
||||
Download it as a stand-alone, compiled binary, or install it from source.</description>
|
||||
</item>
|
||||
|
||||
<item>
|
||||
|
@ -105,6 +105,8 @@
|
||||
</span>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<p><span style="font-family: monospace; font-size: 1.6em;">WTF</span> is a personal information dashboard for your terminal, developed for those who spend most of their day in the command line.</p>
|
||||
|
||||
<p>It allows you to monitor services and systems that you otherwise might
|
||||
@ -120,6 +122,34 @@ modules you want to run.</p>
|
||||
<p>Configuration instructions for each module can be found in the module
|
||||
pages, listed at left.</p>
|
||||
|
||||
<h2 id="command-line-options">Command-line Options</h2>
|
||||
|
||||
<p><code>--config</code> <br />
|
||||
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 />
|
||||
Shows help information for the command-line arguments that WTF
|
||||
takes.</p>
|
||||
|
||||
<p><code>--help [module name]</code> <br />
|
||||
Shows help information for the specific named module, if that module
|
||||
supports help text. Ex: <code>wtf --help git</code>.</p>
|
||||
|
||||
<p><code>--version</code> <br />
|
||||
Shows version info.</p>
|
||||
|
||||
<h2 id="keyboard-commands">Keyboard Commands</h2>
|
||||
|
||||
<p><span class="caption">Key:</span> <code>Ctrl-R</code> <br />
|
||||
<span class="caption">Action:</span> Force-rrefresh the data for all modules.</p>
|
||||
|
||||
<p><span class="caption">Key:</span> <code>Esc</code> <br />
|
||||
<span class="caption">Action:</span> Unfocus the currently-focused
|
||||
widget.</p>
|
||||
|
||||
<p><span class="caption">Key:</span> <code>Tab</code> <br />
|
||||
<span class="caption">Action:</span> Move between focusable modules (<code>Shift-Tab</code> to move backwards).</p>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="footer">
|
||||
|
Loading…
x
Reference in New Issue
Block a user