mirror of
https://github.com/taigrr/wtf
synced 2025-01-18 04:03:14 -08:00
566 lines
19 KiB
HTML
566 lines
19 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<title>WTF - the terminal dashboard</title>
|
|
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no">
|
|
<meta name="generator" content="Hugo 0.46" />
|
|
<title>Attributes :: WTF - the terminal dashboard</title>
|
|
<link rel="shortcut icon" href="/images/favicon.png" type="image/x-icon" />
|
|
<link href="/css/font-awesome.min.css" rel="stylesheet">
|
|
<link href="/css/nucleus.css" rel="stylesheet">
|
|
<link href="/theme-flex/style.css" rel="stylesheet">
|
|
|
|
<link rel="stylesheet" href="/css/bootstrap.min.css">
|
|
<script src="/js/jquery-2.x.min.js"></script>
|
|
<script type="text/javascript">
|
|
var baseurl = "\/";
|
|
</script>
|
|
<meta name="description" content="">
|
|
|
|
|
|
<link rel="stylesheet" href="/css/custom.css">
|
|
|
|
|
|
|
|
</head>
|
|
<body data-url="/configuration/attributes/">
|
|
|
|
<header>
|
|
<div class="logo">
|
|
|
|
|
|
|
|
<a class="baselink" href="/">WTF - the terminal dashboard</a>
|
|
|
|
|
|
</div>
|
|
<div class="burger"><a href="javascript:void(0);" style="font-size:15px;">☰</a></div>
|
|
<nav class="shortcuts">
|
|
<li class="" role="">
|
|
<a href="https://github.com/senorprogrammer/wtf" rel="noopener">
|
|
<i class='fa fa-github'></i> <label>WTF on Github</label>
|
|
</a>
|
|
</li>
|
|
<li class="" role="">
|
|
<a href="https://github.com/senorprogrammer/wtf/releases" rel="noopener">
|
|
<i class='fa fa-cloud-download'></i> <label>Download WTF</label>
|
|
</a>
|
|
</li>
|
|
<li class="" role="">
|
|
<a href="https://github.com/senorprogrammer/wtf/blob/master/README.md#contributors" rel="noopener">
|
|
<i class='fa fa-bullhorn'></i> <label>Credits</label>
|
|
</a>
|
|
</li>
|
|
</nav>
|
|
</header>
|
|
<article>
|
|
<aside>
|
|
<ul class="menu">
|
|
<li data-nav-id="/" class="dd-item">
|
|
<a href="/">
|
|
<i class="fa fa-fw fa-home"></i>
|
|
</a>
|
|
</li>
|
|
<li data-nav-id="/getting_started/" class="dd-item haschildren
|
|
">
|
|
<div>
|
|
<a href="/getting_started/">Getting Started</a><i class="fa fa-angle-right fa-lg category-icon"></i><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
<ul>
|
|
<li data-nav-id="/getting_started/installation/" class="dd-item">
|
|
<div>
|
|
<a href="/getting_started/installation/">
|
|
Installation
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/getting_started/glossary/" class="dd-item">
|
|
<div>
|
|
<a href="/getting_started/glossary/">
|
|
Glossary
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li data-nav-id="/configuration/" class="dd-item parent haschildren
|
|
">
|
|
<div>
|
|
<a href="/configuration/">Configuration</a>
|
|
<i class="fa fa-angle-down fa-lg category-icon"></i><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
<ul>
|
|
<li data-nav-id="/configuration/attributes/" class="dd-item active">
|
|
<div>
|
|
<a href="/configuration/attributes/">
|
|
Attributes
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/configuration/iterm2/" class="dd-item">
|
|
<div>
|
|
<a href="/configuration/iterm2/">
|
|
iTerm2
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li data-nav-id="/modules/" class="dd-item haschildren
|
|
">
|
|
<div>
|
|
<a href="/modules/">Modules</a><i class="fa fa-angle-right fa-lg category-icon"></i><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
<ul>
|
|
<li data-nav-id="/modules/bamboohr/" class="dd-item">
|
|
<div>
|
|
<a href="/modules/bamboohr/">
|
|
BambooHR
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/modules/circleci/" class="dd-item">
|
|
<div>
|
|
<a href="/modules/circleci/">
|
|
CircleCI
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/modules/clocks/" class="dd-item">
|
|
<div>
|
|
<a href="/modules/clocks/">
|
|
Clocks
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/modules/cmdrunner/" class="dd-item">
|
|
<div>
|
|
<a href="/modules/cmdrunner/">
|
|
CmdRunner
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/modules/cryptocurrencies/" class="dd-item haschildren
|
|
">
|
|
<div>
|
|
<a href="/modules/cryptocurrencies/">Crypo Currencies</a><i class="fa fa-angle-right fa-lg category-icon"></i><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
<ul>
|
|
<li data-nav-id="/modules/cryptocurrencies/bittrex/" class="dd-item">
|
|
<div>
|
|
<a href="/modules/cryptocurrencies/bittrex/">
|
|
Bittrex
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/modules/cryptocurrencies/blockfolio/" class="dd-item">
|
|
<div>
|
|
<a href="/modules/cryptocurrencies/blockfolio/">
|
|
Blockfolio
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/modules/cryptocurrencies/cryptolive/" class="dd-item">
|
|
<div>
|
|
<a href="/modules/cryptocurrencies/cryptolive/">
|
|
CryptoLive
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li data-nav-id="/modules/gerrit/" class="dd-item">
|
|
<div>
|
|
<a href="/modules/gerrit/">
|
|
Gerrit
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/modules/git/" class="dd-item">
|
|
<div>
|
|
<a href="/modules/git/">
|
|
Git
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/modules/github/" class="dd-item">
|
|
<div>
|
|
<a href="/modules/github/">
|
|
GitHub
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/modules/gitlab/" class="dd-item">
|
|
<div>
|
|
<a href="/modules/gitlab/">
|
|
GitLab
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/modules/gitter/" class="dd-item">
|
|
<div>
|
|
<a href="/modules/gitter/">
|
|
Gitter
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/modules/google/" class="dd-item haschildren
|
|
">
|
|
<div>
|
|
<a href="/modules/google/">Google Apps</a><i class="fa fa-angle-right fa-lg category-icon"></i><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
<ul>
|
|
<li data-nav-id="/modules/google/gcal/" class="dd-item">
|
|
<div>
|
|
<a href="/modules/google/gcal/">
|
|
Google Calendar
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/modules/google/gspreadsheet/" class="dd-item">
|
|
<div>
|
|
<a href="/modules/google/gspreadsheet/">
|
|
Google Spreadsheets
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li data-nav-id="/modules/hackernews/" class="dd-item">
|
|
<div>
|
|
<a href="/modules/hackernews/">
|
|
Hacker News
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/modules/ipaddress/" class="dd-item haschildren
|
|
">
|
|
<div>
|
|
<a href="/modules/ipaddress/">IP Addresses</a><i class="fa fa-angle-right fa-lg category-icon"></i><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
<ul>
|
|
<li data-nav-id="/modules/ipaddress/ipapi/" class="dd-item">
|
|
<div>
|
|
<a href="/modules/ipaddress/ipapi/">
|
|
IP-API
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/modules/ipaddress/ipinfo/" class="dd-item">
|
|
<div>
|
|
<a href="/modules/ipaddress/ipinfo/">
|
|
IPInfo
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li data-nav-id="/modules/jenkins/" class="dd-item">
|
|
<div>
|
|
<a href="/modules/jenkins/">
|
|
Jenkins
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/modules/jira/" class="dd-item">
|
|
<div>
|
|
<a href="/modules/jira/">
|
|
Jira
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/modules/logger/" class="dd-item">
|
|
<div>
|
|
<a href="/modules/logger/">
|
|
Logger
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/modules/newrelic/" class="dd-item">
|
|
<div>
|
|
<a href="/modules/newrelic/">
|
|
New Relic
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/modules/opsgenie/" class="dd-item">
|
|
<div>
|
|
<a href="/modules/opsgenie/">
|
|
OpsGenie
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/modules/power/" class="dd-item">
|
|
<div>
|
|
<a href="/modules/power/">
|
|
Power
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/modules/security/" class="dd-item">
|
|
<div>
|
|
<a href="/modules/security/">
|
|
Security
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/modules/textfile/" class="dd-item">
|
|
<div>
|
|
<a href="/modules/textfile/">
|
|
Textfile
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/modules/todo/" class="dd-item">
|
|
<div>
|
|
<a href="/modules/todo/">
|
|
Todo
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/modules/todoist/" class="dd-item">
|
|
<div>
|
|
<a href="/modules/todoist/">
|
|
Todoist
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/modules/travisci/" class="dd-item">
|
|
<div>
|
|
<a href="/modules/travisci/">
|
|
TravisCI
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/modules/trello/" class="dd-item">
|
|
<div>
|
|
<a href="/modules/trello/">
|
|
Trello
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/modules/twitter/" class="dd-item">
|
|
<div>
|
|
<a href="/modules/twitter/">
|
|
Twitter
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/modules/weather_services/" class="dd-item haschildren
|
|
">
|
|
<div>
|
|
<a href="/modules/weather_services/">Weather Services</a><i class="fa fa-angle-right fa-lg category-icon"></i><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
<ul>
|
|
<li data-nav-id="/modules/weather_services/prettyweather/" class="dd-item">
|
|
<div>
|
|
<a href="/modules/weather_services/prettyweather/">
|
|
Pretty Weather
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/modules/weather_services/weather/" class="dd-item">
|
|
<div>
|
|
<a href="/modules/weather_services/weather/">
|
|
Weather
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li data-nav-id="/modules/zendesk/" class="dd-item">
|
|
<div>
|
|
<a href="/modules/zendesk/">
|
|
Zendesk
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
<section>
|
|
</section>
|
|
</aside>
|
|
<section class="page">
|
|
|
|
<div class="nav-select">
|
|
<center>Navigation :
|
|
<select onchange="javascript:location.href = this.value;">
|
|
|
|
<option value="/getting_started/" >
|
|
Getting Started</option>
|
|
<option value="/configuration/" >
|
|
Configuration</option>
|
|
|
|
<option value="/modules/" >
|
|
Modules</option>
|
|
|
|
|
|
|
|
</select>
|
|
</center>
|
|
</div>
|
|
<div>
|
|
<div class="searchbox">
|
|
<input data-search-input id="search-by" type="text" placeholder="Search...">
|
|
</div>
|
|
<script type="text/javascript" src="/js/lunr.min.js"></script>
|
|
<script type="text/javascript" src="/js/auto-complete.js"></script>
|
|
<link href="/css/auto-complete.css" rel="stylesheet">
|
|
<script type="text/javascript">
|
|
|
|
var baseurl = "\/";
|
|
|
|
</script>
|
|
<script type="text/javascript" src="/js/search.js"></script>
|
|
</div>
|
|
|
|
|
|
<h1>Attributes</h1>
|
|
|
|
|
|
|
|
|
|
|
|
<p>The following top-level attributes are configurable in <code>config.yml</code>.
|
|
See this <a href="https://github.com/senorprogrammer/wtf/blob/master/_sample_configs/simple_config.yml">example config file</a> for more details.</p>
|
|
<div class="highlight"><pre style="color:#272822;background-color:#fafafa;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-yaml" data-lang="yaml">wtf<span style="color:#111">:</span>
|
|
colors<span style="color:#111">:</span>
|
|
background<span style="color:#111">:</span> <span style="color:#d88200">"red"</span>
|
|
border<span style="color:#111">:</span>
|
|
focusable<span style="color:#111">:</span> <span style="color:#d88200">"darkslateblue"</span>
|
|
focused<span style="color:#111">:</span> <span style="color:#d88200">"orange"</span>
|
|
normal<span style="color:#111">:</span> <span style="color:#d88200">"gray"</span>
|
|
grid<span style="color:#111">:</span>
|
|
<span style="color:#75715e"># How _wide_ the columns are, in terminal characters. In this case we have</span>
|
|
<span style="color:#75715e"># six columns, each of which are 35 characters wide</span>
|
|
columns<span style="color:#111">:</span> <span style="color:#111">[</span><span style="color:#ae81ff">35</span><span style="color:#111">,</span> <span style="color:#ae81ff">35</span><span style="color:#111">,</span> <span style="color:#ae81ff">35</span><span style="color:#111">,</span> <span style="color:#ae81ff">35</span><span style="color:#111">,</span> <span style="color:#ae81ff">35</span><span style="color:#111">,</span> <span style="color:#ae81ff">35</span><span style="color:#111">]</span>
|
|
|
|
<span style="color:#75715e"># How _high_ the rows are, in terminal lines. In this case we have five rows</span>
|
|
<span style="color:#75715e"># that support ten line of text, one of three lines, and one of four</span>
|
|
rows<span style="color:#111">:</span> <span style="color:#111">[</span><span style="color:#ae81ff">10</span><span style="color:#111">,</span> <span style="color:#ae81ff">10</span><span style="color:#111">,</span> <span style="color:#ae81ff">10</span><span style="color:#111">,</span> <span style="color:#ae81ff">10</span><span style="color:#111">,</span> <span style="color:#ae81ff">10</span><span style="color:#111">,</span> <span style="color:#ae81ff">3</span><span style="color:#111">,</span> <span style="color:#ae81ff">4</span><span style="color:#111">]</span>
|
|
openFileUtil<span style="color:#111">:</span> open <span style="color:#75715e"># the name of the utility to call to open files</span>
|
|
refreshInterval<span style="color:#111">:</span> <span style="color:#ae81ff">1</span> <span style="color:#75715e"># the app refreshes once per second</span>
|
|
term<span style="color:#111">:</span> <span style="color:#d88200">"xterm-256color"</span></code></pre></div>
|
|
<h3 id="attributes">Attributes</h3>
|
|
|
|
<p><code>colors.background</code> <br />
|
|
The color to draw the background of the app in. Use this to match your
|
|
terminal colors. May be over-written by individual module
|
|
configurations. <br />
|
|
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11
|
|
color name</a>.</p>
|
|
|
|
<p><code>colors.border.focusable</code> <br />
|
|
The color in which to draw the border of widgets that can accept
|
|
keyboard focus. <br />
|
|
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11
|
|
color name</a>.</p>
|
|
|
|
<p><code>colors.border.focused</code> <br />
|
|
The color in which to draw the border of the widget that currently has
|
|
keyboard focus. <br />
|
|
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11
|
|
color name</a>.</p>
|
|
|
|
<p><code>colors.border.normal</code> <br />
|
|
The color in which to draw the borders of the widgets that cannot accept
|
|
focus. <br/>
|
|
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11
|
|
color name</a>.</p>
|
|
|
|
<p><code>grid.columns</code> <br />
|
|
An array that defines the widths of all the columns. <br />
|
|
Values: See <a href="https://github.com/rivo/tview/wiki/Grid">tview’s
|
|
Grid</a> for details.</p>
|
|
|
|
<p><code>grid.rows</code> <br />
|
|
An array that defines the heights of all the rows. <br />
|
|
Values: See <a href="https://github.com/rivo/tview/wiki/Grid">tview’s
|
|
Grid</a> for details.</p>
|
|
|
|
<p><code>openFileUtil</code> <br />
|
|
Command to use to open a file or URL</p>
|
|
|
|
<p><code>refreshInterval</code> <br />
|
|
How often, in seconds, the UI refreshes itself. <br />
|
|
<strong>Note:</strong> This implementation is probably wrong and buggy and likely to
|
|
change. <br />
|
|
Values: A positive integer, <code>0..n</code>.</p>
|
|
|
|
<p><code>term</code> <br />
|
|
<em>Optional</em>. <br />
|
|
Sets a custom value for the terminal type this app runs in. Leave this entry out of the config if you simply want to use your terminal’s
|
|
default setting. <br />
|
|
<strong>Note:</strong> If an invalid value is provided for this setting, the app will
|
|
crash with a <code>"terminal entry not found"</code> error. <br />
|
|
Values: Any valid terminal type (ie: vt100, xterm, xterm-256color, ansi,
|
|
etc.).</p>
|
|
|
|
|
|
|
|
|
|
<div class="chevrons">
|
|
<div id="navigation">
|
|
<a class="nav nav-prev" href="/configuration/" title="Configuration"> <i class="fa fa-chevron-left"></i><label>Configuration</label></a>
|
|
<a class="nav nav-next" href="/configuration/iterm2/" title="iTerm2" style="margin-right: 0px;"><label>iTerm2</label><i class="fa fa-chevron-right"></i></a></div>
|
|
</div>
|
|
|
|
</section>
|
|
</article>
|
|
|
|
<footer>
|
|
|
|
<div class="footline">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="date">
|
|
<i class='fa fa-calendar'></i> Last update on 16/05/2018
|
|
</div>
|
|
|
|
|
|
<div class="github-link">
|
|
<a href="https://github.com/vjeantet/hugo-theme-docdock/edit/master/exampleSite/content/configuration/attributes.md" target="blank"><i class="fa fa-code-fork"></i>
|
|
Improve this page</a>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</footer>
|
|
|
|
<script src="/js/clipboard.min.js"></script>
|
|
|
|
<link href="/css/featherlight.min.css" rel="stylesheet">
|
|
<script src="/js/featherlight.min.js"></script>
|
|
|
|
|
|
|
|
<script src="/theme-flex/script.js"></script>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</body>
|
|
</html> |