mirror of
https://github.com/GothenburgBitFactory/taskwarrior.git
synced 2025-07-07 20:06:36 +02:00
Product Name Change
- Converted all (appropriate) uses of 'task' to 'taskwarrior'.
This commit is contained in:
Paul Beckingham
parent
a9b18da214
commit
44fe227595
303 changed files with 691 additions and 671 deletions
|
|
@ -18,8 +18,8 @@ which shell you use). If this is a new setting, you will need to either run
|
|||
that profile script, or close and reopen the terminal window (which does the
|
||||
same thing).
|
||||
|
||||
Now tell task that you want to use color. This is the default for task, so
|
||||
the following step may be unnecessary.
|
||||
Now tell taskwarrior that you want to use color. This is the default for
|
||||
taskwarrior, so the following step may be unnecessary.
|
||||
|
||||
$ task config color on
|
||||
|
||||
|
|
@ -28,25 +28,25 @@ like:
|
|||
|
||||
color=on
|
||||
|
||||
Now task is ready.
|
||||
Now taskwarrior is ready.
|
||||
|
||||
.SH AUTOMATIC MONOCHROME
|
||||
It should be mentioned that task is aware of whether it's output is going to a
|
||||
terminal, or to a file or through a pipe. When task output goes to a terminal,
|
||||
color is desirable, but consider the following command:
|
||||
It should be mentioned that taskwarrior is aware of whether its output is going
|
||||
to a terminal, or to a file or through a pipe. When taskwarrior output goes to
|
||||
a terminal, color is desirable, but consider the following command:
|
||||
|
||||
$ task list > file.txt
|
||||
|
||||
Do we really want all those color control codes in the file? Task assumes that
|
||||
you do not, and temporarily sets color to 'off' while generating the output.
|
||||
This explains the output from the following command:
|
||||
Do we really want all those color control codes in the file? Taskwarrior
|
||||
assumes that you do not, and temporarily sets color to 'off' while generating
|
||||
the output. This explains the output from the following command:
|
||||
|
||||
$ task config | grep '^color '
|
||||
color off
|
||||
|
||||
it always returns 'off', no matter what the setting.
|
||||
|
||||
The reason is that the task output gets piped into grep, and the color is
|
||||
The reason is that the taskwarrior output gets piped into grep, and the color is
|
||||
disabled. If you wanted those color codes, you can override this behavior by
|
||||
setting the _forcecolor variable to on, like this:
|
||||
|
||||
|
|
@ -60,7 +60,7 @@ or by temporarily overriding it like this:
|
|||
color on
|
||||
|
||||
.SH AVAILABLE COLORS
|
||||
Task has a 'color' command that will show all the colors it is capable of
|
||||
Taskwarrior has a 'color' command that will show all the colors it is capable of
|
||||
displaying. Try this:
|
||||
|
||||
$ task color
|
||||
|
|
@ -106,7 +106,8 @@ There is an additional 'underline' attribute that may be used:
|
|||
|
||||
underline bright red on black
|
||||
|
||||
Task has a command that helps you visualize these color combinations. Try this:
|
||||
Taskwarrior has a command that helps you visualize these color combinations.
|
||||
Try this:
|
||||
|
||||
$ task color underline bright red on black
|
||||
|
||||
|
|
@ -187,15 +188,15 @@ combination:
|
|||
|
||||
red on gray3
|
||||
|
||||
you are mixing a 16-color and 256-color specification. Task will map red to
|
||||
color1, and proceed. Note that red and color1 are not quite the same.
|
||||
you are mixing a 16-color and 256-color specification. Taskwarrior will map red
|
||||
to color1, and proceed. Note that red and color1 are not quite the same.
|
||||
|
||||
Note also that there is no bold or bright attributes when dealing with 256
|
||||
colors, but there is still underline available.
|
||||
|
||||
.SH LEGEND
|
||||
Task will show examples of all defined colors used in your .taskrc, or theme,
|
||||
if you run this command:
|
||||
Taskwarrior will show examples of all defined colors used in your .taskrc, or
|
||||
theme, if you run this command:
|
||||
|
||||
$ task color legend
|
||||
|
||||
|
|
@ -203,9 +204,9 @@ This gives you an example of each of the colors, so you can see the effect,
|
|||
without necessarily creating a set of tasks that meet each of the rule criteria.
|
||||
|
||||
.SH RULES
|
||||
Task supports colorization rules. These are configuration values that specify
|
||||
a color, and the conditions under which that color is used. By example, let's
|
||||
add a few tasks:
|
||||
Taskwarrior supports colorization rules. These are configuration values that
|
||||
specify a color, and the conditions under which that color is used. By example,
|
||||
let's add a few tasks:
|
||||
|
||||
$ task add project:Home priority:H pay the bills (1)
|
||||
$ task add project:Home clean the rug (2)
|
||||
|
|
@ -236,7 +237,7 @@ those colors can be made subtle, and complementary, but without care, this can
|
|||
be a visual mess. Beware!
|
||||
|
||||
.SH THEMES
|
||||
Task supports themes. What this really means is that with the ability to
|
||||
Taskwarrior supports themes. What this really means is that with the ability to
|
||||
include other files into the .taskrc file, different sets of color rules can
|
||||
be included.
|
||||
|
||||
|
|
@ -247,7 +248,7 @@ your .taskrc file:
|
|||
include /usr/local/share/doc/task/rc/dark-256.theme
|
||||
.RE
|
||||
|
||||
You can use any of the standard task themes:
|
||||
You can use any of the standard taskwarrior themes:
|
||||
|
||||
.RS
|
||||
light-16.theme
|
||||
|
|
@ -269,13 +270,13 @@ Better yet, create your own, and share it. We will gladly host the theme file
|
|||
on <http://taskwarrior.org>.
|
||||
|
||||
.SH "CREDITS & COPYRIGHTS"
|
||||
task was written by P. Beckingham <paul@beckingham.net>.
|
||||
Taskwarrior was written by P. Beckingham <paul@beckingham.net>.
|
||||
.br
|
||||
Copyright (C) 2006 \- 2010 P. Beckingham
|
||||
|
||||
This man page was originally written by Paul Beckingham.
|
||||
|
||||
task is distributed under the GNU General Public License. See
|
||||
Taskwarrior is distributed under the GNU General Public License. See
|
||||
http://www.gnu.org/licenses/gpl-2.0.txt for more information.
|
||||
|
||||
.SH SEE ALSO
|
||||
|
|
@ -284,7 +285,7 @@ http://www.gnu.org/licenses/gpl-2.0.txt for more information.
|
|||
.BR task-faq(5)
|
||||
.BR task-tutorial(5)
|
||||
|
||||
For more information regarding task, the following may be referenced:
|
||||
For more information regarding taskwarrior, the following may be referenced:
|
||||
|
||||
.TP
|
||||
The official site at
|
||||
|
|
@ -300,5 +301,5 @@ You can contact the project by writing an email to
|
|||
|
||||
.SH REPORTING BUGS
|
||||
.TP
|
||||
Bugs in task may be reported to the issue-tracker at
|
||||
Bugs in taskwarrior may be reported to the issue-tracker at
|
||||
<http://taskwarrior.org>
|
||||
|
|
|
|||
|
|
@ -4,26 +4,26 @@
|
|||
task-faq \- A FAQ for the task(1) command line todo manager.
|
||||
|
||||
.SH DESCRIPTION
|
||||
Task is a command line TODO list manager. It maintains a list of tasks that you
|
||||
want to do, allowing you to add/remove, and otherwise manipulate them. Task
|
||||
has a rich list of commands that allow you to do various things with it.
|
||||
Taskwarrior is a command line TODO list manager. It maintains a list of tasks
|
||||
that you want to do, allowing you to add/remove, and otherwise manipulate them.
|
||||
Taskwarrior has a rich list of commands that allow you to do various things with it.
|
||||
|
||||
.SH WELCOME
|
||||
Welcome to the task FAQ. If you have would like to see a question answered
|
||||
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>.
|
||||
|
||||
.TP
|
||||
.B Q: When I redirect the output of task to a file, I lose all the colors. How do I fix this?
|
||||
A: Task knows (or thinks it knows) when the output is not going directly to a
|
||||
terminal, and strips out all the color control characters. This is based on
|
||||
the assumption that the color control codes are not wanted in the file. Prevent
|
||||
this with the following entry in your .taskrc file:
|
||||
.B Q: When I redirect the output to a file, I lose all the colors. How do I fix this?
|
||||
A: Taskwarrior knows (or thinks it knows) when the output is not going directly
|
||||
to a terminal, and strips out all the color control characters. This is based
|
||||
on the assumption that the color control codes are not wanted in the file.
|
||||
Prevent this with the following entry in your .taskrc file:
|
||||
|
||||
_forcecolor=on
|
||||
|
||||
.TP
|
||||
.B Q: How do I backup my task data files? Where are they?
|
||||
A: Task writes all pending tasks to the file
|
||||
.B Q: How do I backup my taskwarrior data files? Where are they?
|
||||
A: Taskwarrior writes all pending tasks to the file
|
||||
|
||||
~/.task/pending.data
|
||||
|
||||
|
|
@ -33,8 +33,8 @@ and all completed and deleted tasks to
|
|||
|
||||
They are text files, so they can just be copied to another location for
|
||||
safekeeping. Don't forget there is also the ~/.taskrc file that contains your
|
||||
task configuration data. To be sure, and to future-proof your backup, consider
|
||||
backing up all the files in the ~/.task directory.
|
||||
taskwarrior configuration data. To be sure, and to future-proof your backup,
|
||||
consider backing up all the files in the ~/.task directory.
|
||||
|
||||
.TP
|
||||
.B Q: How can I separate my work tasks from my home tasks? Specifically, can I keep them completely separate?
|
||||
|
|
@ -50,39 +50,39 @@ This gives you two commands, 'wtask' and 'htask' that operate using two
|
|||
different sets of task data files.
|
||||
|
||||
.TP
|
||||
.B Q: Can I revert to a previous version of task? How?
|
||||
.B Q: Can I revert to a previous version of taskwarrior? How?
|
||||
A: Yes, you can revert to a previous version of task, simply by downloading an
|
||||
older version and installing it. If you find a bug in task, then this may be the
|
||||
only way to work around the bug, until a patch release is made.
|
||||
|
||||
Note that it is possible that the task file format will change. For example, the
|
||||
format changed between versions 1.5.0 and 1.6.0. Task will automatically upgrade
|
||||
the file but if you need to revert to a previous version of task, there is the
|
||||
file format to consider. This is yet another good reason to back up your task
|
||||
data files!
|
||||
Note that it is possible that the taskwarrior file format will change. For
|
||||
example, the format changed between versions 1.5.0 and 1.6.0. Taskwarrior will
|
||||
automatically upgrade the file but if you need to revert to a previous version
|
||||
of taskwarrior, there is the file format to consider. This is yet another good
|
||||
reason to back up your task data files!
|
||||
|
||||
.TP
|
||||
.B Q: I'm using Ubuntu 9.04, and I want task to word-wrap descriptions. How do I do this?
|
||||
.B Q: I'm using Ubuntu 9.04, and I want to word-wrap descriptions. How do I do this?
|
||||
A: You need to install ncurses, by doing this:
|
||||
|
||||
% sudo apt-get install libncurses5-dev
|
||||
|
||||
Then you need to rebuild task from scratch, starting with
|
||||
Then you need to rebuild taskwarrior from scratch, starting with
|
||||
|
||||
% cd task-X.X.X
|
||||
% ./configure
|
||||
...
|
||||
|
||||
The result should be a task program that knows the width of the terminal window,
|
||||
and wraps accordingly.
|
||||
The result should be a taskwarrior program that knows the width of the terminal
|
||||
window, and wraps accordingly.
|
||||
|
||||
Note that there are binary packages that all include this capability.
|
||||
Note that all the binary packages include this capability.
|
||||
|
||||
.TP
|
||||
.B Q: How do I build task under Cygwin?
|
||||
.B Q: How do I build taskwarrior under Cygwin?
|
||||
A: Take a look at the README.build file, where the latest information on build
|
||||
issues is kept. Task is built the same way everywhere. But under Cygwin, you'll
|
||||
need to make sure you have the following packages available first:
|
||||
issues is kept. Taskwarrior is built the same way everywhere. But under Cygwin,
|
||||
you'll need to make sure you have the following packages available first:
|
||||
|
||||
gcc
|
||||
make
|
||||
|
|
@ -90,8 +90,8 @@ need to make sure you have the following packages available first:
|
|||
libncurses8
|
||||
|
||||
The gcc and make packages allow you to compile the code, and are therefore
|
||||
required, but the ncurses packages are optional. Ncurses will allow task to
|
||||
determine the width of the window, and therefore use the whole width and wrap
|
||||
required, but the ncurses packages are optional. Ncurses will allow taskwarrior
|
||||
to determine the width of the window, and therefore use the whole width and wrap
|
||||
text accordingly, for a more aesthetically pleasing display.
|
||||
|
||||
Note that there are binary packages that all include this capability.
|
||||
|
|
@ -106,35 +106,37 @@ If you run the command:
|
|||
|
||||
% task colors
|
||||
|
||||
Task will display all the colors it can use, and you will see which ones you can use.
|
||||
Taskwarrior will display all the colors it can use, and you will see which ones
|
||||
you can use.
|
||||
|
||||
Note that if you install the 'mintty' shell in Cygwin, then you can use 256 colors.
|
||||
Note that if you install the 'mintty' shell in Cygwin, then you can use 256
|
||||
colors.
|
||||
|
||||
See the 'man task-color' for more details on which colors can be used.
|
||||
|
||||
.TP
|
||||
.B Q: Where does task store the data?
|
||||
By default, task creates a .taskrc file in your home directory and populates it
|
||||
with defaults. Task also creates a .task directory in your home directory and
|
||||
puts data files there.
|
||||
.B Q: Where does taskwarrior store the data?
|
||||
By default, taskwarrior creates a .taskrc file in your home directory and
|
||||
populates it with defaults. Taskwarrior also creates a .task directory in your
|
||||
home directory and puts data files there.
|
||||
|
||||
.TP
|
||||
.B Q: Can I edit that data?
|
||||
Of course you can. It is a simple text file, and looks somewhat like the JSON
|
||||
format, and if you are careful not to break the format, there is no reason not
|
||||
to edit it. But task provides a rich command set to do that manipulation for
|
||||
you, so it is probably best to leave those files alone.
|
||||
to edit it. But taskwarrior provides a rich command set to do that manipulation
|
||||
for you, so it is probably best to leave those files alone.
|
||||
|
||||
.TP
|
||||
.B Q: How do I restore my .taskrc file to defaults?
|
||||
If you delete (or rename) your .taskrc file, task will offer to create a default
|
||||
one for you. Another way to do this is with the command:
|
||||
If you delete (or rename) your .taskrc file, taskwarrior will offer to create a
|
||||
default one for you. Another way to do this is with the command:
|
||||
|
||||
$ task rc:new-file version
|
||||
|
||||
Task will create 'new-file' if it doesn't already exist. There will not be
|
||||
much in it though - task relies heavily on default values, which can be seen
|
||||
with this command:
|
||||
Taskwarrior will create 'new-file' if it doesn't already exist. There will not
|
||||
be much in it though - taskwarrior relies heavily on default values, which can
|
||||
be seen with this command:
|
||||
|
||||
$ task show
|
||||
|
||||
|
|
@ -142,18 +144,18 @@ which lists all the currently known settings. If you have just created
|
|||
new-file, then this command lists only the defaults.
|
||||
|
||||
Note that this is a good way to learn about new configuration settings,
|
||||
particularly if your .taskrc file was created by an older version of task.
|
||||
particularly if your .taskrc file was created by an older version.
|
||||
|
||||
.TP
|
||||
.B Q: Do I need to back up my task data?
|
||||
.B Q: Do I need to back up my taskwarrior data?
|
||||
Yes. You should back up your ~/.task directory, and probably your ~/.taskrc
|
||||
file too.
|
||||
|
||||
.TP
|
||||
.B Q: Can I share my tasks between different machines?
|
||||
Yes, you can. Most people have success with a DropBox - a free and secure file
|
||||
synching tool. Simply configure task to store it's data in a dropbox folder, by
|
||||
modifying the:
|
||||
synching tool. Simply configure taskwarrior to store it's data in a dropbox
|
||||
folder, by modifying the:
|
||||
|
||||
data.location=...
|
||||
|
||||
|
|
@ -161,21 +163,21 @@ configuration variable. Check out DropBox at http://www.dropbox.com.
|
|||
|
||||
.TP
|
||||
.B Q: I don't like dropbox. Is there another way to synchronize my tasks?
|
||||
Of course. Especially if you want to modify tasks offline on both machines and
|
||||
synchronize them later on. For this purpose task provides a 'merge' command which
|
||||
is able to insert the modifications you made to one of your task databases into a
|
||||
second database.
|
||||
Of course. Especially if you want to modify tasks offline on both machines and
|
||||
synchronize them later on. For this purpose there is a 'merge' command which is
|
||||
is able to insert the modifications you made to one of your task databases into
|
||||
a second database.
|
||||
|
||||
Here is a basic example of the procedure:
|
||||
|
||||
|
||||
$ rsync myremotehost:.task/undo.data /tmp/undo_remote.data
|
||||
$ task merge /tmp/undo_remote.data
|
||||
$ rsync ${HOME}/.task/*.data myremotehost:.task/
|
||||
|
||||
First you need to get the undo.data file from the remote system with a network
|
||||
protocol of your choice or a removable medium as well. When task finished the merge
|
||||
command you should copy all the local .data files to the remote system. This way you
|
||||
ensure that both systems are fully synchronized.
|
||||
First you need to get the undo.data file from the remote system, or removable
|
||||
media. When the merge command completes, you should copy all the local .data
|
||||
files to the remote system. This way you ensure that both systems are fully
|
||||
synchronized.
|
||||
|
||||
.TP
|
||||
.B Q: The undo.data file gets very large - do I need it?
|
||||
|
|
@ -183,14 +185,14 @@ You need it if you want the undo capability, or the merge capability mentioned
|
|||
above. But if it gets large, you can certainly truncate it to save space, just
|
||||
be careful to delete lines from the top of the file, up to and including a
|
||||
separator '---'. The simplest way is to simply delete the undo.data file. Note
|
||||
that it does not slow down task, because task never reads it until you want to
|
||||
undo. Otherwise task only appends to the file.
|
||||
that it does not slow down taskwarrior, because it is never read until you want
|
||||
to undo. Otherwise taskwarrior only appends to the file.
|
||||
|
||||
.TP
|
||||
.B Q: How do I know whether my terminal support 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 task 1.9 or later, you simply
|
||||
run
|
||||
otherwise the easiest way is to just try it! With version 1.9 or later, you
|
||||
simply run
|
||||
|
||||
$ task color
|
||||
|
||||
|
|
@ -204,11 +206,10 @@ See the task-color(5) man page for more details.
|
|||
Use one of our provided color themes, or create your own - after all, they are
|
||||
just collections of color settings.
|
||||
|
||||
See the task-color(5) man page for an in-depth explanation of the task color
|
||||
rules.
|
||||
See the task-color(5) man page for an in-depth explanation of the color rules.
|
||||
|
||||
.TP
|
||||
.B Q: How can I make task put the command in the terminal window title?
|
||||
.B Q: How can I make taskwarrior put the command in the terminal window title?
|
||||
You cannot. But you can make the shell do it, and you can make the shell
|
||||
call the task program. Here is a Bash script that does this:
|
||||
|
||||
|
|
@ -227,7 +228,7 @@ function that does the same thing:
|
|||
}
|
||||
|
||||
.TP
|
||||
.B Q: Task searches in a case-sensitive fashion - can I change that?
|
||||
.B Q: Taskwarrior searches in a case-sensitive fashion - can I change that?
|
||||
You can. Just set the following value in your .taskrc file:
|
||||
|
||||
search.case.sensitive=no
|
||||
|
|
@ -236,24 +237,24 @@ This will affect searching for keywords:
|
|||
|
||||
$ task list Document
|
||||
|
||||
task will perform a caseless search in the description and any annotations for
|
||||
the keyword 'Document'. It also affects description and annotation
|
||||
substitutions:
|
||||
taskwarrior will perform a caseless search in the description and any
|
||||
annotations for the keyword 'Document'. It also affects description and
|
||||
annotation substitutions:
|
||||
|
||||
$ task 1 /teh/the/
|
||||
|
||||
The pattern on the left will now be a caseless search term.
|
||||
|
||||
.TP
|
||||
.B Q: Why do the task ID numbers change?
|
||||
Task does this to always show you the smallest numbers it can. The idea is that
|
||||
if your tasks are numbered 1 - 33, for example, those are easy to type in. If
|
||||
instead task kept a rolling sequence number, after a while your tasks might be
|
||||
numbered 481 - 513, which makes it more likely to enter one incorrectly, because
|
||||
there are more digits.
|
||||
.B Q: Why do the ID numbers change?
|
||||
Taskwarrior does this to always show you the smallest numbers it can. The idea
|
||||
is that if your tasks are numbered 1 - 33, for example, those are easy to type
|
||||
in. If instead task kept a rolling sequence number, after a while your tasks
|
||||
might be numbered 481 - 513, which makes it more likely to enter one
|
||||
incorrectly, because there are more digits.
|
||||
|
||||
When you run a report (such as "list"), task assigns the numbers before it
|
||||
displays them. For example, you can do this:
|
||||
When you run a report (such as "list"), the numbers are assigned before display.
|
||||
For example, you can do this:
|
||||
|
||||
$ task list
|
||||
$ task do 12
|
||||
|
|
@ -261,17 +262,18 @@ displays them. For example, you can do this:
|
|||
$ task delete 31
|
||||
|
||||
Those id numbers are then good until the next report is run. This is because
|
||||
task performs a garbage-collect operation on the pending tasks file when a
|
||||
report is run, which moves the deleted and completed tasks from the pending.data
|
||||
file to the completed.data file. This keeps the pending tasks file small, and
|
||||
therefore keeps task fast. The completed data file is the one that grows
|
||||
unbounded with use, but that one isn't accessed as much, so it doesn't matter as
|
||||
much. So in all, the ID number resequencing is about efficiency.
|
||||
taskwarrior performs a garbage-collect operation on the pending tasks file when
|
||||
a report is run, which moves the deleted and completed tasks from the
|
||||
pending.data file to the completed.data file. This keeps the pending tasks file
|
||||
small, and therefore keeps taskwarrior fast. The completed data file is the one
|
||||
that grows unbounded with use, but that one isn't accessed as much, so it
|
||||
doesn't matter as much. So in all, the ID number resequencing is about
|
||||
efficiency.
|
||||
|
||||
.TP
|
||||
.B Q: How do I list tasks that are either priority 'H' or 'M', but not 'L'?
|
||||
Task's filters are all combined with and implicit logical AND operator, so if
|
||||
you were to try this:
|
||||
Taskwarriors filters are all combined with and implicit logical AND operator, so
|
||||
if you were to try this:
|
||||
|
||||
$ task list priority:H priority:M
|
||||
|
||||
|
|
@ -292,8 +294,8 @@ to construct task filters.
|
|||
|
||||
.TP
|
||||
.B Q: How do I delete an annotation?
|
||||
Task now has a 'denotate' command to remove annotations. First here is an
|
||||
example task:
|
||||
Taskwarrior now has a 'denotate' command to remove annotations. Here is an
|
||||
example:
|
||||
|
||||
$ task add Original task
|
||||
$ task 1 annotate foo
|
||||
|
|
@ -327,13 +329,13 @@ There are lots of ways. Here are some:
|
|||
- Fix bugs
|
||||
|
||||
.SH "CREDITS & COPYRIGHTS"
|
||||
task was written by P. Beckingham <paul@beckingham.net>.
|
||||
Taskwarrior was written by P. Beckingham <paul@beckingham.net>.
|
||||
.br
|
||||
Copyright (C) 2006 \- 2010 P. Beckingham
|
||||
|
||||
This man page was originally written by P. Beckingham.
|
||||
|
||||
task is distributed under the GNU General Public License. See
|
||||
Taskwarrior is distributed under the GNU General Public License. See
|
||||
http://www.gnu.org/licenses/gpl-2.0.txt for more information.
|
||||
|
||||
.SH SEE ALSO
|
||||
|
|
@ -358,5 +360,5 @@ You can contact the project by writing an email to
|
|||
|
||||
.SH REPORTING BUGS
|
||||
.TP
|
||||
Bugs in task may be reported to the issue-tracker at
|
||||
Bugs in taskwarrior may be reported to the issue-tracker at
|
||||
<http://taskwarrior.org>
|
||||
|
|
|
|||
|
|
@ -7,17 +7,17 @@ task \- A command line todo manager.
|
|||
.B task [subcommand] [args]
|
||||
|
||||
.SH DESCRIPTION
|
||||
Task is a command line todo list manager. It maintains a list of tasks that you
|
||||
want to do, allowing you to add/remove, and otherwise manipulate them. Task
|
||||
has a rich list of subcommands that allow you to do various things with it.
|
||||
Taskwarrior is a command line todo list manager. It maintains a list of tasks
|
||||
that you want to do, allowing you to add/remove, and otherwise manipulate them.
|
||||
Task has a rich list of subcommands that allow you to do various things with it.
|
||||
|
||||
At the core, task is a list processing program. You add text and additional
|
||||
related parameters and task redisplays the information in a nice way. It turns
|
||||
into a todo list program when you add due dates and recurrence. It turns into an
|
||||
organized todo list program when you add priorities, tags (one word descriptors),
|
||||
project groups, etc. Task turns into an organized to do list program when you
|
||||
modify the configuration file to have the output displayed the way you want to
|
||||
see it.
|
||||
At the core, taskwarrior is a list processing program. You add text and
|
||||
additional related parameters and redisplay the information in a nice way. It
|
||||
turns into a todo list program when you add due dates and recurrence. It turns
|
||||
into an organized todo list program when you add priorities, tags (one word
|
||||
descriptors), project groups, etc. Taskwarrior turns into an organized to do
|
||||
list program when you modify the configuration file to have the output displayed
|
||||
the way you want to see it.
|
||||
|
||||
.SH SUBCOMMANDS
|
||||
|
||||
|
|
@ -45,7 +45,7 @@ Shows all data and metadata for the specified task.
|
|||
|
||||
.TP
|
||||
.B ID
|
||||
With an ID but no specific command, task runs the "info" command.
|
||||
With an ID but no specific command, taskwarrior runs the "info" command.
|
||||
|
||||
.TP
|
||||
.B undo
|
||||
|
|
@ -154,7 +154,7 @@ currently defined colors.
|
|||
|
||||
.TP
|
||||
.B version
|
||||
Shows the task version number
|
||||
Shows the taskwarrior version number
|
||||
|
||||
.TP
|
||||
.B help
|
||||
|
|
@ -162,12 +162,13 @@ Shows the long usage text.
|
|||
|
||||
.TP
|
||||
.B show [all | substring]"
|
||||
Shows all the current settings in the task configuration file. If a substring
|
||||
is specified just the settings containing that substring will be displayed.
|
||||
Shows all the current settings in the taskwarrior configuration file. If a
|
||||
substring is specified just the settings containing that substring will be
|
||||
displayed.
|
||||
|
||||
.TP
|
||||
.B config [name [value | '']]
|
||||
Add, modify and remove settings directly in the task configuration.
|
||||
Add, modify and remove settings directly in the taskwarrior configuration.
|
||||
This command either modifies the 'name' setting with a new value of 'value',
|
||||
or adds a new entry that is equivalent to 'name=value':
|
||||
|
||||
|
|
@ -212,8 +213,9 @@ Prepends information to an existing task.
|
|||
.SH REPORT SUBCOMMANDS
|
||||
|
||||
A report is a listing of information from the task database. There are several
|
||||
reports currently predefined in task. The output and sort behavior of these
|
||||
reports can be configured in the configuration file. See also the man page taskrc(5).
|
||||
reports currently predefined in taskwarrior. The output and sort behavior of
|
||||
these reports can be configured in the configuration file. See also the man page
|
||||
taskrc(5).
|
||||
|
||||
.TP
|
||||
.B active [tags] [attrs] [description]
|
||||
|
|
@ -372,11 +374,11 @@ task list due.before:eom priority.not:L
|
|||
.SH SPECIFYING DATES AND FREQUENCIES
|
||||
|
||||
.SS DATES
|
||||
Task reads dates from the command line and displays dates in the
|
||||
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 task configuration file.
|
||||
in the taskwarrior configuration file.
|
||||
|
||||
.RS
|
||||
.TP
|
||||
|
|
@ -433,7 +435,7 @@ task ... due:fri
|
|||
.RE
|
||||
|
||||
.SS FREQUENCIES
|
||||
Recurrence periods. Task supports several ways of specifying the
|
||||
Recurrence periods. Taskwarrior supports several ways of specifying the
|
||||
.I frequency
|
||||
of recurring tasks.
|
||||
|
||||
|
|
@ -473,7 +475,7 @@ Every two years.
|
|||
|
||||
|
||||
.SH COMMAND ABBREVIATION
|
||||
All task commands may be abbreviated as long as a unique prefix is used. E.g.
|
||||
All taskwarrior commands may be abbreviated as long as a unique prefix is used. E.g.
|
||||
|
||||
.RS
|
||||
$ task li
|
||||
|
|
@ -505,7 +507,7 @@ $ task add "quoted ' quote"
|
|||
$ task add escaped \\' quote
|
||||
.RE
|
||||
|
||||
The argument \-\- (a double dash) tells task to treat all other args
|
||||
The argument \-\- (a double dash) tells taskwarrior to treat all other args
|
||||
as description:
|
||||
|
||||
.RS
|
||||
|
|
@ -513,7 +515,7 @@ $ task add -- project:Home needs scheduling
|
|||
.RE
|
||||
|
||||
.SH CONFIGURATION FILE AND OVERRIDE OPTIONS
|
||||
Task stores its configuration in a file in the user's home directory:
|
||||
Taskwarrior stores its configuration in a file in the user's home directory:
|
||||
~/.taskrc . The default configuration file can be overridden with
|
||||
|
||||
.TP
|
||||
|
|
@ -557,7 +559,7 @@ can be configured in the configuration file.
|
|||
~/.task/undo.data The file that contains the information to the "undo" command.
|
||||
|
||||
.SH "CREDITS & COPYRIGHTS"
|
||||
task was written by P. Beckingham <paul@beckingham.net>.
|
||||
Taskwarrior was written by P. Beckingham <paul@beckingham.net>.
|
||||
.br
|
||||
Copyright (C) 2006 \- 2010 P. Beckingham
|
||||
|
||||
|
|
@ -566,7 +568,7 @@ and supplemented by Federico Hernandez.
|
|||
|
||||
Thank also to T. Charles Yun.
|
||||
|
||||
task is distributed under the GNU General Public License. See
|
||||
Taskwarrior is distributed under the GNU General Public License. See
|
||||
http://www.gnu.org/licenses/gpl-2.0.txt for more information.
|
||||
|
||||
.SH SEE ALSO
|
||||
|
|
@ -575,7 +577,7 @@ http://www.gnu.org/licenses/gpl-2.0.txt for more information.
|
|||
.BR task-faq(5)
|
||||
.BR task-color(5)
|
||||
|
||||
For more information regarding task, the following may be referenced:
|
||||
For more information regarding taskwarrior, the following may be referenced:
|
||||
|
||||
.TP
|
||||
The official site at
|
||||
|
|
@ -591,5 +593,5 @@ You can contact the project by writing an email to
|
|||
|
||||
.SH REPORTING BUGS
|
||||
.TP
|
||||
Bugs in task may be reported to the issue-tracker at
|
||||
Bugs in taskwarrior may be reported to the issue-tracker at
|
||||
<http://taskwarrior.org>
|
||||
|
|
|
|||
135
doc/man/taskrc.5
135
doc/man/taskrc.5
|
|
@ -9,7 +9,7 @@ taskrc \- Configuration file for the task(1) command
|
|||
.B task rc:<directory-path>/.taskrc
|
||||
|
||||
.SH DESCRIPTION
|
||||
.B task
|
||||
.B taskwarrior
|
||||
obtains its configuration data from a file called
|
||||
.I .taskrc
|
||||
\&. This file is normally located in the user's home directory:
|
||||
|
|
@ -35,14 +35,14 @@ $ task rc.<name>:<value> ...
|
|||
.RE
|
||||
|
||||
If
|
||||
.B task
|
||||
.B taskwarrior
|
||||
is run without an existing configuration file it will ask if it should create a
|
||||
default, sample
|
||||
.I .taskrc
|
||||
file in the user's home directory.
|
||||
|
||||
The task configuration file consists of a series of "assignments" in each line.
|
||||
The "assignments" have the syntax:
|
||||
The taskwarrior configuration file consists of a series of "assignments" in each
|
||||
line. The "assignments" have the syntax:
|
||||
|
||||
.RS
|
||||
<name-of-configuration-variable>=<value-to-be-set>
|
||||
|
|
@ -66,9 +66,9 @@ The hash mark, or pound sign ("#") is used as a "comment" character. It can be
|
|||
used to annotate the configuration file. All text after the character to the end
|
||||
of the line is ignored.
|
||||
|
||||
Note that task is flexible about the values used to represent Boolean items.
|
||||
You can use "on", "yes", "y", "1", "true", "t", "+", "enabled". Anything else
|
||||
means "off".
|
||||
Note that taskwarrior is flexible about the values used to represent Boolean
|
||||
items. You can use "on", "yes", "y", "1", "true", "t", "+", "enabled".
|
||||
Anything else means "off".
|
||||
|
||||
.SH EDITING
|
||||
You can edit your .taskrc file by hand if you wish, or you can use the 'config'
|
||||
|
|
@ -84,14 +84,14 @@ To delete an entry, use this command:
|
|||
$ task config nag
|
||||
.RE
|
||||
|
||||
Task will then use the default value. To explicitly set a value to blank, and
|
||||
therefore avoid using the default value, use this command:
|
||||
Taskwarrior will then use the default value. To explicitly set a value to
|
||||
blank, and therefore avoid using the default value, use this command:
|
||||
|
||||
.RS
|
||||
$ task config nag ""
|
||||
.RE
|
||||
|
||||
Task will also display all your settings with this command:
|
||||
Taskwarrior will also display all your settings with this command:
|
||||
|
||||
.RS
|
||||
$ task config
|
||||
|
|
@ -120,8 +120,8 @@ include /usr/local/share/doc/task/rc/holidays-US.rc
|
|||
include /usr/local/share/doc/task/rc/dark-16.theme
|
||||
.RE
|
||||
|
||||
This includes two standard files that are distributed with task, which define a
|
||||
set of US holidays, and set up a 16-color theme for task to use, to color the
|
||||
This includes two standard files that are distributed with taskwarrior, which
|
||||
define a set of US holidays, and set up a 16-color theme to use, to color the
|
||||
reports and calendar.
|
||||
|
||||
.SH CONFIGURATION VARIABLES
|
||||
|
|
@ -131,8 +131,8 @@ Valid variable names and their default values are:
|
|||
|
||||
.TP
|
||||
.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, for example: /home/paul/.task
|
||||
This is a path to the directory containing all the taskwarrior files. By
|
||||
default, it is set up to be ~/.task, for example: /home/paul/.task
|
||||
|
||||
Note that you can use the
|
||||
.B ~
|
||||
|
|
@ -140,8 +140,8 @@ shell meta character, which will be properly expanded.
|
|||
|
||||
.TP
|
||||
.B locking=on
|
||||
Determines whether task uses file locking when accessing the pending.data and
|
||||
completed.data files. Defaults to "on". Solaris users who store the task data
|
||||
Determines whether to use file locking when accessing the pending.data and
|
||||
completed.data files. Defaults to "on". Solaris users who store the data
|
||||
files on an NFS mount may need to set locking to "off". Note that there is
|
||||
danger in setting this value to "off" - another program (or another instance of
|
||||
task) may write to the task.pending file at the same time.
|
||||
|
|
@ -149,7 +149,7 @@ task) may write to the task.pending file at the same time.
|
|||
.SS TERMINAL
|
||||
.TP
|
||||
.B curses=on
|
||||
Determines whether task uses ncurses to establish the size of the window you are
|
||||
Determines whether to use ncurses to establish the size of the window you are
|
||||
using, for text wrapping.
|
||||
|
||||
.TP
|
||||
|
|
@ -160,31 +160,32 @@ The width of tables used when ncurses support is not available. Defaults to 80.
|
|||
.B editor=vi
|
||||
Specifies which text editor you wish to use for when the
|
||||
.B task edit <ID>
|
||||
command is used. Task will first look for this configuration variable. If found,
|
||||
it is used. Otherwise task will look for the $VISUAL or $EDITOR environment
|
||||
variables, before it defaults to using "vi".
|
||||
command is used. Taskwarrior will first look for this configuration variable. If
|
||||
found, it is used. Otherwise it will look for the $VISUAL or $EDITOR
|
||||
environment variables, before it defaults to using "vi".
|
||||
|
||||
.SS MISCELLANEOUS
|
||||
|
||||
.TP
|
||||
.B locale=en-US
|
||||
The locale is a combination of ISO 639-1 language code and ISO 3166 country
|
||||
code. If not specified, task will assume en-US. If specified, task will locate
|
||||
the correct file of localized strings and proceed. It is an error to specify a
|
||||
locale for which there is no strings file.
|
||||
code. If not specified, will assume en-US. If specified, taskwarrior will
|
||||
locate the correct file of localized strings and proceed. It is an error to
|
||||
specify a locale for which there is no strings file.
|
||||
|
||||
.TP
|
||||
.B verbose=yes
|
||||
Controls some of the verbosity of task.
|
||||
Controls some of the verbosity of taskwarrior.
|
||||
|
||||
.TP
|
||||
.B confirmation=yes
|
||||
May be "yes" or "no", and determines whether task will ask for confirmation
|
||||
before deleting a task or doing bulk changes. The default value is "yes".
|
||||
May be "yes" or "no", and determines whether taskwarrior will ask for
|
||||
confirmation before deleting a task or doing bulk changes. The default value
|
||||
is "yes".
|
||||
|
||||
.TP
|
||||
.B echo.command=yes
|
||||
May be "yes" or "no", and causes task to display the ID and description of any
|
||||
May be "yes" or "no", and causes the display of the ID and description of any
|
||||
task when you run the start, stop, do, undo or delete commands. The default
|
||||
value is "yes".
|
||||
|
||||
|
|
@ -254,8 +255,8 @@ description and annotations are done in a case sensitive way. Defaults to yes.
|
|||
|
||||
.TP
|
||||
.B _forcecolor=no
|
||||
Task shuts off color automatically when the output is not sent directly to a
|
||||
a TTY. For example, this command:
|
||||
Taskwarrior shuts off color automatically when the output is not sent directly
|
||||
to a TTY. For example, this command:
|
||||
|
||||
.RS
|
||||
.RS
|
||||
|
|
@ -271,7 +272,8 @@ $ task rc._forcecolor=yes list > file
|
|||
|
||||
.TP
|
||||
.B blanklines=yes
|
||||
Turning this value off causes task to generate a more vertically compact output.
|
||||
Turning this value off causes taskwarrior to generate a more vertically compact
|
||||
output.
|
||||
|
||||
.TP
|
||||
.B shell.prompt=task>
|
||||
|
|
@ -299,24 +301,25 @@ and one for a week from tomorrow.
|
|||
|
||||
.TP
|
||||
.B undo.style=side
|
||||
When the 'undo' command is run, task presents a before and after comparison of the
|
||||
data. This can be in either the 'side' style, which compares values side-by-side
|
||||
in a table, or 'diff' style, which uses a format similar to the 'diff' command.
|
||||
When the 'undo' command is run, taskwarrior presents a before and after
|
||||
comparison of the data. This can be in either the 'side' style, which compares
|
||||
values side-by-side in a table, or 'diff' style, which uses a format similar to
|
||||
the 'diff' command.
|
||||
|
||||
.TP
|
||||
.B debug=off
|
||||
Task has a debug mode that causes diagnostic output to be displayed. Typically
|
||||
this is not something anyone would want, but when reporting a bug, debug output
|
||||
can be useful. It can also help explain how the command line is being parsed,
|
||||
but the information is displayed in a developer-friendly, not a user-friendly
|
||||
way.
|
||||
Taskwarrior has a debug mode that causes diagnostic output to be displayed.
|
||||
Typically this is not something anyone would want, but when reporting a bug,
|
||||
debug output can be useful. It can also help explain how the command line is
|
||||
being parsed, but the information is displayed in a developer-friendly, not a
|
||||
user-friendly way.
|
||||
|
||||
.TP
|
||||
.B alias.rm=delete
|
||||
Task supports command aliases. This alias provides an alternate name (rm) for
|
||||
the delete command. You can use aliases to provide alternate names for any of
|
||||
task's commands. Several commands you may use are actually aliases - 'history',
|
||||
for example, or 'export'.
|
||||
Taskwarrior supports command aliases. This alias provides an alternate name
|
||||
(rm) for the delete command. You can use aliases to provide alternate names for
|
||||
any of the commands. Several commands you may use are actually aliases -
|
||||
the 'history' report, for example, or 'export'.
|
||||
|
||||
.SS DATES
|
||||
|
||||
|
|
@ -330,8 +333,8 @@ for example, or 'export'.
|
|||
.B dateformat.annotation=m/d/Y
|
||||
.TP
|
||||
.B report.X.dateformat=m/d/Y
|
||||
This is a string of characters that define how task formats date values. The
|
||||
precedence order for the configuration variable is report.X.dateformat then
|
||||
This is a string of characters that define how taskwarrior formats date values.
|
||||
The precedence order for the configuration variable is report.X.dateformat then
|
||||
reportdateformat then dateformat. While report.X.dateformat only formats the
|
||||
due date in reports, reportdateformat formats the due date both in reports
|
||||
and "task info". If both of these are not set then dateformat will be applied
|
||||
|
|
@ -495,8 +498,8 @@ holiday.eastersunday.date=easter
|
|||
.RE
|
||||
.RE
|
||||
|
||||
Note that the task distribution contains example holiday files that can be
|
||||
included like this:
|
||||
Note that the taskwarrior distribution contains example holiday files that can
|
||||
be included like this:
|
||||
|
||||
.RS
|
||||
.RS
|
||||
|
|
@ -509,14 +512,14 @@ include /usr/local/share/doc/task/rc/holidays-US.rc
|
|||
.B monthsperline=3
|
||||
Determines how many months the "task calendar" command renders across the
|
||||
screen. Defaults to however many will fit. If more months than will fit are
|
||||
specified, task will only show as many that will fit.
|
||||
specified, taskwarrior will only show as many that will fit.
|
||||
|
||||
.SS COLOR CONTROLS
|
||||
|
||||
.TP
|
||||
.B color=on
|
||||
May be "on" or "off". Determines whether task uses color. When "off", task will
|
||||
use dashes (-----) to underline column headings.
|
||||
May be "on" or "off". Determines whether taskwarrior uses color. When "off",
|
||||
will use dashes (-----) to underline column headings.
|
||||
|
||||
.TP
|
||||
.B fontunderline=on
|
||||
|
|
@ -524,7 +527,7 @@ Determines if font underlines or ASCII dashes should be used to underline
|
|||
headers, even when color is enabled.
|
||||
.RE
|
||||
|
||||
Task has a number of coloration rules. They correspond to a particular
|
||||
Taskwarrior 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 coloring of that task. A list of valid colors, depending on your
|
||||
terminal, can be obtained by running the command:
|
||||
|
|
@ -693,11 +696,11 @@ a change that is to be reverted.
|
|||
.B
|
||||
shadow.file=$HOME/.task/shadow.txt
|
||||
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 in maintaining a current file for use by
|
||||
programs like GeekTool, Conky or Samurize.
|
||||
taskwarrior, 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 in maintaining a current
|
||||
file for use by programs like GeekTool, Conky or Samurize.
|
||||
|
||||
.TP
|
||||
.B
|
||||
|
|
@ -711,8 +714,8 @@ configuration variable. The format is identical to that of
|
|||
.TP
|
||||
.B
|
||||
shadow.notify=on
|
||||
When this value is set to "on", task will display a message whenever the shadow
|
||||
file is updated by some task command.
|
||||
When this value is set to "on", taskwarrior will display a message whenever the
|
||||
shadow file is updated by some task command.
|
||||
|
||||
.SS DEFAULTS
|
||||
|
||||
|
|
@ -733,7 +736,7 @@ command, if you don't specify one. The default is blank.
|
|||
.TP
|
||||
.B
|
||||
default.command=list
|
||||
Provides a default command that is run every time task is invoked with no
|
||||
Provides a default command that is run every time taskwarrior is invoked with no
|
||||
arguments. For example, if set to:
|
||||
|
||||
.RS
|
||||
|
|
@ -743,8 +746,8 @@ default.command=list project:foo
|
|||
.RE
|
||||
|
||||
.RS
|
||||
then task will run the "list project:foo" command if no command is specified.
|
||||
This means that by merely typing
|
||||
then taskwarrior will run the "list project:foo" command if no command is
|
||||
specified. This means that by merely typing
|
||||
.RE
|
||||
|
||||
.RS
|
||||
|
|
@ -823,8 +826,8 @@ An optional value to a report limiting the number of displayed tasks in the
|
|||
generated report.
|
||||
|
||||
.TP
|
||||
Task comes with a number of predefined reports in its default configuration
|
||||
file. These reports are:
|
||||
Taskwarrior comes with a number of predefined reports in its default
|
||||
configuration file. These reports are:
|
||||
|
||||
.TP
|
||||
.B long
|
||||
|
|
@ -879,13 +882,13 @@ Lists all tasks matching the specified criteria.
|
|||
Lists all tasks with upcoming due dates matching the specified criteria.
|
||||
|
||||
.SH "CREDITS & COPYRIGHTS"
|
||||
task was written by P. Beckingham <paul@beckingham.net>.
|
||||
Taskwarrior was written by P. Beckingham <paul@beckingham.net>.
|
||||
.br
|
||||
Copyright (C) 2006 \- 2010 P. Beckingham
|
||||
|
||||
This man page was originally written by Federico Hernandez.
|
||||
|
||||
task is distributed under the GNU General Public License. See
|
||||
Taskwarrior is distributed under the GNU General Public License. See
|
||||
http://www.gnu.org/licenses/gpl-2.0.txt for more information.
|
||||
|
||||
.SH SEE ALSO
|
||||
|
|
@ -894,7 +897,7 @@ http://www.gnu.org/licenses/gpl-2.0.txt for more information.
|
|||
.BR task-faq(5)
|
||||
.BR task-color(5)
|
||||
|
||||
For more information regarding task, the following may be referenced:
|
||||
For more information regarding taskwarrior, the following may be referenced:
|
||||
|
||||
.TP
|
||||
The official site at
|
||||
|
|
@ -910,5 +913,5 @@ You can contact the project by writing an email to
|
|||
|
||||
.SH REPORTING BUGS
|
||||
.TP
|
||||
Bugs in task may be reported to the issue-tracker at
|
||||
Bugs in taskwarrior may be reported to the issue-tracker at
|
||||
<http://taskwarrior.org>
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue