Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion content/docs/man/task-color.5.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: 'Taskwarrior - task-color.5 for task-3.4.2'
title: 'Taskwarrior - task-color.5 for task-3.5.0'
viewport: 'width=device-width, initial-scale=1'
layout: single
---
Expand Down
36 changes: 34 additions & 2 deletions content/docs/man/task-sync.5.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: 'Taskwarrior - task-sync.5 for task-3.4.2'
title: 'Taskwarrior - task-sync.5 for task-3.5.0'
viewport: 'width=device-width, initial-scale=1'
layout: single
---
Expand Down Expand Up @@ -46,7 +46,7 @@ Taskwarrior provides several options for synchronizing your tasks:

\- To a server specifically designed to handle Taskwarrior data. + To a
cloud storage provider. Currently both AWS and GCP are supported. - To a
local, on-disk file.
local, on-disk file. - Via a git repository (local or remote).

For most of these, you will need an encryption secret used to encrypt
and decrypt your tasks. This can be any secret string, and must match
Expand Down Expand Up @@ -209,6 +209,38 @@ tasks locally. To configure local sync:
The default configuration is to sync to a database in the task directory
("data.location").

## Git Synchronization

To synchronize your tasks using a git repository, configure the path to
a local git repository and the branch to use:

$ task config sync.git.local_path /path/to/local/repo
$ task config sync.git.branch taskchampion
$ task config sync.encryption_secret <encryption_secret>

The repository will be created if it does not exist. It is recommended
to use a dedicated branch.

For remote sync (push and pull), also configure a remote:

$ task config sync.git.remote origin

The remote can be a named remote such as "origin" or a full git URL such
as "git@myserver.com:/path/to/repo.git". Authentication is handled
entirely by the git credential system; for remote sync, "git push" and
"git pull" must work without prompts (use SSH keys or a credential
helper).

It is possible to operate offline while keeping the remote configured.
WANRING: If another replica also syncs with the remote, you will not be
able to go back to syncing from this replica.

$ task config sync.git.local_only true

If a non-standard git binary is needed, its path can be specified:

$ task config sync.git.git_path /path/to/git

# RUNNING TASKCHAMPION-SYNC-SERVER

The TaskChampion sync server is an HTTP server supporting multiple
Expand Down
65 changes: 19 additions & 46 deletions content/docs/man/task.1.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: 'Taskwarrior - task.1 for task-3.4.2'
title: 'Taskwarrior - task.1 for task-3.5.0'
viewport: 'width=device-width, initial-scale=1'
layout: single
---
Expand All @@ -11,6 +11,7 @@ task - A command line todo manager.

**task &lt;filter&gt; &lt;command&gt; \[ &lt;mods&gt; | &lt;args&gt;
\]**
**task --help**
**task --version**

# DESCRIPTION
Expand Down Expand Up @@ -120,11 +121,14 @@ predefined in Taskwarrior. The output and sort behavior of these reports
can be configured in the configuration file. See also the man page
taskrc(5). There are also other read subcommands that are not reports.

**task --help**
Displays the same usage and command documentation as the 'task help'
command.

**task --version**
This is the only conventional command line argument that Taskwarrior
supports, and is intended for add-on scripts to verify the version
number of an installed Taskwarrior without invoking the mechanisms that
create default files.
This command line argument is intended for add-on scripts to verify the
version number of an installed Taskwarrior without invoking the
mechanisms that create default files.

**task &lt;filter&gt;**
With no command specified, the default command is run, and the filter
Expand Down Expand Up @@ -154,6 +158,9 @@ alias to the 'burndown.weekly' report. Is affected by the context.
**task &lt;filter&gt; burndown.monthly**
Shows a graphical burndown chart, by month. Is affected by the context.

**task &lt;filter&gt; burndown.annual**
Shows a graphical burndown chart, by year. Is affected by the context.

**task calendar \[due|&lt;month&gt; &lt;year&gt;|&lt;year&gt;\] \[y\]**
Shows a monthly calendar with due tasks marked. Shows one horizontal
line of months. If the 'y' argument is provided, will show at least one
Expand Down Expand Up @@ -188,8 +195,6 @@ you wish to save it, or pipe it to another command or script to convert
it to another format. You'll find these example scripts online at
&lt;https://taskwarrior.org/tools/&gt;:

<!-- -->

export-csv.pl
export-sql.py
export-xml.py
Expand Down Expand Up @@ -235,8 +240,6 @@ Applies the filter then extracts only the task IDs and presents them as
a space-separated list. This is useful as input to a task command, to
achieve this:

<!-- -->

task $(task project:Home ids) modify priority:H

This example first gets the IDs for the project:Home filter, then sets
Expand All @@ -252,8 +255,6 @@ Applies the filter on all tasks (even deleted and completed tasks) then
extracts only the task UUIDs and presents them as a space-separated
list. This is useful as input to a task command, to achieve this:

<!-- -->

task $(task project:Home status:completed uuids) modify status:pending

This example first gets the UUIDs for the project:Home and
Expand Down Expand Up @@ -421,8 +422,6 @@ configuration. This command either modifies the 'name' setting with a
new value of 'value', or adds a new entry that is equivalent to
'name=value':

<!-- -->

task config name value

This command sets a blank value. This has the effect of suppressing any
Expand Down Expand Up @@ -571,8 +570,6 @@ for use by third-party applications.
Reports a unique set of attribute values. For example, to see all the
active projects:

<!-- -->

task +PENDING _unique project

**task &lt;filter&gt; \_uuids**
Expand Down Expand Up @@ -610,8 +607,6 @@ Shows the UUIDs and descriptions of matching tasks.
Accesses and displays the DOM reference(s). Used to extract individual
values from tasks, or the system. Supported DOM references are:

<!-- -->

rc.<name>
tw.syncneeded
tw.program
Expand Down Expand Up @@ -654,13 +649,18 @@ run. When modifying tasks, it is safe to rely on the last displayed ID.
Always run a report to check you have the right ID for a task. IDs can
be given to task as a sequence, for example:

<!-- -->

task 1,4-10,19 delete

**+tag|-tag**
Tags are arbitrary words associated with a task. Use + to add a tag
and - to remove a tag from a task. A task can have any quantity of tags.
Tags cannot contain whitespace, and cannot start with any of the special
characters:

see also taskwarrior:src/Lexer.cpp isSingleCharOperator() see also
taskchampion:src/task/task.rs INVALID\_TAG\_CHARACTERS

+-*/()<>^!%=~

Certain tags (called 'special tags'), can be used to affect the way
tasks are treated. For example, if a task has the special tag 'nocolor',
Expand Down Expand Up @@ -932,39 +932,24 @@ reports. The expected and desired date format is determined by the
configuration variable *dateformat*

> Exact specification
>
> <!-- -->
>
> task ... due:7/14/2008
>
> ISO-8601
>
> <!-- -->
>
> task ... due:2013-03-14T22:30:00Z
>
> Relative wording
>
> <!-- -->
>
> task ... due:now
> task ... due:today
> task ... due:yesterday
> task ... due:tomorrow
>
> Day number with ordinal
>
> <!-- -->
>
> task ... due:23rd
> task ... due:3wks
> task ... due:1day
> task ... due:9hrs
>
> Start of next (work) week (Monday), calendar week (Sunday or Monday), month, quarter and year
>
> <!-- -->
>
> task ... due:sow
> task ... due:soww
> task ... due:socw
Expand All @@ -973,9 +958,6 @@ configuration variable *dateformat*
> task ... due:soy
>
> End of current (work) week (Friday), calendar week (Saturday or Sunday), month, quarter and year
>
> <!-- -->
>
> task ... due:eow
> task ... due:eoww
> task ... due:eocw
Expand All @@ -984,24 +966,15 @@ configuration variable *dateformat*
> task ... due:eoy
>
> At some point or later
>
> <!-- -->
>
> task ... wait:later
> task ... wait:someday
>
> This sets the wait date to 12/30/9999.
>
> Next occurring weekday
>
> <!-- -->
>
> task ... due:fri
>
> Predictable holidays
>
> <!-- -->
>
> task ... due:goodfriday
> task ... due:easter
> task ... due:eastermonday
Expand Down
Loading