diff options
Diffstat (limited to 'docs/akonadish.md')
-rw-r--r-- | docs/akonadish.md | 18 |
1 files changed, 9 insertions, 9 deletions
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 @@ | |||
1 | The akonadi shell is the primary interaction point from the commandline. It can be used for debugging, maintenance and scripting. | 1 | The sink shell is the primary interaction point from the commandline. It can be used for debugging, maintenance and scripting. |
2 | 2 | ||
3 | The syntax is: | 3 | The syntax is: |
4 | `akonadish COMMAND TYPE ...` | 4 | `sinksh COMMAND TYPE ...` |
5 | 5 | ||
6 | # Commands | 6 | # Commands |
7 | 7 | ||
@@ -23,7 +23,7 @@ Drops all caches of a resource but leaves the config intact. This is useful whil | |||
23 | 23 | ||
24 | ## synchronize | 24 | ## synchronize |
25 | 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, | 25 | 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, |
26 | for a maildir resource it simply means all data is indexed and becomes queriable by akonadi. | 26 | for a maildir resource it simply means all data is indexed and becomes queriable by sink. |
27 | 27 | ||
28 | Eventually this will allow to specify a query as well to i.e. only synchronize a specific folder. | 28 | Eventually this will allow to specify a query as well to i.e. only synchronize a specific folder. |
29 | 29 | ||
@@ -31,24 +31,24 @@ Eventually this will allow to specify a query as well to i.e. only synchronize a | |||
31 | 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. | 31 | 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. |
32 | 32 | ||
33 | # Setting up a new resource instance | 33 | # Setting up a new resource instance |
34 | akonadi_cmd is already the primary way how you create resource instances: | 34 | sink_cmd is already the primary way how you create resource instances: |
35 | 35 | ||
36 | `akonadish create resource org.kde.maildir path /home/developer/maildir1` | 36 | `sinksh create resource org.kde.maildir path /home/developer/maildir1` |
37 | 37 | ||
38 | 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. | 38 | 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. |
39 | 39 | ||
40 | `akonadish list resource` | 40 | `sinksh list resource` |
41 | 41 | ||
42 | By listing all available resources we can find the identifier of the resource that was automatically assigned. | 42 | By listing all available resources we can find the identifier of the resource that was automatically assigned. |
43 | 43 | ||
44 | `akonadish synchronize org.kde.maildir.instance1` | 44 | `sinksh synchronize org.kde.maildir.instance1` |
45 | 45 | ||
46 | This triggers the actual synchronization in the resource, and from there on the data is available. | 46 | This triggers the actual synchronization in the resource, and from there on the data is available. |
47 | 47 | ||
48 | `akonadish list folder org.kde.maildir.instance1` | 48 | `sinksh list folder org.kde.maildir.instance1` |
49 | 49 | ||
50 | This will get you all folders that are in the resource. | 50 | This will get you all folders that are in the resource. |
51 | 51 | ||
52 | `akonadish remove resource org.kde.maildir.instance1` | 52 | `sinksh remove resource org.kde.maildir.instance1` |
53 | 53 | ||
54 | And this will finally remove all traces of the resource instance. | 54 | And this will finally remove all traces of the resource instance. |