diff --git a/_site/content/posts/modules/logging.md b/_site/content/posts/modules/logging.md new file mode 100644 index 00000000..544cd701 --- /dev/null +++ b/_site/content/posts/modules/logging.md @@ -0,0 +1,54 @@ +--- +title: "Logging" +date: 2018-06-16T14:22:18-07:00 +draft: false +--- + +Displays the contents of the WTF log file. + +To log to this file in your own modules: + +```golang +require "github.com/senorprogrammer/wtf/logging" + logging.Log("This is a log entry") +``` + +## Source Code + +```bash +wtf/logging/ +``` + +## Required ENV Variables + +None. + +## Keyboard Commands + +Arrow keys scroll through the log file. + +## Configuration + +```yaml +textfile: + enabled: true + position: + top: 5 + left: 4 + height: 2 + width: 1 + refreshInterval: 1 +``` + +### Attributes + +`enabled`
+Determines whether or not this module is executed and if its data displayed onscreen.
+Values: `true`, `false`. + +`position`
+Defines where in the grid this module's widget will be displayed.
+ +`refreshInterval`
+How often, in seconds, this module will update its data.
+Values: A positive integer, `0..n`. diff --git a/_site/themes/hyde-hyde/layouts/partials/sidebar.html b/_site/themes/hyde-hyde/layouts/partials/sidebar.html index a5b24d6a..9c7e92f2 100644 --- a/_site/themes/hyde-hyde/layouts/partials/sidebar.html +++ b/_site/themes/hyde-hyde/layouts/partials/sidebar.html @@ -38,6 +38,7 @@ + diff --git a/docs/404.html b/docs/404.html index 7ce23127..abc09821 100644 --- a/docs/404.html +++ b/docs/404.html @@ -79,6 +79,7 @@ + diff --git a/docs/categories/index.html b/docs/categories/index.html index a0c96c23..959cb245 100644 --- a/docs/categories/index.html +++ b/docs/categories/index.html @@ -81,6 +81,7 @@ + diff --git a/docs/index.html b/docs/index.html index 62d70dbe..99975824 100644 --- a/docs/index.html +++ b/docs/index.html @@ -80,6 +80,7 @@ + diff --git a/docs/index.xml b/docs/index.xml index d5b16ac5..4249f027 100644 --- a/docs/index.xml +++ b/docs/index.xml @@ -6,11 +6,25 @@ Recent content on WTF - A Terminal Dashboard Hugo -- gohugo.io en-us - Wed, 13 Jun 2018 09:29:59 -0700 + Sat, 16 Jun 2018 14:22:18 -0700 + + Logging + https://wtfutil.com/posts/modules/logging/ + Sat, 16 Jun 2018 14:22:18 -0700 + + https://wtfutil.com/posts/modules/logging/ + Displays the contents of the WTF log file. +To log to this file in your own modules: +require "github.com/senorprogrammer/wtf/logging" logging.Log("This is a log entry") Source Code wtf/logging/ Required ENV Variables None. +Keyboard Commands Arrow keys scroll through the log file. +Configuration textfile:enabled:trueposition:top:5left:4height:2width:1refreshInterval:1 Attributes enabled Determines whether or not this module is executed and if its data displayed onscreen. Values: true, false. +position Defines where in the grid this module’s widget will be displayed. + + Blockfolio https://wtfutil.com/posts/modules/cryptocurrencies/blockfolio/ diff --git a/docs/posts/configuration/attributes/index.html b/docs/posts/configuration/attributes/index.html index a7513494..45f00e4b 100644 --- a/docs/posts/configuration/attributes/index.html +++ b/docs/posts/configuration/attributes/index.html @@ -79,6 +79,7 @@ + diff --git a/docs/posts/configuration/index.html b/docs/posts/configuration/index.html index de751889..24262a30 100644 --- a/docs/posts/configuration/index.html +++ b/docs/posts/configuration/index.html @@ -79,6 +79,7 @@ + diff --git a/docs/posts/configuration/iterm2/index.html b/docs/posts/configuration/iterm2/index.html index c240c3db..ad673ae2 100644 --- a/docs/posts/configuration/iterm2/index.html +++ b/docs/posts/configuration/iterm2/index.html @@ -79,6 +79,7 @@ + diff --git a/docs/posts/glossary/index.html b/docs/posts/glossary/index.html index 192fde00..67d7d7f9 100644 --- a/docs/posts/glossary/index.html +++ b/docs/posts/glossary/index.html @@ -79,6 +79,7 @@ + diff --git a/docs/posts/index.html b/docs/posts/index.html index b7b08c55..f7df2293 100644 --- a/docs/posts/index.html +++ b/docs/posts/index.html @@ -81,6 +81,7 @@ + @@ -105,6 +106,13 @@

Posts