From 944d1f728cb1612daa51aa2c550c0bcb67166852 Mon Sep 17 00:00:00 2001 From: Christian Mollekopf Date: Wed, 20 Jan 2016 19:07:38 +0100 Subject: Use Sink in docs. --- docs/akonadish.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) (limited to 'docs/akonadish.md') diff --git a/docs/akonadish.md b/docs/akonadish.md index b144dba..9884169 100644 --- a/docs/akonadish.md +++ b/docs/akonadish.md @@ -1,7 +1,7 @@ -The akonadi shell is the primary interaction point from the commandline. It can be used for debugging, maintenance and scripting. +The sink shell is the primary interaction point from the commandline. It can be used for debugging, maintenance and scripting. The syntax is: - `akonadish COMMAND TYPE ...` + `sinksh COMMAND TYPE ...` # Commands @@ -23,7 +23,7 @@ Drops all caches of a resource but leaves the config intact. This is useful whil ## synchronize Allows to synchronize a resource. For an imap resource that would mean that the remote server is contacted and the local dataset is brought up to date, -for a maildir resource it simply means all data is indexed and becomes queriable by akonadi. +for a maildir resource it simply means all data is indexed and becomes queriable by sink. Eventually this will allow to specify a query as well to i.e. only synchronize a specific folder. @@ -31,24 +31,24 @@ Eventually this will allow to specify a query as well to i.e. only synchronize a Provides the same contents as "list" but in a graphical tree view. This was really just a way for me to test whether I can actually get data into a view, so I'm not sure if it will survive as a command. For the time being it's nice to compare it's performance to the QML counterpart. # Setting up a new resource instance -akonadi_cmd is already the primary way how you create resource instances: +sink_cmd is already the primary way how you create resource instances: - `akonadish create resource org.kde.maildir path /home/developer/maildir1` + `sinksh create resource org.kde.maildir path /home/developer/maildir1` This creates a resource of type "org.kde.maildir" and a configuration of "path" with the value "home/developer/maildir1". Resources are stored in configuration files, so all this does is write to some config files. - `akonadish list resource` + `sinksh list resource` By listing all available resources we can find the identifier of the resource that was automatically assigned. - `akonadish synchronize org.kde.maildir.instance1` + `sinksh synchronize org.kde.maildir.instance1` This triggers the actual synchronization in the resource, and from there on the data is available. - `akonadish list folder org.kde.maildir.instance1` + `sinksh list folder org.kde.maildir.instance1` This will get you all folders that are in the resource. - `akonadish remove resource org.kde.maildir.instance1` + `sinksh remove resource org.kde.maildir.instance1` And this will finally remove all traces of the resource instance. -- cgit v1.2.3