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

50
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:
@@ -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 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.
@@ -222,7 +223,7 @@ Colors any task where the description contains X.
.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
@@ -301,8 +302,10 @@ Lists all task, all data, matching the specified criteria
.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
.br
.B .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
.br
.B .B
report.long.sort=due+,priority-,project+ report.long.sort=due+,priority-,project+
@@ -315,8 +318,10 @@ Lists all tasks matching the specified criteria
.B .B
report.list.labels=ID,Project,Pri,Due,Active,Age,Description report.list.labels=ID,Project,Pri,Due,Active,Age,Description
.RE .RE
.br
.B .B
report.list.columns=id,project,priority,due,active,age,description report.list.columns=id,project,priority,due,active,age,description
.br
.B .B
report.list.sort=due+,priority-,project+ report.list.sort=due+,priority-,project+
@@ -330,8 +335,10 @@ Minimal listing of all tasks matching the specified criteria
.B .B
report.ls.labels=ID,Project,Pri,Description report.ls.labels=ID,Project,Pri,Description
.RE .RE
.br
.B .B
report.ls.columns=id,project,priority,description report.ls.columns=id,project,priority,description
.br
.B .B
report.ls.sort=priority-,project+ report.ls.sort=priority-,project+
@@ -344,10 +351,13 @@ Shows the newest tasks
.B .B
report.newest.labels=ID,Project,Pri,Due,Active,Age,Description report.newest.labels=ID,Project,Pri,Due,Active,Age,Description
.RE .RE
.br
.B .B
report.newest.columns=id,project,priority,due,active,age,description report.newest.columns=id,project,priority,due,active,age,description
.br
.B .B
report.newest.sort=id- report.newest.sort=id-
.br
.B .B
report.newest.limit=10 report.newest.limit=10
@@ -361,16 +371,18 @@ Shows the oldest tasks
.B .B
report.oldest.labels=ID,Project,Pri,Due,Active,Age,Description report.oldest.labels=ID,Project,Pri,Due,Active,Age,Description
.RE .RE
.br
.B .B
report.oldest.columns=id,project,priority,due,active,age,description report.oldest.columns=id,project,priority,due,active,age,description
.br
.B .B
report.oldest.sort=id+ report.oldest.sort=id+
.br
.B .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