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/>


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.

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


package: terminator

title: terminator_config(5)

text:
# terminator_config(5)

## NAME
~/.config/terminator/config - the config file for Terminator terminal emulator.

## DESCRIPTION
This manual page documents briefly the Terminator config file. Terminator manages its configuration file via the ConfigObj library to combine flexibility with clear, human editable files. As of version 0.90, Terminator offers a full GUI preferences editor which automatically saves its config file so you don't need to write a config file by hand.

## FILE LOCATION
Normally the config file will be ~/.config/terminator/config, but it may be overridden with $XDG_CONFIG_HOME (in which case it will be $XDG_CONFIG_HOME/terminator/config)

## FILE FORMAT
This is what a Terminator config file should look like:

\# This is a comment

[global_config]

focus = system

[keybindings]

full_screen = <Ctrl><Shift>F11

[profiles]

[[default]]

font = Fixed 10

background_color = "#000000" # A comment

foreground_color = "#FFFFFF" # Note that hex colour values must be quoted

scrollback_lines = '500' #More comment. Single quotes are valid too

cursor_blink = True

custom_command = "echo \"foo#bar\"" #Final comment - this will work as expected.

Below are the individual sections that can exist in the config file:

## global_config
These are the options Terminator currently supports in the global_config section:

dbus

Control whether or not Terminator will load its DBus server. When this server is loaded, running Terminator multiple times will cause the first Terminator process to open additional windows. If this configuration item is set to False, or the python dbus module is unavailable, running Terminator multiple times will run a separate Terminator process for each invocation. Default value: True

focus

Control how focus is given to terminals. 'click' means the focus only moves to a terminal after you click in it. 'sloppy' means the focus will follow the mouse pointer. 'system' means the focus will match that used by a GNOME window manager. Default value: click

handle_size

Controls the width of the separator between terminals. Anything outside the range 0-20 (inclusive) will be ignored and use your default theme value. Default value: -1

geometry_hinting

If True the window will resize in step with font sizes, if False it will follow pixels Default value: False

window_state

When set to 'normal' the Terminator window opens normally. 'maximise' opens the window in a maximised state, 'fullscreen' in a fullscreen state and 'hidden' will make it not shown by default. Default value: normal

borderless (boolean)

Controls whether the Terminator window will be started without window borders Default value: False

tab_position

Defines where tabs are placed. Can be any of: top, left, right, bottom. If this is set to "hidden", the tab bar will not be shown. Note that hiding the tab bar is very confusing and not recommended. Default value: top

broadcast_default

Defines default broadcast behavior. Can be any of: all, group, off. Default value: group

close_button_on_tab (boolean)

If set to True, tabs will have a close button on them. Default value: True

hide_tabbar (boolean)

If set to True, the tab bar will be hidden. This means there will be no visual indication of either how many tabs there are, or which one you are on. Be warned that this can be very confusing and hard to use. NOTE: THIS OPTION IS DEPRECATED, USE tab_position INSTEAD Default value: False

scroll_tabbar (boolean)

If set to True, the tab bar will not fill the width of the window. The titlebars of the tabs will only take as much space as is necessary for the text they contain. Except, that is, if the tabs no longer fit the width of the window - in that case scroll buttons will appear to move through the tabs. Default value: False

try_posix_regexp (boolean)

If set to True, URL matching regexps will try to use POSIX style first, and fall back on GNU style on failure. If you are on Linux but URL matches don't work, try setting this to True. If you are not on Linux, but you get VTE warnings on startup saying "Error compiling regular expression", set this to False to silence them (they are otherwise harmless). Default value: False on Linux, True otherwise.

use_custom_url_handler (boolean)

If set to True, URL handling will be given over entirely to the program specified by 'custom_url_handler'. Default value: False

custom_url_handler (string)

Path to a program which accepts a URI as an argument and does something relevant with it. This option is ignored unless 'use_custom_url_handler' is set to True. Default value: unset

disable_real_transparency (string)

If this is set to True, Terminator will never try to use 'real' transparency if your windowing environment supports it. Instead it will use 'fake' transparency where a background image is shown, but other windows are not. Default value: False

title_transmit_fg_color

Sets the colour of the text shown in the titlebar of the active terminal. Default value: '#FFFFFF'

title_transmit_bg_color

Sets the colour of the background of the titlebar in the active terminal. Default value: '#C80003'

title_receive_fg_color

Sets the colour of the text shown in the titlebar of any terminal that will receive input from the active terminal. Default value: '#FFFFFF'

title_receive_bg_color

Sets the colour of the background of the titlebar of any terminal that will receive input from the active terminal. Default value: '#0076C9'

title_inactive_fg_color

Sets the colour of the text shown in the titlebar of any terminal that will not receive input from the active terminal. Default value: '#000000'

title_inactive_bg_color

Sets the colour of the background of the titlebar of any terminal that will not receive input from the active terminal. Default value: '#C0BEBF'

title_use_system_font (boolean)

Whether or not to use the GNOME default proportional font for titlebars. Default value: True

title_font (string)

An Pango font name. Examples are "Sans 12" or "Monospace Bold 14". Default value: "Sans 9"

inactive_color_offset

Controls how much to reduce the colour values of fonts in terminals that do not have focus. It is a simple multiplication factor. A font colour that was RGB(200,200,200) with an inactive_color_offset of 0.5 would set inactive terminals to RGB(100,100,100).

always_split_with_profile

Controls whether splits/tabs will continue to use the profile of their peer terminal. If set to False, they will always use the default profile. Default value: False

putty_paste_style (boolean)

If set to True, right-click will paste the Primary selection, middle-click will popup the context menu. Default value: False

smart_copy (boolean)

If set to True, and there is no selection, the shortcut is allowed to pass through. This is useful for overloading Ctrl-C to copy a selection, or send the SIGINT to the current process if there is no selection. If False the shortcut does not pass through at all, and the SIGINT does not get sent. Default value: True

enabled_plugins

A list of plugins which should be loaded by default. All other plugin classes will be ignored. The default value includes two plugins related to Launchpad, which are enabled by default to provide continuity with earlier releases where these were the only substantial plugins available, and all plugins were loaded by default. Default value: "LaunchpadBugURLHandler, LaunchpadCodeURLHandler"

## keybindings
These are the options Terminator currently supports in the keybindings section:

zoom_in

Make font one unit larger. Default value: <Ctrl>plus

zoom_out

Make font one unit smaller. Default value: <Ctrl>minus

zoom_normal

Return font to pre-configured size. Default value: <Ctrl>0

new_tab

Open a new tab. Default value: <Ctrl><Shift>T

cycle_next

Cycle forwards through the tabs. Default value: <Ctrl>Tab

cycle_prev

Cycle backwards through the tabs. Default value: <Ctrl><Shift>Tab go_next Move cursor focus to the next tab. Default value: <Ctrl><Shift>N

go_prev

Move cursor focus to the previous tab. Default value: <Ctrl><Shift>P

go_up

Move cursor focus to the terminal above. Default value: <Alt>Up

go_down

Move cursor focus to the terminal below. Default value: <Alt>Down

go_left

Move cursor focus to the terminal to the left. Default value: <Alt>Left

go_right

Move cursor focus to the terminal to the right. Default value: <Alt>Right

rotate_cw

Rotate terminals clockwise. Default value: <Super>R

rotate_ccw

Rotate terminals counter-clockwise. Default value: <Super><Shift>R

split_horiz

Split the current terminal horizontally. Default value: <Ctrl><Shift>O

split_vert

Split the current terminal vertically. Default value: <Ctrl><Shift>E

close_term

Close the current terminal. Default value: <Ctrl><Shift>W

copy

Copy the currently selected text to the clipboard. Default value: <Ctrl><Shift>C

paste

Paste the current contents of the clipboard. Default value: <Ctrl><Shift>V

paste_selection

Paste the current contents of the primary selection. Default value: Unbound

toggle_scrollbar

Show/Hide the scrollbar. Default value: <Ctrl><Shift>S

search

Search for text in the terminal scrollback history. Default value: <Ctrl><Shift>F

close_window

Quit Terminator. Default value: <Ctrl><Shift>Q

resize_up

Move the parent dragbar upwards. Default value: <Ctrl><Shift>Up

resize_down

Move the parent dragbar downwards. Default value: <Ctrl><Shift>Down

resize_left

Move the parent dragbar left. Default value: <Ctrl><Shift>Left

resize_right

Move the parent dragbar right. Default value: <Ctrl><Shift>Right

move_tab_right

Swap the current tab with the one to its right. Default value: <Ctrl><Shift>Page_Down

move_tab_left

Swap the current tab with the one to its left. Default value: <Ctrl><Shift>Page_Up

toggle_zoom

Zoom/Unzoom the current terminal to fill the window. Default value: <Ctrl><Shift>X

scaled_zoom

Zoom/Unzoom the current terminal to fill the window, and scale its font. Default value: <Ctrl><Shift>Z

next_tab

Move to the next tab. Default value: <Ctrl>Page_Down

prev_tab

Move to the previous tab. Default value: <Ctrl>Page_Up

switch_to_tab_1 - switch_to_tab_10

Keys to switch directly to the numbered tab. Note that <Alt><Shift>1 may need to be provided as <Alt>! or similar, depending on your keyboard layout. Default value: Unbound

edit_window_title

Edit the current active window's title Default value: <Ctrl><Alt>W

edit_tab_title

Edit the currently active tab's title Default value: <Ctrl><Alt>A

edit_terminal_title

Edit the currently active terminal's title Default value: <Ctrl><Alt>X

full_screen

Toggle the window to a fullscreen window. Default value: F11

reset

Reset the terminal state. Default value: <Ctrl><Shift>R

reset_clear

Reset the terminal state and clear the terminal window. Default value: <Ctrl><Shift>G

hide_window

Toggle visibility of the Terminator window. Default value: <Ctrl><Shift><Alt>a

group_all

Group all terminals together so input sent to one goes to all of them. Default value: <Super>g

ungroup_all

Remove grouping from all terminals. Default value: <Super><Shift>G

group_tab

Group all terminals in the current tab together so input sent to one goes to all of them. Default value: <Super>t

ungroup_tab

Remove grouping from all terminals in the current tab. Default value: <Super><Shift>T

new_window

Open a new Terminator window as part of the existing process. Default value: <Ctrl><Shift>I

new_terminator

Spawn a new instance of Terminator. Default value: <Super>i

## profiles
These are the options Terminator currently supports in the profiles section. Each profile should be its own subsection with a header in the format [[name]]

allow_bold (boolean) If true, allow applications in the terminal to make text boldface. Default value: True

audible_bell (boolean)

If true, make a noise when applications send the escape sequence for the terminal bell. Default value: False

visible_bell (boolean)

If true, flash the terminal when applications send the escape sequence for the terminal bell. Default value: False

urgent_bell (boolean)

If true, set the window manager "urgent" hint when applications send the escale sequence for the terminal bell. Any keypress will cancel the urgent status. Default value: False

icon_bell (boolean)

If true, briefly show a small icon on the terminal title bar for the terminal bell. Default value: True

force_no_bell (boolean)

If true, don't make a noise or flash. All terminal bells will be ignored. Default value: False

use_theme_colors

If true, ignore the configured colours and use values from the theme instead. Default value: False

bold_is_bright

If true, show bold text with increased brightness. If false, then text boldness can be controlled by applications independently from the text brightness. Default value: False

background_color

Default colour of terminal background, as a colour specification (can be HTML-style hex digits, or a colour name such as "red"). Note: You may need to set use_theme_colors=False to force this setting to take effect. Default value: '#000000'

background_darkness

A value between 0.0 and 1.0 indicating how much to darken the background image. 0.0 means no darkness, 1.0 means fully dark. If the terminal is set to transparent, this setting controls how transparent it is. 0.0 means fully transparent, 1.0 means fully opaque. Default value: 0.5

background_type

Type of terminal background. May be "solid" for a solid colour or "transparent" for full transparency in compositing window managers. Default value: solid

backspace_binding

Sets what code the backspace key generates. Possible values are "ascii-del" for the ASCII DEL character, "control-h" for Control-H (AKA the ASCII BS character), "escape-sequence" for the escape sequence typically bound to backspace or delete. "ascii-del" is normally considered the correct setting for the Backspace key. Default value: ascii-del

delete_binding

Sets what code the delete key generates. Possible values are "ascii-del" for the ASCII DEL character, "control-h" for Control-H (AKA the ASCII BS character), "escape-sequence" for the escape sequence typically bound to backspace or delete. "escape-sequence" is normally considered the correct setting for the Delete key. Default value: escape-sequence

color_scheme (boolean)

If specified this sets foreground_color and background_color to pre-set values. Possible options are 'grey_on_black', 'black_on_yellow', 'black_on_white', 'white_on_black', 'green_on_black', 'orange_on_black', 'ambience', 'solarized_dark', 'solarized_light'. Default value: grey_on_black

cursor_blink (boolean)

Controls if the cursor blinks. Default value: True

cursor_color

Default colour of cursor, as a colour specification (can be HTML-style hex digits, or a colour name such as "red"). Default value: Current value of foreground_color

cursor_shape

Default shape of cursor. Possibilities are "block", "ibeam", and "underline". Default value: block

term

This translates into the value that will be set for TERM in the environment of your terminals. Default value: xterm-256color

colorterm

This translates into the value that will be set for COLORTERM in the environment of your terminals. Default value: truecolor

use_system_font

Whether or not to use the GNOME default monospace font for terminals. Default value: True

font

An Pango font name. Examples are "Sans 12" or "Monospace Bold 14". Default value: Mono 10

foreground_color

Default colour of text in the terminal, as a colour specification (can be HTML-style hex digits, or a colour name such as "red"). Note: You may need to set use_theme_colors=False to force this setting to take effect. Default value: '#AAAAAA'

scrollbar_position

Where to put the terminal scrollbar. Possibilities are "left", "right", and "disabled". Default value: right

show_titlebar

If true, a titlebar will be drawn for each terminal which shows the current title of that terminal. Default value: True

scroll_background (boolean)

If true, scroll the background image with the foreground text; if false, keep the image in a fixed position and scroll the text above it. Default value: True

scroll_on_keystroke (boolean)

If true, pressing a key jumps the scrollbar to the bottom. Default value: True

scroll_on_output (boolean)

If true, whenever there's new output the terminal will scroll to the bottom. Default value: False

scrollback_lines

Number of scrollback lines to keep around. You can scroll back in the terminal by this number of lines; lines that don't fit in the scrollback are discarded. Warning: with large values, rewrapping on resize might be slow. Default value: 500

scrollback_infinite

If this is set to True, scrollback_lines will be ignored and VTE will keep the entire scrollback history. Default value: False

focus_on_close

Sets which terminal should get the focus when another terminal is closed. Values can be "prev", "next" or "auto". Using "auto", if the closed terminal is within a split window, the focus will be on the sibling terminal rather than another tab. Default value: auto

exit_action

Possible values are "close" to close the terminal, and "restart" to restart the command. Default value: close

palette

Terminals have a 16-colour palette that applications inside the terminal can use. This is that palette, in the form of a colon-separated list of colour names. Colour names should be in hex format e.g. "#FF00FF".

word_chars

When selecting text by word, sequences of these characters are also considered members of single words. The hyphen and alphanumerics do not need to be specified. Ranges can be given as "A-Z". Default value: ',./?%&#:_'

mouse_autohide (boolean)

Controls whether the mouse cursor should be hidden while typing. Default value: True

use_custom_command (boolean)

If True, the value of custom_command will be used instead of the default shell. Default value: False

custom_command

Command to execute instead of the default shell, if use_custom_command is set to True. Default value: Nothing

http_proxy

URL of an HTTP proxy to use, e.g. http://proxy.lan:3128/ Default value: Nothing

encoding

Character set to use for the terminal. Default value: UTF-8

copy_on_selection (boolean)

If set to True, text selections will be automatically copied to the clipboard, in addition to being made the Primary selection. Default value: False

## layouts
This describes the layouts section of the config file. Like with the profiles, each layout should be defined as a sub-section with a name formatted like: [[name]].

Each object in a layout is a named sub-sub-section with various properties:

[layouts]

[[default]]

[[window0]]

type = Window

[[child1]]

type = Terminal

parent = window0

Window objects may not have a parent attribute. Every other object must specify a parent. This is how the structure of the window is determined.

## plugins
Terminator plugins can add their own configuration to the config file, and will appear as a sub-section. Please refer to the documentation of individual plugins for more information.

## SEE ALSO
terminator(1), http://www.voidspace.org.uk/python/configobj.html


package: terminfo

title: scr_dump(5)

summary: format of curses screen-dumps.

text:
# scr_dump(5)

## NAME
scr_dump - format of curses screen-dumps.

## SYNOPSIS
scr_dump

## DESCRIPTION
The curses library provides applications with the ability to write the contents of a window to an external file using scr_dump or putwin, and read it back using scr_restore or getwin.

The putwin and getwin functions do the work; while scr_dump and scr_restore conveniently save and restore the whole screen, i.e., stdscr.

### ncurses6
A longstanding implementation of screen-dump was revised with ncurses6 to remedy problems with the earlier approach:

•

A “magic number” is written to the beginning of the dump file, allowing applications (such as file(1)) to recognize curses dump files.

Because ncurses6 uses a new format, that requires a new magic number was unused by other applications. This 16-bit number was unused:

```
0x8888 (octal “\210\210”)
```

but to be more certain, this 32-bit number was chosen:

```
0x88888888 (octal “\210\210\210\210”)
```

This is the pattern submitted to the maintainers of the file program:

```
#
# ncurses5 (and before) did not use a magic number,
# making screen dumps "data".
#
# ncurses6 (2015) uses this format, ignoring byte-order
0    string    \210\210\210\210ncurses    ncurses6 screen image
#
```

•

The screen dumps are written in textual form, so that internal data sizes are not directly related to the dump-format, and enabling the library to read dumps from either narrow- or wide-character- configurations.

The narrow library configuration holds characters and video attributes in a 32-bit chtype, while the wide-character library stores this information in the cchar_t structure, which is much larger than 32-bits.

- It is possible to read a screen dump into a terminal with a different screen-size, because the library truncates or fills the screen as necessary.

- The ncurses6 getwin reads the legacy screen dumps from ncurses5.

### ncurses5 (legacy)
The screen-dump feature was added to ncurses in June 1995. While there were fixes and improvements in succeeding years, the basic scheme was unchanged:

- The WINDOW structure was written in binary form.

- The WINDOW structure refers to lines of data, which were written as an array of binary data following the WINDOW.

- When getwin restored the window, it would keep track of offsets into the array of line-data and adjust the WINDOW structure which was read back into memory.

This is similar to Unix SystemV, but does not write a “magic number” to identify the file format.

## PORTABILITY
There is no standard format for putwin. This section gives a brief description of the existing formats.

### X/Open Curses
Refer to X/Open Curses, Issue 7 (2009).

X/Open's documentation for enhanced curses says only:

The getwin( ) function reads window-related data stored in the file by putwin( ). The function then creates and initializes a new window using that data.

The putwin( ) function writes all data associated with win into the stdio(3) stream to which filep points, using an unspecified format. This information can be retrieved later using getwin( ).

In the mid-1990s when the X/Open Curses document was written, there were still systems using older, less capable curses libraries (aside from the BSD curses library which was not relevant to X/Open because it did not meet the criteria for base curses). The document explained the term “enhanced” as follows:

•

Shading is used to identify X/Open Enhanced Curses material, relating to interfaces included to provide enhanced capabilities for applications originally written to be compiled on systems based on the UNIX operating system. Therefore, the features described may not be present on systems that conform to XPG4 or to earlier XPG releases. The relevant reference pages may provide additional or more specific portability warnings about use of the material.

In the foregoing, emphasis was added to unspecified format and to XPG4 or to earlier XPG releases, for clarity.

### Unix SystemV
Unix SystemV curses identified the file format by writing a “magic number” at the beginning of the dump. The WINDOW data and the lines of text follow, all in binary form.

The Solaris curses source has these definitions:

```
/* terminfo magic number */
#define MAGNUM  0432
/* curses screen dump magic number */
#define SVR2_DUMP_MAGIC_NUMBER  0433
#define SVR3_DUMP_MAGIC_NUMBER  0434
```

That is, the feature was likely introduced in SVr2 (1984), and improved in SVr3 (1987). The Solaris curses source has no magic number for SVr4 (1989). Other operating systems (AIX and HPUX) use a magic number which would correspond to this definition:

```
/* curses screen dump magic number */
#define SVR4_DUMP_MAGIC_NUMBER  0435
```

That octal number in bytes is 001, 035. Because most Unix vendors use big-endian hardware, the magic number is written with the high-order byte first, e.g.,

```
 01 35
```

After the magic number, the WINDOW structure and line-data are written in binary format. While the magic number used by the Unix systems can be seen using od(1), none of the Unix systems documents the format used for screen-dumps.

The Unix systems do not use identical formats. While collecting information for for this manual page, the savescreen test-program produced dumps of different size (all on 64-bit hardware, on 40x80 screens):

- AIX (51817 bytes)

- HPUX (90093 bytes)

- Solaris 10 (13273 bytes)

- ncurses5 (12888 bytes)

### Solaris
As noted above, Solaris curses has no magic number corresponding to SVr4 curses. This is odd since Solaris was the first operating system to pass the SVr4 guidelines. Solaris has two versions of curses:

- The default curses library uses the SVr3 magic number.

- There is an alternate curses library in /usr/xpg4. This uses a textual format with no magic number.

According to the copyright notice, the xpg4 Solaris curses library was developed by MKS (Mortice Kern Systems) from 1990 to 1995.

Like ncurses6, there is a file-header with parameters. Unlike ncurses6, the contents of the window are written piecemeal, with coordinates and attributes for each chunk of text rather than writing the whole window from top to bottom.

### PDCurses
PDCurses added support for screen dumps in version 2.7 (2005). Like Unix SystemV and ncurses5, it writes the WINDOW structure in binary, but begins the file with its three-byte identifier “PDC”, followed by a one-byte version, e.g.,

```
	“PDC\001”
```

### NetBSD
As of April 2017, NetBSD curses does not support scr_dump and scr_restore (or scr_init, scr_set), although it has putwin and getwin.

Like ncurses5, NetBSD putwin does not identify its dumps with a useful magic number. It writes

- the curses shared library major and minor versions as the first two bytes (e.g., 7 and 1),

- followed by a binary dump of the WINDOW,

- some data for wide-characters referenced by the WINDOW structure, and

- finally, lines as done by other implementations.

## EXAMPLE
Given a simple program which writes text to the screen (and for the sake of example, limiting the screen-size to 10x20):

```
#include <curses.h>
int
main(void)
{

    putenv("LINES=10");

    putenv("COLUMNS=20");

    initscr();

    start_color();

    init_pair(1, COLOR_WHITE, COLOR_BLUE);

    init_pair(2, COLOR_RED, COLOR_BLACK);

    bkgd(COLOR_PAIR(1));

    move(4, 5);

    attron(A_BOLD);

    addstr("Hello");

    move(5, 5);

    attroff(A_BOLD);

    attrset(A_REVERSE | COLOR_PAIR(2));

    addstr("World!");

    refresh();

    scr_dump("foo.out");

    endwin();

    return 0;
}
```

When run using ncurses6, the output looks like this:

```
\210\210\210\210ncurses 6.0.20170415
_cury=5
_curx=11
_maxy=9
_maxx=19
_flags=14
_attrs=\{REVERSE|C2}
flag=_idcok
_delay=-1
_regbottom=9
_bkgrnd=\{NORMAL|C1}\s
rows:
1:\{NORMAL|C1}\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s
2:\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s
3:\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s
4:\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s
5:\s\s\s\s\s\{BOLD}Hello\{NORMAL}\s\s\s\s\s\s\s\s\s\s
6:\s\s\s\s\s\{REVERSE|C2}World!\{NORMAL|C1}\s\s\s\s\s\s\s\s\s
7:\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s
8:\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s
9:\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s
10:\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s
```

The first four octal escapes are actually nonprinting characters, while the remainder of the file is printable text. You may notice:

- The actual color pair values are not written to the file.

- All characters are shown in printable form; spaces are “\s” to ensure they are not overlooked.

- Attributes are written in escaped curly braces, e.g., “\{BOLD}”, and may include a color-pair (C1 or C2 in this example).

- The parameters in the header are written out only if they are nonzero. When reading back, order does not matter.

Running the same program with Solaris xpg4 curses gives this dump:

```
MAX=10,20
BEG=0,0
SCROLL=0,10
VMIN=1
VTIME=0
FLAGS=0x1000
FG=0,0
BG=0,0,
0,0,0,1,
0,19,0,0,
1,0,0,1,
1,19,0,0,
2,0,0,1,
2,19,0,0,
3,0,0,1,
3,19,0,0,
4,0,0,1,
4,5,0x20,0,Hello
4,10,0,1,
4,19,0,0,
5,0,0,1,
5,5,0x4,2,World!
5,11,0,1,
5,19,0,0,
6,0,0,1,
6,19,0,0,
7,0,0,1,
7,19,0,0,
8,0,0,1,
8,19,0,0,
9,0,0,1,
9,19,0,0,
CUR=11,5
```

Solaris getwin requires that all parameters are present, and in the same order. The xpg4 curses library does not know about the bce (back color erase) capability, and does not color the window background.

On the other hand, the SVr4 curses library does know about the background color. However, its screen dumps are in binary. Here is the corresponding dump (using “od -t x1”):

```
0000000 1c 01 c3 d6 f3 58 05 00 0b 00 0a 00 14 00 00 00
0000020 00 00 02 00 00 00 00 00 00 00 00 00 00 00 00 00
0000040 00 00 b8 1a 06 08 cc 1a 06 08 00 00 09 00 10 00
0000060 00 00 00 80 00 00 20 00 00 00 ff ff ff ff 00 00
0000100 ff ff ff ff 00 00 00 00 20 80 00 00 20 80 00 00
0000120 20 80 00 00 20 80 00 00 20 80 00 00 20 80 00 00
*
0000620 20 80 00 00 20 80 00 00 20 80 00 00 48 80 00 04
0000640 65 80 00 04 6c 80 00 04 6c 80 00 04 6f 80 00 04
0000660 20 80 00 00 20 80 00 00 20 80 00 00 20 80 00 00
*
0000740 20 80 00 00 20 80 00 00 20 80 00 00 57 00 81 00
0000760 6f 00 81 00 72 00 81 00 6c 00 81 00 64 00 81 00
0001000 21 00 81 00 20 80 00 00 20 80 00 00 20 80 00 00
0001020 20 80 00 00 20 80 00 00 20 80 00 00 20 80 00 00
*
0001540 20 80 00 00 20 80 00 00 00 00 f6 d1 01 00 f6 d1
0001560 08 00 00 00 40 00 00 00 00 00 00 00 00 00 00 07
0001600 00 04 00 01 00 01 00 00 00 01 00 00 00 00 00 00
0001620 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
*
0002371
```

## SEE ALSO
curs_scr_dump(3X), curs_util(3X).

## AUTHORS
Thomas E. Dickey

extended screen-dump format for ncurses 6.0 (2015)

Eric S. Raymond

screen dump feature in ncurses 1.9.2d (1995)


term

title: term(5)

summary: format of compiled term file.

text:
# term(5)

## NAME
term - format of compiled term file.

## SYNOPSIS
term

## DESCRIPTION

### STORAGE LOCATION
Compiled terminfo descriptions are placed under the directory /usr/share/terminfo. Two configurations are supported (when building the ncurses libraries):

directory tree

A two-level scheme is used to avoid a linear search of a huge UNIX system directory: /usr/share/terminfo/c/name where name is the name of the terminal, and c is the first character of name. Thus, act4 can be found in the file /usr/share/terminfo/a/act4. Synonyms for the same terminal are implemented by multiple links to the same compiled file.

hashed database

Using Berkeley database, two types of records are stored: the terminfo data in the same format as stored in a directory tree with the terminfo's primary name as a key, and records containing only aliases pointing to the primary name.

If built to write hashed databases, ncurses can still read terminfo databases organized as a directory tree, but cannot write entries into the directory tree. It can write (or rewrite) entries in the hashed database.

ncurses distinguishes the two cases in the TERMINFO and TERMINFO_DIRS environment variable by assuming a directory tree for entries that correspond to an existing directory, and hashed database otherwise.

### LEGACY STORAGE FORMAT
The format has been chosen so that it will be the same on all hardware. An 8 or more bit byte is assumed, but no assumptions about byte ordering or sign extension are made.

The compiled file is created with the tic program, and read by the routine setupterm(3X). The file is divided into six parts:

a) header,

b) terminal names,

c) boolean flags,

d) numbers,

e) strings, and

f) string table.

The header section begins the file. This section contains six short integers in the format described below. These integers are

(1) the magic number (octal 0432);

(2) the size, in bytes, of the terminal names section;

(3) the number of bytes in the boolean flags section;

(4) the number of short integers in the numbers section;

(5) the number of offsets (short integers) in the strings section;

(6) the size, in bytes, of the string table.

The capabilities in the boolean flags, numbers, and strings sections are in the same order as the file <term.h>.

Short integers are signed, in the range -32768 to 32767. They are stored as two 8-bit bytes. The first byte contains the least significant 8 bits of the value, and the second byte contains the most significant 8 bits. (Thus, the value represented is 256*second+first.) This format corresponds to the hardware of the VAX and PDP-11 (that is, little-endian machines). Machines where this does not correspond to the hardware must read the integers as two bytes and compute the little-endian value.

Numbers in a terminal description, whether they are entries in the numbers or strings table, are positive integers. Boolean flags are treated as positive one-byte integers. In each case, those positive integers represent a terminal capability. The terminal compiler tic uses negative integers to handle the cases where a capability is not available:

•

If a capability is absent from this terminal, tic stores a -1 in the corresponding table.

The integer value -1 is represented by two bytes 0377, 0377.

Absent boolean values are represented by the byte 0 (false).

•

If a capability has been canceled from this terminal, tic stores a -2 in the corresponding table.

The integer value -2 is represented by two bytes 0377, 0376.

The boolean value -2 is represented by the byte 0376.

•

Other negative values are illegal.

The terminal names section comes after the header. It contains the first line of the terminfo description, listing the various names for the terminal, separated by the “|” character. The terminal names section is terminated with an ASCII NUL character.

The boolean flags section has one byte for each flag. Boolean capabilities are either 1 or 0 (true or false) according to whether the terminal supports the given capability or not.

Between the boolean flags section and the number section, a null byte will be inserted, if necessary, to ensure that the number section begins on an even byte This is a relic of the PDP-11's word-addressed architecture, originally designed to avoid traps induced by addressing a word on an odd byte boundary. All short integers are aligned on a short word boundary.

The numbers section is similar to the boolean flags section. Each capability takes up two bytes, and is stored as a little-endian short integer.

The strings section is also similar. Each capability is stored as a short integer. The capability value is an index into the string table.

The string table is the last section. It contains all of the values of string capabilities referenced in the strings section. Each string is null-terminated. Special characters in ^X or \c notation are stored in their interpreted form, not the printing representation. Padding information $<nn> and parameter information %x are stored intact in uninterpreted form.

### EXTENDED STORAGE FORMAT
The previous section describes the conventional terminfo binary format. With some minor variations of the offsets (see PORTABILITY), the same binary format is used in all modern UNIX systems. Each system uses a predefined set of boolean, number or string capabilities.

The ncurses libraries and applications support extended terminfo binary format, allowing users to define capabilities which are loaded at runtime. This extension is made possible by using the fact that the other implementations stop reading the terminfo data when they have reached the end of the size given in the header. ncurses checks the size, and if it exceeds that due to the predefined data, continues to parse according to its own scheme.

First, it reads the extended header (5 short integers):

(1)

count of extended boolean capabilities

(2)

count of extended numeric capabilities

(3)

count of extended string capabilities

(4)

count of the items in extended string table

(5)

size of the extended string table in bytes

The count- and size-values for the extended string table include the extended capability names as well as extended capability values.

Using the counts and sizes, ncurses allocates arrays and reads data for the extended capabilities in the same order as the header information.

The extended string table contains values for string capabilities. After the end of these values, it contains the names for each of the extended capabilities in order, e.g., booleans, then numbers and finally strings.

Applications which manipulate terminal data can use the definitions described in term_variables(3X) which associate the long capability names with members of a TERMTYPE structure.

### EXTENDED NUMBER FORMAT
On occasion, 16-bit signed integers are not large enough. With ncurses 6.1, a new format was introduced by making a few changes to the legacy format:

- a different magic number (octal 01036)

- changing the type for the number array from signed 16-bit integers to signed 32-bit integers.

To maintain compatibility, the library presents the same data structures to direct users of the TERMTYPE structure as in previous formats. However, that cannot provide callers with the extended numbers. The library uses a similar but hidden data structure TERMTYPE2 to provide data for the terminfo functions.

## PORTABILITY

### setupterm
Note that it is possible for setupterm to expect a different set of capabilities than are actually present in the file. Either the database may have been updated since setupterm was recompiled (resulting in extra unrecognized entries in the file) or the program may have been recompiled more recently than the database was updated (resulting in missing entries). The routine setupterm must be prepared for both possibilities - this is why the numbers and sizes are included. Also, new capabilities must always be added at the end of the lists of boolean, number, and string capabilities.

### Binary format
X/Open Curses does not specify a format for the terminfo database. UNIX System V curses used a directory-tree of binary files, one per terminal description.

Despite the consistent use of little-endian for numbers and the otherwise self-describing format, it is not wise to count on portability of binary terminfo entries between commercial UNIX versions. The problem is that there are at least three versions of terminfo (under HP-UX, AIX, and OSF/1) which diverged from System V terminfo after SVr1, and have added extension capabilities to the string table that (in the binary format) collide with System V and XSI Curses extensions. See terminfo(5) for detailed discussion of terminfo source compatibility issues.

This implementation is by default compatible with the binary terminfo format used by Solaris curses, except in a few less-used details where it was found that the latter did not match X/Open Curses. The format used by the other Unix versions can be matched by building ncurses with different configuration options.

### Magic codes
The magic number in a binary terminfo file is the first 16-bits (two bytes). Besides making it more reliable for the library to check that a file is terminfo, utilities such as file(1) also use that to tell what the file-format is. System V defined more than one magic number, with 0433, 0435 as screen-dumps (see scr_dump(5)). This implementation uses 01036 as a continuation of that sequence, but with a different high-order byte to avoid confusion.

### The TERMTYPE structure
Direct access to the TERMTYPE structure is provided for legacy applications. Portable applications should use the tigetflag and related functions described in curs_terminfo(3X) for reading terminal capabilities.

### Mixed-case terminal names
A small number of terminal descriptions use uppercase characters in their names. If the underlying filesystem ignores the difference between uppercase and lowercase, ncurses represents the “first character” of the terminal name used as the intermediate level of a directory tree in (two-character) hexadecimal form.

## EXAMPLE
As an example, here is a description for the Lear-Siegler ADM-3, a popular though rather stupid early terminal:

```
adm3a|lsi adm3a,

        am,

        cols#80, lines#24,

        bel=^G, clear= 32$<1>, cr=^M, cub1=^H, cud1=^J,

        cuf1=^L, cup=\E=%p1%{32}%+%c%p2%{32}%+%c, cuu1=^K,

        home=^^, ind=^J,
```

```
and a hexadecimal dump of the compiled terminal description:

0000  1a 01 10 00 02 00 03 00  82 00 31 00 61 64 6d 33  ........ ..1.adm3
0010  61 7c 6c 73 69 20 61 64  6d 33 61 00 00 01 50 00  a|lsi ad m3a...P.
0020  ff ff 18 00 ff ff 00 00  02 00 ff ff ff ff 04 00  ........ ........
0030  ff ff ff ff ff ff ff ff  0a 00 25 00 27 00 ff ff  ........ ..%.'...
0040  29 00 ff ff ff ff 2b 00  ff ff 2d 00 ff ff ff ff  ).....+. ..-.....
0050  ff ff ff ff ff ff ff ff  ff ff ff ff ff ff ff ff  ........ ........
0060  ff ff ff ff ff ff ff ff  ff ff ff ff ff ff ff ff  ........ ........
0070  ff ff ff ff ff ff ff ff  ff ff ff ff ff ff ff ff  ........ ........
0080  ff ff ff ff ff ff ff ff  ff ff ff ff ff ff ff ff  ........ ........
0090  ff ff ff ff ff ff ff ff  ff ff ff ff ff ff ff ff  ........ ........
00a0  ff ff ff ff ff ff ff ff  ff ff ff ff ff ff ff ff  ........ ........
00b0  ff ff ff ff ff ff ff ff  ff ff ff ff ff ff ff ff  ........ ........
00c0  ff ff ff ff ff ff ff ff  ff ff ff ff ff ff ff ff  ........ ........
00d0  ff ff ff ff ff ff ff ff  ff ff ff ff ff ff ff ff  ........ ........
00e0  ff ff ff ff ff ff ff ff  ff ff ff ff ff ff ff ff  ........ ........
00f0  ff ff ff ff ff ff ff ff  ff ff ff ff ff ff ff ff  ........ ........
0100  ff ff ff ff ff ff ff ff  ff ff ff ff ff ff ff ff  ........ ........
0110  ff ff ff ff ff ff ff ff  ff ff ff ff ff ff ff ff  ........ ........
0120  ff ff ff ff ff ff 2f 00  07 00 0d 00 1a 24 3c 31  ....../. .....$<1
0130  3e 00 1b 3d 25 70 31 25  7b 33 32 7d 25 2b 25 63  >..=%p1% {32}%+%c
0140  25 70 32 25 7b 33 32 7d  25 2b 25 63 00 0a 00 1e  %p2%{32} %+%c....
0150  00 08 00 0c 00 0b 00 0a  00                       ........ .
```

## LIMITS
Some limitations:

- total compiled entries cannot exceed 4096 bytes in the legacy format.

- total compiled entries cannot exceed 32768 bytes in the extended format.

- the name field cannot exceed 128 bytes.

Compiled entries are limited to 32768 bytes because offsets into the strings table use two-byte integers. The legacy format could have supported 32768-byte entries, but was limited a virtual memory page's 4096 bytes.

## FILES
/usr/share/terminfo/*/* compiled terminal capability database

## SEE ALSO
curses(3X), terminfo(5).

## AUTHORS
Thomas E. Dickey

extended terminfo format for ncurses 5.0

hashed database support for ncurses 5.6

extended number support for ncurses 6.1

Eric S. Raymond

documented legacy terminfo format, e.g., from pcurses.