updated doc

README

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

mddiff.1.txt

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

smd-check-conf.1.txt

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

smd-translate.1.txt

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