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
.B active
Shows all tasks that are started but not comleted.
Shows all tasks that are started but not completed.
.TP
.B overdue
@@ -220,7 +220,7 @@ Specify alternate configuration file.
.SH SPECIFYING DATES AND FREQUENCIES
.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
configuration variable
.I dateformat
@@ -252,7 +252,7 @@ task ... due:eom
task ... due:eoy
.TP
Next occuring weekday
Next occurring weekday
task ... due:fri
.RE
@@ -272,15 +272,15 @@ Mondays, Tuesdays, Wednesdays, Thursdays, Fridays and skipping weekend days.
.TP
weekly, 1w, 2w, ...
Eery week or a number of weeks.
Every week or a number of weeks.
.TP
biweekly, fortnight
Every two weeks.
.TP
quaterly, 1q, 2q, ...
Every three months, a quarter, or a number of quaters.
quarterly, 1q, 2q, ...
Every three months, a quarter, or a number of quarters.
.TP
semiannual
@@ -319,16 +319,14 @@ could be list, ls or long.
.SH EXAMPLES
A small section for examples e.g. some stuff from
For examples please see the online documentation at
.br
http://www.beckingham.net/30second.html
.br
http://www.beckingham.net/simple.html
<http://taskwarrior.org/wiki/taskwarrior/Simple>
.SH FILES
.TP
~/.taskrc User configuration file.
~/.taskrc User configuration file - see also taskrc(5).
.TP
~/.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.
.SH "CREDITS & COPYRIGHTS"
task was written by P. Beckingham <task@beckingham.net>.
task was written by P. Beckingham <paul@beckingham.net>.
.br
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:
.TP
<http://www.beckingham.net/task.html>
The official site.
.TP
<http://groups.google.com/group/taskprogram>
The official mailing list.
The official site at
<http://taskwarrior.org>
.TP
The official code repository at
<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
.TP
Bugs in task may be reported to the issue-tracker at
.RS
<http://github.com/pbeckingham/task/issues>
.RE
or to the mailing list at
.RS
<http://groups.google.com/group/taskprogram>
.RE
<http://taskwarrior.org>

50
doc/man5/taskrc.5
View File

@@ -5,6 +5,7 @@ taskrc \- Configuration file for the task(1) command
.SH SYNOPSIS
.B $HOME/.taskrc
.br
.B task rc:<directory-path>/.taskrc
.SH DESCRIPTION
@@ -17,7 +18,7 @@ obtains its configuration data from a file called
$HOME/.taskrc
.RE
The default location can be overriden using the
The default location can be overridden using the
.I rc:
attribute when running task:
@@ -51,7 +52,7 @@ is the value the variable is to be set to.
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.
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
end of the line is ignored.
@@ -222,7 +223,7 @@ Colors any task where the description contains X.
.TP
.B
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.
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
@@ -301,8 +302,10 @@ Lists all task, all data, matching the specified criteria
.B
report.long.labels=ID,Project,Pri,Added,Started,Due,Recur,Age,Tags,Description
.RE
.br
.B
report.long.columns=id,project,priority,entry,start,due,recur,age,tags,description
.br
.B
report.long.sort=due+,priority-,project+
@@ -315,8 +318,10 @@ Lists all tasks matching the specified criteria
.B
report.list.labels=ID,Project,Pri,Due,Active,Age,Description
.RE
.br
.B
report.list.columns=id,project,priority,due,active,age,description
.br
.B
report.list.sort=due+,priority-,project+
@@ -330,8 +335,10 @@ Minimal listing of all tasks matching the specified criteria
.B
report.ls.labels=ID,Project,Pri,Description
.RE
.br
.B
report.ls.columns=id,project,priority,description
.br
.B
report.ls.sort=priority-,project+
@@ -344,10 +351,13 @@ Shows the newest tasks
.B
report.newest.labels=ID,Project,Pri,Due,Active,Age,Description
.RE
.br
.B
report.newest.columns=id,project,priority,due,active,age,description
.br
.B
report.newest.sort=id-
.br
.B
report.newest.limit=10
@@ -361,16 +371,18 @@ Shows the oldest tasks
.B
report.oldest.labels=ID,Project,Pri,Due,Active,Age,Description
.RE
.br
.B
report.oldest.columns=id,project,priority,due,active,age,description
.br
.B
report.oldest.sort=id+
.br
.B
report.oldest.limit=10
.SH "CREDITS & COPYRIGHTS"
task was written by P. Beckingham <task@beckingham.net>.
task was written by P. Beckingham <paul@beckingham.net>.
.br
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.
.SH SEE ALSO
.BR task (1)
.BR task(1)
For more information regarding task, the following may be referenced:
.TP
<http://www.beckingham.net/task.html>
The official site.
.TP
<http://groups.google.com/group/taskprogram>
The official mailing list.
The official site at
<http://taskwarrior.org>
.TP
The official code repository at
<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
.TP
Bugs in task may be reported to the issue-tracker at
.RS
<http://github.com/pbeckingham/task/issues>
.RE
or to the mailing list at
.RS
<http://groups.google.com/group/taskprogram>
.RE
<http://taskwarrior.org>