Documentation

- Now uses proper name 'Taskserver'.
This commit is contained in:
Paul Beckingham 2013-11-16 16:06:23 -05:00
parent 0df30a5be0
commit 6bc352f713
13 changed files with 57 additions and 57 deletions

View file

@ -20,7 +20,7 @@ Features
+ #1423 sync vs. push, pull, merge collision avoidance.
+ #1385 Need a way to configure the trust of self-signed certificates.
+ Stores un-synched transactions in <data.location>/backlog.data.
+ Adds a new 'synchronize' command to sync data with a task server.
+ Adds a new 'synchronize' command to sync data with a Taskserver.
+ Adds a new 'initialize' synchronize command argument that uploads all pending
tasks for first-time initialization.
+ Adds a new 'sync' verbosity token, which will remind when a backlog builds

View file

@ -90,7 +90,7 @@ Files
'merge' command.
The backlog.data file contains an accumulated set of changes that have not
been transmitted to the task server. It grows unbounded between 'synch'
been transmitted to the Taskserver. It grows unbounded between 'synch'
commands.

16
NEWS
View file

@ -1,7 +1,7 @@
New Features in taskwarrior 2.3.0
- New task server sync capabilities.
- New Taskserver sync capabilities.
- New shell (tasksh) with Readline support replaces old 'task shell' command.
- The 'dateformat' settings now default to the ISO-8601 standard of 'Y-M-D'.
- Italian translation.
@ -15,17 +15,17 @@ New Features in taskwarrior 2.3.0
New commands in taskwarrior 2.3.0
- New 'sync' command to synchronize data with a Task Server.
- New 'sync' command to synchronize data with a Taskserver.
- New 'tasksh' command which replaces the old 'task shell' with an improved
standalone shell, featuring Readline support.
New configuration options in taskwarrior 2.3.0
- 'taskd.server' specifies host:port of the task server.
- 'taskd.credentials' specifies user credentials for the task server.
- 'taskd.certificate' specifies the task server certificate for authentication.
- 'taskd.key' specifies the task server key for encryption.
- 'taskd.ca' specifies the task server CA.
- 'taskd.server' specifies host:port of the Taskserver.
- 'taskd.credentials' specifies user credentials for the Taskserver.
- 'taskd.certificate' specifies the Taskserver certificate for authentication.
- 'taskd.key' specifies the Taskserver key for encryption.
- 'taskd.ca' specifies the Taskserver CA.
- 'taskd.trust' overrides certificate checking.
- 'taskd.ciphers' overrides default cipher selection.
- 'debug.tls' shows TLS log information, for debugging.
@ -35,7 +35,7 @@ Newly deprecated features in taskwarrior 2.3.0
- File format 2 (used in version 0.9.3 - 1.5.0) is no longer supported.
- The 'push', 'pull' and 'merge' commands will be removed in a subsequent
release. The new 'sync' command, in conjunction with the Task Server is the
release. The new 'sync' command, in conjunction with the Taskserver is the
new sync mechanism.
- The 'diagnostics' command no longer generates 1000 UUIDs as a uniqueness
test, because libuuid is now mandatory.

View file

@ -1,7 +1,7 @@
Welcome To Taskwarrior 2.3.0 Beta
---------------------------------
The beta release of Taskwarrior 2.3.0 is for testing the Task Server. There are
The beta release of Taskwarrior 2.3.0 is for testing the Taskserver. There are
several unaddressed bugs in this release, so proper precautions with your data
are required.
@ -19,14 +19,14 @@ You will need the following dependencies:
libreadline
Configuring Taskwarrior as a Task Server Client
-----------------------------------------------
Configuring Taskwarrior as a Taskserver Client
----------------------------------------------
When a new user is added to the Task Server, a UUID key is generated, along with
an x.509 cert. See Task Server operation document. Before proceeding, you will
When a new user is added to the Taskserver, a UUID key is generated, along with
an x.509 cert. See Taskserver operation document. Before proceeding, you will
need the following items:
<server:port> Where Task Server is running (Default: localhost:6544)
<server:port> Where Taskserver is running (Default: localhost:6544)
<org> Name of organization (default: Public)
<user> User name added to server
<password> UUID generated by server

View file

@ -179,7 +179,7 @@ an alias in the .bashrc file along the lines of
.TP
.B Q: I don't want to use dropbox. Is there another way to synchronize my tasks?
Yes. Get a Task Server account, and sync tasks between all your machines and
Yes. Get a Taskserver account, and sync tasks between all your machines and
devices. See task-sync(5).
.TP

View file

@ -16,7 +16,7 @@ There are three alternatives for syncing data, which are:
.br
2) File hosting systems, such as DropBox
.br
3) Using the Task Server and the 'sync' command
3) Using the Taskserver and the 'sync' command
.SH OPTION 1: VERSION CONTROL SYSTEMS
@ -75,15 +75,15 @@ Weaknesses:
- Tasks are not properly merged
.SH OPTION 3: TASK SERVER
The Task Server was designed for this purpose to be secure, fast and conflict
.SH OPTION 3: TASKSERVER
The Taskserver was designed for this purpose to be secure, fast and conflict
free, allowing data interchange between assorted Taskwarrior clients, and
tolerant of network connectivity problems.
There is a 'sync' command built in to Taskwarrior, and with a server account
and client configuration, syncing is done on demand.
Setup is a matter of creating an account on a Task Server (see your Task Server
Setup is a matter of creating an account on a Taskserver (see your Taskserver
provider or operate your own - see
http://taskwarrior.org/projects/taskwarrior/wiki/Server_setup)

View file

@ -1341,41 +1341,41 @@ server.
.TP
.B taskd.server=<host>:<port>
.RS
Specifies the hostname and port of the task server. Hostname may be an IPv4 or
Specifies the hostname and port of the Taskserver. Hostname may be an IPv4 or
IPv6 address, or domain. Port is an integer.
.RE
.TP
.B taskd.credentials=<organization>/<user>/<key>
.RS
User identification for the task server, which includes a private key.
User identification for the Taskserver, which includes a private key.
.RE
.TP
.B taskd.certificate=<path>
.RS
Specifies the path to the client certificate used for identification with the
task server.
Taskserver.
.RE
.TP
.B taskd.key=<path>
.RS
Specifies the path to the client key used for encrypted communication with the
task server.
Taskserver.
.RE
.TP
.B taskd.ca=<path>
.RS
Specifies the path to the CA certificate in the event that your task server is
Specifies the path to the CA certificate in the event that your Taskserver is
using a self-signed certificate. Optional.
.RE
.TP
.B taskd.trust=yes|no
.RS
If you do not specify a CA certificate when your task server is using a self-
If you do not specify a CA certificate when your Taskserver is using a self-
signed certificate, you can override the certificate validation by setting this
value to 'yes'. Default is not to trust a server certificate.
.RE

View file

@ -5,7 +5,7 @@ Calendar trick
Metadata
Sync
sync (needs 2.3.0 & task server)
sync (needs 2.3.0 & Taskserver)
Logo?

View file

@ -297,7 +297,7 @@ std::string Config::_defaults =
"shell.prompt=task> # Prompt used by the shell command\n"
"\n"
"# WARNING: Please read the documentation (man task-sync) before setting up\n"
"# Taskwarrior for Task Server synchronization.\n"
"# Taskwarrior for Taskserver synchronization.\n"
"#taskd.certificate <certificat file>\n"
"#taskd.credentials <organization>/<name>/<password>\n"
"#taskd.server <server>:<port>\n"

View file

@ -403,11 +403,11 @@
#define STRING_CMD_SHELL_HELP1 "Enter any task command (such as 'list'), or hit 'Enter'."
#define STRING_CMD_SHELL_HELP2 "There is no need to include the 'task' command itself."
#define STRING_CMD_SHELL_HELP3 "Enter 'quit' (or 'bye', 'exit') to end the session."
#define STRING_CMD_SYNC_USAGE "Synchronizes data with the Task Server"
#define STRING_CMD_SYNC_NO_SERVER "Task Server is not configured."
#define STRING_CMD_SYNC_BAD_CRED "Task Server credentials malformed."
#define STRING_CMD_SYNC_BAD_CERT "Task Server certificate missing."
#define STRING_CMD_SYNC_BAD_KEY "Task Server key missing."
#define STRING_CMD_SYNC_USAGE "Synchronizes data with the Taskserver"
#define STRING_CMD_SYNC_NO_SERVER "Taskserver is not configured."
#define STRING_CMD_SYNC_BAD_CRED "Taskserver credentials malformed."
#define STRING_CMD_SYNC_BAD_CERT "Taskserver certificate missing."
#define STRING_CMD_SYNC_BAD_KEY "Taskserver key missing."
#define STRING_CMD_SYNC_ADD " add {1} '{2}'"
#define STRING_CMD_SYNC_MOD "modify {1} '{2}'"
#define STRING_CMD_SYNC_PROGRESS "Syncing with {1}"
@ -416,12 +416,12 @@
#define STRING_CMD_SYNC_SUCCESS2 "Sync successful. {1} changes downloaded."
#define STRING_CMD_SYNC_SUCCESS3 "Sync successful. {1} changes uploaded, {2} changes downloaded."
#define STRING_CMD_SYNC_SUCCESS_NOP "Sync successful. No changes."
#define STRING_CMD_SYNC_FAIL_ACCOUNT "Sync failed. Either your credentials are incorrect, or your Task Server account is not enabled."
#define STRING_CMD_SYNC_FAIL_ERROR "Sync failed. The Task Server returned error: {1} {2}"
#define STRING_CMD_SYNC_FAIL_CONNECT "Sync failed. Could not connect to the Task Server."
#define STRING_CMD_SYNC_FAIL_ACCOUNT "Sync failed. Either your credentials are incorrect, or your Taskserver account is not enabled."
#define STRING_CMD_SYNC_FAIL_ERROR "Sync failed. The Taskserver returned error: {1} {2}"
#define STRING_CMD_SYNC_FAIL_CONNECT "Sync failed. Could not connect to the Taskserver."
#define STRING_CMD_SYNC_BAD_SERVER "Sync failed. Malformed configuration setting '{1}'"
#define STRING_CMD_SYNC_NO_TLS "Taskwarrior was built without GnuTLS support. Sync is not available."
#define STRING_CMD_SYNC_INIT "Please confirm that you wish to upload all your pending tasks to the Task Server"
#define STRING_CMD_SYNC_INIT "Please confirm that you wish to upload all your pending tasks to the Taskserver"
#define STRING_CMD_SYNC_NO_INIT "Taskwarrior will not proceed with first-time sync initialization."
#define STRING_CMD_SYNC_RELOCATE0 "The server account has been relocated. Please update your configuration using:"
#define STRING_CMD_SYNC_RELOCATE1 "task config taskd.server {1}"

View file

@ -418,7 +418,7 @@
#define STRING_CMD_SYNC_NO_SERVER "El Servidor Task no está configurado."
#define STRING_CMD_SYNC_BAD_CRED "Credenciales del Servidor Task incorrectas."
#define STRING_CMD_SYNC_BAD_CERT "Certificado del Servidor Task no encontrado."
#define STRING_CMD_SYNC_BAD_KEY "Task Server key missing."
#define STRING_CMD_SYNC_BAD_KEY "Taskserver key missing."
#define STRING_CMD_SYNC_ADD " añade {1} '{2}'"
#define STRING_CMD_SYNC_MOD "modifica {1} '{2}'"
#define STRING_CMD_SYNC_PROGRESS "Sincronizando con {1}"

View file

@ -403,11 +403,11 @@
#define STRING_CMD_SHELL_HELP1 "Enter any task command (such as 'list'), or hit 'Enter'."
#define STRING_CMD_SHELL_HELP2 "There is no need to include the 'task' command itself."
#define STRING_CMD_SHELL_HELP3 "Enter 'quit' (or 'bye', 'exit') to end the session."
#define STRING_CMD_SYNC_USAGE "Synchronizes data with the Task Server"
#define STRING_CMD_SYNC_NO_SERVER "Task Server is not configured."
#define STRING_CMD_SYNC_BAD_CRED "Task Server credentials malformed."
#define STRING_CMD_SYNC_BAD_CERT "Task Server certificate missing."
#define STRING_CMD_SYNC_BAD_KEY "Task Server key missing."
#define STRING_CMD_SYNC_USAGE "Synchronizes data with the Taskserver"
#define STRING_CMD_SYNC_NO_SERVER "Taskserver is not configured."
#define STRING_CMD_SYNC_BAD_CRED "Taskserver credentials malformed."
#define STRING_CMD_SYNC_BAD_CERT "Taskserver certificate missing."
#define STRING_CMD_SYNC_BAD_KEY "Taskserver key missing."
#define STRING_CMD_SYNC_ADD " add {1} '{2}'"
#define STRING_CMD_SYNC_MOD "modify {1} '{2}'"
#define STRING_CMD_SYNC_PROGRESS "Syncing with {1}"
@ -416,12 +416,12 @@
#define STRING_CMD_SYNC_SUCCESS2 "Sync successful. {1} changes downloaded."
#define STRING_CMD_SYNC_SUCCESS3 "Sync successful. {1} changes uploaded, {2} changes downloaded."
#define STRING_CMD_SYNC_SUCCESS_NOP "Sync successful. No changes."
#define STRING_CMD_SYNC_FAIL_ACCOUNT "Sync failed. Either your credentials are incorrect, or your Task Server account is not enabled."
#define STRING_CMD_SYNC_FAIL_ERROR "Sync failed. The Task Server returned error: {1} {2}"
#define STRING_CMD_SYNC_FAIL_CONNECT "Sync failed. Could not connect to the Task Server."
#define STRING_CMD_SYNC_FAIL_ACCOUNT "Sync failed. Either your credentials are incorrect, or your Taskserver account is not enabled."
#define STRING_CMD_SYNC_FAIL_ERROR "Sync failed. The Taskserver returned error: {1} {2}"
#define STRING_CMD_SYNC_FAIL_CONNECT "Sync failed. Could not connect to the Taskserver."
#define STRING_CMD_SYNC_BAD_SERVER "Sync failed. Malformed configuration setting '{1}'"
#define STRING_CMD_SYNC_NO_TLS "Taskwarrior was built without GnuTLS support. Sync is not available."
#define STRING_CMD_SYNC_INIT "Please confirm that you wish to upload all your pending tasks to the Task Server"
#define STRING_CMD_SYNC_INIT "Please confirm that you wish to upload all your pending tasks to the Taskserver"
#define STRING_CMD_SYNC_NO_INIT "Taskwarrior will not proceed with first-time sync initialization."
#define STRING_CMD_SYNC_RELOCATE0 "The server account has been relocated. Please update your configuration using:"
#define STRING_CMD_SYNC_RELOCATE1 "task config taskd.server {1}"

View file

@ -404,11 +404,11 @@
#define STRING_CMD_SHELL_HELP1 "Inserisci un comando (es. 'list'), o premi 'Enter'."
#define STRING_CMD_SHELL_HELP2 "Non è necessario includere il comando 'task'."
#define STRING_CMD_SHELL_HELP3 "Inserisci 'quit' (o 'bye', 'exit') per terminare la sessione."
#define STRING_CMD_SYNC_USAGE "Sincronizza i dati con il Task Server"
#define STRING_CMD_SYNC_NO_SERVER "Task Server non configurato."
#define STRING_CMD_SYNC_BAD_CRED "Credenziali del Task Server malformate."
#define STRING_CMD_SYNC_BAD_CERT "Task Server certificate missing."
#define STRING_CMD_SYNC_BAD_KEY "Task Server key missing."
#define STRING_CMD_SYNC_USAGE "Sincronizza i dati con il Taskserver"
#define STRING_CMD_SYNC_NO_SERVER "Taskserver non configurato."
#define STRING_CMD_SYNC_BAD_CRED "Credenziali del Taskserver malformate."
#define STRING_CMD_SYNC_BAD_CERT "Taskserver certificate missing."
#define STRING_CMD_SYNC_BAD_KEY "Taskserver key missing."
#define STRING_CMD_SYNC_ADD " aggiunto {1} '{2}'"
#define STRING_CMD_SYNC_MOD "modificato {1} '{2}'"
#define STRING_CMD_SYNC_PROGRESS "Sincronizzazione con {1}"
@ -417,12 +417,12 @@
#define STRING_CMD_SYNC_SUCCESS2 "Sincronizzazione effettuata. {1} modifiche scaricate."
#define STRING_CMD_SYNC_SUCCESS3 "Sincronizzazione effettuata. {1} modifiche caricate, {2} modifiche scaricate."
#define STRING_CMD_SYNC_SUCCESS_NOP "Sincronizzazione effettuata. Nessuna modifica."
#define STRING_CMD_SYNC_FAIL_ACCOUNT "Sincronizzazione fallita. Credenziali non corrette o Task Server non abilitato."
#define STRING_CMD_SYNC_FAIL_ERROR "Sincronizzazione fallita. Il Task Server ha ritornato l'errore: {1} {2}"
#define STRING_CMD_SYNC_FAIL_CONNECT "Sincronizzazione fallita. Impossibile connettersi al Task Server."
#define STRING_CMD_SYNC_FAIL_ACCOUNT "Sincronizzazione fallita. Credenziali non corrette o Taskserver non abilitato."
#define STRING_CMD_SYNC_FAIL_ERROR "Sincronizzazione fallita. Il Taskserver ha ritornato l'errore: {1} {2}"
#define STRING_CMD_SYNC_FAIL_CONNECT "Sincronizzazione fallita. Impossibile connettersi al Taskserver."
#define STRING_CMD_SYNC_BAD_SERVER "Sincronizzazione fallita. Impostazione di configurazione '{1}' malformata"
#define STRING_CMD_SYNC_NO_TLS "Taskwarrior was built without GnuTLS support. Sync is not available."
#define STRING_CMD_SYNC_INIT "Please confirm that you wish to upload all your pending tasks to the Task Server"
#define STRING_CMD_SYNC_INIT "Please confirm that you wish to upload all your pending tasks to the Taskserver"
#define STRING_CMD_SYNC_NO_INIT "Taskwarrior will not proceed with first-time sync initialization."
#define STRING_CMD_SYNC_RELOCATE0 "The server account has been relocated. Please update your configuration using:"
#define STRING_CMD_SYNC_RELOCATE1 "task config taskd.server {1}"