File: README.html

package info (click to toggle)
ptask 1.0.0-1.1
links: PTS, VCS
area: main
in suites: bookworm, bullseye, forky, sid, trixie
size: 1,400 kB
sloc: sh: 4,762; perl: 2,623; ansic: 2,086; makefile: 72; xml: 57; sed: 16
file content (494 lines) | stat: -rw-r--r-- 13,331 bytes
parent folder | download | duplicates (2)
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
    "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 8.6.9" />
<title>ptask README</title>
<style type="text/css">
body {
    background: #FFFFFF;
    color: #333333;
    font-family: Ubuntu,Arial,sans-serif;
    line-height: 1.6;
    font-weight: lighter;
    margin: 1em 2em 2em 2em;
    padding: 0 0 0 0;
}

h1 {
    font-size: 2.813em;
    margin: 0 0 0.267em 0;
    padding: 0 0 0 0;
    font-weight: normal;
}

h2 {
    font-size: 2em;
    margin: 0 0 0.375em;
    padding: 0 0 0 0;
    font-weight: normal;
}

h3 {
    font-size: 1.438em;
    margin: 0 0 0.522em;
    padding: 0 0 0 0;
    font-weight: normal;
}

h4 {
    font-size: 1.219em;
    margin: 0 0 0.615em;
    padding: 0 0 0 0;
    font-weight: normal;
}

h5 {
    font-size: 1em;
    margin: 0 0 0.75em;
    padding: 0 0 0 0;
    font-weight: bold;
}

h6 {
    font-weight: normal;
    font-size: 0.813em;
    letter-spacing: 0.1em;
    margin: 0 0 0.923em;
    text-transform: uppercase;
    padding: 0 0 0 0;
}

li {
    margin: 0 0 0 1em;
    line-height: 1.6;
}

li p {
    margin: 0 0 0 0;
}

ul {
    margin: 0 0 0 0;
    padding: 0 0 0 0;
}

a:link, a:visited {
    color: #19B6EE;
    text-decoration: none;
}

a:hover {
    text-decoration: underline;
}

code, pre, tt {
    font-family: "Ubuntu Mono","Courier New",Courier,monospace;
    font-weight: normal;
    color: #333333;
}

pre {
    background: none repeat scroll 0 0 #e0e0e0;
    border-radius: 4px;
    padding: 0.5em 0.5em;
    margin: 0 0 0 0;
    white-space: pre-wrap;
    word-wrap: break-word;
}

/* ASCIIDOC */

div.toclevel2 {
    margin-left: 1em;
}

#toctitle {
    font-size: 1.219em;
    margin: 0 0 0.615em;
    padding: 0 0 0 0;
    font-weight: normal;
}

#footer {
    margin: 2em 0 0 0;
    font-size: 0.8em;
    font-weight: lighter;
}


</style>
<script type="text/javascript">
/*<![CDATA[*/
var asciidoc = {  // Namespace.

/////////////////////////////////////////////////////////////////////
// Table Of Contents generator
/////////////////////////////////////////////////////////////////////

/* Author: Mihai Bazon, September 2002
 * http://students.infoiasi.ro/~mishoo
 *
 * Table Of Content generator
 * Version: 0.4
 *
 * Feel free to use this script under the terms of the GNU General Public
 * License, as long as you do not remove or alter this notice.
 */

 /* modified by Troy D. Hanson, September 2006. License: GPL */
 /* modified by Stuart Rackham, 2006, 2009. License: GPL */

// toclevels = 1..4.
toc: function (toclevels) {

  function getText(el) {
    var text = "";
    for (var i = el.firstChild; i != null; i = i.nextSibling) {
      if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
        text += i.data;
      else if (i.firstChild != null)
        text += getText(i);
    }
    return text;
  }

  function TocEntry(el, text, toclevel) {
    this.element = el;
    this.text = text;
    this.toclevel = toclevel;
  }

  function tocEntries(el, toclevels) {
    var result = new Array;
    var re = new RegExp('[hH]([1-'+(toclevels+1)+'])');
    // Function that scans the DOM tree for header elements (the DOM2
    // nodeIterator API would be a better technique but not supported by all
    // browsers).
    var iterate = function (el) {
      for (var i = el.firstChild; i != null; i = i.nextSibling) {
        if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
          var mo = re.exec(i.tagName);
          if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
            result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
          }
          iterate(i);
        }
      }
    }
    iterate(el);
    return result;
  }

  var toc = document.getElementById("toc");
  if (!toc) {
    return;
  }

  // Delete existing TOC entries in case we're reloading the TOC.
  var tocEntriesToRemove = [];
  var i;
  for (i = 0; i < toc.childNodes.length; i++) {
    var entry = toc.childNodes[i];
    if (entry.nodeName.toLowerCase() == 'div'
     && entry.getAttribute("class")
     && entry.getAttribute("class").match(/^toclevel/))
      tocEntriesToRemove.push(entry);
  }
  for (i = 0; i < tocEntriesToRemove.length; i++) {
    toc.removeChild(tocEntriesToRemove[i]);
  }

  // Rebuild TOC entries.
  var entries = tocEntries(document.getElementById("content"), toclevels);
  for (var i = 0; i < entries.length; ++i) {
    var entry = entries[i];
    if (entry.element.id == "")
      entry.element.id = "_toc_" + i;
    var a = document.createElement("a");
    a.href = "#" + entry.element.id;
    a.appendChild(document.createTextNode(entry.text));
    var div = document.createElement("div");
    div.appendChild(a);
    div.className = "toclevel" + entry.toclevel;
    toc.appendChild(div);
  }
  if (entries.length == 0)
    toc.parentNode.removeChild(toc);
},


/////////////////////////////////////////////////////////////////////
// Footnotes generator
/////////////////////////////////////////////////////////////////////

/* Based on footnote generation code from:
 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
 */

footnotes: function () {
  // Delete existing footnote entries in case we're reloading the footnodes.
  var i;
  var noteholder = document.getElementById("footnotes");
  if (!noteholder) {
    return;
  }
  var entriesToRemove = [];
  for (i = 0; i < noteholder.childNodes.length; i++) {
    var entry = noteholder.childNodes[i];
    if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")
      entriesToRemove.push(entry);
  }
  for (i = 0; i < entriesToRemove.length; i++) {
    noteholder.removeChild(entriesToRemove[i]);
  }

  // Rebuild footnote entries.
  var cont = document.getElementById("content");
  var spans = cont.getElementsByTagName("span");
  var refs = {};
  var n = 0;
  for (i=0; i<spans.length; i++) {
    if (spans[i].className == "footnote") {
      n++;
      var note = spans[i].getAttribute("data-note");
      if (!note) {
        // Use [\s\S] in place of . so multi-line matches work.
        // Because JavaScript has no s (dotall) regex flag.
        note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
        spans[i].innerHTML =
          "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
          "' title='View footnote' class='footnote'>" + n + "</a>]";
        spans[i].setAttribute("data-note", note);
      }
      noteholder.innerHTML +=
        "<div class='footnote' id='_footnote_" + n + "'>" +
        "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
        n + "</a>. " + note + "</div>";
      var id =spans[i].getAttribute("id");
      if (id != null) refs["#"+id] = n;
    }
  }
  if (n == 0)
    noteholder.parentNode.removeChild(noteholder);
  else {
    // Process footnoterefs.
    for (i=0; i<spans.length; i++) {
      if (spans[i].className == "footnoteref") {
        var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
        href = href.match(/#.*/)[0];  // Because IE return full URL.
        n = refs[href];
        spans[i].innerHTML =
          "[<a href='#_footnote_" + n +
          "' title='View footnote' class='footnote'>" + n + "</a>]";
      }
    }
  }
},

install: function(toclevels) {
  var timerId;

  function reinstall() {
    asciidoc.footnotes();
    if (toclevels) {
      asciidoc.toc(toclevels);
    }
  }

  function reinstallAndRemoveTimer() {
    clearInterval(timerId);
    reinstall();
  }

  timerId = setInterval(reinstall, 500);
  if (document.addEventListener)
    document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
  else
    window.onload = reinstallAndRemoveTimer;
}

}
asciidoc.install(2);
/*]]>*/
</script>
</head>
<body class="article">
<div id="header">
<h1>ptask README</h1>
<div id="toc">
  <div id="toctitle">Table of Contents</div>
  <noscript><p><b>JavaScript must be enabled in your browser to display the table of contents.</b></p></noscript>
</div>
</div>
<div id="content">
<div id="preamble">
<div class="sectionbody">
<div class="paragraph"><p><code>ptask</code> is a GTK+ graphical user interface for managing tasks.</p></div>
<div class="paragraph"><p>It is based on <a href="http://taskwarrior.org">taskwarrior</a>, a well-known and robust command line
tasks manager.</p></div>
<div class="paragraph"><p>Unlike <code>taskwarrior</code>, it is possible to associate a note (long
description) to each task.</p></div>
<div class="paragraph"><p><code>ptask</code> is licensed under the GPLv2 terms and should compile on any
modern GNU/Linux distribution.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_installation_on_ubuntu">1. Installation on Ubuntu</h2>
<div class="sectionbody">
<div class="paragraph"><p>To install <code>ptask</code> on Ubuntu and derivates, the easiest way is to use the dedicated PPA:</p></div>
<div class="listingblock">
<div class="content">
<pre><code>sudo apt-add-repository ppa:jfi/ptask
sudo apt-get update
sudo apt-get install ptask</code></pre>
</div></div>
<div class="paragraph"><p>The PPA <code>ppa:jfi/ptask</code> contains the binary package of the last
released version of <code>ptask</code> for the last released version of Ubuntu.</p></div>
<div class="paragraph"><p>The PPA <code>ppa:jfi/ptask-daily</code> contains the binary package of the last
development snapshot. It should only be used for testing purpose.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_installation_from_source_archive">2. Installation from source archive</h2>
<div class="sectionbody">
<div class="paragraph"><p><code>ptask</code> can be compiled and installed on any modern GNU/Linux
distribution.</p></div>
<div class="sect2">
<h3 id="_prerequisites">2.1. Prerequisites</h3>
<div class="paragraph"><p>The compilation of <code>ptask</code> requires:</p></div>
<div class="ulist"><ul>
<li>
<p>
asciidoc
</p>
</li>
<li>
<p>
autotools
</p>
</li>
<li>
<p>
cppcheck (optional, static source checker)
</p>
</li>
<li>
<p>
gcc
</p>
</li>
<li>
<p>
help2man
</p>
</li>
<li>
<p>
library gtk3 &gt;= 3.12
</p>
</li>
<li>
<p>
library json-c
</p>
</li>
<li>
<p>
make
</p>
</li>
</ul></div>
<div class="paragraph"><p>For Ubuntu 12.10:</p></div>
<div class="listingblock">
<div class="content">
<pre><code>sudo apt-get install autoconf automake asciidoc cppcheck gcc gettext autopoint help2man libgtk-3-dev libjson0-dev make perl</code></pre>
</div></div>
</div>
<div class="sect2">
<h3 id="_download_sources">2.2. Download sources</h3>
<div class="paragraph"><p>Download a source tarballs of a release and extracts its content:</p></div>
<div class="listingblock">
<div class="content">
<pre><code>mkdir TMP_DIR
cd TMP_DIR
wget http://wpitchoune.net/ptask/files/ptask-last.tar.gz
tar -xzvf ptask-last.tar.gz
cd ptask-*</code></pre>
</div></div>
<div class="paragraph"><p>Alternatively, you can get the last development snapshot of the
sources directly from the SVN source repository:</p></div>
<div class="listingblock">
<div class="content">
<pre><code>mkdir TMP_DIR
cd TMP_DIR
svn co http://wpitchoune.net/svnpub/ptask/trunk
cd trunk</code></pre>
</div></div>
</div>
<div class="sect2">
<h3 id="_compilation">2.3. Compilation</h3>
<div class="listingblock">
<div class="content">
<pre><code>./configure
make clean all</code></pre>
</div></div>
</div>
<div class="sect2">
<h3 id="_installation">2.4. Installation</h3>
<div class="listingblock">
<div class="content">
<pre><code>make install</code></pre>
</div></div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_resources">3. Resources</h2>
<div class="sectionbody">
<div class="ulist"><ul>
<li>
<p>
<strong>Home page</strong>: <a href="http://wpitchoune.net/ptask">http://wpitchoune.net/ptask</a>.
</p>
</li>
<li>
<p>
<strong>RSS feed</strong>: <a href="http://wpitchoune.net/blog/category/ptask/feed/">http://wpitchoune.net/blog/category/ptask/feed/</a>.
</p>
</li>
<li>
<p>
<strong>Release changes</strong>: <a href="NEWS.html">NEWS</a>.
</p>
</li>
<li>
<p>
<strong>Source tarballs</strong>: <a href="http://wpitchoune.net/ptask/files">http://wpitchoune.net/ptask/files</a>.
</p>
</li>
<li>
<p>
<strong>Documentation</strong>: <a href="http://wpitchoune.net/ptask/doc">http://wpitchoune.net/ptask/doc</a>.
</p>
</li>
</ul></div>
</div>
</div>
<div class="sect1">
<h2 id="_contact">4. Contact</h2>
<div class="sectionbody">
<div class="paragraph"><p>Bugs and comments can be sent to <a href="mailto:jeanfi@gmail.com">jeanfi@gmail.com</a>.</p></div>
</div>
</div>
</div>
<div id="footnotes"><hr /></div>
<div id="footer">
<div id="footer-text">
Last updated
 2014-11-21 18:14:30 CET
</div>
</div>
</body>
</html>