Skip to content

Commit

Permalink
Deploying to gh-pages from @ ecca103 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
@nomeata
nomeata committed Jul 26, 2023
0 parents commit 94b494f
Show file tree
Hide file tree
Showing 19 changed files with 1,529 additions and 0 deletions.
Empty file added .nojekyll
Empty file.
1 change: 1 addition & 0 deletions CNAME
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
arbtt.nomeata.de
124 changes: 124 additions & 0 deletions arbtt.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,124 @@

/**************************** FULL-HEIGHT SIDEBAR *****************************/
html, body {
margin: 0;
height: 100%;
}

#wrapper {
min-height: 100%;
height: auto !important;
height: 100%;
margin: 0 auto;
position: relative;
}

section {
padding: 1rem;
}

nav {
width: 20rem;
position: fixed;
left: 0;
top: 0;
bottom: 0;
/* only for visual indication of layout.
* should be overriden in visual styles. */
background: silver;
}

#content {
margin-left: 20rem;max-width:60em;
}

section[id]:not(:target) { display: none; }

/****************************** VISUAL STYLES ******************************/

body {
font-family: sans-serif;
}
#wrapper:before { /* alternative image: http://upload.wikimedia.org/wikipedia/commons/9/96/Simon_Lachez_zakhorloge.jpg */
/* Freely licensed image from http://commons.wikimedia.org/wiki/File:Revolutionstaschenuhr.jpg */
background: right top url("page-bg.jpg") no-repeat;
height:100%;
width:100%;
opacity: 0.1;
position: fixed;
top:0;
right:0;
content: "";
z-index:-1;
}

#content {
color: #456;
font-size: 85%;
}

nav {
background-color: #445F66;
color: white;
border-right: 4px solid #DACFB5;
}

nav > ul {
list-style: none;
text-align: right;
}
nav > ul > li > a.active {
font-weight: bold;
color: Gold;
}

nav > ul > li > a {
color: white;
font-weight: bold;
display: block;
padding: 0.5em;
}

a {
color: OrangeRed;
text-decoration: none;
}

a:hover {
text-decoration: underline;
}

a:focus {
outline: none;
}

h1 {
font-size: 4em;
text-shadow: 2px 2px 3px rgba(255,255,255,0.2), -2px -2px 3px rgba(0,0,0,0.2);
}

.title {
text-align: center;
margin: 0;
}

code, pre {
background: #eee;
font-size: 115%;
}

pre {
padding: 1em;
}

.command:before {
content: "$ ";
}

li p {
margin: 0;
}

.installation li {
margin-top: 1em;
}
23 changes: 23 additions & 0 deletions arbtt.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
"use strict";

function get(selector) { return document.querySelectorAll(selector); };
var menuLinks = get('nav > ul > li > a');

for (var i = 0; i < menuLinks.length; i++) {
menuLinks[i].onclick = function(){
for (var j = 0; j < menuLinks.length; j++) {
menuLinks[j ].classList.remove('active');
}
this.classList.add('active');
};
}

var x = window.location;
if ( x.href.indexOf("#") < 0 ) {
var anchor = document.getElementsByTagName("section")[0].id
window.location = window.location + "#" + anchor;
menuLinks[0].classList.add('active');
}
else {
get('a[href="' + window.location.hash + '"]')[0].classList.add('active');
}
8 changes: 8 additions & 0 deletions doc/users_guide/arbtt-capture.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>arbtt-capture</title><link rel="stylesheet" type="text/css" href="fptools.css" /><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot" /><link rel="home" href="index.html" title="arbtt – The Automatic Rule-Base Time Tracker" /><link rel="up" href="references.html" title="Program references" /><link rel="prev" href="arbtt-stats.html" title="arbtt-stats" /><link rel="next" href="arbtt-dump.html" title="arbtt-dump" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">arbtt-capture</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="arbtt-stats.html">Prev</a> </td><th width="60%" align="center">Program references</th><td width="20%" align="right"> <a accesskey="n" href="arbtt-dump.html">Next</a></td></tr></table><hr /></div><div class="refentry"><a id="arbtt-capture"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>arbtt-capture — collect data samples for arbtt</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">arbtt-capture</code> [OPTION...]</p></div></div><div class="refsect1"><a id="idp877"></a><h2>Description</h2><p>
<span class="command"><strong>arbtt-capture</strong></span> runs continuously and saves at the given
sample rate, usually once per minute, the collected data to
<code class="filename">~/.arbtt/capture.log</code>.
</p></div><div class="refsect1"><a id="idp882"></a><h2>Options</h2><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">-h</code>, </span><span class="term"><code class="option">-?</code>, </span><span class="term"><code class="option">--help</code></span></dt><dd>shows a short summary of the available
options, and exists.</dd><dt><span class="term"><code class="option">-V</code>, </span><span class="term"><code class="option">--version</code></span></dt><dd>shows the version number, and exists.</dd><dt><span class="term"><code class="option">-r</code> <em class="replaceable"><code>RATE</code></em>, </span><span class="term"><code class="option">--sample-rate</code> <em class="replaceable"><code>RATE</code></em></span></dt><dd>sets the sample rate in seconds (default: 60)</dd><dt><span class="term"><code class="option">-f</code> <em class="replaceable"><code>FILE</code></em>, </span><span class="term"><code class="option">--logfile</code> <em class="replaceable"><code>FILE</code></em></span></dt><dd>logfile to use instead of <code class="filename">~/.arbtt/capture.log</code></dd><dt><span class="term"><code class="option">-d</code>, </span><span class="term"><code class="option">--dump</code></span></dt><dd>dump one current sample instead of modifying the logfile</dd></dl></div></div><div class="refsect1"><a id="idp927"></a><h2>Files</h2><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="filename">~/.arbtt/capture.log</code></span></dt><dd><p>binary file, storing the arbtt data samples</p></dd></dl></div></div><div class="refsect1"><a id="idp935"></a><h2>See also</h2><p>See the arbtt manual for more information and the <a class="ulink" href="http://hackage.haskell.org/package/arbtt" target="_top">arbtt hackage page</a> for
newer versions of arbtt.</p></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="arbtt-stats.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="references.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="arbtt-dump.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">arbtt-stats </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> arbtt-dump</td></tr></table></div></body></html>
46 changes: 46 additions & 0 deletions doc/users_guide/arbtt-dump.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>arbtt-dump</title><link rel="stylesheet" type="text/css" href="fptools.css" /><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot" /><link rel="home" href="index.html" title="arbtt – The Automatic Rule-Base Time Tracker" /><link rel="up" href="references.html" title="Program references" /><link rel="prev" href="arbtt-capture.html" title="arbtt-capture" /><link rel="next" href="arbtt-import.html" title="arbtt-import" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">arbtt-dump</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="arbtt-capture.html">Prev</a> </td><th width="60%" align="center">Program references</th><td width="20%" align="right"> <a accesskey="n" href="arbtt-import.html">Next</a></td></tr></table><hr /></div><div class="refentry"><a id="arbtt-dump"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>arbtt-dump — dumps arbtt data samples</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">arbtt-dump</code> [OPTION...]</p></div></div><div class="refsect1"><a id="idp951"></a><h2>Description</h2><p>
<span class="command"><strong>arbtt-dump</strong></span> reads the data samples recorded by <a class="xref" href="arbtt-capture.html" title="arbtt-capture"><span class="refentrytitle">arbtt-capture</span>(1)</a> and writes them so the standard output in an
ascii based format.
</p></div><div class="refsect1"><a id="idp956"></a><h2>Options</h2><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">-h</code>, </span><span class="term"><code class="option">-?</code>, </span><span class="term"><code class="option">--help</code></span></dt><dd>shows a short summary of the available
options, and exists.</dd><dt><span class="term"><code class="option">-V</code>, </span><span class="term"><code class="option">--version</code></span></dt><dd>shows the version number, and exists.</dd><dt><span class="term"><code class="option">-f</code> <em class="replaceable"><code>FILE</code></em>, </span><span class="term"><code class="option">--logfile</code> <em class="replaceable"><code>FILE</code></em></span></dt><dd>logfile to use instead of <code class="filename">~/.arbtt/capture.log</code></dd><dt><span class="term"><code class="option">-t</code> <em class="replaceable"><code>FORMAT</code></em>, </span><span class="term"><code class="option">--format</code> <em class="replaceable"><code>FORMAT</code></em></span></dt><dd>dumping format to use, where <em class="replaceable"><code>FORMAT</code></em> is one of <code class="literal">human</code> (the default), <code class="literal">show</code> or <code class="literal">JSON</code>. Case in-sensitive.</dd><dt><span class="term"><code class="option">-l</code> <em class="replaceable"><code>NUMBER</code></em>, </span><span class="term"><code class="option">--last</code> <em class="replaceable"><code>NUMBER</code></em></span></dt><dd>dump only the last <em class="replaceable"><code>NUMBER</code></em> of samples.</dd></dl></div></div><div class="refsect1"><a id="idp1008"></a><h2>Files</h2><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="filename">~/.arbtt/capture.log</code></span></dt><dd><p>binary file, storing the arbtt data samples</p></dd></dl></div></div><div class="refsect1"><a id="idp1016"></a><h2>Formats</h2><div class="refsect2"><a id="idp1018"></a><h3>Human</h3><p>This format is intended for human inspection, but not for further
processing. Hence, it may change in new versions of arbtt without notice.
Example output:</p><pre class="screen">2013-06-20 14:53:50 (48ms inactive):
( ) Navigator: arbtt-dump - Iceweasel
( ) gnome-terminal-server: jojo@kirk:~/projekte/programming/arbtt/doc
(*) gvim: arbtt.xml + (~/projekte/programming/arbtt/doc) - GVIM2
</pre><p>The line with a star indicates the currently active window.</p></div><div class="refsect2"><a id="idp1023"></a><h3>Show</h3><p>This is the default serialization format of Haskell's
<code class="literal">Show</code> type class, one entry per line. This can be
useful if the data is to be processed by further Haskell code. Example
output, with indentation added manually:</p><pre class="screen">TimeLogEntry
{ tlTime = 2013-06-20 14:53:50.957763 UTC
, tlRate = 60000
, tlData = CaptureData
{ cWindows =
[ (False,"arbtt-dump - Iceweasel","Navigator")
, (False,"jojo@kirk:~/projekte/programming/arbtt/doc","gnome-terminal-server")
, (True,"arbtt.xml + (~/projekte/programming/arbtt/doc) - GVIM2","gvim")
]
, cLastActivity = 48
}
}</pre></div><div class="refsect2"><a id="idp1028"></a><h3>JSON</h3><p>For interoperability, arbtt supports dumping its data to JSON, which can
easily be parsed by many different programming languages. Some level of
backward-compatibility will be provided, as far as possible. Default
output, again with indentation and spacing added manually:</p><pre class="screen">[ ...,
{ "windows": [
{ "program": "arbtt-dump - Iceweasel",
"title": "Navigator",
"active": false},
{ "program": "jojo@kirk:~/projekte/programming/arbtt/doc",
"title":" gnome-terminal-server",
"active": false},
{ "program": "arbtt.xml + (~/projekte/programming/arbtt/doc) - GVIM2",
"title": "gvim",
"active":true
}],
"inactive": 48,
"date": "2013-06-20T14:53:50.957Z",
"rate": 60000},
...
]</pre></div></div><div class="refsect1"><a id="idp1032"></a><h2>See also</h2><p>See the arbtt manual for more information and the <a class="ulink" href="http://hackage.haskell.org/package/arbtt" target="_top">arbtt hackage page</a> for
newer versions of arbtt.</p></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="arbtt-capture.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="references.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="arbtt-import.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">arbtt-capture </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> arbtt-import</td></tr></table></div></body></html>
16 changes: 16 additions & 0 deletions doc/users_guide/arbtt-import.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>arbtt-import</title><link rel="stylesheet" type="text/css" href="fptools.css" /><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot" /><link rel="home" href="index.html" title="arbtt – The Automatic Rule-Base Time Tracker" /><link rel="up" href="references.html" title="Program references" /><link rel="prev" href="arbtt-dump.html" title="arbtt-dump" /><link rel="next" href="arbtt-recover.html" title="arbtt-recover" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">arbtt-import</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="arbtt-dump.html">Prev</a> </td><th width="60%" align="center">Program references</th><td width="20%" align="right"> <a accesskey="n" href="arbtt-recover.html">Next</a></td></tr></table><hr /></div><div class="refentry"><a id="arbtt-import"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>arbtt-import — imports dumped arbtt data samples</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">arbtt-import</code> [OPTION...]</p></div></div><div class="refsect1"><a id="idp1044"></a><h2>Description</h2><p>
<span class="command"><strong>arbtt-import</strong></span> reads data from standard input and adds
the entries to the logfile. It supports the <code class="literal">Show</code>
format as well as the <code class="literal">JSON</code> format, and can be used in
a streaming fashion (i.e. it will write entries as they are read from
standard input).
</p><p>
By default, this program completely overrides the existing file, therefore it
will refuse to work if the log file already exists. If you want to
overwrite a file, please delete it before running
<span class="command"><strong>arbtt-import</strong></span>. If you want to extend an existing file,
use the <code class="option">--append</code> option.
</p></div><div class="refsect1"><a id="idp1053"></a><h2>Options</h2><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">-h</code>, </span><span class="term"><code class="option">-?</code>, </span><span class="term"><code class="option">--help</code></span></dt><dd>shows a short summary of the available
options, and exists.</dd><dt><span class="term"><code class="option">-V</code>, </span><span class="term"><code class="option">--version</code></span></dt><dd>shows the version number, and exists.</dd><dt><span class="term"><code class="option">-f</code> <em class="replaceable"><code>FILE</code></em>, </span><span class="term"><code class="option">--logfile</code> <em class="replaceable"><code>FILE</code></em></span></dt><dd>logfile to use instead of <code class="filename">~/.arbtt/capture.log</code></dd><dt><span class="term"><code class="option">-a</code>, </span><span class="term"><code class="option">--append</code></span></dt><dd>append the log file, if it already exists</dd><dt><span class="term"><code class="option">-t</code> <em class="replaceable"><code>FORMAT</code></em>, </span><span class="term"><code class="option">--format</code> <em class="replaceable"><code>FORMAT</code></em></span></dt><dd>format to use, where <em class="replaceable"><code>FORMAT</code></em> is one of <code class="literal">show</code> (the default) or <code class="literal">JSON</code>. The JSON format can either be a list of records (as dumped by <a class="xref" href="arbtt-dump.html" title="arbtt-dump"><span class="refentrytitle">arbtt-dump</span>(1)</a>), or just one record after another (useful in streaming mode).</dd></dl></div></div><div class="refsect1"><a id="idp1102"></a><h2>Files</h2><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="filename">~/.arbtt/capture.log</code></span></dt><dd><p>binary file, storing the arbtt data samples</p></dd></dl></div></div><div class="refsect1"><a id="idp1110"></a><h2>See also</h2><p>See the arbtt manual for more information and the <a class="ulink" href="http://hackage.haskell.org/package/arbtt" target="_top">arbtt hackage page</a> for
newer versions of arbtt.</p></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="arbtt-dump.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="references.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="arbtt-recover.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">arbtt-dump </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> arbtt-recover</td></tr></table></div></body></html>
Loading

0 comments on commit 94b494f

Please sign in to comment.