GothenburgBitFactory/taskwarrior
1
0
Fork 0
mirror of https://github.com/GothenburgBitFactory/taskwarrior.git synced 2025-06-26 10:54:26 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Documentation

Browse source 
- Fixed several typos in man pages.
  (Thanks to Scott Kostyshak for the comprehensive patch)
This commit is contained in:
Federico Hernandez 2012-07-23 13:13:30 +02:00
parent 09074dc708
commit 4fe671f895
4 changed files with 46 additions and 39 deletions
Download patch file Download diff file Expand all files Collapse all files

21
doc/man/task-faq.5.in
View file

@ -4,8 +4,8 @@
task-faq \- A FAQ for the task(1) command line todo manager.
.SH WELCOME
Welcome to the taskwarrior FAQ. If you have would like to see a question answered
here, please send us a note at <support@taskwarrior.org>.
Welcome to the taskwarrior FAQ. If you would like to see a question answered
here, please send us a note to <support@taskwarrior.org>.
.TP
.B Q: When I redirect the output to a file, I lose all the colors. How do I fix this?
@ -20,7 +20,7 @@ or by temporarily overriding the value on the command line:
task ... rc._forcecolor=on
There is an additional problem using pagers such as 'less' and 'more', because
There is an additional problem when using pagers such as 'less' and 'more', because
color control codes are stripped. When using less, these options will preserve
the color codes:
@ -112,7 +112,7 @@ required.
.TP
.B Q: Do colors work under Cygwin?
They do, but only in a limited way. You can use regular foreground colors
(black, red, green ...) and you can regular background colors (on_black, on_red,
(black, red, green ...) and regular background colors (on_black, on_red,
on_green ...), but underline and bold are not supported.
If you run the command:
@ -174,6 +174,13 @@ folder, by modifying the:
configuration variable. Check out DropBox at http://www.dropbox.com.
You might also want to share the same .taskrc file. You can do this by putting an alias in the .bashrc file along the lines of
alias task="task rc:/home/username/Dropbox/mysharedtaskrc"
An alternative to Dropbox is to use the push/pull/merge features built into Taskwarrior. See 'man task-sync' for details.
.TP
.B Q: I don't want to use dropbox. Is there another way to synchronize my tasks?
Of course. Especially if you want to modify tasks offline on both machines and
@ -206,7 +213,7 @@ It is not recommended that you delete the undo.data file, as it limits
functionality.
.TP
.B Q: How do I know whether my terminal support 256 colors?
.B Q: How do I know whether my terminal supports 256 colors?
You will need to make sure your TERM environment variable is set to xterm-color,
otherwise the easiest way is to just try it! With version 1.9 or later, you
simply run
@ -276,7 +283,7 @@ efficiency.
.TP
.B Q: How do I list tasks that are either priority 'H' or 'M', but not 'L'?
Taskwarrior's filters are all by default combined with and implicit logical AND
Taskwarrior's filters are all by default combined with an implicit logical AND
operator, so if you were to try this:
task priority:H priority:M list
@ -325,7 +332,7 @@ non-exact match:
This will remove the second annotation - the first non-exact match.
.TP
.B Q: How do I show tasks completed on certain day?
.B Q: How do I show tasks completed on a certain day?
The day in question has to be boxed by a range, like this:
task end.after:3/29/2012 end.before:3/30/2012 completed

26
doc/man/task.1.in
View file

@ -28,7 +28,7 @@ example, to list all tasks belonging to the 'Home' project:
task project:Home list
You can specify multiple filter terms, each of which further restrict the
You can specify multiple filter terms, each of which further restricts the
result:
task project:Home +weekend garden list
@ -41,7 +41,7 @@ In this example, 'garden' is translated internally to:
as a convenient shortcut. The 'contains' here is an attribute modifier, which
is used to exert more control over the filter than simply absence or presence.
See 'ATTRIBUTE MODIFIERS' for a complete list of modifiers.
See the section 'ATTRIBUTE MODIFIERS' below for a complete list of modifiers.
Note that a filter may have zero terms, which means that all tasks apply to the
command. This can be dangerous, and this special case is confirmed, and
@ -219,7 +219,7 @@ this:
task $(task project:Home status:completed uuids) modify status:pending
This example first gets the UUIDs for the project:Home and status:completed
filter, then makes each of those tasks pending again.
filters, then makes each of those tasks pending again.
This command is mainly of use to external scripts.
@ -352,7 +352,7 @@ argument. URL may have the following syntaxes:
/path/to/local/.task/
You can set aliases for frequently used URLs in the .taskrc. Further
documentation can be found in task-sync(5) man page.
documentation can be found in the task-sync(5) man page.
.TP
.B task <filter> modify <mods>
@ -369,7 +369,7 @@ Overwrites the task database with those files found at the URL.
.TP
.B task push <URL>
Pushes the task database to a remote another location for distributing the
Pushes the task database to a remote location for distributing the
changes made by the merge command.
(See 'merge' command for valid URL syntax.)
@ -439,7 +439,7 @@ Launches an interactive shell with all the task commands available.
.TP
.B task show [all | substring]
Shows all the current settings in the taskwarrior configuration file. If a
Shows all the current settings. If a
substring is specified just the settings containing that substring will be
displayed.
@ -526,8 +526,8 @@ Shows the UUIDs and descriptions of matching tasks.
.TP
.B ID
Tasks can be specified uniquely by IDs, which are simply the index of the
task in the data file. The ID of a task may therefore change, but only when
Tasks can be specified uniquely by IDs, which are simply the indexes of the
tasks in the data file. The ID of a task may therefore change, but only when
a command is run that displays IDs. When modifying tasks, it is safe to
rely on the last displayed ID. Always run a report to check you have the right
ID for a task. IDs can be given to task as a sequence, for example,
@ -541,7 +541,7 @@ Tags are arbitrary words associated with a task. Use + to add a tag and - to
remove a tag from a task. A task can have any quantity of tags.
Certain tags (called 'special tags'), can be used to affect the way tasks are
treated. For example, is a task has the special tag 'nocolor', then it is
treated. For example, if a task has the special tag 'nocolor', then it is
exempt from all color rules. The supported special tags are:
+nocolor Disable color rules processing for this task
@ -736,7 +736,7 @@ For example:
task '( due < eom or priority != L )' list
Note that the parentheses are required when using a logical operator other than
the 'and' operator. The reason is that some report contains filters that must
the 'and' operator. The reason is that some reports contain filters that must
be combined with the command line. Consider this example:
task project:Home or project:Garden list
@ -785,7 +785,7 @@ Taskwarrior 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
in the taskwarrior configuration file.
.
.RS
.TP
@ -1026,11 +1026,11 @@ The file that contains the tasks that are not yet done.
.TP
~/.task/completed.data
The file that contains the completed "done" tasks.
The file that contains the completed ("done") tasks.
.TP
~/.task/undo.data
The file that contains the information to the "undo" command.
The file that contains information needed by the "undo" and "merge" commands.
.SH "CREDITS & COPYRIGHTS"
Copyright (C) 2006 \- 2012 P. Beckingham, F. Hernandez.

34
doc/man/taskrc.5.in
View file

@ -28,7 +28,7 @@ attribute when running task:
$ task rc:<directory-path>/.taskrc ...
.RE
or usign the TASKRC environment variable:
or using the TASKRC environment variable:
.RS
$ TASKRC=/tmp/.taskrc task ...
@ -143,11 +143,11 @@ These environmant variables override defaults and command line arguments.
.TP
.B TASKDATA=~/.task
The overrides the default path for the taskwarrior data files.
This overrides the default path for the taskwarrior data files.
.TP
.B TASKRC=~/.taskrc
The overrides the default RC file.
This overrides the default RC file.
.SH CONFIGURATION VARIABLES
Valid variable names and their default values are:
@ -194,14 +194,14 @@ using, for text wrapping.
.TP
.B defaultwidth=80
The width of output used when auto-detection support is not available. Defaults
to 80. If set to 0, is interpreted as infinite width, therefore with no
word-wrapping; useful when redirecting report output to a file for subsequent
to 80. If set to 0, it is interpreted as infinite width, therefore with no
word-wrapping; this is useful when redirecting report output to a file for subsequent
handling.
.TP
.B defaultheight=24
The height of output used when auto-detection support is not available. Defaults
to 24. If set to 0, is interpreted as infinite height. Useful when redirecting
to 24. If set to 0, it is interpreted as infinite height. This is useful when redirecting
charts to a file for subsequent handling.
.TP
@ -243,7 +243,7 @@ output from Taskwarrior. Setting this to "off" means that you would see regular
output.
The special value "nothing" can be used to eliminate all optional output, which
results in only the formatted data being show, with nothing else. This output
results in only the formatted data being shown, with nothing else. This output
is most readily parsed and used by shell scripts.
Alternatively, you can specify a comma-separated list of verbosity tokens that
@ -308,7 +308,7 @@ Controls padding between columns of the report output. Default is "1".
.TP
.B bulk=3
Is a number, defaulting to 3. When this number or greater tasks are modified
Is a number, defaulting to 3. When this number or greater of tasks are modified
in a single command, confirmation will be required, unless the
.B confirmation
variable is "no".
@ -330,7 +330,7 @@ default value is "no".
.TP
.B list.all.projects=yes
May be yes or no, and determines whether 'projects' command lists all the project
May be yes or no, and determines whether the 'projects' command lists all the project
names you have used, or just the ones used in active tasks. The default value is
"no".
@ -485,7 +485,7 @@ Enables the extension system. Defaults to on.
.B dateformat.annotation=m/d/Y
.TP
.B report.X.dateformat=m/d/Y
This is a string of characters that define how taskwarrior formats date values.
This is a string of characters that defines how taskwarrior formats date values.
The precedence order for the configuration variable is report.X.dateformat then
dateformat.report then dateformat for formating the due dates in reports.
If both report.X.dateformat and dateformat.report are not set then dateformat
@ -560,7 +560,7 @@ yMD.HN would do an output as "110124.2342"
.br
m/d/Y H:N would do an output as "1/24/2011 10:42"
.br
a D b Y H:N:S would do and output as "Mon 24 Jan 2011 11:19:42"
a D b Y H:N:S would do an output as "Mon 24 Jan 2011 11:19:42"
.RE
.RE
@ -591,7 +591,7 @@ is "sparse".
.TP
.B calendar.details.report=list
The report to run when displaying the details of tasks with due date when
The report to run when displaying the details of tasks with due dates when
running the "task calendar" command. The default value is "list".
.TP
@ -942,7 +942,7 @@ Colors the output of the merge command.
.RS
This setting specifies the precedence of the color rules, from highest to
lowest. Note that the prefix 'color.' is omitted (for brevity), and that any
wildcard values (color.tag.XXX) is shortened to 'tag.', which places all
wildcard value (color.tag.XXX) is shortened to 'tag.', which places all
specific tag rules at the same precedence, again for brevity.
.RE
@ -1205,7 +1205,7 @@ Lists the most important tasks.
.TP
.B long
Lists all task, all data, matching the specified criteria.
Lists all tasks and all data, matching the specified criteria.
.TP
.B list
@ -1253,18 +1253,18 @@ Lists all tasks matching the specified criteria.
.TP
.B blocked
List all tasks that have dependencies.
Lists all tasks that have dependencies.
.SS USER DEFINED ATTRIBUTES
User defined attributes (UDAs) are an extension mechanism that allows you to
define new attributes for Taskwarrior to store. One such example is
define new attributes for Taskwarrior to store and display. One such example is
an 'estimate' attribute that could be used to store time estimates associated
with a task. This 'estimate' attribute is not built in to Taskwarrior, but with
a few simple configuration settings you can instruct Taskwarrior to store this
item, and provide access to it for custom reports and filters.
This allows you to augment Taskwarrior to accomodate your workflow, or bend the
This allows you to augment Taskwarrior to accommodate your workflow, or bend the
rules and use Taskwarrior to store and synch data that is not necessarily
task-related.

4
scripts/bash/task.sh
View file

@ -35,7 +35,7 @@
# To use these routines:
#
# 1) Copy this file to somewhere (e.g. ~/.bash_completion.d/task.sh).
# 2) Added the following line to your .bashrc:
# 2) Add the following line to your .bashrc:
# source ~/.bash_completion.d/task.sh
#
# OR
@ -45,7 +45,7 @@
#
# To submit patches/bug reports:
#
# *) Go to the projects website at
# *) Go to the project's website at
#
# http://taskwarrior.org
#