.\" Text automatically generated by txt2man
.TH smd-translate 1 "17 March 2018" "" "Sync Mail Dir (smd) documentation"
.SH NAME
\fBsmd-translate \fP- translates mailbox names according to predefined patterns
\fB
.SH SYNOPSIS
.nf
.fam C
\fBsmd-translate\fP [\fB-m\fP \fImode\fP] [\fB-d\fP \fIdirection\fP] \fIendpoint\fP \fImailbox\fP

.fam T
.fi
.fam T
.fi
.SH DESCRIPTION
\fBsmd-translate\fP translates \fImailbox\fP names according to predefined patterns.
It is designed to be used in the configuration file of \fBsmd-push\fP(1) and
\fBsmd-pull\fP(1).
.PP
Refer to \fBsmd-config\fP(5) for a longer discussion on translators.
.PP
Supported modes follow.
.TP
.B
oimap-dovecot
.PP
This \fImode\fP is designed to make the transition of offlineimap users to
smd simpler. It assumes remote mailboxes are named like in the 
following:
.PP
.nf
.fam C
    Maildir/cur
    Maildir/.sub.folder/new

.fam T
.fi
The corresponding local mailboxes are named like in the following:
.PP
.nf
.fam C
    Mail/cur
    Mail/sub.folder/new

.fam T
.fi
.TP
.B
nodots
.PP
This \fImode\fP simply gets rid of all dots. It assumes remote mailboxes are 
named like in the following:
.PP
.nf
.fam C
    Maildir/cur
    Maildir/.sub.folder/new

.fam T
.fi
The corresponding local mailboxes are named like in the following:
.PP
.nf
.fam C
    Mail/cur
    Mail/sub/folder/new

.fam T
.fi
.TP
.B
move
.PP
This \fImode\fP just replaces the root of the \fImailbox\fP, i.e. substitutes
MAILBOX_LOCAL for MAILBOX_REMOTE and viceversa.
.RE
.PP

.SH 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
configuration file snippet in ~/.smd/config.endpoint:
.PP
.nf
.fam C
    TRANSLATOR_RL="smd-translate -m oimap-dovecot -d RL endpoint"
    TRANSLATOR_LR="smd-translate -m oimap-dovecot -d LR endpoint"

.fam T
.fi
To test your setup use the \fBsmd-check-conf\fP(1) utility.
.SH OPTIONS
.TP
.B
\fB-m\fP \fImode\fP
One of the supported modes listed above
.TP
.B
\fB-d\fP \fIdirection\fP
One of RL or LR
.TP
.B
\fIendpoint\fP
Is the suffix for the name of the configuration file to use
.TP
.B
\fImailbox\fP
The \fImailbox\fP name to translate
.SH FILES
~/.smd/config.*
.SH SEE ALSO
\fBsmd-push\fP(1), \fBsmd-pull\fP(1), \fBsmd-config\fP(5), \fBsmd-check-conf\fP(1)
.SH AUTHOR
Enrico Tassi <gares@fettunta.org>