1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
|
.TH taskd 1 2015-05-10 "${PACKAGE_STRING}" "User Manuals"
.SH NAME
taskd \- Taskserver
.SH SYNOPSIS
.B taskd <command> [options] [<args>]
.br
.B taskd -v|--version
.br
.B taskd -h|--help
.br
.B taskd diagnostics
.br
.B taskd validate <JSON | file>
.br
.B taskd help [<command>]
.SH DESCRIPTION
Taskserver is a sync server for Taskwarrior and related products.
.SH COMMANDS
Taskserver supports several commands, which provide administrative capabilities.
The commands are:
.TP
.B taskd init [--data <root>] [options]
Performs a one-time initialization of the Taskserver instance. Creates the
bare data structure.
Either '\-\-data <root>' must be specified, or TASKDDATA must be set.
.TP
.B taskd help <command> [options]
Provides option and syntax help for each command.
.TP
.B taskd config [options] [--data <root>] [--force] [<name> [<value>]]
Allows modification of the taskd configuration. Can add, remove, modify or list
all configuration settings.
Either '\-\-data <root>' must be specified, or TASKDDATA must be set.
.TP
.B taskd server [--daemon] [options]
Starts the server in daemon or TTY mode. While there is no interactivity, the
difference is whether taskd is attached to a TTY or not.
Note that sending the HUP signal to the taskd server causes a configuration
file reload before the next request is handled.
.TP
.B taskd add [--data <root>] org <org>
.TP
.B taskd add [--data <root>] group <org> <group>
.TP
.B taskd add [--data <root>] user <org> <user>
Adds organizations, groups and users.
Either '\-\-data <root>' must be specified, or TASKDDATA must be set.
.TP
.B taskd remove [--data <root>] org <org>
.TP
.B taskd remove [--data <root>] group <org> <group>
.TP
.B taskd remove [--data <root>] user <org> <user>
Removes organizations, groups and users.
Either '\-\-data <root>' must be specified, or TASKDDATA must be set.
.TP
.B taskd suspend [--data <root>] org <org>
.TP
.B taskd suspend [--data <root>] group <org> <group>
.TP
.B taskd suspend [--data <root>] user <org> <user>
Suspends organizations, groups and users.
Either '\-\-data <root>' must be specified, or TASKDDATA must be set.
.TP
.B taskd resume [--data <root>] org <org>
.TP
.B taskd resume [--data <root>] group <org> <group>
.TP
.B taskd resume [--data <root>] user <org> <user>
Resumes organizations, groups and users.
Either '\-\-data <root>' must be specified, or TASKDDATA must be set.
.TP
.B taskd diagnostics
Displays diagnostic information important when reporting bugs.
.TP
.B taskd validate <JSON | file>
Parses the quoted JSON string or JSON file. Useful for debugging JSON that is
generated by Taskserver clients.
.TP
.B taskd client [options] <host:port> <file> [<file> ...]
Sends the Taskserver request in <file> to <host:port>. Options specified must
include ca.cert (for self-signed certs), client.cert, client.key.
.SH COMMON OPTIONS
Most commands support the following options:
.TP
.B --NAME=VALUE
Temporary configuration override.
.TP
.B --force
Does not ask for confirmation of changes.
.TP
.B --quiet
Suppresses verbose output.
.TP
.B --debug
Shows debugging information.
.TP
.B --data <root>
Many commands require the location of the data root, so either it must be
provided as shown, or via the TASKDDATA environment variable.
.SH CONFIGURATION
The Taskserver configuration file can be found in the top level of the data
root. It is recommended that the 'taskd config' command is used to manipulate
this file.
Note that any configuration variable may be overridden on the command line using
this syntax:
$ taskd server \-\-NAME=VALUE
In all commands but one, this will _temporarily_ override the value, but with
the 'init' command, which creates a config file, overrides are made permanent.
.SH ENVIRONMENT VARIABLES
Environment variables provide values that would otherwise be required at the
command line.
.TP
.B TASKDDATA=<root>
Most command require either '\-\-data <root>' or this environment variable. If
both are provided, the command line overrides the environment.
.SH "CREDITS & COPYRIGHTS"
Copyright (C) 2010 \- 2015, Göteborg Bit Factory.
Taskserver is distributed under the MIT license. See
http://www.opensource.org/licenses/mit-license.php for more information.
.SH SEE ALSO
.BR taskdrc(5), taskdctl(1)
For more information regarding Taskserver, see the following:
.TP
The official site at
<http://taskwarrior.org>
.TP
The official code repository at
<https://git.tasktools.org/scm/tm/taskd.git>
.TP
You can contact the project by emailing
<support@taskwarrior.org>
.SH REPORTING BUGS
.TP
Bugs in Taskserver may be reported to the issue-tracker at
<http://taskwarrior.org
|
