task-color

package: task-core

title: task-color(5)

text:
# task-color(5)

## NAME
task-color - A color tutorial for the Taskwarrior command line todo manager.

## SETUP
The first thing you need is a terminal program that supports color. All terminal programs support color, but only a few support lots of colors. First tell your terminal program to use color by specifying the TERM environment variable like this:

TERM=xterm-color

In this example, xterm-color is used - a common value, and one that doesn't require that you use xterm. This works for most setups. This setting belongs in your shell profile (~/.bash_profile, ~/.bashrc, ~/.cshrc etc, depending on 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 Taskwarrior that you want to use color. This is the default for Taskwarrior, so the following step may be unnecessary.

$ task config color on

This command will make sure there is an entry in your ~/.taskrc file that looks like:

color=on

Now Taskwarrior is ready.

## AUTOMATIC MONOCHROME
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? 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 show | grep '^color '

color off

it always returns 'off', no matter what the setting, because the output is being sent to a pipe.

If you wanted those color codes, you can override this behavior by setting the _forcecolor variable to on, like this:

$ task config _forcecolor on

$ task config | grep '^color '

color on

or by temporarily overriding it like this:

$ task rc._forcecolor=on config | grep '^color '

color on

## AVAILABLE COLORS
Taskwarrior has a 'color' command that will show all the colors it is capable of displaying. Try this:

$ task color

The output cannot be replicated here in a man page, but you should see a set of color samples. How many you see depends on your terminal program's ability to render them.

You should at least see the Basic colors and Effects - if you do, then you have 16-color support. If your terminal supports 256 colors, you'll know it!

## 16-COLOR SUPPORT
The basic color support is provided through named colors:

black, red, blue, green, magenta, cyan, yellow, white

Foreground color (for text) is simply specified as one of the above colors, or not specified at all to use the default terminal text color.

Background color is specified by using the word 'on', and one of the above colors. Some examples:

green # green text, default background color

green on yellow # green text, yellow background

on yellow # default text color, yellow background

These colors can be modified further, by making the foreground bold, or by making the background bright. Some examples:

bold green

bold white on bright red

on bright cyan

The order of the words is not important, so the following are equivalent:

bold green

green bold

But the 'on' is important - colors before the 'on' are foreground, and colors after 'on' are background.

There is an additional 'underline' attribute that may be used:

underline bold red on black

And an 'inverse' attribute:

inverse red

Taskwarrior has a command that helps you visualize these color combinations. Try this:

$ task color underline bold red on black

You can use this command to see how the various color combinations work. You will also see some sample colors displayed, like the ones above, in addition to the sample requested.

Some combinations look very nice, some look terrible. Different terminal programs do implement slightly different versions of 'red', for example, so you may see some unexpected variation across machines. The brightness of your display is also a factor.

## 256-COLOR SUPPORT
Using 256 colors follows the same form, but the names are different, and some colors can be referenced in different ways. First there is by color ordinal, which is like this:

color0

color1

color2

...

color255

This gives you access to all 256 colors, but doesn't help you much. This range is a combination of 8 basic colors (color0 - color7), then 8 brighter variations (color8 - color15). Then a block of 216 colors (color16 - color231). Then a block of 24 gray colors (color232 - color255).

The large block of 216 colors (6x6x6 = 216) represents a color cube, which can be addressed via RGB values from 0 to 5 for each component color. A value of 0 means none of this component color, and a value of 5 means the most intense component color. For example, a bright red is specified as:

rgb500

And a darker red would be:

rgb300

Note that the three digits represent the three component values, so in this example the 5, 0 and 0 represent red=5, green=0, blue=0. Combining intense red with no green and no blue yields red. Similarly, blue and green are:

rgb005

rgb050

Another example - bright yellow - is a mix of bright red and bright green, but no blue component, so bright yellow is addressed as:

rgb550

A soft pink would be addressed as:

rgb515

See if you agree, by running:

$ task color black on rgb515

You may notice that the large color block is represented as 6 squares. All colors in the first square have a red value of 0. All colors in the 6th square have a red value of 5. Within each square, blue ranges from 0 to 5 left to right, and within each square green ranges from 0 to 5, top to bottom. This scheme takes some getting used to.

The block of 24 gray colors can also be accessed as gray0 - gray23, in a continuous ramp from black to white.

## MIXING 16- AND 256-COLORS
If you specify 16-colors, and view on a 256-color terminal, no problem. If you try the reverse, specifying 256-colors and viewing on a 16-color terminal, you will be disappointed, perhaps even appalled.

There is some limited color mapping - for example, if you were to specify this combination:

red on gray3

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 tone.

Note also that there is no bold or bright attributes when dealing with 256 colors, but there is still underline available.

## LEGEND
Taskwarrior will show examples of all defined colors used in your .taskrc, or theme, if you run this command:

$ task color legend

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.

## RULES
Taskwarrior supports colorization rules. These are configuration values that specify a color, and the conditions under which that color is used. By example, let us add a few tasks:

$ task add project:Home priority:H pay the bills (1)

$ task add project:Home clean the rug (2)

$ task add project:Garden clean out the garage (3)

We can add a color rule that uses a blue background for all tasks in the Home project:

$ task config color.project.Home 'on blue'

We use quotes around 'on blue' because there are two words, but they represent one value in the .taskrc file. Now suppose we wish to use a bold yellow text color for all cleaning work:

$ task config color.keyword.clean 'bold yellow'

Now what happens to task 2, which belongs to project Home (blue background), and is also a cleaning task (bold yellow foreground)? The colors are combined, and the task is shown as "bold yellow on blue".

Color rules can be applied by project and description keyword, as shown, and also by priority (or lack of priority), by active status, by being due or overdue, by being tagged, or having a specific tag (perhaps the most useful rule) or by being a recurring task.

It is possible to create a very colorful mix of rules. With 256-color support, those colors can be made subtle, and complementary, but without care, this can be a visual mess. Beware!

In such cases, consider using the 'rule.color.merge=no' option to disable the color blending.

The precedence for the color rules is determined by the configuration variable 'rule.precedence.color', which by default contains:

deleted,completed,active,keyword.,tag.,project.,overdue,scheduled,due.today,due,blocked,blocking,recurring,tagged,uda.

These are just the color rules with the 'color.' prefix removed. The rule 'color.due.today' is the highest precedence, and 'color.deleted' is the lowest.

The keyword rule shown here as 'keyword.' corresponds to a wildcard pattern, meaning 'color.keyword.*', or in other words all the keyword rules. Similarly for the 'color.tag.*' and 'color.project.*' rules.

There is also 'color.project.none', 'color.tag.none' and 'color.pri.none' to specifically represent missing data.

## THEMES
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.

To get a good idea of what a color theme looks like, try adding this entry to your .taskrc file (note that your installation may use a slightly different path from the example):

include /usr/share/doc/task/rc/dark-256.theme

You can use any of the standard Taskwarrior themes:

dark-16.theme

dark-256.theme

dark-blue-256.theme

dark-gray-256.theme

dark-green-256.theme

dark-red-256.theme

dark-violets-256.theme

dark-yellow-green.theme

light-16.theme

light-256.theme

solarized-dark-256.theme

solarized-light-256.theme

dark-default-16.theme

dark-gray-blue-256.theme

no-color.theme

Bear in mind that if you are using a terminal with a dark background, you will see better results using a dark theme.

You can also see how the theme will color the various tasks with the command:

$ task color legend

Better yet, create your own, and share it. We will gladly host the theme file on <http://taskwarrior.org>.

## CREDITS & COPYRIGHTS
Copyright (C) 2006 - 2016 P. Beckingham, F. Hernandez.

Taskwarrior is distributed under the MIT license. See http://www.opensource.org/licenses/mit-license.php for more information.

## SEE ALSO
task(1), taskrc(5), task-sync(5)

For more information regarding Taskwarrior, the following may be referenced:

The official site at

<http://taskwarrior.org>

The official code repository at

<https://git.tasktools.org/scm/tm/task.git>

You can contact the project by writing an email to

<support@taskwarrior.org>

## REPORTING BUGS
Bugs in Taskwarrior may be reported to the issue-tracker at

<http://taskwarrior.org>


task-sync

title: task-sync(5)

text:
# task-sync(5)

## NAME
task-sync - A discussion and tutorial for the various task(1) data synchronization capabilities.

## INTRODUCTION
Taskwarrior has several sync options, external and internal. If you wish to sync your data, choose one method only; mixing methods is only going to lead to problems. Each of the methods discussed have their own strengths.

## ALTERNATIVES
There are three alternatives for syncing data, which are:

1) Version control systems, such as git, hg, svn

2) File hosting systems, such as DropBox

3) Using the Taskserver and the 'sync' command

## OPTION 1: VERSION CONTROL SYSTEMS
There are several good, distributed VCS systems (git, hg, ...) and centralized VCS systems (svn ...), and they function in a similar fashion for our purposes.

Setup is straightforward. You place your .task directory under revision control. You then need to perform a regular commit/push/pull/update to make sure that the data is propagated when needed. You can even do this using shell scripts so that every task command is preceded by a 'pull' and followed by a 'push'.

Strengths:

- Good data transport mechanisms

- Secure transport options

Weaknesses:

- You need proficiency with VCS tools

- You will need to manually resolve conflicts frequently

- You need to provide the mechanism for making sure copies are up to date

## OPTION 2: FILE HOSTING SERVICES
There are many file hosting services, such as DropBox, Amazon S3, Google Drive, SkyDrive and more. This technique involves storing your .task directory in a shared directory under the control of the file hosting services.

Syncing happens quickly, although it is possible to run into conflict situations when there is no network connectivity, and the tasks are modified in two separate locations. This is because the file hosting service knows only about files, and it has no idea how to merge tasks. Avoid this problem by never modifying the same task on two machines, without an intervening sync.

Setup simply involves creating the directory and modifying your data.location configuration variable like this:

$ task config data.location /path/to/shared/directory

Strengths:

- Always secure

- Good client support

- Easy setup

- Transparent use

Weaknesses:

- Tasks are not properly merged

## OPTION 3: TASKSERVER
The Taskserver was designed for this purpose to be secure, fast and conflict free, allowing data interchange between assorted Taskwarrior clients, and tolerant of network connectivity problems.

There is a 'sync' command built in to Taskwarrior (provided the GnuTLS library is installed), and with a server account and client configuration, syncing is done on demand.

Setup is a matter of creating an account on a Taskserver (see your Taskserver provider or operate your own - see http://taskwarrior.org/docs/server_setup.html)

Once you have an account, you'll receive a certificate, key, and credentials. You'll need to put the certificate and key somewhere like this:

$ cp <name>.cert.pem ~/.task

$ cp <name>.key.pem ~/.task

Then you configure Taskwarrior, using the provided details:

$ task config taskd.certificate ~/.task/<name>.cert.pem

$ task config taskd.key ~/.task/<name>.key.pem

$ task config taskd.credentials <organization>/<name>/<UUID>

$ task config taskd.server <server domain>:<port>

If you are using a private server, you are likely also using a self-signed certificate, which means you will need one of the following additional entries:

$ task config taskd.ca ~/.task/ca.cert.pem

The CA (Certificate Authority) will be used to verify the server certificate. Alternatively, you can override the cert verification process using:

$ task config taskd.trust 'allow all'

This is an insecure option that should be used with caution, because it directs Taskwarrior to trust any certificate.

After setup, you run a one-time sync initialization, like this:

$ task sync initialize

This will make sure your client and the server are properly in sync to begin with. From this point on, you never run the 'initialize' command again, just go about your business, and when you want to sync, run this:

$ task sync

You'll see a summary of how many tasks were uploaded and downloaded. You can safely run the command as often as you like. When there are no changes to sync, nothing happens. If you do not have connectivity, your task changes accumulate so that when you next run 'sync' with proper connectivity, the changes are properly handled, in the right order.

Strengths:

- Always secure

- Minimal bandwidth

- Tolerates connectivity outage

Weaknesses:

- You need to manage your own server, or gain access to a hosted server.

## CREDITS & COPYRIGHTS
Copyright (C) 2006 - 2016 P. Beckingham, F. Hernandez.

Taskwarrior is distributed under the MIT license. See http://www.opensource.org/licenses/mit-license.php for more information.

## SEE ALSO
task(1), taskrc(5), task-color(5),

For more information regarding task, the following may be referenced:

The official site at

<http://taskwarrior.org>

The official code repository at

<https://git.tasktools.org/scm/tm/task.git>

You can contact the project by writing an email to

<support@taskwarrior.org>

## REPORTING BUGS
Bugs in task may be reported to the issue-tracker at

<http://taskwarrior.org>


taskrc

title: taskrc(5)

text:
# taskrc(5)

## NAME
taskrc - Configuration details for the task(1) command

## SYNOPSIS
$HOME/.taskrc

task rc:<directory-path>/.taskrc ...

TASKRC=<directory-path>/.taskrc task ...

## DESCRIPTION
Taskwarrior obtains its configuration data from a file called .taskrc . This file is normally located in the user's home directory:

$HOME/.taskrc

The default location can be overridden using the rc: attribute when running task:

$ task rc:<directory-path>/.taskrc ...

or using the TASKRC environment variable:

$ TASKRC=/tmp/.taskrc task ...

Individual options can be overridden by using the rc.<name>: attribute when running task:

$ task rc.<name>:<value> ...

or

$ task rc.<name>=<value> ...

If Taskwarrior is run without an existing configuration file it will ask if it should create a default, sample .taskrc file in the user's home directory.

The .taskrc file follows a very simply syntax defining name/value pairs:

<name> = <value>

There may be whitespace around <name>, '=' and <value>, and it is ignored. Whitespace within the <value> is left intact. Whitespace is not permitted in comma-separated lists. The entry must be on a single line, no continuations. Values support UTF8 as well as JSON encoding, such as \uNNNN.

Note that Taskwarrior is flexible about the values used to represent Boolean items. You can use "on", "yes", "y", "1" and "true". Anything else means "off".

include <file>

There may be whitespace around 'include' and <file>. The file may be an absolute or relative path, and the special character '~' is expanded to mean $HOME. The entry must be on a single line, no continuations.

\# <comment>

A comment consists of the character '#', and extends from the '#' to the end of the line. There is no way to comment a multi-line block. There may be blank lines.

Almost every value has a default setting, and an empty .taskrc file is one that makes use of every default. The contents of the .taskrc file therefore represent overrides of the default values. To remove a default value completely there must be an entry like this:

<name> =

This entry overrides the default value with a blank value.

## EDITING
You can edit your .taskrc file by hand if you wish, or you can use the 'config' command. To permanently set a value in your .taskrc file, use this command:

$ task config nag "You have more urgent tasks."

To delete an entry, use this command:

$ task config nag

Taskwarrior will then use the default value. To explicitly set a value to blank, and therefore avoid using the default value, use this command:

$ task config nag ""

Taskwarrior will also display all your settings with this command:

$ task show

and in addition, will also perform a check of all the values in the file, warning you of anything it finds amiss.

## NESTING CONFIGURATION FILES
The .taskrc can include other files containing configuration settings by using the include statement:

include <path/to/the/configuration/file/to/be/included>

By using include files you can divide your main configuration file into several ones containing just the relevant configuration data like colors, etc.

There are two excellent uses of includes in your .taskrc, shown here:

include /usr/share/doc/task/rc/holidays.en-US.rc

include /usr/share/doc/task/rc/dark-16.theme

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.

## ENVIRONMENT VARIABLES
These environment variables override defaults and command line arguments.

TASKDATA=~/.task

This overrides the default path for the Taskwarrior data files.

TASKRC=~/.taskrc

This overrides the default RC file.

## CONFIGURATION VARIABLES
Valid variable names and their default values are:

### FILES
data.location=$HOME/.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 ~ shell meta character, which will be properly expanded.

Note that the TASKDATA environment variable overrides this setting.

locking=on

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.

gc=on

Can be used to temporarily suspend garbage collection (gc), so that task IDs don't change. Note that this should be used in the form of a command line override (task rc.gc=off ...), and not permanently used in the .taskrc file, as this significantly affects performance in the long term.

hooks=on

This master control switch enables hook script processing. The default value is 'on', but certain extensions and environments may need to disable hooks.

exit.on.missing.db=no

When set to 'yes' causes the program to exit if the database (~/.task or rc.data.location or TASKDATA override) is missing. Default value is 'no'.

### TERMINAL
detection=on

Determines whether to use ioctl to establish the size of the window you are using, for text wrapping.

defaultwidth=80

The width of output used when auto-detection support is not available. Defaults 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.

defaultheight=24

The height of output used when auto-detection support is not available. Defaults to 24. If set to 0, it is interpreted as infinite height. This is useful when redirecting charts to a file for subsequent handling.

avoidlastcolumn=no

Causes the width of the terminal minus one to be used as the full width. This avoids placing color codes in the last column which can cause problems for Cygwin users. Default value is 'no'.

hyphenate=on

Hyphenates lines when wrapping breaks occur mid-word. Default value is 'on'.

editor=vi

Specifies which text editor you wish to use for when the task edit <ID> 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".

reserved.lines=1

This is the number of lines reserved at the bottom of the screen for the shell prompt. This is only referenced when 'limit:page' is used.

### MISCELLANEOUS
verbose=on|off|nothing|list...

When set to "on" (the default), helpful explanatory comments are added to all 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 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 control specific occasions when output is generated. This list may contain:

blank Inserts extra blank lines in output, for clarity

header Messages that appear before report output

footnote Messages that appear after report output

label Column labels on tabular reports

new-id Provides feedback of any new task IDs

new-uuid Provides feedback of any new task UUIDs. Deprecated, to be

merged with new-id.

affected Reports 'N tasks affected' and similar

edit Used the verbose template for the 'edit' command

special Feedback when applying special tags

project Feedback about project status changes

sync Feedback about sync

filter Shows the filter used in the command

unwait Notification when a task leaves the 'waiting' state

recur Notification when a new recurring task instance is created

"affected", "new-id", "new-uuid" "project" and "unwait" imply "footnote".

Note that the "on" setting is equivalent to all the tokens being specified, and the "nothing" setting is equivalent to none of the tokens being specified.

Here are the shortcut equivalents:

verbose=on

verbose=blank,header,footnote,label,new-id,affected,edit,special,project,sync,filter,unwait

verbose=off

verbose=blank,label,new-id,edit

verbose=nothing

verbose=

Those additional comments are sent to the standard error for header, footnote and project. The others are sent to standard output.

confirmation=yes

May be "yes" or "no", and determines whether Taskwarrior will ask for confirmation before deleting a task or performing the undo command. The default value is "yes". Consider leaving this setting as "yes", for safety.

allow.empty.filter=yes

An empty filter combined with a write command is potentially a way to modify all tasks by mistake, and when this is detected, confirmation is required. Setting this to 'no' means that it is an error to use a write command with no filter.

indent.annotation=2

Controls the number of spaces to indent annotations when shown beneath the description field. The default value is "2".

indent.report=0

Controls the indentation of the entire report output. Default is "0".

row.padding=0

Controls left and right padding around each row of the report output. Default is "0".

column.padding=0

Controls padding between columns of the report output. Default is "1".

bulk=3

Is a number, defaulting to 3. When this number or greater of tasks are modified in a single command, confirmation will be required, regardless of the value of confirmation variable. The special value bulk=0 is treated as an infinity. This is useful for preventing large-scale unintended changes.

nag=You have more urgent tasks.

This may be a string of text, or blank. It is used as a prompt when a task is started of completed, when there are other tasks with a higher urgency. Default value is: 'You have more urgent tasks'. It is a gentle reminder that you are contradicting your own urgency settings.

list.all.projects=no

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".

summary.all.projects=no

If set to yes, shows all projects in the summary report, even if there are no pending tasks. The default value is "no".

complete.all.tags=yes

May be yes or no, and determines whether the tab completion scripts consider all the tag names you have used, or just the ones used in active tasks. The default value is "no".

list.all.tags=yes

May be yes or no, and determines whether the 'tags' command lists all the tag names you have used, or just the ones used in active tasks. The default value is "no".

print.empty.columns=no

May be yes or no, and determines whether columns with no data for any task are printed. Defaults to no.

search.case.sensitive=yes

May be yes or no, and determines whether keyword lookup and substitutions on the description and annotations are done in a case sensitive way. Defaults to yes on most platforms. Defaults to no on Cygwin due to older regex library problems with case-insensitivity.

regex=on

Controls whether regular expression support is enabled. The default value is on.

xterm.title=no

Sets the xterm window title when reports are run. Defaults to off.

expressions=infix|postfix

Sets a preference for infix expressions (1 + 2) or postfix expressions (1 2 +). Defaults to infix.

json.array=on

Determines whether the export command encloses the JSON output in '[...]' and adds ',' after each exported task object to create a properly-formed JSON array. With json.array=off, export writes raw JSON objects to STDOUT, one per line. Defaults to on.

json.depends.array=on

Determines whether the export command encodes dependencies as an array of string UUIDs, or one comma-separated string. Defaults to on.

_forcecolor=no

Taskwarrior shuts off color automatically when the output is not sent directly to a TTY. For example, this command:

$ task list > file

will not use any color. To override this, use:

$ task rc._forcecolor=yes list > file

active.indicator=*

The character or string to show in the start.active column. Defaults to *.

tag.indicator=+

The character or string to show in the tag.indicator column. Defaults to +.

dependency.indicator=D

The character or string to show in the depends.indicator column. Defaults to +.

uda.<name>.indicator=U

The character or string to show in the <uda>.indicator column. Defaults to U.

recurrence=yes

Controls whether recurrence is enabled, and whether recurring tasks continue to generate new task instances. Defaults to 'yes'.

recurrence.confirmation=prompt

Controls whether changes to recurring tasks propagates to other child tasks with or without confirmation. A value of 'yes' means propagate changes without confirmation. A value of 'no' means do not propagate changes and don't ask for confirmation. A value of 'prompt' prompts you every time. Defaults to 'prompt'.

recurrence.indicator=R

The character or string to show in the recurrence_indicator column. Defaults to R.

recurrence.limit=1

The number of future recurring tasks to show. Defaults to 1. For example, if a weekly recurring task is added with a due date of tomorrow, and recurrence.limit is set to 2, then a report will list 2 pending recurring tasks, one for tomorrow, and one for a week from tomorrow.

undo.style=side

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.

abbreviation.minimum=2

Minimum length of any abbreviated command/value. This means that "ve", "ver", "vers", "versi", "versio" will all equate to "version", but "v" will not. Default is 2.

debug=off

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. Turning debug on automatically sets debug.hooks=1, debug.parser=1 and debug.tls=2 if they do not already have assigned values.

debug.hooks=0

Controls the hook system diagnostic level. Level 0 means no diagnostics. Level 1 shows hook calls. Level 2 also shows exit status and I/O.

debug.parser=0

Controls the parser diagnostic level. Level 0 shows no diagnostics. Level 1 shows the final parse tree. Level 2 shows the parse tree from all phases of the parse. Level 3 shows expression evaluation details.

debug.tls=0

Controls the GnuTLS diagnostic level. For 'sync' debugging. Level 0 means no diagnostics. Level 9 is the highest. Level 2 is a good setting for debugging.

obfuscate=1

When set to '1', will replace all report text with 'xxx'. This is useful for sharing report output in bug reports. Default value is '0'.

alias.rm=delete

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'.

### DATES
dateformat=Y-M-D

dateformat.report=

dateformat.holiday=YMD

dateformat.edit=Y-M-D H:N:S

dateformat.info=Y-M-D H:N:S

dateformat.annotation=

report.X.dateformat=Y-M-D

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 formatting the due dates in reports. If both report.X.dateformat and dateformat.report are not set then dateformat will be applied to the date. Entered dates as well as all other displayed dates in reports are formatted according to dateformat. The default value is the ISO-8601 standard: Y-M-D. The string can contain the characters:

m minimal-digit month, for example 1 or 12

d minimal-digit day, for example 1 or 30

y two-digit year, for example 09 or 12

D two-digit day, for example 01 or 30

M two-digit month, for example 01 or 12

Y four-digit year, for example 2009 or 2015

a short name of weekday, for example Mon or Wed

A long name of weekday, for example Monday or Wednesday

b short name of month, for example Jan or Aug

B long name of month, for example January or August

v minimal-digit week, for example 3 or 37

V two-digit week, for example 03 or 37

h minimal-digit hour, for example 3 or 21

n minimal-digit minutes, for example 5 or 42

s minimal-digit seconds, for example 7 or 47

H two-digit hour, for example 03 or 21

N two-digit minutes, for example 05 or 42

S two-digit seconds, for example 07 or 47

J three-digit Julian day, for example 023 or 365

j Julian day, for example 23 or 365

The characters 'v', 'V', 'a' and 'A' can only be used for formatting printed dates (not to parse them).

The string may also contain other characters to act as spacers, or formatting. Examples for other values of dateformat:

d/m/Y would use for input and output 24/7/2009

yMD would use for input and output 090724

M-D-Y would use for input and output 07-24-2009

Examples for other values of dateformat.report:

a D b Y (V) would emit "Fri 24 Jul 2009 (30)"

A, B D, Y would emit "Friday, July 24, 2009"

wV a Y-M-D would emit "w30 Fri 2009-07-24"

yMD.HN would emit "110124.2342"

m/d/Y H:N would emit "1/24/2011 10:42"

a D b Y H:N:S would emit "Mon 24 Jan 2011 11:19:42"

Undefined fields are put to their minimal valid values (1 for month and day and 0 for hour, minutes and seconds) when there is at least one more global date field that is set. Otherwise, they are set to the corresponding values of "now". For example:

8/1/2013 with m/d/Y implies August 1, 2013 at midnight (inferred)

8/1 20:40 with m/d H:N implies August 1, 2013 (inferred) at 20:40

date.iso=yes

Enables ISO-8601 date support. The default value is "yes".

weekstart=Sunday

Determines the day a week starts. Valid values are Sunday or Monday only. The default value is "Sunday".

displayweeknumber=yes

Determines if week numbers are displayed when using the "task calendar" command. The week number is dependent on the day a week starts. The default value is "yes".

due=7

This is the number of days into the future that define when a task is considered due, and is colored accordingly. The default value is 7.

calendar.details=sparse

If set to full running "task calendar" will display the details of tasks with due dates that fall into the calendar period. The corresponding days will be color-coded in the calendar. If set to sparse only the corresponding days will be color coded and no details will be displayed. The displaying of due dates with details is turned off by setting the variable to none. The default value is "sparse".

calendar.details.report=list

The report to run when displaying the details of tasks with due dates when running the "task calendar" command. The default value is "list".

calendar.offset=off

If "on" the first month in the calendar report is effectively changed by the offset value specified in calendar.offset.value. It defaults to "off".

calendar.offset.value=-1

The offset value to apply to the first month in the calendar report. The default value is "-1".

calendar.holidays=full

If set to full running "task calendar" will display holidays in the calendar by color-coding the corresponding days. A detailed list with the dates and names of the holidays is also shown. If set to sparse only the days are color-coded and no details on the holidays will be displayed. The displaying of holidays is turned off by setting the variable to none. The default value is "none".

calendar.legend=yes

Determines whether the calendar legend is displayed. The default value is "yes".

### JOURNAL ENTRIES
journal.time=no

May be yes or no, and determines whether the 'start' and 'stop' commands should record an annotation when being executed. The default value is "no". The text of the corresponding annotations is controlled by:

journal.time.start.annotation=Started task

The text of the annotation that is recorded when executing the start command and having set journal.time.

journal.time.stop.annotation=Stopped task

The text of the annotation that is recorded when executing the stop command and having set journal.time.

journal.info=on

When enabled, this setting causes a change log of each task to be displayed by the 'info' command. Default value is "on".

### HOLIDAYS
Holidays are entered either directly in the .taskrc file or via an include file that is specified in .taskrc. For each holiday the name and the date is required to be given:

holiday.towel.name=Day of the towel

holiday.towel.date=20100525

holiday.sysadmin.name=System Administrator Appreciation Day

holiday.sysadmin.date=20100730

Dates are to be entered according to the setting in the dateformat.holiday variable.

The following holidays are computed automatically: Good Friday (goodfriday), Easter (easter), Easter Monday (eastermonday), Ascension (ascension), Pentecost (pentecost). The date for these holidays is the given keyword:

holiday.eastersunday.name=Easter

holiday.eastersunday.date=easter

Note that the Taskwarrior distribution contains example holiday files that can be included like this:

include /usr/share/doc/task/rc/holidays.en-US.rc

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, Taskwarrior will only show as many that will fit.

### DEPENDENCIES
dependency.reminder=on

Determines whether dependency chain violations generate reminders.

dependency.confirmation=yes

Determines whether dependency chain repair requires confirmation.

### COLOR CONTROLS
color=on

May be "on" or "off". Determines whether Taskwarrior uses color. When "off", will use dashes (-----) to underline column headings.

fontunderline=on

Determines if font underlines or ASCII dashes should be used to underline headers, even when color is enabled.

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:

task color

Note that no default values are listed here - the defaults now correspond to the dark-256.theme (Linux) and dark-16.theme (other) theme values. The coloration rules are as follows:

color.due.today Task is due today

color.active Task is started, therefore active.

color.scheduled Task is scheduled, therefore ready for work.

color.until Task has an expiration date.

color.blocking Task is blocking another in a dependency.

color.blocked Task is blocked by a dependency.

color.overdue Task is overdue (due some time prior to now).

color.due Task is coming due.

color.project.none Task does not have an assigned project.

color.tag.none Task has no tags.

color.tagged Task has at least one tag.

color.recurring Task is recurring.

color.completed Task is completed.

color.deleted Task is deleted.

To disable a coloration rule for which there is a default, set the value to nothing, for example: color.tagged=

By default, colors produced by rules blend. This has the advantage of conveying additional information, by producing combinations that are not used by any particular rule directly. However, color blending can produce highlighting combinations which are not desired. In such cases, use the following option to disable this behaviour:

rule.color.merge=yes

Can be "yes" or "no". When "no", disables merging of colors produced by different color rules. Use if your color scheme produces unpleasing foreground and background combinations.

See the task-color(5) man pages for color details.

Certain attributes like tags, projects and keywords can have their own coloration rules.

color.tag.X=yellow

Colors any task that has the tag X.

color.project.X=on green

Colors any task assigned to project X.

color.keyword.X=on blue

Colors any task where the description or any annotation contains X.

color.uda.X=on green

Colors any task that has the user defined attribute X.

color.uda.X.VALUE=on green

Colors any task that has the user defined attribute X set to VALUE.

color.uda.X.none=on green

Colors any task that does not have the user defined attribute X.

color.error=white on red

Colors any of the error messages.

color.warning=bold red

Colors any of the warning messages.

color.header=green

Colors any of the messages printed prior to the report output.

color.footnote=green

Colors any of the messages printed last.

color.summary.bar=on green

Colors the summary progress bar. Should consist of a background color.

color.summary.background=on black

Colors the summary progress bar. Should consist of a background color.

color.calendar.today=black on cyan

Color of today in calendar.

color.calendar.due=black on green

Color of days with due tasks in calendar.

color.calendar.due.today=black on magenta

Color of today with due tasks in calendar.

color.calendar.overdue=black on red

Color of days with overdue tasks in calendar.

color.calendar.weekend=bright white on black

Color of weekend days in calendar.

color.calendar.holiday=black on bright yellow

Color of holidays in calendar.

color.calendar.weeknumber=black on white

Color of weeknumbers in calendar.

color.label=

Colors the report labels. Defaults to not use color.

color.label.sort=

Colors the report labels for sort columns. Defaults to color.label.

color.alternate=on rgb253

Color of alternate tasks. This is to apply a specific color to every other task in a report, which can make it easier to visually separate tasks. This is especially useful when tasks are displayed over multiple lines due to long descriptions or annotations.

color.history.add=on red

color.history.done=on green

color.history.delete=on yellow Colors the bars on the ghistory report graphs. Defaults to red, green and yellow bars.

color.burndown.pending=on red

color.burndown.started=on yellow

color.burndown.done=on green Colors the bars on the burndown reports graphs. Defaults to red, green and yellow bars.

color.undo.before=red

color.undo.after=green Colors used by the undo command, to indicate the values both before and after a change that is to be reverted.

color.sync.added=green

color.sync.changed=yellow

color.sync.rejected=red Colors the output of the sync command.

rule.precedence.color=due.today,active,blocking,blocked,overdue,due,

scheduled,keyword.,project.,tag.,uda.,recurring, pri.,tagged,completed,deleted

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 value (color.tag.XXX) is shortened to 'tag.', which places all specific tag rules at the same precedence, again for brevity.

color.debug=green

Colors all debug output, if enabled.

### URGENCY
The urgency calculation uses a polynomial with several terms, each of which has a configurable coefficient. Those coefficients are:

urgency.blocking.coefficient=8.0

Urgency coefficient for blocking tasks

urgency.blocked.coefficient=-5.0 Urgency coefficient for blocked tasks

urgency.due.coefficient=12.0 Urgency coefficient for due dates

urgency.waiting.coefficient=-3.0 Urgency coefficient for waiting status

urgency.active.coefficient=4.0 Urgency coefficient for active tasks

urgency.scheduled.coefficient=5.0 Urgency coefficient for scheduled tasks

urgency.project.coefficient=1.0 Urgency coefficient for projects

urgency.tags.coefficient=1.0 Urgency coefficient for tags

urgency.annotations.coefficient=1.0 Urgency coefficient for annotations

urgency.age.coefficient=2.0 Urgency coefficient for the age of tasks

urgency.age.max=365 Maximum age in days. After this number of days has elapsed, the urgency of a task won't increase any more because of aging.

urgency.user.tag.<tag>.coefficient=... Specific tag coefficient.

urgency.user.tag.next.coefficient=15.0 Urgency coefficient for tag 'next'.

urgency.user.project.<project>.coefficient=... Specific project coefficient.

urgency.user.keyword.<keyword>.coefficient=... Specific description keyword coefficient.

urgency.uda.<name>.coefficient=... Presence/absence of UDA data.

urgency.uda.<name>.<value>.coefficient=... Specific value of UDA data.

The coefficients reflect the relative importance of the various terms in the urgency calculation. These are default values, and may be modified to suit your preferences, but it is important that you carefully consider any modifications.

urgency.inherit=off

Not actually a coefficient. When enabled, blocking tasks inherit the highest urgency value found in the tasks they block. This is done recursively. It is recommended to set urgency.blocking.coefficient and urgency.blocked.coefficient to 0.0 in order for this setting to be the most useful.

### DEFAULTS
default.project=foo

Provides a default project name for the task add command, if you don't specify one. The default is blank.

default.due=...

Provides a default due date for the task add command, if you don't specify one. You can use a date, or a duration value which is assumed to be relative to 'now'. The default is blank.

uda.<name>.default=...

Provides default values for UDA fields when using the task add command, if you don't specify values. The default is blank.

default.command=next

Provides a default command that is run every time Taskwarrior is invoked with no arguments. For example, if set to:

default.command=project:foo list

then Taskwarrior will run the "project:foo list" command if no command is specified. This means that by merely typing

$ task

[task project:foo list]

ID Project Pri Description

1 foo H Design foo

2 foo Build foo

### REPORTS
The reports can be customized by using the following configuration variables. The output columns, their labels and the sort order can be set using the corresponding variables for each report. Each report name is used as a "command" name. For example

task overdue

report.X.description

The description for report X when running the "task help" command.

report.X.columns

This is a comma-separated list of columns and formatting specifiers. See the command 'task columns' for a full list of options and examples.

report.X.labels

The labels for each column that will be used when generating report X. The labels are a comma separated list.

report.X.sort

The sort order of the tasks in the generated report X. The sort order is specified by using the column ids post-fixed by a "+" for ascending sort order or a "-" for descending sort order. The sort IDs are separated by commas. For example:

report.list.sort=due+,priority-,start.active-,project+

Additionally, after the "+" or "-", there can be a solidus "/" which indicates that there are breaks after the column values change. For example:

report.minimal.sort=project+/,description+

This sort order now specifies that there is a listing break between each project. A listing break is simply a blank line, which provides a visual grouping.

A special sort value of "none" indicates that no sorting is required, and tasks will be presented in the order (if any) in which they are selected.

report.X.filter

This adds a filter to the report X so that only tasks matching the filter criteria are displayed in the generated report.

report.X.dateformat

This adds a dateformat to the report X that will be used by the "due date" column. If it is not set then dateformat.report and dateformat will be used in this order. See the DATES section for details on the sequence placeholders.

report.X.annotations

This adds the possibility to control the output of annotations for a task in a report. Deprecated. Use the description column with a format (e.g., description.count) instead.

Taskwarrior comes with a number of predefined reports, which are:

next

Lists the most important tasks.

long

Lists all pending tasks and all data, matching the specified criteria.

list

Lists all tasks matching the specified criteria.

ls

Short listing of all tasks matching the specified criteria.

minimal

Minimal listing of all tasks matching the specified criteria.

newest

Shows the newest tasks.

oldest

Shows the oldest tasks.

overdue

Lists overdue tasks matching the specified criteria.

active

Lists active tasks matching the specified criteria.

completed

Lists completed tasks matching the specified criteria.

recurring

Lists recurring tasks matching the specified criteria.

waiting

Lists all waiting tasks matching the specified criteria.

all

Lists all tasks matching the specified criteria.

blocked

Lists all tasks that have dependencies.

### USER DEFINED ATTRIBUTES
User defined attributes (UDAs) are an extension mechanism that allows you to 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 accommodate your workflow, or bend the rules and use Taskwarrior to store and synch data that is not necessarily task-related.

One important restriction is that because this is an open system that allows the definition of any new attribute, Taskwarrior cannot understand the meaning of that attribute. So while Taskwarrior will faithfully store, modify, report, sort and filter your UDA, it does not understand anything about it. For example if you define a UDA named 'estimate', Taskwarrior will not know that this value is weeks, hours, minutes, money, or some other resource count.

uda.<name>.type=string|numeric|date|duration

Defines a UDA called '<name>', of the specified type.

uda.<name>.label=<column heading>

Provides a default report label for the UDA called '<name>'.

uda.<name>.values=A,B,C

For type 'string' UDAs only, this provides a comma-separated list of acceptable values. In this example, the '<name>' UDA may only contain values 'A', 'B', or 'C', but may also contain no value. Note that the order of the value is important, and denotes the sort order from highest ('A') to lowest ('C').

Note that a blank value is permitted.

uda.<name>.default=...

Provides a default value for the UDA called '<name>'.

Example 'estimate' UDA

This example shows an 'estimate' UDA that stores specific values for the size of a task. Note the blank value after 'trivial'.

uda.estimate.type=string

uda.estimate.label=Size Estimate

uda.estimate.values=huge,large,medium,small,trivial,

Note that the value are sorted

huge > large > medium > small > trivial > ''

### CONTEXT
Context setting is a mechanism which allows the user to set a permanent filter, thus avoiding the need to specify one filter repeatedly. More details on usage can be found in the task(1) man page.

The current context is stored in the .taskrc file, along with definitions for all user provided contexts.

context=<name>

Stores the value of the currently active context.

context.<name>=<filter>

Stores the definition of the context with the name <name>.

### SYNC
These configuration settings are used to connect and sync tasks with the task server.

taskd.server=<host>:<port>

Specifies the hostname and port of the Taskserver. Hostname may be an IPv4 or IPv6 address, or domain. Port is an integer.

taskd.credentials=<organization>/<user>/<key>

User identification for the Taskserver, which includes a private key.

taskd.certificate=<path>

Specifies the path to the client certificate used for identification with the Taskserver.

taskd.key=<path>

Specifies the path to the client key used for encrypted communication with the Taskserver.

taskd.ca=<path>

Specifies the path to the CA certificate in the event that your Taskserver is using a self-signed certificate. Optional.

taskd.trust=strict|ignore hostname|allow all

This settings allows you to override the trust level when server certificates are validated. With "allow all", the server certificate is trusted automatically. With "ignore hostname", the server certificate is verified but the hostname is ignored. With "strict", the server certificate is verified. Default is "strict", which requires full validation.

taskd.ciphers=NORMAL

Override of the cipher selection. The set of ciphers used by TLS may be controlled by both server and client. There must be some overlap between client and server supported ciphers, or communication cannot occur. Default is "NORMAL". See GnuTLS documentation for full details.

## CREDITS & COPYRIGHTS
Copyright (C) 2006 - 2016 P. Beckingham, F. Hernandez.

This man page was originally written by Federico Hernandez.

Taskwarrior is distributed under the MIT license. See http://www.opensource.org/licenses/mit-license.php for more information.

## SEE ALSO
task(1), task-color(5), task-sync(5)

For more information regarding Taskwarrior, see the following:

The official site at

<http://taskwarrior.org>

The official code repository at

<https://git.tasktools.org/scm/tm/task.git>

You can contact the project by emailing

<support@taskwarrior.org>

## REPORTING BUGS
Bugs in Taskwarrior may be reported to the issue-tracker at

<https://bug.tasktools.org/>


taskdrc

package: taskd

title: taskdrc(5)

text:
# taskdrc(5)

## NAME
taskdrc - Configuration details for the taskd(1) server

## CONFIGURATION VARIABLES
Valid variable names and their default values are:

ca.cert

Fully qualified path to the CA certificate. Optional.

ciphers

List of GnuTLS ciphers to use. Default is "NORMAL". See your GnuTLS documentation for full details.

confirmation=on

Determines whether certain commands are confirmed. Defaults to on.

client.cert

Fully qualified path of the client cert. This is used by the 'client' command.

debug=off

Logs debugging information.

debug.tls=0

GnuTLS log level, an integer from 0 to 9, where 0 means no logging, and 9 means sensitive data leaks. Caution!

extensions=<path>

Fully qualified path of the Taskserver extension scripts. Currently there are none.

family=IPv4

Specifies the address family to use. Can be 'IPv4', 'IPv6', or not specified which means 'any'. Default is no value.

ip.log=on

Logs the IP addresses of incoming requests.

log=/tmp/taskd.log

Fully-qualified path name to the Taskserver log file. Alternately, specifying the value '-' will cause all logging to go to STDOUT. This does not apply when the server is run as a daemon.

pid.file=/tmp/taskd.pid

Fully-qualified path name to the Taskserver PID file. This is used by the 'taskdctl' script to start/stop the daemon.

queue.size=10

Size of the connection backlog. See 'man listen'.

request.limit=1048576

Size limit of incoming requests, in bytes. Use a value of zero '0' to indicate no size limit.

server=localhost:53589

The address (IPv4, IPv6 or DNS) of the Taskserver, followed by a colon and the port number.

server.cert

Fully qualified path to the server certificate.

server.crl

Fully qualified path to the server certificate revocation list.

server.key

Fully qualified path to the server key.

trust

Trust level of the server, which determines how the client certificates are verified. If the value is 'allow all' then no verification is performed. Defaults to 'strict'. Note that sending the HUP signal to the Taskserver causes a configuration file reload before the next request is handled.

## ENVIRONMENT VARIABLES
Environment variables provide values that would otherwise be required at the command line.

TASKDDATA=<root>

Most command require either '--data <root>' or this environment variable. If both are provided, the command line overrides the environment.

## CREDITS & COPYRIGHTS
Copyright (C) 2012 - 2015, Göteborg Bit Factory.

Taskserver is distributed under the MIT license. See http://www.opensource.org/licenses/mit-license.php for more information.

## SEE ALSO
taskd(1),taskdctl(1)

For more information regarding Taskserver, see the following:

The official site at

<http://taskwarrior.org>

The official code repository at

<https://git.tasktools.org/scm/tm/taskd.git>

You can contact the project by emailing

<support@taskwarrior.org>

## REPORTING BUGS
Bugs in Taskserver may be reported to the issue-tracker at

<http://taskwarrior.org


tayga.conf

package: tayga

title: tayga.conf(5)

text:
# tayga.conf(5)

## NAME
tayga.conf - configuration file of the TAYGA stateless NAT64 daemon

## DESCRIPTION
This file contains the configuration parameters for the TAYGA stateless NAT64 daemon. It must exist and contain the mandatory configuration items or TAYGA will refuse to run.

The configuration directives are listed below. With the exception of the map directive, only one instance of each directive may appear in tayga.conf.

tun-device device

Name of the network interface that will be created by the kernel TUN module for TAYGA to exchange IPv4 and IPv6 packets with the in-kernel TCP/IP stack. If device does not already exist as a persistent interface (created by the --mktun flag to tayga(8), for example), it will be created automatically when the TAYGA daemon starts and destroyed when the daemon exits.

Note that TAYGA does not configure the host-side parameters of device. This must be done by the system administrator using the ifconfig(8), route(8), and/or ip(8) commands.

This configuration directive is mandatory.

ipv4-addr ipv4_address

IPv4 address that TAYGA will use as the source address for ICMPv4 errors generated by the translation process. TAYGA will also respond to ICMP echo requests (pings) at this address.

ipv4_address is permitted to overlap with the prefix specified in the dynamic-pool directive, in which case ipv4_address will be removed from the pool of available addresses.

This configuration directive is mandatory.

ipv6-addr ipv6_address

IPv6 address that TAYGA will use as the source address for ICMPv6 errors generated by the translation process. TAYGA will also respond to ICMPv6 echo requests (pings) at this address.

This configuration directive is mandatory unless the NAT64 prefix is specified with the prefix directive, in which case TAYGA will generate its IPv6 address by mapping the address specified in ipv4-addr into the NAT64 prefix.

prefix ipv6_address/length

NAT64 prefix for mapping IPv4 addresses into the IPv6 address space. TAYGA performs address translation as specified in RFC 6052, and only prefix lengths allowed in that document will be permitted in the prefix directive.

The use of either a Network-Specific Prefix or the Well-Known Prefix (64:ff9b::/96) is allowed, however, as required by RFC 6052, TAYGA will refuse to translate packets with a source or destination address composed of the Well-Known Prefix and a non-global IPv4 address (10.x.x.x, 192.168.x.x, etc).

Use of the prefix directive is optional. If it is not specified, all addresses to be translated must be listed individually with the map directive.

map ipv4_address ipv6_address

Creates a static mapping between ipv4_address and ipv6_address to be used when translating IPv4 packets to IPv6 or IPv6 packets to IPv4. Multiple map directives are permitted in the tayga.conf file.

ipv4_address is permitted to overlap with the prefix specified in the dynamic-pool directive, in which case ipv4_address will be removed from the pool of available addresses.

ipv6_address must not overlap with the prefix specified in the prefix directive.

dynamic-pool ipv4_address/length

Address prefix containing addresses available to be assigned to IPv6 hosts. length must be 31 or less, as the lowest-numbered address in the prefix is considered reserved and will not be used for dynamic assignment.

If TAYGA receives an IPv6 packet to be translated with an IPv6 source address that does not match any existing mapping rules (as specified by the map directive or the prefix directive), TAYGA will create a dynamic mapping between the IPv6 address and an IPv4 address drawn from the prefix specified by the dynamic-pool directive. This mapping will be valid for two hours and four minutes after the last packet matching the mapping is translated.

The dynamic-pool directive is optional. If it is not specified, all IPv6 addresses appearing in packets passing through TAYGA must match the NAT64 prefix or a static mapping rule.

data-dir path

The absolute path of a directory where TAYGA should store its data files. Presently the only data file that TAYGA will store is the dynamic.map file, which tracks dynamic address assignments made from the dynamic pool.

path is also the directory that will be used as a chroot(2) "jail" if the --chroot command-line option is specified to the TAYGA daemon.

The TAYGA daemon must have full permissions (rwx) to path after it has dropped superuser privileges. Generally this means that the owner of path should be the user specified in the --user command-line option.

The data-dir directive is optional, but without it, dynamic mappings will be lost when the TAYGA daemon is stopped. Also, use of the --chroot command-line option will not be possible.

strict-frag-hdr on|off|true|false|1|0

Flag to control whether TAYGA adds fragmentation headers to IPv6 packets that do not require fragmentation. RFC 6145 stipulates that the fragmentation header SHOULD be added to all translated packets when the sender has not set the DF (Don't Fragment) flag, to indicate that the sender allows fragmentation and may not support path MTU discovery. Unfortunately, some firewall implementations drop IPv6 packets that are fragmented into a single fragment, most notably Linux netfilter conntrack in kernels older than 2.6.34.

When strict-frag-hdr is set to true, on, or 1, fragmentation headers will be added to all translated packets where the DF bit in the original packet is clear. This is the RFC-complaint behavior.

When strict-frag-hdr is set to false, off, or 0, fragmentation headers will be suppressed when the translated packet fits entirely within the IPv6 network MTU (1280 bytes). This is the default behavior.

This setting does not affect packets that arrive at TAYGA already fragmented, or packets that must be fragmented to fit within the IPv6 network MTU.

## SEE ALSO
tayga(8)

<http://www.litech.org/tayga/>


tcb

package: tcb-utils

title: tcb(5)

summary: alternative password shadowing scheme

text:
# tcb(5)

## NAME
tcb - alternative password shadowing scheme

## PROBLEM
With the traditional password shadowing scheme, password hashes and password aging information of all users is stored in one file, /etc/shadow. Therefore, if a process requires access to information on a single user, it is forced to possess privileges which are sufficient to access data on all users. This is a design flaw, which is most clearly visible in the case of passwd(1) utility. Let's assume that unprivileged users are to be allowed to change their own passwords. Whatever permissions are assigned to /etc/shadow, passwd(1), invoked by unprivileged user U, must be able to modify the contents of this file. If malicious user U finds a way to control the passwd(1) process (with the help of a buffer overflow or another bug in the passwd(1) code, in the libraries it uses, or in the kernel), the user will be able to change passwords of all users and thus obtain full control over the system.

## SOLUTION
The solution is straightforward - each user is assigned its own, separate shadow-style file. User U's shadow file is owned by U, so passwd(1) invoked by U does not require superuser privileges.

The directory where all users' shadow files reside is /etc/tcb:

```
drwx--x---    2 root     shadow       1024 Jul  4 01:18 /etc/tcb
```

For each user, there is a directory under /etc/tcb with appropriate ownership and permissions:

```
# ls -l /etc/tcb
total 2
drwx--s---    2 root     auth         1024 Jul  4 01:18 root
drwx--s---    2 user     auth         1024 Jul  4 01:18 user
```

and so on. Each of the directories contains a shadow file for just the appropriate user:

```
# ls -l /etc/tcb/user
total 1
-rw-r-----    1 user     auth           91 Jul  4 01:18 shadow
```

The per-user directories are also used as scratch space for temporary and lock files which are needed during password change.

## ADVANTAGES
This design has the following benefits:

1.

passwd(1) needs to be SGID to group shadow only, not SUID to root. chage(1) and /usr/lib/chkpwd/tcb_chkpwd are SGID to group shadow too, which with the tcb scheme means they only possess the privilege to access the user's own shadow file entry. A bug in one of these utilities may at most give a malicious user direct access to their own shadow file.

2.

If a process needs to possess read-only access to all shadow files, it is sufficient to assign it supplementary groups "shadow" and "auth".

3.

On systems supporting NSS, this scheme is completely transparent to applications which need read-only access to shadow file information. The libnss_tcb library implements getspnam(3) and other related functions with their traditional semantics. Password changing is provided by pam_tcb(8), a PAM module.

See the tcb_convert(8) manual page for instructions on how to enable the tcb scheme seamlessly.

## DISADVANTAGES
Honestly, there are a few minor ones:

1.

It is impractical to lock all of the shadow database (see tcb_unconvert(8)).

2.

Giving a process read-only access to all shadow files as described above has the side-effect of also giving it read-write access to the shadow entry of the (pseudo-)user it is running as.

3.

It is impossible to give a process privileges sufficient for read-only access to a single shadow file only, without also having it actually run as the user.

4.

The user management tools initially required heavy patching to support the tcb scheme.

## WORKAROUNDS FOR FILESYSTEMS LIMITS
In case of ext2fs, the maximum number of hardlinks to a single file is limited to 32000. Therefore, with this filesystem, there can be at most 31998 directory entries in /etc/tcb and, with the filesystem layout described above, at most 31998 users.

The workaround: a tcb directory of user U can be located not only in /etc/tcb, but also in /etc/tcb/:some/path. In the latter case, there should be a symlink /etc/tcb/U -> /etc/tcb/:some/path/U.

Starting with tcb 0.9.8, directories which match the shell pattern /etc/tcb/:* are not treated as per-user directories by tcb libraries. These directories are reserved to hold symlinked per-user directories, and for other purposes.

By default, shadow suite utilities create directory entries directly in /etc/tcb; if one expects more than 31998 users on the system, one can switch on the symlink creation anytime by editing login.defs(5) config file.

## AUTHORS
The tcb suite was implemented for Openwall GNU/*/Linux by Rafal Wojtczuk <nergal at owl.openwall.com> and Solar Designer <solar at owl.openwall.com>. pam_tcb is meant to be backwards-compatible with pam_unix, therefore some design decisions are cloned from pam_unix. Also certain less critical code fragments, as well as some of the code layout, are taken from the Linux-PAM implementation of pam_unix. The names of contributors to pam_unix can be found under orig_copyright/ in source distribution of the tcb suite.

## SEE ALSO
login.defs(5), pam_tcb(8), tcb_convert(8)


teamd.conf

package: teamd

title: teamd.conf(5)

summary: libteam daemon configuration file

text:
# teamd.conf(5)

## NAME
teamd.conf — libteam daemon configuration file

## DESCRIPTION
teamd uses JSON format configuration.

## OPTIONS
device (string)

Desired name of new team device.

debug_level (int)

Level of debug messages. The higher it is the more debug messages will be printed. It is the same as adding "-g" command line options.

Default: 0 (disabled)

hwaddr (string)

Desired hardware address of new team device. Usual MAC address format is accepted.

runner.name (string)

Name of team device. The following runners are available:

broadcast — Simple runner which directs the team device to transmit packets via all ports.

roundrobin — Simple runner which directs the team device to transmits packets in a round-robin fashion.

random — Simple runner which directs the team device to transmits packets on a randomly selected port.

activebackup — Watches for link changes and selects active port to be used for data transfers.

loadbalance — To do passive load balancing, runner only sets up BPF hash function which will determine port for packet transmit. To do active load balancing, runner moves hashes among available ports trying to reach perfect balance.

lacp — Implements 802.3ad LACP protocol. Can use same Tx port selection possibilities as loadbalance runner.

Default: roundrobin

notify_peers.count (int)

Number of bursts of unsolicited NAs and gratuitous ARP packets sent after port is enabled or disabled.

Default: 0 (disabled)

Default for activebackup runner: 1

notify_peers.interval (int)

Value is positive number in milliseconds. Specifies an interval between bursts of notify-peer packets.

Default: 0

mcast_rejoin.count (int)

Number of bursts of multicast group rejoin requests sent after port is enabled or disabled.

Default: 0 (disabled)

Default for activebackup runner: 1

mcast_rejoin.interval (int)

Value is positive number in milliseconds. Specifies an interval between bursts of multicast group rejoin requests.

Default: 0

link_watch.name | ports.PORTIFNAME.link_watch.name (string)

Name of link watcher to be used. The following link watchers are available:

ethtool — Uses Libteam lib to get port ethtool state changes.

arp_ping — ARP requests are sent through a port. If an ARP reply is received, the link is considered to be up.

nsna_ping — Similar to the previous, except that it uses IPv6 Neighbor Solicitation / Neighbor Advertisement mechanism. This is an alternative to arp_ping and becomes handy in pure-IPv6 environments.

ports (object)

List of ports, network devices, to be used in a team device.

See examples for more information.

ports.PORTIFNAME.queue_id (int)

ID of queue which this port should be mapped to.

Default: None

## ACTIVE-BACKUP RUNNER SPECIFIC OPTIONS
runner.hwaddr_policy (string)

This defines the policy of how hardware addresses of team device and port devices should be set during the team lifetime. The following are available:

same_all — All ports will always have the same hardware address as the associated team device.

by_active — Team device adopts the hardware address of the currently active port. This is useful when the port device is not able to change its hardware address.

only_active — Only the active port adopts the hardware address of the team device. The others have their own.

Default: same_all

ports.PORTIFNAME.prio (int)

Port priority. The higher number means higher priority.

Default: 0

ports.PORTIFNAME.sticky (bool)

Flag which indicates if the port is sticky. If set, it means the port does not get unselected if another port with higher priority or better parameters becomes available.

Default: false

## LOAD BALANCE RUNNER SPECIFIC OPTIONS
runner.tx_hash (array)

List of fragment types (strings) which should be used for packet Tx hash computation. The following are available:

eth — Uses source and destination MAC addresses.

vlan — Uses VLAN id.

ipv4 — Uses source and destination IPv4 addresses.

ipv6 — Uses source and destination IPv6 addresses.

ip — Uses source and destination IPv4 and IPv6 addresses.

l3 — Uses source and destination IPv4 and IPv6 addresses.

tcp — Uses source and destination TCP ports.

udp — Uses source and destination UDP ports.

sctp — Uses source and destination SCTP ports.

l4 — Uses source and destination TCP and UDP and SCTP ports.

Default: ["eth", "ipv4", "ipv6"]

runner.tx_balancer.name (string)

Name of active Tx balancer. Active Tx balancing is disabled by default. The only value available is basic.

Default: None

runner.tx_balancer.balancing_interval (int)

In tenths of a second. Periodic interval between rebalancing.

Default: 50

## LACP RUNNER SPECIFIC OPTIONS
runner.active (bool)

If active is true LACPDU frames are sent along the configured links periodically. If not, it acts as "speak when spoken to".

Default: true

runner.fast_rate (bool)

Option specifies the rate at which our link partner is asked to transmit LACPDU packets. If this is true then packets will be sent once per second. Otherwise they will be sent every 30 seconds.

Default: false

runner.tx_hash (array)

Same as for load balance runner.

runner.tx_balancer.name (string)

Same as for load balance runner.

runner.tx_balancer.balancing_interval (int)

Same as for load balance runner.

runner.sys_prio (int)

System priority, value can be 0 – 65535.

Default: 65535

runner.min_ports (int)

Specifies the minimum number of ports that must be active before asserting carrier in the master interface, value can be 1 – 1024.

Default: 1

runner.agg_select_policy (string)

This selects the policy of how the aggregators will be selected. The following are available:

lacp_prio — Aggregator with highest priority according to LACP standard will be selected. Aggregator priority is affected by per-port option lacp_prio.

lacp_prio_stable — Same as previous one, except do not replace selected aggregator if it is still usable.

bandwidth — Select aggregator with highest total bandwidth.

count — Select aggregator with highest number of ports.

port_config — Aggregator with highest priority according to per-port options prio and sticky will be selected. This means that the aggregator containing the port with the highest priority will be selected unless at least one of the ports in the currently selected aggregator is sticky.

Default: lacp_prio

ports.PORTIFNAME.lacp_prio (int)

Port priority according to LACP standard. The lower number means higher priority.

Default: 255

ports.PORTIFNAME.lacp_key (int)

Port key according to LACP standard. It is only possible to aggregate ports with the same key.

Default: 0

## ETHTOOL LINK WATCH SPECIFIC OPTIONS
link_watch.delay_up | ports.PORTIFNAME.link_watch.delay_up (int)

Value is a positive number in milliseconds. It is the delay between the link coming up and the runner being notified about it.

Default: 0

link_watch.delay_down | ports.PORTIFNAME.link_watch.delay_down (int)

Value is a positive number in milliseconds. It is the delay between the link going down and the runner being notified about it.

Default: 0

## ARP PING LINK WATCH SPECIFIC OPTIONS
link_watch.interval | ports.PORTIFNAME.link_watch.interval (int)

Value is a positive number in milliseconds. It is the interval between ARP requests being sent.

Default: 1000

link_watch.init_wait | ports.PORTIFNAME.link_watch.init_wait (int)

Value is a positive number in milliseconds. It is the delay between link watch initialization and the first ARP request being sent.

Default: 0

link_watch.missed_max | ports.PORTIFNAME.link_watch.missed_max (int)

Maximum number of missed ARP replies. If this number is exceeded, link is reported as down.

Default: 3

link_watch.source_host | ports.PORTIFNAME.link_watch.source_host (hostname)

Hostname to be converted to IP address which will be filled into ARP request as source address.

Default: 0.0.0.0

link_watch.target_host | ports.PORTIFNAME.link_watch.target_host (hostname)

Hostname to be converted to IP address which will be filled into ARP request as destination address.

link_watch.validate_active | ports.PORTIFNAME.link_watch.validate_active (bool)

Validate received ARP packets on active ports. If this is not set, all incoming ARP packets will be considered as a good reply.

Default: false

link_watch.validate_inactive | ports.PORTIFNAME.link_watch.validate_inactive (bool)

Validate received ARP packets on inactive ports. If this is not set, all incoming ARP packets will be considered as a good reply.

Default: false

link_watch.vlanid | ports.PORTIFNAME.link_watch.vlanid (int)

By default, ARP requests are sent without VLAN tags. This option causes outgoing ARP requests to be sent with the specified VLAN ID number.

Default: None

link_watch.send_always | ports.PORTIFNAME.link_watch.send_always (bool)

By default, ARP requests are sent on active ports only. This option allows sending even on inactive ports.

Default: false

## NS/NA PING LINK WATCH SPECIFIC OPTIONS
link_watch.interval | ports.PORTIFNAME.link_watch.interval (int)

Value is a positive number in milliseconds. It is the interval between sending NS packets.

Default: 1000

link_watch.init_wait | ports.PORTIFNAME.link_watch.init_wait (int)

Value is a positive number in milliseconds. It is the delay between link watch initialization and the first NS packet being sent.

link_watch.missed_max | ports.PORTIFNAME.link_watch.missed_max (int)

Maximum number of missed NA reply packets. If this number is exceeded, link is reported as down.

Default: 3

link_watch.target_host | ports.PORTIFNAME.link_watch.target_host (hostname)

Hostname to be converted to IPv6 address which will be filled into NS packet as target address.

link_watch_policy (string)

Name of link-watchers evaluation policy. Available options are following:

any — Link is up if any of the link-watchers reports the link up.

all — Link is up if all of the link-watchers reports the link up.

Default: any

## EXAMPLES

```
{

  "device": "team0",

  "runner": {"name": "roundrobin"},

  "ports": {"eth1": {}, "eth2": {}}
}
```

Very basic configuration.

```
{

  "device": "team0",

  "runner": {"name": "activebackup"},

  "link_watch": {"name": "ethtool"},

  "ports": {

    "eth1": {

      "prio": -10,

      "sticky": true

    },

    "eth2": {

      "prio": 100

    }

  }
}
```

This configuration uses active-backup runner with ethtool link watcher. Port eth2 has higher priority, but the sticky flag ensures that if eth1 becomes active, it stays active while the link remains up.

```
{

  "device": "team0",

  "runner": {"name": "activebackup"},

  "link_watch": {

    "name": "ethtool",

    "delay_up": 2500,

    "delay_down": 1000

  },

  "ports": {

    "eth1": {

      "prio": -10,

      "sticky": true

    },

    "eth2": {

      "prio": 100

    }

  }
}
```

Similar to the previous one. Only difference is that link changes are not propagated to the runner immediately, but delays are applied.

```
{

  "device": "team0",

  "runner": {"name": "activebackup"},

  "link_watch":	{

    "name": "arp_ping",

    "interval": 100,

    "missed_max": 30,

    "target_host": "192.168.23.1"

  },

  "ports": {

    "eth1": {

      "prio": -10,

      "sticky": true

    },

    "eth2": {

      "prio": 100

    }

  }
}
```

This configuration uses ARP ping link watch.

```
{
"device": "team0",
"runner": {"name": "activebackup"},
"link_watch": [

  {

    "name": "arp_ping",

    "interval": 100,

    "missed_max": 30,

    "target_host": "192.168.23.1"

  },

  {

    "name": "arp_ping",

    "interval": 50,

    "missed_max": 20,

    "target_host": "192.168.24.1"

  }
],
"ports": {

  "eth1": {

    "prio": -10,

    "sticky": true

  },

  "eth2": {

    "prio": 100

    }

  }
}
```

Similar to the previous one, only this time two link watchers are used at the same time.

```
{

  "device": "team0",

  "runner": {"name": "activebackup"},

  "link_watch_policy": "all",

  "link_watch": [

    {

    "name": "arp_ping",

    "interval": 100,

    "missed_max": 30,

    "target_host": "192.168.23.1"

    },

    {

    "name": "ethtool"

    }

  ],

  "ports":  {

    "eth1": {

      "prio": -10,

      "sticky": true

    },

    "eth2": {

      "prio": 100

    }

  }
}
```

Two link-watchers are used at the same time. Link is up only if all configured link-watchers report link is up.

```
{

  "device": "team0",

  "runner": {

    "name": "loadbalance",

    "tx_hash": ["eth", "ipv4", "ipv6"]

  },

  "ports": {"eth1": {}, "eth2": {}}
}
```

Configuration for hash-based passive Tx load balancing.

```
{

  "device": "team0",

  "runner": {

    "name": "loadbalance",

    "tx_hash": ["eth", "ipv4", "ipv6"],

    "tx_balancer": {

      "name": "basic"

    }

  },

  "ports": {"eth1": {}, "eth2": {}}
}
```

Configuration for active Tx load balancing using basic load balancer.

```
{

  "device": "team0",

  "runner": {

    "name": "lacp",

    "active": true,

    "fast_rate": true,

    "tx_hash": ["eth", "ipv4", "ipv6"]

  },

  "link_watch": {"name": "ethtool"},

  "ports": {"eth1": {}, "eth2": {}}
}
```

Configuration for connection to LACP capable counterpart.

## SEE ALSO
teamd(8), teamdctl(8), teamnl(8), bond2team(1)

## AUTHOR
Jiri Pirko is the original author and current maintainer of libteam.