From 641dce9333e183f71ba7f8bf78916bcaf884306b Mon Sep 17 00:00:00 2001 From: Chris Cummer Date: Tue, 22 May 2018 20:48:06 -0700 Subject: [PATCH] Add Configuration and Keyboard Commands to Overview documentation. --- _site/content/posts/overview.md | 28 ++++++++++++++++++++++++++++ docs/index.xml | 3 +-- docs/posts/index.xml | 3 +-- docs/posts/overview/index.html | 32 +++++++++++++++++++++++++++++++- wtf.go | 2 -- 5 files changed, 61 insertions(+), 7 deletions(-) diff --git a/_site/content/posts/overview.md b/_site/content/posts/overview.md index cd3b1774..8299c05e 100644 --- a/_site/content/posts/overview.md +++ b/_site/content/posts/overview.md @@ -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`
+Allows you to define a custom config file to use. See Configuration for more details. + +`-h`
+Shows help information for the command-line arguments that WTF +takes. + +`--help [module name]`
+Shows help information for the specific named module, if that module +supports help text. Ex: `wtf --help git`. + +`--version`
+Shows version info. + +## Keyboard Commands + +Key: `Ctrl-R`
+Action: Force-rrefresh the data for all modules. + +Key: `Esc`
+Action: Unfocus the currently-focused +widget. + +Key: `Tab`
+Action: Move between focusable modules (`Shift-Tab` to move backwards). diff --git a/docs/index.xml b/docs/index.xml index e1d77472..05e8472f 100644 --- a/docs/index.xml +++ b/docs/index.xml @@ -19,8 +19,7 @@ http://wtfutil.com/posts/overview/ 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’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. +Download it as a stand-alone, compiled binary, or install it from source. diff --git a/docs/posts/index.xml b/docs/posts/index.xml index 002e5fa4..2fb198d9 100644 --- a/docs/posts/index.xml +++ b/docs/posts/index.xml @@ -19,8 +19,7 @@ http://wtfutil.com/posts/overview/ 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’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. +Download it as a stand-alone, compiled binary, or install it from source. diff --git a/docs/posts/overview/index.html b/docs/posts/overview/index.html index 48768a7d..aca28f10 100644 --- a/docs/posts/overview/index.html +++ b/docs/posts/overview/index.html @@ -105,7 +105,9 @@ -

WTF is a personal information dashboard for your terminal, developed for those who spend most of their day in the command line.

+ + +

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’t always need @@ -120,6 +122,34 @@ modules you want to run.

Configuration instructions for each module can be found in the module pages, listed at left.

+

Command-line Options

+ +

--config
+Allows you to define a custom config file to use. See Configuration for more details.

+ +

-h
+Shows help information for the command-line arguments that WTF +takes.

+ +

--help [module name]
+Shows help information for the specific named module, if that module +supports help text. Ex: wtf --help git.

+ +

--version
+Shows version info.

+ +

Keyboard Commands

+ +

Key: Ctrl-R
+Action: Force-rrefresh the data for all modules.

+ +

Key: Esc
+Action: Unfocus the currently-focused +widget.

+ +

Key: Tab
+Action: Move between focusable modules (Shift-Tab to move backwards).

+
diff --git a/wtf.go b/wtf.go index b58d5b94..be8b5598 100644 --- a/wtf.go +++ b/wtf.go @@ -136,8 +136,6 @@ func main() { help.DisplayVersionInfo(version) } - //help.DisplayCommandInfo(flag.Args(), version) - /* -------------------- end flag parsing and handling -------------------- */ // Responsible for creating the configuration directory and default