doneyet/doneyet.1

   1 .TH doneyet 1
   2 .SH NAME
   3 doneyet \- an ncurses\-based heirarchical todo list manager
   4 .SH SYNOPSIS
   5 .B doneyet
   6 .SH DESCRIPTION
   7 .PP
   8 \fBdoneyet\fR is a filter\-based todo list manager. Currently there are four filters:
   9 .TP
  10 \fBShow All Tasks\fR
  11 This shows all tasks in the current project.
  12 .TP
  13 \fBShow Unfinished Tasks\fR
  14 This shows any task with a status of \fIunstarted\fR, \fIin progress\fR, or \fIpaused\fR.
  15 .TP
  16 \fBShow Completed Tasks\fR
  17 This shows only tasks that have a completion date within 7 days of now.
  18 .TP
  19 \fBFind\fR
  20 This filter takes a user specified string and shows any that match. This uses case\-sensitive search.
  21 .SH KEY SHORTCUTS
  22 .PP
  23 \fBdoneyet\fR is used primarily through key commands. There is a menu system in place, but not everything can be achieved through it. The key commands are as follows:
  24 .TP
  25 \fBA\fR
  26 Apply the \fIShow All Tasks\fR filter.
  27 .TP
  28 \fBa\fR
  29 If a task is selected, add a new subtask of that task. If no task is selected, add a root level task.
  30 .TP
  31 \fBM\fR
  32 Show the menu bar.
  33 .TP
  34        \fBj\fR, \fBk\fR        Change menu item.
  35 .TP
  36        \fBl\fR, \fBh\fR        Change menu.
  37 .TP
  38        \fBReturn\fR      Select the selected menu item.
  39 .TP
  40        \fBEscape\fR      Hide the menu bar.
  41 .TP
  42 \fBm\fR
  43 Move the currently selected task.
  44 .br
  45 \fINote\fR: this does not work for root level tasks yet.
  46 .TP
  47        \fBk\fR, \fBu\fR, \fBUP\fR    Move selected task up
  48 .TP
  49        \fBj\fR, \fBd\fR, \fBDOWN\fR  Move selected task down
  50 .TP
  51        \fBReturn\fR      Place task at current position.
  52 .TP
  53        \fBEscape\fR      Place task to where it was originally.
  54 .TP
  55 \fBn\fR
  56 Add a note to the selected task.
  57 .TP
  58 \fBv\fR
  59 View the notes of the selected task.
  60 .TP
  61 \fBj\fR
  62 Select next task.
  63 .TP
  64 \fBk\fR
  65 Select previous task.
  66 .TP
  67 \fBEscape\fR
  68 Select no task.
  69 .TP
  70 \fBe\fR
  71 Edit selected task.
  72 .TP
  73 \fBd\fR
  74 Delete selected task.
  75 .TP
  76 \fBc\fR
  77 Toggle collapsed state of selected task.
  78 .TP
  79 \fBR\fR
  80 Apply the \fIShow Uncompleted Tasks\fR filter.
  81 .TP
  82 \fBC\fR
  83 Apply the \fIShow Completed Tasks\fR filter.
  84 .TP
  85 \fBf\FR
  86 Apply the \fIFind Tasks\fR filter.
  87 .TP
  88 \fBSpace\fR
  89 Toggle the status of the selected item.
  90 .br
  91 white=\fIunstarted\fR; green=\fIin progress\fR; blue=\fIcompleted\fR; red=\fIpaused\fR.
  92 .TP
  93 \fBq\fR
  94 Quit.
  95 .SH SAVING
  96 .PP
  97 \fBdoneyet\fR will save upon quitting or when choosing 'Save' from the 'Project' menu.
  98 .SH MENU SYSTEM
  99 .PP
 100 The menu system also contains the 'Plain Text' menu item in the 'Generate' menu. This creates a text file of whatever is currently filtered in "/tmp/snippet.txt" and then calls \fBless\fR on that file.
 101 .PP
 102 A potential use of this is reporting weekly progress in email. Copying directly out of the ncurses window is difficult and time consuming. This however generates a plain text version with no borders.
 103 .SH AUTHOR
 104 .TP
 105 .B doneyet
 106 written by gtaubman
 107 .TP
 108 .B doneyet(1)
 109 written by tdy, based on the online readme
 110 .SH COPYRIGHT
 111 .PP
 112 Copyright \(co 2008 gtaubman
 113 .PP
 114 This program may be freely redistributed under the terms of the GNU General Public License.
 115 .PP
 116 http://code.google.com/p/doneyet/