mirror of
https://github.com/GothenburgBitFactory/taskwarrior.git
synced 2025-06-26 10:54:26 +02:00
e1a7f61fb1
Added reference for taskrc(5) into task(1) man page Fixed typo/missing word in html documentation
445 lines
16 KiB
HTML
445 lines
16 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<title>Task Configuration</title>
|
|
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
|
|
<link rel="stylesheet" href="task.css" type="text/css" />
|
|
</head>
|
|
|
|
<body>
|
|
<div id="container">
|
|
<table>
|
|
<tr>
|
|
<td>
|
|
<div id="toolbar">
|
|
<a href="task.html">Home</a>
|
|
<a href="setup.html">Setup</a>
|
|
<a href="30second.html">30-second Tutorial</a>
|
|
<a href="simple.html">Simple</a>
|
|
<a href="advanced.html">Advanced</a>
|
|
<a href="shell.html">Shell</a>
|
|
<a href="config.html">Configuration</a>
|
|
<a href="color.html">Colors</a>
|
|
<a href="recur.html">Recurrence</a>
|
|
<a href="date.html">Date Handling</a>
|
|
<a href="faq.html">FAQ</a>
|
|
<a href="versions.html">Old Versions</a>
|
|
<a href="links.html">Task on the Web</a>
|
|
</div>
|
|
|
|
<div id="content">
|
|
<br />
|
|
<br />
|
|
<br />
|
|
<h2 class="title"><a name="config">Configuring Task</a></h2>
|
|
<div class="content">
|
|
<p>
|
|
Task recognizes several entries in the .taskrc file for
|
|
configuration purposes. Valid entries are of the form:
|
|
</p>
|
|
|
|
<pre><code>name=value</code></pre>
|
|
|
|
<p>
|
|
Valid examples are:
|
|
</p>
|
|
|
|
<dt>data.location</dt>
|
|
<dd>
|
|
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
|
|
</dd>
|
|
|
|
<dt>confirmation</dt>
|
|
<dd>
|
|
May be "yes" or "no", and determines whether task will ask for
|
|
confirmation before deleting a task.
|
|
</dd>
|
|
|
|
<dt>echo.command</dt>
|
|
<dd>
|
|
May be "yes" or "no", and causes task to display the ID and
|
|
description of any task when you run the start, stop, do, undo,
|
|
delete and undelete commands. The default value is "yes".
|
|
</dd>
|
|
|
|
<dt>nag</dt>
|
|
<dd>
|
|
This may be a string of text, or blank. It is used as a prompt
|
|
when a task is completed that is not considered high priority.
|
|
The "task next" command lists important tasks, and completing
|
|
one of those does not generate this nagging. Default value is:
|
|
|
|
<strong>Note: try to stick to high priority tasks. See "task next".</strong>
|
|
</dd>
|
|
|
|
<dt>next</dt>
|
|
<dd>
|
|
Is a number, defaulting to 2, which is the number of tasks for
|
|
each project that are shown in the "task next" command.
|
|
</dd>
|
|
|
|
<dt>curses</dt>
|
|
<dd>
|
|
Determines whether task uses ncurses to establish the size of
|
|
the window you are using, for text wrapping.
|
|
</dd>
|
|
|
|
<dt>blanklines</dt>
|
|
<dd>
|
|
May be "on" or "off". Prevents the display of unnecessary blank
|
|
lines so that task makes better use screen real estate on small-
|
|
screened devices.
|
|
</dd>
|
|
|
|
<dt>dateformat</dt>
|
|
<dd>
|
|
<p>
|
|
This is a string of characters that define how task formats dates.
|
|
The default value is:
|
|
</p>
|
|
|
|
<pre><code>m/d/Y</code></pre>
|
|
|
|
<p>
|
|
which means dates look like:
|
|
</p>
|
|
|
|
<pre><code>6/7/2008</code></pre>
|
|
|
|
<p>
|
|
The string should contain the characters:
|
|
|
|
<table>
|
|
<tr>
|
|
<th class="table_h">Character</th>
|
|
<th class="table_h">Meaning</th>
|
|
<th class="table_h">Example</th>
|
|
</tr>
|
|
<tr>
|
|
<td class="table_d">m</td>
|
|
<td class="table_d">minimal-digit month</td>
|
|
<td class="table_d">1, 12</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="table_d">d</td>
|
|
<td class="table_d">minimal-digit day</td>
|
|
<td class="table_d">1, 30</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="table_d">y</td>
|
|
<td class="table_d">two-digit year</td>
|
|
<td class="table_d">08</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="table_d">M</td>
|
|
<td class="table_d">two-digit month</td>
|
|
<td class="table_d">01, 12</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="table_d">D</td>
|
|
<td class="table_d">two-digit day</td>
|
|
<td class="table_d">01, 30</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="table_d">Y</td>
|
|
<td class="table_d">four-digit year</td>
|
|
<td class="table_d">2008</td>
|
|
</tr>
|
|
</table>
|
|
</p>
|
|
|
|
<p>
|
|
The string may also contain other characters to act as spacers,
|
|
or formatting. Other values could include (but are not limited to):
|
|
</p>
|
|
|
|
<p>
|
|
<table>
|
|
<tr>
|
|
<th class="table_h">dateformat</td>
|
|
<th class="table_h">How it looks</th>
|
|
</tr>
|
|
<tr>
|
|
<td class="table_d">d/m/Y</td>
|
|
<td class="table_d">7/6/2008</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="table_d">YMD</td>
|
|
<td class="table_d">20080607</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="table_d">m-d-y</td>
|
|
<td class="table_d">6-7-08</td>
|
|
</tr>
|
|
</table>
|
|
</p>
|
|
</dd>
|
|
|
|
<dt>monthsperline</dt>
|
|
<dd>
|
|
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, task will
|
|
only show as many that will fit.
|
|
</dd>
|
|
|
|
<dt>weekstart</dt>
|
|
<dd>
|
|
The day of the week that represents the first day of the week.
|
|
Defaults to "Monday".
|
|
</dd>
|
|
|
|
<dt>editor</dt>
|
|
<dd>
|
|
Specifies which text editor you wish to use for when the
|
|
|
|
<pre><code>task edit <ID></code></pre>
|
|
|
|
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'.
|
|
</dd>
|
|
|
|
<dt>defaultwidth</dt>
|
|
<dd>
|
|
The width of tables used when ncurses support is not available.
|
|
Defaults to 80.
|
|
</dd>
|
|
|
|
<dt>due</dt>
|
|
<dd>
|
|
|
|
This is the number of days into the future that define when a
|
|
task is considered due, and is colored accordingly.
|
|
Defaults to 7.
|
|
</dd>
|
|
|
|
<dt>color</dt>
|
|
<dd>
|
|
May be "on" or "off". Determines whether task uses color.
|
|
When "off", task will use dashes (-----) to underline column
|
|
headings.
|
|
</dd>
|
|
|
|
<dt>
|
|
color.overdue<br />
|
|
color.due<br />
|
|
color.pri.H<br />
|
|
color.pri.M<br />
|
|
color.pri.L<br />
|
|
color.pri.none<br />
|
|
color.active<br />
|
|
color.tagged<br />
|
|
color.recurring
|
|
</dt>
|
|
<dd>
|
|
These are the 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. The value may
|
|
be one optional foreground color (see below) and one optional
|
|
background color. For example, the value may be:
|
|
<br />
|
|
<strong>bold_red on_bright_yellow</strong>
|
|
</dd>
|
|
|
|
<dt>color.tag.X</dt>
|
|
<dd>
|
|
Colors any task that has the tag X.
|
|
</dd>
|
|
|
|
<dt>color.project.X</dt>
|
|
<dd>
|
|
Colors any task assigned to project X.
|
|
</dd>
|
|
|
|
<dt>color.keyword.X</dt>
|
|
<dd>
|
|
Colors any task where the description contains X.
|
|
</dd>
|
|
|
|
<dt>default.project</dt>
|
|
<dd>
|
|
Provides a default project name for the "task add ..." command.
|
|
</dd>
|
|
|
|
<dt>default.priority</dt>
|
|
<dd>
|
|
Provides a default priority for the "task add ..." command.
|
|
</dd>
|
|
|
|
<dt>default.command</dt>
|
|
<dd>
|
|
<p>
|
|
Provides a default command that is run every time task is
|
|
invoked with no arguments. For example, if set to:
|
|
</p>
|
|
|
|
<pre><code>default.command=list project:foo</code></pre>
|
|
|
|
<p>
|
|
Then task will run the "list project:foo" command if no
|
|
command is specified. This means that by merely typing:
|
|
</p>
|
|
|
|
<pre><code>% task
|
|
[task list project:foo]
|
|
|
|
ID Project Pri Description
|
|
1 foo H Design the thing
|
|
2 foo Build the thing</code></pre>
|
|
|
|
<p>
|
|
Note that the value of this variable is simply the command
|
|
line that you would ordinarily type, but without the
|
|
preceding "task" program name.
|
|
</p>
|
|
</dd>
|
|
|
|
<dt>shadow.file</dt>
|
|
<dd>
|
|
<p>
|
|
If specified, designates a file path that will be autoamtically
|
|
written to by task, whenever the task database changes. In other
|
|
words, it is automatically kept up to date.
|
|
</p>
|
|
|
|
<p>
|
|
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.
|
|
</p>
|
|
|
|
<p>
|
|
This feature can be useful in maintaining a current file for
|
|
use by the "Samurize" program.
|
|
</p>
|
|
</dd>
|
|
|
|
<dt>shadow.command</dt>
|
|
<dd>
|
|
<p>
|
|
This is the command that is run to maintain the shadow file,
|
|
determined by the shadow.file configuration variable. The
|
|
format is identical to that of default.command - please see
|
|
the documentation for default.command.
|
|
</p>
|
|
|
|
<p>
|
|
If this command is not specified, task will use the default.command
|
|
value instead. If that is not specified, the command "list" is used.
|
|
</p>
|
|
</dd>
|
|
|
|
<dt>shadow.notify</dt>
|
|
<dd>
|
|
When this value is set to "on", task will display a message
|
|
whenever the shadow file is updated by some task command.
|
|
</dd>
|
|
|
|
<dt>locking</dt>
|
|
<dd>
|
|
<p>
|
|
Determines whether task uses file locking when accessing the pending.data
|
|
and completed.data files. Default to "on". Solaris users who store
|
|
the task data files on an NFS mount may need to set locking to "off".
|
|
</p>
|
|
|
|
<p>
|
|
Note that setting this value to "off" is dangerous. It means that
|
|
another program may write to the task.pending file when task is
|
|
attempting to do the same.
|
|
</p>
|
|
</dd>
|
|
|
|
<dt>import.synonym.id</dt>
|
|
<dt>import.synonym.uuid</dt>
|
|
<dt>import.synonym.status</dt>
|
|
<dt>import.synonym.tags</dt>
|
|
<dt>import.synonym.entry</dt>
|
|
<dt>import.synonym.start</dt>
|
|
<dt>import.synonym.due</dt>
|
|
<dt>import.synonym.recur</dt>
|
|
<dt>import.synonym.end</dt>
|
|
<dt>import.synonym.project</dt>
|
|
<dt>import.synonym.priority</dt>
|
|
<dt>import.synonym.fg</dt>
|
|
<dt>import.synonym.bg</dt>
|
|
<dt>import.synonym.description</dt>
|
|
<dd>
|
|
If any of these configuration variables are found, they influence
|
|
data import by specifying a single additional field name synonym.
|
|
If a data import is failing because certain column names are not
|
|
being recognized, then this is how the field mapping can be
|
|
controlled.
|
|
</dd>
|
|
|
|
<p>
|
|
Note that the command:
|
|
</p>
|
|
|
|
<pre><code>task version</code></pre>
|
|
|
|
<p>
|
|
will display the configuration variables found in the .taskrc file,
|
|
and will warn you of any variables that are not recognized.
|
|
</p>
|
|
|
|
|
|
</div>
|
|
|
|
<br />
|
|
<br />
|
|
<div class="content">
|
|
<p>
|
|
Copyright 2006-2009, P. Beckingham. All rights reserved.
|
|
</p>
|
|
</div>
|
|
|
|
</div>
|
|
</td>
|
|
|
|
<td align="right" valign="top" width="200px">
|
|
<br />
|
|
<br />
|
|
<br />
|
|
<br />
|
|
<br />
|
|
<br />
|
|
<br />
|
|
<br />
|
|
<br />
|
|
<br />
|
|
|
|
<script type="text/javascript"><!--
|
|
google_ad_client = "pub-9709799404235424";
|
|
/* Task Main */
|
|
google_ad_slot = "8660617875";
|
|
google_ad_width = 120;
|
|
google_ad_height = 600;
|
|
//-->
|
|
</script>
|
|
<script type="text/javascript"
|
|
src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
|
|
</script>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
</div>
|
|
|
|
<script type="text/javascript">
|
|
var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
|
|
document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
|
|
</script>
|
|
<script type="text/javascript">
|
|
var pageTracker = _gat._getTracker("UA-4737637-1");
|
|
pageTracker._initData();
|
|
pageTracker._trackPageview();
|
|
</script>
|
|
|
|
</body>
|
|
</html>
|
|
|