Browse Source

updated doc

Enrico Tassi 9 years ago
parent
commit
7b960abb7e
4 changed files with 18 additions and 16 deletions
  1. 11
    10
      README
  2. 1
    1
      mddiff.1.txt
  3. 4
    3
      smd-check-conf.1.txt
  4. 2
    2
      smd-translate.1.txt

+ 11
- 10
README View File

@@ -189,12 +189,12 @@ programs must be defined:
189 189
 
190 190
 A translator is a program that receives in standard input one or more
191 191
 folder names,
192
-and must return 0 and print on standard output a corresponding folder name
193
-on success, or return 1 and prints the string `ERROR` on the first line
194
-and an optional following error message otherwise.  Note that the folder
195
-names will be complete of the `MAILBOX` part and will always terminate
196
-with `cur`, `new` or `tmp`.  For example, consider the following configuration
197
-file:
192
+and must print on standard output a corresponding folder name
193
+on success, or prints the string `ERROR` followed by a new line
194
+and an optional following error message otherwise end exists returning 1.
195
+Note that the folder names will be complete of the `MAILBOX_LOCAL` or
196
+`MAILBOX_REMOTE` part and will always terminate with `cur`, `new` or `tmp`.
197
+For example, consider the following configuration file:
198 198
 
199 199
     MAILBOX_LOCAL=Mail
200 200
     MAILBOX_REMOTE=Maildir
@@ -240,11 +240,12 @@ may take a long time depending on the size of your mailboxes.
240 240
 To avoid common mistakes in writing translators, some recurrent renaming
241 241
 scenarios are handled by the `smd-translate` utility. 
242 242
 Assuming the `MAILBOX_LOCAL` configuration variable is set to `Mail`
243
-and the `MAILBOX_REMOTE` is set to `Maildir`, one can use the following
244
-configuration file snippet in `~/.smd/config.endpoint`:
243
+and the `MAILBOX_REMOTE` is set to `Maildir`, 
244
+One can use the following configuration file snippet as a reference,
245
+where default must be repaced with the endpoint name:
245 246
   
246
-    TRANSLATOR_RL="smd-translate -m oimap-dovecot -d RL endpoint"
247
-    TRANSLATOR_LR="smd-translate -m oimap-dovecot -d LR endpoint"
247
+    TRANSLATOR_RL="smd-translate -m oimap-dovecot -d RL default"
248
+    TRANSLATOR_LR="smd-translate -m oimap-dovecot -d LR default"
248 249
 
249 250
 ### smd-loop
250 251
 

+ 1
- 1
mddiff.1.txt View File

@@ -21,7 +21,7 @@ DESCRIPTION
21 21
   If paths is a single file name, and that file is a fifo, and the -s option
22 22
   is passed, mddiff reads from that fifo two lines at a time, respectively
23 23
   a source name and a target name. It then creates a symlink named as
24
-  as the target name pointing to the source name. If fome dictories need to be
24
+  as the target name pointing to the source name. If some dictories need to be
25 25
   created in order to create the symlink, this is also done.
26 26
   
27 27
   If paths is a list of directories, mddiff outputs a list of actions a client

+ 4
- 3
smd-check-conf.1.txt View File

@@ -1,11 +1,12 @@
1 1
 NAME
2
-  smd-check-conf - checks translators round trip
2
+  smd-check-conf - checks smd configuration file
3 3
 
4 4
 SYNOPSIS
5 5
   smd-check-conf [endpoint]
6 6
 
7 7
 DESCRIPTION
8
-  smd-check-translators tests the translators for a configured endpoint.
8
+  smd-check-conf performs some sanity check on a configuration file.
9
+  It mainly tests the translators for a configured endpoint.
9 10
   The test consists in listing local and remote mailboxes, calling
10 11
   the translators, displaying the result to the user and checking for
11 12
   round trip (i.e. that the translators programs behave as inverse
@@ -20,7 +21,7 @@ FILES
20 21
   ~/.smd/config.*
21 22
 
22 23
 SEE ALSO
23
-  smd-translate(1), smd-config(5), smd-check-translators(1)
24
+  smd-translate(1), smd-config(5)
24 25
 
25 26
 AUTHOR
26 27
   Enrico Tassi <gares@fettunta.org>

+ 2
- 2
smd-translate.1.txt View File

@@ -35,7 +35,7 @@ USAGE IN CONFIGURATION FILE
35 35
     TRANSLATOR_RL="smd-translate -m oimap-dovecot -d RL endpoint"
36 36
     TRANSLATOR_LR="smd-translate -m oimap-dovecot -d LR endpoint"
37 37
     
38
-  To test your setup use the smd-check-translators(1) utility.
38
+  To test your setup use the smd-check-conf(1) utility.
39 39
 
40 40
 OPTIONS
41 41
   -m mode       One of the supported modes listed above
@@ -47,7 +47,7 @@ FILES
47 47
   ~/.smd/config.*
48 48
 
49 49
 SEE ALSO
50
-  smd-push(1), smd-pull(1), smd-config(5), smd-check-translators(1)
50
+  smd-push(1), smd-pull(1), smd-config(5), smd-check-conf(1)
51 51
 
52 52
 AUTHOR
53 53
   Enrico Tassi <gares@fettunta.org>

Loading…
Cancel
Save