gergely/taskwarrior-2.x
1
0
Fork 0
Code Issues Actions Packages Projects Releases 1 Wiki Activity

Fixed documentation for 1.7.1

Browse Source
This commit is contained in:
Federico Hernandez
2009-06-09 17:30:09 +02:00
parent db6de54ccc
commit 20d8124a1d
2 changed files with 88 additions and 94 deletions
Download Patch File Download Diff File Expand all files Collapse all files

48
doc/man1/task.1
View File

@@ -111,7 +111,7 @@ Shows a monthly calendar with due tasks marked.
.TP .TP
.B active .B active
Shows all tasks that are started but not comleted. Shows all tasks that are started but not completed.
.TP .TP
.B overdue .B overdue
@@ -220,7 +220,7 @@ Specify alternate configuration file.
.SH SPECIFYING DATES AND FREQUENCIES .SH SPECIFYING DATES AND FREQUENCIES
.SS DATES .SS DATES
Task reads dates from the commandline and displays dates in the Task reads dates from the command line and displays dates in the
reports. The expected and desired date format is determined by the reports. The expected and desired date format is determined by the
configuration variable configuration variable
.I dateformat .I dateformat
@@ -252,7 +252,7 @@ task ... due:eom
task ... due:eoy task ... due:eoy
.TP .TP
Next occuring weekday Next occurring weekday
task ... due:fri task ... due:fri
.RE .RE
@@ -272,15 +272,15 @@ Mondays, Tuesdays, Wednesdays, Thursdays, Fridays and skipping weekend days.
.TP .TP
weekly, 1w, 2w, ... weekly, 1w, 2w, ...
Eery week or a number of weeks. Every week or a number of weeks.
.TP .TP
biweekly, fortnight biweekly, fortnight
Every two weeks. Every two weeks.
.TP .TP
quaterly, 1q, 2q, ... quarterly, 1q, 2q, ...
Every three months, a quarter, or a number of quaters. Every three months, a quarter, or a number of quarters.
.TP .TP
semiannual semiannual
@@ -319,16 +319,14 @@ could be list, ls or long.
.SH EXAMPLES .SH EXAMPLES
A small section for examples e.g. some stuff from For examples please see the online documentation at
.br .br
http://www.beckingham.net/30second.html <http://taskwarrior.org/wiki/taskwarrior/Simple>
.br
http://www.beckingham.net/simple.html
.SH FILES .SH FILES
.TP .TP
~/.taskrc User configuration file. ~/.taskrc User configuration file - see also taskrc(5).
.TP .TP
~/.task The default directory where task stores its data files. The location ~/.task The default directory where task stores its data files. The location
@@ -341,7 +339,7 @@ can be configured in the configuration file.
~/.task/completed.data The file that contains the completed "done" tasks. ~/.task/completed.data The file that contains the completed "done" tasks.
.SH "CREDITS & COPYRIGHTS" .SH "CREDITS & COPYRIGHTS"
task was written by P. Beckingham <task@beckingham.net>. task was written by P. Beckingham <paul@beckingham.net>.
.br .br
Copyright (C) 2006 \- 2009 P. Beckingham Copyright (C) 2006 \- 2009 P. Beckingham
@@ -357,26 +355,18 @@ http://www.gnu.org/licenses/gpl-2.0.txt for more information.
For more information regarding task, the following may be referenced: For more information regarding task, the following may be referenced:
.TP .TP
<http://www.beckingham.net/task.html> The official site at
The official site. <http://taskwarrior.org>
.TP
<http://groups.google.com/group/taskprogram>
The official mailing list.
.TP .TP
The official code repository at
<http://github.com/pbeckingham/task/> <http://github.com/pbeckingham/task/>
The official code repository.
.TP
You can contact the project by writing an email to
<support@taskwarrior.org>
.SH REPORTING BUGS .SH REPORTING BUGS
.TP
Bugs in task may be reported to the issue-tracker at Bugs in task may be reported to the issue-tracker at
<http://taskwarrior.org>
.RS
<http://github.com/pbeckingham/task/issues>
.RE
or to the mailing list at
.RS
<http://groups.google.com/group/taskprogram>
.RE

134
doc/man5/taskrc.5
View File

@@ -5,6 +5,7 @@ taskrc \- Configuration file for the task(1) command
.SH SYNOPSIS .SH SYNOPSIS
.B $HOME/.taskrc .B $HOME/.taskrc
.br
.B task rc:<directory-path>/.taskrc .B task rc:<directory-path>/.taskrc
.SH DESCRIPTION .SH DESCRIPTION
@@ -17,7 +18,7 @@ obtains its configuration data from a file called
$HOME/.taskrc $HOME/.taskrc
.RE .RE
The default location can be overriden using the The default location can be overridden using the
.I rc: .I rc:
attribute when running task: attribute when running task:
@@ -49,9 +50,9 @@ is the value the variable is to be set to.
.RE .RE
and set a configuration variable to a certain value. The equal sign ("=") is used to separate the variable and set a configuration variable to a certain value. The equal sign ("=") is used to separate the variable
name from the value to be set. name from the value to be set.
The hash mark, or pounf sign ("#") is used as a "comment" character. It can be used to annotte the The hash mark, or pound sign ("#") is used as a "comment" character. It can be used to annotate the
configuration file. It is placed at the beginning of a line and all text after the character to the configuration file. It is placed at the beginning of a line and all text after the character to the
end of the line is ignored. end of the line is ignored.
@@ -61,7 +62,7 @@ Valid variable names and their default values are:
.TP .TP
.B data.location=$HOME/.task .B data.location=$HOME/.task
This is a path to the directory containing all the task files. By default, it is set up to be ~/.task, This is a path to the directory containing all the task files. By default, it is set up to be ~/.task,
for example: /Users/paul/.task for example: /Users/paul/.task
.TP .TP
.B confirmation=yes .B confirmation=yes
@@ -75,7 +76,7 @@ May be "yes" or "no", and causes task to display the ID and description of any t
.B next=2 .B next=2
Is a number, defaulting to 2, which is the number of tasks for each project that are shown in the Is a number, defaulting to 2, which is the number of tasks for each project that are shown in the
.B task next .B task next
command. command.
.TP .TP
.B dateformat=m/d/Y .B dateformat=m/d/Y
@@ -112,21 +113,21 @@ m-d-y would output 07-24-09
.B monthsperline=99 .B monthsperline=99
Determines how many months the "task calendar" command renders across the screen. Determines how many months the "task calendar" command renders across the screen.
Defaults to however many will fit. If more months that will fit are specified, Defaults to however many will fit. If more months that will fit are specified,
task will only show as many that will fit. task will only show as many that will fit.
.TP .TP
.B defaultwidth=80 .B defaultwidth=80
The width of tables used when ncurses support is not available. Defaults to 80. The width of tables used when ncurses support is not available. Defaults to 80.
.TP .TP
.B curses=on .B curses=on
Determines whether task uses ncurses to establish the size of the window you are Determines whether task uses ncurses to establish the size of the window you are
using, for text wrapping. using, for text wrapping.
.TP .TP
.B due=7 .B due=7
This is the number of days into the future that define when a task is considered due, This is the number of days into the future that define when a task is considered due,
and is colored accordingly. Defaults to 7. and is colored accordingly. Defaults to 7.
.TP .TP
.B nag=You have higher priority tasks. .B nag=You have higher priority tasks.
@@ -153,7 +154,7 @@ to using "vi".
.TP .TP
.B color=on .B color=on
May be "on" or "off". Determines whether task uses color. When "off", task will May be "on" or "off". Determines whether task uses color. When "off", task will
use dashes (-----) to underline column headings. use dashes (-----) to underline column headings.
Task has a number of coloration rules. They correspond to a particular attribute Task has a number of coloration rules. They correspond to a particular attribute
of a task, such as it being due, or being active, and specifies the automatic of a task, such as it being due, or being active, and specifies the automatic
@@ -206,7 +207,7 @@ Certain attributes like tags, projects and keywords can also have their own colo
.RE .RE
.RS .RS
.TP .TP
.B color.tag.X=yellow .B color.tag.X=yellow
Colors any task that has the tag X. Colors any task that has the tag X.
@@ -216,49 +217,49 @@ Colors any task assigned to project X.
.TP .TP
.B color.keyword.X=on_blue .B color.keyword.X=on_blue
Colors any task where the description contains X. Colors any task where the description contains X.
.RE .RE
.TP .TP
.B .B
shadow.file=$HOME/.task/shadow.txt shadow.file=$HOME/.task/shadow.txt
If specified, designates a file path that will be autoamtically written to by task, If specified, designates a file path that will be automatically written to by task,
whenever the task database changes. In other words, it is automatically kept up to date. whenever the task database changes. In other words, it is automatically kept up to date.
The shadow.command configuration variable is used to determine which report is written The shadow.command configuration variable is used to determine which report is written
to the shadow file. There is no color used in the shadow file. This feature can be useful to the shadow file. There is no color used in the shadow file. This feature can be useful
in maintaining a current file for use by programs like GeekTool, Conky or Samurize. in maintaining a current file for use by programs like GeekTool, Conky or Samurize.
.TP .TP
.B .B
shadow.command=list shadow.command=list
This is the command that is run to maintain the shadow file, determined by the This is the command that is run to maintain the shadow file, determined by the
.I shadow.file .I shadow.file
configuration variable. The format is identical to that of configuration variable. The format is identical to that of
.I default.command .I default.command
\&. Please see the corresponding documentation for that command. \&. Please see the corresponding documentation for that command.
.TP .TP
.B .B
shadow.notify=on shadow.notify=on
When this value is set to "on", task will display a message whenever the shadow When this value is set to "on", task will display a message whenever the shadow
file is updated by some task command. file is updated by some task command.
.TP .TP
.B .B
default.project=foo default.project=foo
Provides a default project name for the Provides a default project name for the
.I task add .I task add
command. command.
.TP .TP
.B .B
default.priority=M default.priority=M
Provides a default priority for the Provides a default priority for the
.I task add .I task add
command. command.
.TP .TP
.B .B
default.command=list default.command=list
Provides a default command that is run every time task is invoked with no arguments. Provides a default command that is run every time task is invoked with no arguments.
For example, if set to: For example, if set to:
@@ -293,84 +294,95 @@ The output columns, their labels and the sort order can be set using the corresp
variables for each report. variables for each report.
.TP .TP
.B .B
report.long.description report.long.description
Lists all task, all data, matching the specified criteria Lists all task, all data, matching the specified criteria
.TP .TP
.B .B
report.long.labels=ID,Project,Pri,Added,Started,Due,Recur,Age,Tags,Description report.long.labels=ID,Project,Pri,Added,Started,Due,Recur,Age,Tags,Description
.RE .RE
.B .br
.B
report.long.columns=id,project,priority,entry,start,due,recur,age,tags,description report.long.columns=id,project,priority,entry,start,due,recur,age,tags,description
.B .br
.B
report.long.sort=due+,priority-,project+ report.long.sort=due+,priority-,project+
.TP .TP
.B .B
report.list.description report.list.description
Lists all tasks matching the specified criteria Lists all tasks matching the specified criteria
.TP .TP
.B .B
report.list.labels=ID,Project,Pri,Due,Active,Age,Description report.list.labels=ID,Project,Pri,Due,Active,Age,Description
.RE .RE
.B .br
.B
report.list.columns=id,project,priority,due,active,age,description report.list.columns=id,project,priority,due,active,age,description
.B .br
.B
report.list.sort=due+,priority-,project+ report.list.sort=due+,priority-,project+
.TP .TP
.B .B
report.ls.description report.ls.description
Minimal listing of all tasks matching the specified criteria Minimal listing of all tasks matching the specified criteria
.TP .TP
.B .B
report.ls.labels=ID,Project,Pri,Description report.ls.labels=ID,Project,Pri,Description
.RE .RE
.B .br
.B
report.ls.columns=id,project,priority,description report.ls.columns=id,project,priority,description
.B .br
.B
report.ls.sort=priority-,project+ report.ls.sort=priority-,project+
.TP .TP
.B .B
report.newest.description report.newest.description
Shows the newest tasks Shows the newest tasks
.TP .TP
.B .B
report.newest.labels=ID,Project,Pri,Due,Active,Age,Description report.newest.labels=ID,Project,Pri,Due,Active,Age,Description
.RE .RE
.B .br
.B
report.newest.columns=id,project,priority,due,active,age,description report.newest.columns=id,project,priority,due,active,age,description
.B .br
.B
report.newest.sort=id- report.newest.sort=id-
.B .br
.B
report.newest.limit=10 report.newest.limit=10
.TP .TP
.B .B
report.oldest.description report.oldest.description
Shows the oldest tasks Shows the oldest tasks
.TP .TP
.B .B
report.oldest.labels=ID,Project,Pri,Due,Active,Age,Description report.oldest.labels=ID,Project,Pri,Due,Active,Age,Description
.RE .RE
.B .br
.B
report.oldest.columns=id,project,priority,due,active,age,description report.oldest.columns=id,project,priority,due,active,age,description
.B .br
.B
report.oldest.sort=id+ report.oldest.sort=id+
.B .br
.B
report.oldest.limit=10 report.oldest.limit=10
.SH "CREDITS & COPYRIGHTS" .SH "CREDITS & COPYRIGHTS"
task was written by P. Beckingham <task@beckingham.net>. task was written by P. Beckingham <paul@beckingham.net>.
.br .br
Copyright (C) 2006 \- 2009 P. Beckingham Copyright (C) 2006 \- 2009 P. Beckingham
@@ -381,31 +393,23 @@ task is distributed under the GNU General Public License. See
http://www.gnu.org/licenses/gpl-2.0.txt for more information. http://www.gnu.org/licenses/gpl-2.0.txt for more information.
.SH SEE ALSO .SH SEE ALSO
.BR task (1) .BR task(1)
For more information regarding task, the following may be referenced: For more information regarding task, the following may be referenced:
.TP .TP
<http://www.beckingham.net/task.html> The official site at
The official site. <http://taskwarrior.org>
.TP
<http://groups.google.com/group/taskprogram>
The official mailing list.
.TP .TP
The official code repository at
<http://github.com/pbeckingham/task/> <http://github.com/pbeckingham/task/>
The official code repository.
.TP
You can contact the project by writing an email to
<support@taskwarrior.org>
.SH REPORTING BUGS .SH REPORTING BUGS
.TP
Bugs in task may be reported to the issue-tracker at Bugs in task may be reported to the issue-tracker at
<http://taskwarrior.org>
.RS
<http://github.com/pbeckingham/task/issues>
.RE
or to the mailing list at
.RS
<http://groups.google.com/group/taskprogram>
.RE