README.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"\r
   2     "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">\r
   3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">\r
   4 <head>\r
   5 <meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />\r
   6 <meta name="generator" content="AsciiDoc 8.6.9" />\r
   7 <title>ptask README</title>\r
   8 <style type="text/css">\r
   9 body {\r
  10     background: #FFFFFF;\r
  11     color: #333333;\r
  12     font-family: Ubuntu,Arial,sans-serif;\r
  13     line-height: 1.6;\r
  14     font-weight: lighter;\r
  15     margin: 1em 2em 2em 2em;\r
  16     padding: 0 0 0 0;\r
  17 }\r
  18 \r
  19 h1 {\r
  20     font-size: 2.813em;\r
  21     margin: 0 0 0.267em 0;\r
  22     padding: 0 0 0 0;\r
  23     font-weight: normal;\r
  24 }\r
  25 \r
  26 h2 {\r
  27     font-size: 2em;\r
  28     margin: 0 0 0.375em;\r
  29     padding: 0 0 0 0;\r
  30     font-weight: normal;\r
  31 }\r
  32 \r
  33 h3 {\r
  34     font-size: 1.438em;\r
  35     margin: 0 0 0.522em;\r
  36     padding: 0 0 0 0;\r
  37     font-weight: normal;\r
  38 }\r
  39 \r
  40 h4 {\r
  41     font-size: 1.219em;\r
  42     margin: 0 0 0.615em;\r
  43     padding: 0 0 0 0;\r
  44     font-weight: normal;\r
  45 }\r
  46 \r
  47 h5 {\r
  48     font-size: 1em;\r
  49     margin: 0 0 0.75em;\r
  50     padding: 0 0 0 0;\r
  51     font-weight: bold;\r
  52 }\r
  53 \r
  54 h6 {\r
  55     font-weight: normal;\r
  56     font-size: 0.813em;\r
  57     letter-spacing: 0.1em;\r
  58     margin: 0 0 0.923em;\r
  59     text-transform: uppercase;\r
  60     padding: 0 0 0 0;\r
  61 }\r
  62 \r
  63 li {\r
  64     margin: 0 0 0 1em;\r
  65     line-height: 1.6;\r
  66 }\r
  67 \r
  68 li p {\r
  69     margin: 0 0 0 0;\r
  70 }\r
  71 \r
  72 ul {\r
  73     margin: 0 0 0 0;\r
  74     padding: 0 0 0 0;\r
  75 }\r
  76 \r
  77 a:link, a:visited {\r
  78     color: #19B6EE;\r
  79     text-decoration: none;\r
  80 }\r
  81 \r
  82 a:hover {\r
  83     text-decoration: underline;\r
  84 }\r
  85 \r
  86 code, pre, tt {\r
  87     font-family: "Ubuntu Mono","Courier New",Courier,monospace;\r
  88     font-weight: normal;\r
  89     color: #333333;\r
  90 }\r
  91 \r
  92 pre {\r
  93     background: none repeat scroll 0 0 #e0e0e0;\r
  94     border-radius: 4px;\r
  95     padding: 0.5em 0.5em;\r
  96     margin: 0 0 0 0;\r
  97     white-space: pre-wrap;\r
  98     word-wrap: break-word;\r
  99 }\r
 100 \r
 101 /* ASCIIDOC */\r
 102 \r
 103 div.toclevel2 {\r
 104     margin-left: 1em;\r
 105 }\r
 106 \r
 107 #toctitle {\r
 108     font-size: 1.219em;\r
 109     margin: 0 0 0.615em;\r
 110     padding: 0 0 0 0;\r
 111     font-weight: normal;\r
 112 }\r
 113 \r
 114 #footer {\r
 115     margin: 2em 0 0 0;\r
 116     font-size: 0.8em;\r
 117     font-weight: lighter;\r
 118 }\r
 119 \r
 120 \r
 121 </style>\r
 122 <script type="text/javascript">\r
 123 /*<![CDATA[*/\r
 124 var asciidoc = {  // Namespace.\r
 125 \r
 126 /////////////////////////////////////////////////////////////////////\r
 127 // Table Of Contents generator\r
 128 /////////////////////////////////////////////////////////////////////\r
 129 \r
 130 /* Author: Mihai Bazon, September 2002\r
 131  * http://students.infoiasi.ro/~mishoo\r
 132  *\r
 133  * Table Of Content generator\r
 134  * Version: 0.4\r
 135  *\r
 136  * Feel free to use this script under the terms of the GNU General Public\r
 137  * License, as long as you do not remove or alter this notice.\r
 138  */\r
 139 \r
 140  /* modified by Troy D. Hanson, September 2006. License: GPL */\r
 141  /* modified by Stuart Rackham, 2006, 2009. License: GPL */\r
 142 \r
 143 // toclevels = 1..4.\r
 144 toc: function (toclevels) {\r
 145 \r
 146   function getText(el) {\r
 147     var text = "";\r
 148     for (var i = el.firstChild; i != null; i = i.nextSibling) {\r
 149       if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.\r
 150         text += i.data;\r
 151       else if (i.firstChild != null)\r
 152         text += getText(i);\r
 153     }\r
 154     return text;\r
 155   }\r
 156 \r
 157   function TocEntry(el, text, toclevel) {\r
 158     this.element = el;\r
 159     this.text = text;\r
 160     this.toclevel = toclevel;\r
 161   }\r
 162 \r
 163   function tocEntries(el, toclevels) {\r
 164     var result = new Array;\r
 165     var re = new RegExp('[hH]([1-'+(toclevels+1)+'])');\r
 166     // Function that scans the DOM tree for header elements (the DOM2\r
 167     // nodeIterator API would be a better technique but not supported by all\r
 168     // browsers).\r
 169     var iterate = function (el) {\r
 170       for (var i = el.firstChild; i != null; i = i.nextSibling) {\r
 171         if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {\r
 172           var mo = re.exec(i.tagName);\r
 173           if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {\r
 174             result[result.length] = new TocEntry(i, getText(i), mo[1]-1);\r
 175           }\r
 176           iterate(i);\r
 177         }\r
 178       }\r
 179     }\r
 180     iterate(el);\r
 181     return result;\r
 182   }\r
 183 \r
 184   var toc = document.getElementById("toc");\r
 185   if (!toc) {\r
 186     return;\r
 187   }\r
 188 \r
 189   // Delete existing TOC entries in case we're reloading the TOC.\r
 190   var tocEntriesToRemove = [];\r
 191   var i;\r
 192   for (i = 0; i < toc.childNodes.length; i++) {\r
 193     var entry = toc.childNodes[i];\r
 194     if (entry.nodeName.toLowerCase() == 'div'\r
 195      && entry.getAttribute("class")\r
 196      && entry.getAttribute("class").match(/^toclevel/))\r
 197       tocEntriesToRemove.push(entry);\r
 198   }\r
 199   for (i = 0; i < tocEntriesToRemove.length; i++) {\r
 200     toc.removeChild(tocEntriesToRemove[i]);\r
 201   }\r
 202 \r
 203   // Rebuild TOC entries.\r
 204   var entries = tocEntries(document.getElementById("content"), toclevels);\r
 205   for (var i = 0; i < entries.length; ++i) {\r
 206     var entry = entries[i];\r
 207     if (entry.element.id == "")\r
 208       entry.element.id = "_toc_" + i;\r
 209     var a = document.createElement("a");\r
 210     a.href = "#" + entry.element.id;\r
 211     a.appendChild(document.createTextNode(entry.text));\r
 212     var div = document.createElement("div");\r
 213     div.appendChild(a);\r
 214     div.className = "toclevel" + entry.toclevel;\r
 215     toc.appendChild(div);\r
 216   }\r
 217   if (entries.length == 0)\r
 218     toc.parentNode.removeChild(toc);\r
 219 },\r
 220 \r
 221 \r
 222 /////////////////////////////////////////////////////////////////////\r
 223 // Footnotes generator\r
 224 /////////////////////////////////////////////////////////////////////\r
 225 \r
 226 /* Based on footnote generation code from:\r
 227  * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html\r
 228  */\r
 229 \r
 230 footnotes: function () {\r
 231   // Delete existing footnote entries in case we're reloading the footnodes.\r
 232   var i;\r
 233   var noteholder = document.getElementById("footnotes");\r
 234   if (!noteholder) {\r
 235     return;\r
 236   }\r
 237   var entriesToRemove = [];\r
 238   for (i = 0; i < noteholder.childNodes.length; i++) {\r
 239     var entry = noteholder.childNodes[i];\r
 240     if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")\r
 241       entriesToRemove.push(entry);\r
 242   }\r
 243   for (i = 0; i < entriesToRemove.length; i++) {\r
 244     noteholder.removeChild(entriesToRemove[i]);\r
 245   }\r
 246 \r
 247   // Rebuild footnote entries.\r
 248   var cont = document.getElementById("content");\r
 249   var spans = cont.getElementsByTagName("span");\r
 250   var refs = {};\r
 251   var n = 0;\r
 252   for (i=0; i<spans.length; i++) {\r
 253     if (spans[i].className == "footnote") {\r
 254       n++;\r
 255       var note = spans[i].getAttribute("data-note");\r
 256       if (!note) {\r
 257         // Use [\s\S] in place of . so multi-line matches work.\r
 258         // Because JavaScript has no s (dotall) regex flag.\r
 259         note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];\r
 260         spans[i].innerHTML =\r
 261           "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +\r
 262           "' title='View footnote' class='footnote'>" + n + "</a>]";\r
 263         spans[i].setAttribute("data-note", note);\r
 264       }\r
 265       noteholder.innerHTML +=\r
 266         "<div class='footnote' id='_footnote_" + n + "'>" +\r
 267         "<a href='#_footnoteref_" + n + "' title='Return to text'>" +\r
 268         n + "</a>. " + note + "</div>";\r
 269       var id =spans[i].getAttribute("id");\r
 270       if (id != null) refs["#"+id] = n;\r
 271     }\r
 272   }\r
 273   if (n == 0)\r
 274     noteholder.parentNode.removeChild(noteholder);\r
 275   else {\r
 276     // Process footnoterefs.\r
 277     for (i=0; i<spans.length; i++) {\r
 278       if (spans[i].className == "footnoteref") {\r
 279         var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");\r
 280         href = href.match(/#.*/)[0];  // Because IE return full URL.\r
 281         n = refs[href];\r
 282         spans[i].innerHTML =\r
 283           "[<a href='#_footnote_" + n +\r
 284           "' title='View footnote' class='footnote'>" + n + "</a>]";\r
 285       }\r
 286     }\r
 287   }\r
 288 },\r
 289 \r
 290 install: function(toclevels) {\r
 291   var timerId;\r
 292 \r
 293   function reinstall() {\r
 294     asciidoc.footnotes();\r
 295     if (toclevels) {\r
 296       asciidoc.toc(toclevels);\r
 297     }\r
 298   }\r
 299 \r
 300   function reinstallAndRemoveTimer() {\r
 301     clearInterval(timerId);\r
 302     reinstall();\r
 303   }\r
 304 \r
 305   timerId = setInterval(reinstall, 500);\r
 306   if (document.addEventListener)\r
 307     document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);\r
 308   else\r
 309     window.onload = reinstallAndRemoveTimer;\r
 310 }\r
 311 \r
 312 }\r
 313 asciidoc.install(2);\r
 314 /*]]>*/\r
 315 </script>\r
 316 </head>\r
 317 <body class="article">\r
 318 <div id="header">\r
 319 <h1>ptask README</h1>\r
 320 <div id="toc">
 321   <div id="toctitle">Table of Contents</div>
 322   <noscript><p><b>JavaScript must be enabled in your browser to display the table of contents.</b></p></noscript>
 323 </div>\r
 324 </div>\r
 325 <div id="content">\r
 326 <div id="preamble">\r
 327 <div class="sectionbody">\r
 328 <div class="paragraph"><p><code>ptask</code> is a GTK+ graphical user interface for managing tasks.</p></div>\r
 329 <div class="paragraph"><p>It is based on <a href="http://taskwarrior.org">taskwarrior</a>, a well-known and robust command line\r
 330 tasks manager.</p></div>\r
 331 <div class="paragraph"><p>Unlike <code>taskwarrior</code>, it is possible to associate a note (long\r
 332 description) to each task.</p></div>\r
 333 <div class="paragraph"><p><code>ptask</code> is licensed under the GPLv2 terms and should compile on any\r
 334 modern GNU/Linux distribution.</p></div>\r
 335 </div>\r
 336 </div>\r
 337 <div class="sect1">\r
 338 <h2 id="_installation_on_ubuntu">1. Installation on Ubuntu</h2>\r
 339 <div class="sectionbody">\r
 340 <div class="paragraph"><p>To install <code>ptask</code> on Ubuntu and derivates, the easiest way is to use the dedicated PPA:</p></div>\r
 341 <div class="listingblock">\r
 342 <div class="content">\r
 343 <pre><code>sudo apt-add-repository ppa:jfi/ptask\r
 344 sudo apt-get update\r
 345 sudo apt-get install ptask</code></pre>\r
 346 </div></div>\r
 347 <div class="paragraph"><p>The PPA <code>ppa:jfi/ptask</code> contains the binary package of the last\r
 348 released version of <code>ptask</code> for the last released version of Ubuntu.</p></div>\r
 349 <div class="paragraph"><p>The PPA <code>ppa:jfi/ptask-daily</code> contains the binary package of the last\r
 350 development snapshot. It should only be used for testing purpose.</p></div>\r
 351 </div>\r
 352 </div>\r
 353 <div class="sect1">\r
 354 <h2 id="_installation_from_source_archive">2. Installation from source archive</h2>\r
 355 <div class="sectionbody">\r
 356 <div class="paragraph"><p><code>ptask</code> can be compiled and installed on any modern GNU/Linux\r
 357 distribution.</p></div>\r
 358 <div class="sect2">\r
 359 <h3 id="_prerequisites">2.1. Prerequisites</h3>\r
 360 <div class="paragraph"><p>The compilation of <code>ptask</code> requires:</p></div>\r
 361 <div class="ulist"><ul>\r
 362 <li>\r
 363 <p>\r
 364 asciidoc\r
 365 </p>\r
 366 </li>\r
 367 <li>\r
 368 <p>\r
 369 autotools\r
 370 </p>\r
 371 </li>\r
 372 <li>\r
 373 <p>\r
 374 cppcheck (optional, static source checker)\r
 375 </p>\r
 376 </li>\r
 377 <li>\r
 378 <p>\r
 379 gcc\r
 380 </p>\r
 381 </li>\r
 382 <li>\r
 383 <p>\r
 384 help2man\r
 385 </p>\r
 386 </li>\r
 387 <li>\r
 388 <p>\r
 389 library gtk3 &gt;= 3.12\r
 390 </p>\r
 391 </li>\r
 392 <li>\r
 393 <p>\r
 394 library json-c\r
 395 </p>\r
 396 </li>\r
 397 <li>\r
 398 <p>\r
 399 make\r
 400 </p>\r
 401 </li>\r
 402 </ul></div>\r
 403 <div class="paragraph"><p>For Ubuntu 12.10:</p></div>\r
 404 <div class="listingblock">\r
 405 <div class="content">\r
 406 <pre><code>sudo apt-get install autoconf automake asciidoc cppcheck gcc gettext autopoint help2man libgtk-3-dev libjson0-dev make perl</code></pre>\r
 407 </div></div>\r
 408 </div>\r
 409 <div class="sect2">\r
 410 <h3 id="_download_sources">2.2. Download sources</h3>\r
 411 <div class="paragraph"><p>Download a source tarballs of a release and extracts its content:</p></div>\r
 412 <div class="listingblock">\r
 413 <div class="content">\r
 414 <pre><code>mkdir TMP_DIR\r
 415 cd TMP_DIR\r
 416 wget http://wpitchoune.net/ptask/files/ptask-last.tar.gz\r
 417 tar -xzvf ptask-last.tar.gz\r
 418 cd ptask-*</code></pre>\r
 419 </div></div>\r
 420 <div class="paragraph"><p>Alternatively, you can get the last development snapshot of the\r
 421 sources directly from the SVN source repository:</p></div>\r
 422 <div class="listingblock">\r
 423 <div class="content">\r
 424 <pre><code>mkdir TMP_DIR\r
 425 cd TMP_DIR\r
 426 svn co http://wpitchoune.net/svnpub/ptask/trunk\r
 427 cd trunk</code></pre>\r
 428 </div></div>\r
 429 </div>\r
 430 <div class="sect2">\r
 431 <h3 id="_compilation">2.3. Compilation</h3>\r
 432 <div class="listingblock">\r
 433 <div class="content">\r
 434 <pre><code>./configure\r
 435 make clean all</code></pre>\r
 436 </div></div>\r
 437 </div>\r
 438 <div class="sect2">\r
 439 <h3 id="_installation">2.4. Installation</h3>\r
 440 <div class="listingblock">\r
 441 <div class="content">\r
 442 <pre><code>make install</code></pre>\r
 443 </div></div>\r
 444 </div>\r
 445 </div>\r
 446 </div>\r
 447 <div class="sect1">\r
 448 <h2 id="_resources">3. Resources</h2>\r
 449 <div class="sectionbody">\r
 450 <div class="ulist"><ul>\r
 451 <li>\r
 452 <p>\r
 453 <strong>Home page</strong>: <a href="http://wpitchoune.net/ptask">http://wpitchoune.net/ptask</a>.\r
 454 </p>\r
 455 </li>\r
 456 <li>\r
 457 <p>\r
 458 <strong>RSS feed</strong>: <a href="http://wpitchoune.net/blog/category/ptask/feed/">http://wpitchoune.net/blog/category/ptask/feed/</a>.\r
 459 </p>\r
 460 </li>\r
 461 <li>\r
 462 <p>\r
 463 <strong>Release changes</strong>: <a href="NEWS.html">NEWS</a>.\r
 464 </p>\r
 465 </li>\r
 466 <li>\r
 467 <p>\r
 468 <strong>Source tarballs</strong>: <a href="http://wpitchoune.net/ptask/files">http://wpitchoune.net/ptask/files</a>.\r
 469 </p>\r
 470 </li>\r
 471 <li>\r
 472 <p>\r
 473 <strong>Documentation</strong>: <a href="http://wpitchoune.net/ptask/doc">http://wpitchoune.net/ptask/doc</a>.\r
 474 </p>\r
 475 </li>\r
 476 </ul></div>\r
 477 </div>\r
 478 </div>\r
 479 <div class="sect1">\r
 480 <h2 id="_contact">4. Contact</h2>\r
 481 <div class="sectionbody">\r
 482 <div class="paragraph"><p>Bugs and comments can be sent to <a href="mailto:jeanfi@gmail.com">jeanfi@gmail.com</a>.</p></div>\r
 483 </div>\r
 484 </div>\r
 485 </div>\r
 486 <div id="footnotes"><hr /></div>\r
 487 <div id="footer">\r
 488 <div id="footer-text">\r
 489 Last updated\r
 490  2014-11-21 18:14:30 CET\r
 491 </div>\r
 492 </div>\r
 493 </body>\r
 494 </html>\r