summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorChristian Mollekopf <chrigi_1@fastmail.fm>2016-07-08 11:22:40 +0200
committerChristian Mollekopf <chrigi_1@fastmail.fm>2016-07-08 11:36:32 +0200
commit81fa4c3635a029b1c8f9cc3cd670f0b04f1c3f21 (patch)
tree3acd44ee1d055e4dfe6c8c0409406235b39e0980 /docs
parent9317fbffeab4a8c258acb1116eb12fbded7053d8 (diff)
downloadsink-81fa4c3635a029b1c8f9cc3cd670f0b04f1c3f21.tar.gz
sink-81fa4c3635a029b1c8f9cc3cd670f0b04f1c3f21.zip
Shorten the types to be more distinctive.
The org.kde prefix is useless and possibly misleading. Simply prefixing with sink is more unique and shorter.
Diffstat (limited to 'docs')
-rw-r--r--docs/sinksh.md10
1 files changed, 5 insertions, 5 deletions
diff --git a/docs/sinksh.md b/docs/sinksh.md
index 9884169..b04eb0c 100644
--- a/docs/sinksh.md
+++ b/docs/sinksh.md
@@ -33,22 +33,22 @@ Provides the same contents as "list" but in a graphical tree view. This was real
33# Setting up a new resource instance 33# Setting up a new resource instance
34sink_cmd is already the primary way how you create resource instances: 34sink_cmd is already the primary way how you create resource instances:
35 35
36 `sinksh create resource org.kde.maildir path /home/developer/maildir1` 36 `sinksh create resource sink.maildir path /home/developer/maildir1`
37 37
38This 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. 38This creates a resource of type "sink.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 `sinksh list resource` 40 `sinksh list resource`
41 41
42By listing all available resources we can find the identifier of the resource that was automatically assigned. 42By listing all available resources we can find the identifier of the resource that was automatically assigned.
43 43
44 `sinksh synchronize org.kde.maildir.instance1` 44 `sinksh synchronize sink.maildir.instance1`
45 45
46This triggers the actual synchronization in the resource, and from there on the data is available. 46This triggers the actual synchronization in the resource, and from there on the data is available.
47 47
48 `sinksh list folder org.kde.maildir.instance1` 48 `sinksh list folder sink.maildir.instance1`
49 49
50This will get you all folders that are in the resource. 50This will get you all folders that are in the resource.
51 51
52 `sinksh remove resource org.kde.maildir.instance1` 52 `sinksh remove resource sink.maildir.instance1`
53 53
54And this will finally remove all traces of the resource instance. 54And this will finally remove all traces of the resource instance.