tudu(1) - f29

1
2TuDu(1)                          User Manuals                          TuDu(1)
3
4
5

NAME

7       TuDu - A command-line tool to manage TODO lists hierarchically.
8

SYNOPSIS

10       tudu [-f tudu_file] [-c config_file] [-v[v]] [-h]
11

DESCRIPTION

13       TuDu  is  a commandline tool to manage hierarchical TODO lists, so that
14       you can organize everything you have to do in a  simple  and  efficient
15       way.  It does not use any database backend, but plain XML files.
16
17       Every TODO is composed by:
18
19       Status             Currently only two options: Pending and Done.
20       Title              A short sentence summarizing the task.
21       Description text   A longer text providing more details. (Optional)
22       Priority           The urgency of the task. (Optional)
23       Category           A short tag such as @home, @work, @inet. (Optional)
24       Deadline           The latest date the task should be done. (Optional)
25       Scheduled date     The planned date to do the task. (Optional)
26       Subtasks           Every task can have any number of subtasks. (Optional)
27
28       Tasks can be ordered by any of those fields, and categories can be used
29       to show only some certain kinds of tasks. Tudu also warns when a  dead‐
30       line is approaching, and shows the percentage of the task done so far.
31

OPTIONS

33       -f tudu_file
34                 Load the given tudu file
35
36       -c config-file
37                 Load specific config file
38
39       -v        Display the TuDu version number.
40
41       -vv       Display license and copyright information.
42
43       -h        Display help.
44

INTERFACE

46       All  the key bindings described here are the defaults in tudu. They can
47       be changed in the config file.
48
49       h      Move the cursor one level out in the tree depth.
50
51       l      Move the cursor one level in in the tree depth.
52
53       j      Move the cursor to the next task.
54
55       k      Move the cursor to the previous task.
56
57       J      Move a task one position down.
58
59       K      Move a task one position up.
60
61       m      Mark a task as done.
62
63       dd     Delete a task.
64
65       dt     Remove the deadline of the task.
66
67       df     Remove the priority of the task.
68
69       dS     Remove the scheduled date of the task.
70
71       p      Paste the last deleted task under the current cursor line.
72
73       P      Paste the last deleted task over the current cursor line.
74
75       V      Paste the last deleted  task  as  a  subtask  of  the  currently
76              selected task.
77
78       o      Add new task.
79
80       O      Add a new task over the current cursor line.
81
82       a      Edit the title of the task.
83
84       t      Edit the deadline.
85
86       f      Set the priority of the task.
87
88       C      Add or modify the category of the task.
89
90       e      Edit the description text of the task.
91
92       x      Scroll the text window upwards.
93
94       z      Scroll the text window downwards.
95
96       S      Edit the scheduled date of the task.
97
98       X      Scroll the schedule window upwards.
99
100       Z      Scroll the schedule window downwards.
101
102       c      Collapse or expand the children of the current task.
103
104       M      Hide or show tasks marked as done.
105
106       /      Search for a pattern in tasks titles.
107
108       n      Search the next occurrence of last search.
109
110       N      Search the previous occurrence of the last searched tasks.
111
112       /      Search for a pattern in tasks titles.
113
114       n      Search the next occurrence of last search.
115
116       N      Search the previous occurrence of the last search.
117
118       :      Open the command input. See the COMMANDS section.
119
120       bt     Sort by title.
121
122       bT     Sort by title in reverse order.
123
124       bd     Sort by done.
125
126       bD     Sort by done in reverse order.
127
128       bl     Sort by deadline.
129
130       bL     Sort by deadline in reverse order.
131
132       bp     Sort by priority.
133
134       bP     Sort by priority in reverse order.
135
136       bc     Sort by category.
137
138       bC     Sort by category in reverse order.
139
140       bu     Sort by user-defined order.
141
142       bU     Sort by reversed user-defined order.
143
144       bd     Sort by done.
145
146       bD     Sort by done in reverse order.
147
148       bl     Sort by deadline.
149
150       bL     Sort by deadline in reverse order.
151
152       bp     Sort by priority.
153
154       bP     Sort by priority in reverse order.
155
156       bc     Sort by category.
157
158       bC     Sort by category in reverse order.
159
160       bu     Sort by user.
161
162       bU     Sort by user in reverse order.
163
164       s      Save all the changes.
165
166       ?      Display the help.
167
168       q      Quit tudu saving the last changes.
169
170       Q      Quit tudu without saving anything.
171

COMMANDS

173       hide category1 category2 ... categoryN
174              Hide one or more categories.
175
176       show category1 category2 ... categoryN
177              Display one or more categories.
178
179       showall
180              Display all the categories.
181
182       showonly category1 category2 ... categoryN
183              Hide all the categories except the ones given.
184
185       help   Display the man page.
186

CONFIG

188       The  config  file  have  several sections which start by a name between
189       brackets, like [ general ]. Other config files can be included with the
190       option:
191
192       @include = 'path'
193
194
195       The options of each section are:
196
197
198   general
199       collapse = yes|no
200              Collapse the tasks by default.
201
202       hide_done = yes|no
203              Whether to hide tasks marked as done.
204
205       hide_percent = yes|no
206              Whether to hide the percentage display on each task.
207
208       visual_tree = yes|no
209              Toggle  graphical  tree. It shows marks, like (+) at the left of
210              the tasks.  It is necessary in some shells that can not  display
211              bold characters.
212
213       bold_parent = yes|no
214              Hilight the parents with children with bold letters.
215
216       loop_move = yes|no
217              Whether  to  jump  to  the  beginning  (or end) when the end (or
218              beginning) is reached.
219
220       days_warn = number
221              How many days before the task is due will the deadline  sport  a
222              warning remark.  By default is 7.
223
224       us_dates = yes|no
225              Use US date format (mm/dd/yyyy), by default it uses dd/mm/yyyy.
226
227       old_sched = yes|no
228              Whether display or not past scheduled tasks on the scheduler. In
229              case of yes the scheduled tasks for days already  past  will  be
230              displayed on warn color.
231
232       tudu_file = full-path
233              Location  of  the  tudu  xml  to be load if no '-f' parameter is
234              given. The  path  have  to  be  a  full  path.  If  is  not  set
235              ~/.tudu.xml will be use.
236
237       sort_order = string
238              Default order in which tasks will be shown. Tasks are ordered by
239              the 1st letter in the string, then by the 2nd, and so on.
240
241              The letters mean:
242
243              t      title
244
245              T      reverse title
246
247              d      done
248
249              D      reverse done
250
251              l      deadline
252
253              L      reverse deadline
254
255              c      category
256
257              C      reverse category
258
259              e      percentage done
260
261              E      reverse percentage done
262
263              u      user-defined order
264
265              U      reverse user-defined order
266
267       editor = 'path_bin %s'
268
269   keys
270       This section defines any key binding on the program. See the example in
271       the default config file.
272
273   theme
274       Window positions are described by rows; each row with the syntax:
275              row = [height]([width|]window[, [width|]window, ...])
276       The  height  and  width can be the number of characters or a percentage
277       followed by %. The possible  windows  are:  help,  tree,  info,  blank,
278       vpipe, hpipe text, and schedule. The windows help, vpipe and info don't
279       need to have height, neither hpipe needs to have width, because is pre‐
280       defined as 1.  TuDu will try to guess the non given information.
281
282       Other options for the theme are:
283
284       columns = colm1,...,colmN
285              Columns  in tree window. The possible columns are: title, prior‐
286              ity, category and deadline.
287
288       category_length = numChar
289              Number of characters to be displayed of the category.
290
291       color = color_text, color_background
292              The default colors for the text and background. If your terminal
293              has  support  to change colora the colors can be defined  as (r,
294              g, b), where r, g and b are numbers from 0 to 1000, or with  the
295              words:  black,  red,  green, yellow, blue, magenta, cyan, white,
296              transparent.
297
298       window = color_text, color_background
299              For each window can be defined it's own colors.  The  colors  of
300              vpipe  and  hpipe are the same, and defined with the window name
301              pipe.
302
303       selected = color_text, color_background
304              Color for the items under the cursor.
305
306       warn = color_text, color_background
307              Color for the warnings, like the mark of deadline  soon  or  the
308              color of the task scheduled on the past.
309

FILES

311       ~/.tudurc
312              User configuration file.
313
314       /etc/tudurc
315              Global configuration file.
316
317       ~/.tudu.xml
318              User default tudu.
319

NO WARRANTIES

321       This  program  is  distributed  in the hope that it will be useful, but
322       WITHOUT ANY  WARRANTY;  without  even  the  implied  warranty  of  MER‐
323       CHANTABILITY  or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General
324       Public License for more details.
325

AUTHOR

330       TuDu was written by Rubén Pollán Bella <meskio@sindominio.net>.
331
332       This manual page was written by Rubén Pollán Bella and further improved
333       by Enrique Matías Sánchez.
334
335
336
337Unix                           January 09, 2010                        TuDu(1)