debian man page for smd-translate

smd-translate(1)					 Sync Mail Dir (smd) documentation					  smd-translate(1)

NAME
       smd-translate - translates mailbox names according to predefined patterns

SYNOPSIS
       smd-translate [-m mode] [-d direction] endpoint mailbox

DESCRIPTION
       smd-translate  translates  mailbox  names  according  to  predefined patterns.  It is designed to be used in the configuration file of smd-
       push(1) and smd-pull(1).

       Refer to smd-config(5) for a longer discussion on translators.

       Supported modes follow.

       oimap-dovecot

       This mode is designed to make the transition of offlineimap users to smd simpler. It assumes remote mailboxes are named like in the follow-
       ing:

	   Maildir/cur
	   Maildir/.sub.folder/new

       The corresponding local mailboxes are named like in the following:

	   Mail/cur
	   Mail/sub.folder/new

       nodots

       This mode simply gets rid of all dots. It assumes remote mailboxes are named like in the following:

	   Maildir/cur
	   Maildir/.sub.folder/new

       The corresponding local mailboxes are named like in the following:

	   Mail/cur
	   Mail/sub/folder/new

       move

       This mode just replaces the root of the mailbox, i.e. substitutes MAILBOX_LOCAL for MAILBOX_REMOTE and viceversa.

USAGE IN CONFIGURATION FILE
       Assuming  the  MAILBOX_LOCAL configuration variable is set to Mail and the MAILBOX_REMOTE is set to Maildir, one can use the following con-
       figuration file snippet in ~/.smd/config.endpoint:

	   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-conf(1) utility.

OPTIONS
       -m mode
	      One of the supported modes listed above

       -d direction
	      One of RL or LR

       endpoint
	      Is the suffix for the name of the configuration file to use

       mailbox
	      The mailbox name to translate

FILES
       ~/.smd/config.*

SEE ALSO
       smd-push(1), smd-pull(1), smd-config(5), smd-check-conf(1)

AUTHOR
       Enrico Tassi <gares@fettunta.org>

								   11 June 2012 						  smd-translate(1)