Documentation Update

- Fixed formatting problem in taskrc.5, where the indentation was
  not consistent.
This commit is contained in:
Paul Beckingham 2010-06-27 15:40:59 -04:00
parent 12cdee9809
commit 688233b3a4

View file

@ -472,6 +472,7 @@ use dashes (-----) to underline column headings.
.B fontunderline=on .B fontunderline=on
Determines if font underlines or ASCII dashes should be used to underline Determines if font underlines or ASCII dashes should be used to underline
headers, even when color is enabled. headers, even when color is enabled.
.RE
Task has a number of coloration rules. They correspond to a particular Task 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 attribute of a task, such as it being due, or being active, and specifies the
@ -486,7 +487,6 @@ terminal, can be obtained by running the command:
The coloration rules and their defaults are: The coloration rules and their defaults are:
.RE .RE
.RS
.RS .RS
.B color.overdue=bold red .B color.overdue=bold red
The color for overdue tasks. The color for overdue tasks.
@ -528,82 +528,91 @@ nothing, for example:
.RE .RE
.RE .RE
.RS
See the task-color(5) man pages for color details. See the task-color(5) man pages for color details.
.RE .RE
.RS
Certain attributes like tags, projects and keywords can have their own Certain attributes like tags, projects and keywords can have their own
coloration rules. coloration rules.
.RE .RE
.RS
.TP .TP
.B color.tag.X=yellow .B color.tag.X=yellow
Colors any task that has the tag X. Colors any task that has the tag X.
.RE
.TP .TP
.B color.project.X=on green .B color.project.X=on green
Colors any task assigned to project X. Colors any task assigned to project X.
.RE
.TP .TP
.B color.keyword.X=on blue .B color.keyword.X=on blue
Colors any task where the description or any annotation contains X. Colors any task where the description or any annotation contains X.
.RE
.TP .TP
.B color.header=green .B color.header=green
Colors any of the messages printed prior to the report output. Colors any of the messages printed prior to the report output.
.RE
.TP .TP
.B color.footnote=green .B color.footnote=green
Colors any of the messages printed last. Colors any of the messages printed last.
.RE
.TP .TP
.B color.summary.bar=on green .B color.summary.bar=on green
Colors the summary progress bar. Should include both a foreground and a Colors the summary progress bar. Should include both a foreground and a
background color. background color.
.RE
.TP .TP
.B color.summary.background=on black .B color.summary.background=on black
Colors the summary progress bar. Should include at least a background color. Colors the summary progress bar. Should include at least a background color.
.RE
.TP .TP
.B color.calendar.today=black on cyan .B color.calendar.today=black on cyan
Color of today in calendar. Color of today in calendar.
.RE
.TP .TP
.B color.calendar.due=black on green .B color.calendar.due=black on green
Color of days with due tasks in calendar. Color of days with due tasks in calendar.
.RE
.TP .TP
.B color.calendar.due.today=black on magenta .B color.calendar.due.today=black on magenta
Color of today with due tasks in calendar. Color of today with due tasks in calendar.
.RE
.TP .TP
.B color.calendar.overdue=black on red .B color.calendar.overdue=black on red
Color of days with overdue tasks in calendar. Color of days with overdue tasks in calendar.
.RE
.TP .TP
.B color.calendar.weekend=bright white on black .B color.calendar.weekend=bright white on black
Color of weekend days in calendar. Color of weekend days in calendar.
.RE
.TP .TP
.B color.calendar.holiday=black on bright yellow .B color.calendar.holiday=black on bright yellow
Color of holidays in calendar. Color of holidays in calendar.
.RE
.TP .TP
.B color.calendar.weeknumber=black on white .B color.calendar.weeknumber=black on white
Color of weeknumbers in calendar. Color of weeknumbers in calendar.
.RE .RE
.RS
It is possible 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.
.TP .TP
.B color.alternate=on rgb253 .B color.alternate=on rgb253
Color of alternate tasks. 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.
.RE .RE
.SS SHADOW FILE .SS SHADOW FILE