.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "IMAP::Shell 3pm"
.TH IMAP::Shell 3pm "2021-06-19" "perl v5.28.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Cyrus::IMAP::Shell \- Perl version of cyradm
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&  $ cyradm [\-\-user authid] [\-\-authz authzid] [\-\-[no]rc] [\-\-systemrc file] [\-\-userrc file] \e
\&  > [\-\-port n] [\-\-auth mechanism] [\-\-server] server
.Ve
.PP
but possibly
.PP
.Vb 1
\&  $ perl \-MCyrus::IMAP::Shell \-e \*(Aqrun("myscript")\*(Aq
.Ve
.PP
or even (not recommended)
.PP
.Vb 1
\&  use Cyrus::IMAP::Admin::Shell;
\&
\&  run(\*(Aqmyscriptname\*(Aq);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module implements \fBcyradm\fR in Perl.  It is a shell around
Cyrus::IMAP::Admin.  Commands are provided in both Tcl-compatible
forms and GNU-style long option forms.
.PP
The ``cyradm`` utility is a simple command line for performing common
administrative tasks on a Cyrus \s-1IMAP\s0 server, written in Perl.
.PP
The cyradm utility can either be executed from a client where it has been
installed and connect to the server via \s-1IMAP\s0 or it can be executed
locally via a shell on the server.
.PP
cyradm understands /bin/sh\-style redirection: any command can have its 
standard or error output redirected, with all sh-style redirections 
(except \e<\e>) supported. It does not currently understand pipes or 
backgrounding.
.PP
If the Term::Readline::Perl or Term::Readline::GNU modules are 
available, cyradm will use it.
.SH "COMMAND-LINE ARGUMENTS"
.IX Header "COMMAND-LINE ARGUMENTS"
.ie n .IP """\-\-u"", ""\-\-user"" \fIuser\fR" 4
.el .IP "\f(CW\-\-u\fR, \f(CW\-\-user\fR \fIuser\fR" 4
.IX Item "--u, --user user"
Authenticate with the specified username.
.ie n .IP """\-\-authz"" \fIuser\fR" 4
.el .IP "\f(CW\-\-authz\fR \fIuser\fR" 4
.IX Item "--authz user"
Authorize the connection as being the specified username.
.ie n .IP """\-\-norc"", ""\-\-rc""" 4
.el .IP "\f(CW\-\-norc\fR, \f(CW\-\-rc\fR" 4
.IX Item "--norc, --rc"
(Do not) load the configuration files.
.ie n .IP """\-\-systemrc"" \fIfile\fR" 4
.el .IP "\f(CW\-\-systemrc\fR \fIfile\fR" 4
.IX Item "--systemrc file"
Use the system configuration file specified.
.ie n .IP """\-\-userrc"" \fIfile\fR" 4
.el .IP "\f(CW\-\-userrc\fR \fIfile\fR" 4
.IX Item "--userrc file"
Use the user configuration file specified.
.ie n .IP """\-\-port"" \fIport\fR" 4
.el .IP "\f(CW\-\-port\fR \fIport\fR" 4
.IX Item "--port port"
Connect to the *server* specified on the port specified.
.ie n .IP """\-\-auth"" \fImechanism\fR" 4
.el .IP "\f(CW\-\-auth\fR \fImechanism\fR" 4
.IX Item "--auth mechanism"
Use the mechanism specified to authenticate. One of \s-1PLAIN, LOGIN, DIGEST\-MD5,\s0 etc.
.ie n .IP """\-\-help""" 4
.el .IP "\f(CW\-\-help\fR" 4
.IX Item "--help"
Show a help message about these command-line options.
.ie n .IP """\-\-version""" 4
.el .IP "\f(CW\-\-version\fR" 4
.IX Item "--version"
Display the version of Cyrus \s-1IMAP\s0 the current ``cyradm`` command is a part of.
.ie n .IP """\-\-server"" \fIserver\fR" 4
.el .IP "\f(CW\-\-server\fR \fIserver\fR" 4
.IX Item "--server server"
The server address to connect to.
.SH "COMMANDS"
.IX Header "COMMANDS"
.SS "authenticate"
.IX Subsection "authenticate"
\&\fBauthenticate\fR [\f(CW\*(C`\-\-minssf\*(C'\fR \fIN\fR] [\f(CW\*(C`\-\-maxssf\*(C'\fR \fIN\fR] [\f(CW\*(C`\-\-mechanisms\*(C'\fR \fIlist\fR] [\f(CW\*(C`\-\-service\*(C'\fR \fIname\fR] [\f(CW\*(C`\-\-tlskey\*(C'\fR \fIkeyfile\fR] [\f(CW\*(C`\-\-notls\*(C'\fR] [\f(CW\*(C`\-\-cafile\*(C'\fR \fIcacertfile\fR] [\f(CW\*(C`\-\-capath\*(C'\fR \fIcacertdir\fR] \fIuser\fR
.PP
Authenticate to server.  You must already be connected to a server and
Cyrus imapd will refuse to allow you to re-authenticate once you have
authenticated once.
.PP
aliases: \f(CW\*(C`auth\*(C'\fR, \f(CW\*(C`login\*(C'\fR
.SS "chdir"
.IX Subsection "chdir"
\&\fBchdir\fR \fIdirectory\fR
.PP
Change directory.  A \f(CW\*(C`pwd\*(C'\fR builtin is not provided, but the default command
action will run \f(CW\*(C`pwd\*(C'\fR from a shell if invoked.
.PP
aliases: \f(CW\*(C`cd\*(C'\fR
.SS "createmailbox"
.IX Subsection "createmailbox"
\&\fBcreatemailbox\fR [\f(CW\*(C`\-\-partition\*(C'\fR \fIpartition\fR] [\f(CW\*(C`\-\-specialuse\*(C'\fR \fIspecialuse\fR] \fImailbox\fR
.PP
\&\fBcreatemailbox\fR [\f(CW\*(C`\-\-specialuse\*(C'\fR \fIspecialuse\fR] \fImailbox\fR \fIpartition\fR
.PP
Create a mailbox on the default or a specified partition.  Both old-style
and getopt-style usages are accepted (combining them will produce an error).
Optionally assign a special use to the mailbox.
.PP
New mailboxes inherit the \s-1ACL\s0 permissions of
their parent mailbox, except for top-level mailboxes such as the user's
\&\s-1INBOX.\s0 Mailboxes that are the user's \s-1INBOX\s0 are assigned all to the
corresponding user.
.IP "Example Usage" 4
.IX Item "Example Usage"
.Vb 5
\&    localhost> :command:\`cm user.john\`
\&    localhost> :command:\`lm\`
\&    user.john (\eHasNoChildren)
\&    localhost> :command:\`lam user.john\`
\&    john lrswipkxtecda
.Ve
.Sp
Note that in the above example, the \f(CW\*(C`unixhierarchysep\*(C'\fR setting in
imapd.conf is set to \f(CW0\fR. When using the \s-1UNIX\s0
hierarchy separator, the \f(CW\*(C`/\*(C'\fR (forward slash) character would be
used as the hierarchy separator, and the example would look as
follows:
.ie n .IP "Example Usage with ""unixhierarchysep: 1""" 4
.el .IP "Example Usage with \f(CWunixhierarchysep: 1\fR" 4
.IX Item "Example Usage with unixhierarchysep: 1"
.Vb 5
\&    localhost> :command:\`cm user/john\`
\&    localhost> :command:\`lm\`
\&    user/john (\eHasNoChildren)
\&    localhost> :command:\`lam user/john\`
\&    john lrswipkxtecda
.Ve
.IP "Note" 4
.IX Item "Note"
The above examples use the unqualified, shorthand user
identifier john as the mailbox name.
.Sp
With the use of virtual domains, controlled through the
\&\f(CW\*(C`virtdomains\*(C'\fR setting in \fBimapd.conf\fR\|(5).
.PP
aliases: \f(CW\*(C`cm\*(C'\fR, \f(CW\*(C`create\*(C'\fR
.SS "deleteaclmailbox"
.IX Subsection "deleteaclmailbox"
\&\fBdeleteaclmailbox\fR \fImailbox\fR \fIid\fR [...]
.PP
Remove ACLs from the specified mailbox.
.PP
aliases: \f(CW\*(C`delteacl\*(C'\fR, \f(CW\*(C`dam\*(C'\fR
.SS "deletemailbox"
.IX Subsection "deletemailbox"
\&\fBdeletemailbox\fR \fImailbox\fR
.PP
Delete the specified mailbox.
.PP
Administrators do not have implicit delete rights on mailboxes.  Use the
\&\*(L"setaclmailbox\*(R" command to grant the \f(CW\*(C`x\*(C'\fR permission to your
principal if you need to delete a mailbox you do not own.
.PP
Note that the online help admits to an optional host argument.  This argument
is not currently used, and will be rejected with an error if specified; it
is reserved for \s-1IMSP.\s0
.PP
aliases: \f(CW\*(C`delete\*(C'\fR, \f(CW\*(C`dm\*(C'\fR
.SS "disconnect"
.IX Subsection "disconnect"
\&\fBdisconnect\fR
.PP
Disconnect from the current server.  The prompt will revert to \f(CW\*(C`cyradm>\*(C'\fR. 
This does not quit cyradm.
.PP
aliases: \f(CW\*(C`disc\*(C'\fR
.SS "exit"
.IX Subsection "exit"
\&\fBexit\fR [\fInumber\fR]
.PP
Exit \f(CW\*(C`cyradm\*(C'\fR, optionally with a specific exit status; the exit status of the
last command will be used if one is not specified.
.PP
aliases: \f(CW\*(C`quit\*(C'\fR
.SS "help"
.IX Subsection "help"
\&\fBhelp\fR [command]
.PP
Show help for \f(CW\*(C`command\*(C'\fR or all commands.
.PP
aliases: \f(CW\*(C`?\*(C'\fR
.SS "getmetadata"
.IX Subsection "getmetadata"
\&\fBgetmetadata\fR [\fImailbox\fR]
.PP
Display mailbox/server metadata
.PP
aliases: \f(CW\*(C`getmd\*(C'\fR
.SS "info"
.IX Subsection "info"
\&\fBinfo\fR [\fImailbox\fR]
.PP
Display the mailbox/server annotations.
.SS "listaclmailbox"
.IX Subsection "listaclmailbox"
\&\fBlistaclmailbox\fR \fImailbox\fR
.PP
List ACLs on the specified mailbox.
.PP
aliases: \f(CW\*(C`lam\*(C'\fR, \f(CW\*(C`listacl\*(C'\fR
.SS "listmailbox"
.IX Subsection "listmailbox"
\&\fBlistmailbox\fR [\f(CW\*(C`\-\-subscribed\*(C'\fR] [\f(CW\*(C`\-\-specialuse\*(C'\fR] [\fIpattern\fR [\fIreference\fR]]
.PP
List all, or all subscribed or special-use, mailboxes matching the specified
pattern.  The pattern may have embedded wildcards \f(CW\*(Aq*\*(Aq\fR or \f(CW\*(Aq%\*(Aq\fR, which
match anything or anything except the separator character, respectively.
.PP
Mailboxes returned will be relative to the specified reference if one
is specified.  This allows a mailbox list to be limited to a particular
hierarchy.
.PP
In some cases when the \f(CW\*(Aq%\*(Aq\fR wildcard is used to end a pattern, it may
match an entry which is not a mailbox but which contains other mailboxes.
In this case, the entry will be parenthesized to indicate that it is a
root for other mailboxes, as opposed to a mailbox itself.
.PP
aliases: \f(CW\*(C`list\*(C'\fR, \f(CW\*(C`lm\*(C'\fR
.SS "listquota"
.IX Subsection "listquota"
\&\fBlistquota\fR \fIroot\fR
.PP
List quotas on specified root.  If the specified mailbox path does not have
a quota assigned, an error will be raised; see \*(L"listquotaroot\*(R" for a way to
find the quota root for a mailbox.
.PP
aliases: \f(CW\*(C`lq\*(C'\fR
.SS "listquotaroot"
.IX Subsection "listquotaroot"
\&\fBlistquotaroot\fR \fImailbox\fR
.PP
Show quota roots and quotas for mailbox
.PP
aliases: \f(CW\*(C`lqm\*(C'\fR, \f(CW\*(C`lqr\*(C'\fR
.SS "mboxconfig"
.IX Subsection "mboxconfig"
\&\fBmboxconfig\fR [\f(CW\*(C`\-\-private\*(C'\fR] \fImailbox\fR \fIattribute\fR \fIvalue\fR
.PP
Set mailbox metadata, optionally set the private instead of the shared
version of the metadata. A value of \*(L"none\*(R" will remove the attribute.
.PP
The currently supported attributes are:
.ie n .IP """comment"" \fIdescription\fR" 4
.el .IP "\f(CWcomment\fR \fIdescription\fR" 4
.IX Item "comment description"
Sets a comment or description associated with the mailbox.
.ie n .IP """expire"" \fIdays\fR" 4
.el .IP "\f(CWexpire\fR \fIdays\fR" 4
.IX Item "expire days"
Sets the number of days after which messages will be expired from the mailbox.
.ie n .IP """news2mail"" \fIaddress\fR" 4
.el .IP "\f(CWnews2mail\fR \fIaddress\fR" 4
.IX Item "news2mail address"
Sets an email address to which messages injected into the server via \s-1NNTP\s0
will be sent.
.ie n .IP """pop3showafter"" \fItime\fR" 4
.el .IP "\f(CWpop3showafter\fR \fItime\fR" 4
.IX Item "pop3showafter time"
Sets a time (in \s-1RFC3501\s0 format, for example \*(L"6\-Jan\-2011 11:45:32 +1100\*(R")
which specifies a cutoff date such that \s-1POP3\s0 fetching of the folder does
not see messages whose internaldate is before or equal to the date.
.ie n .IP """sharedseen"" \fItrue|false\fR" 4
.el .IP "\f(CWsharedseen\fR \fItrue|false\fR" 4
.IX Item "sharedseen true|false"
Enables the use of a shared \eSeen flag on messages rather than a
per-user \eSeen flag.  The 's' right in the mailbox \s-1ACL\s0 still controls
whether a user can set the shared \eSeen flag.
.ie n .IP """sieve"" \fIscriptname\fR" 4
.el .IP "\f(CWsieve\fR \fIscriptname\fR" 4
.IX Item "sieve scriptname"
Indicates the name of the global sieve script that should be run when
a message is delivered to the shared mailbox (not used for personal
mailboxes).
.ie n .IP """squat"" \fItrue|false\fR" 4
.el .IP "\f(CWsquat\fR \fItrue|false\fR" 4
.IX Item "squat true|false"
Indicates that the mailbox should have a squat index created for it.
.PP
aliases: \f(CW\*(C`mboxcfg\*(C'\fR
.SS "reconstruct"
.IX Subsection "reconstruct"
\&\fBreconstruct\fR [\f(CW\*(C`\-r\*(C'\fR] \fImailbox\fR
.PP
Reconstruct the specified mailbox, optionally recursing and reconstructing child mailboxes if the \f(CW\*(C`\-r\*(C'\fR flag is given.
.PP
For more information see \fBreconstruct\fR\|(8).
.SS "renamemailbox"
.IX Subsection "renamemailbox"
\&\fBrenamemailbox\fR [\f(CW\*(C`\-\-partition\*(C'\fR \fIpartition\fR] \fIoldname\fR \fInewname\fR
.PP
\&\fBrenamemailbox\fR \fIoldname\fR \fInewname\fR [\fIpartition\fR]
.PP
Rename the specified mailbox, optionally moving it to a different partition.
Both old-style and getopt-style usages are accepted; combining them will
produce an error.
.PP
aliases: \f(CW\*(C`rename\*(C'\fR, \f(CW\*(C`renm\*(C'\fR
.SS "server"
.IX Subsection "server"
\&\fBserver\fR
.PP
\&\fBserver\fR \fI[\-\-noauthenticate]\fR \fI[server]\fR
.PP
With no arguments, show the current server.  With an argument, connect to that
server.  It will prompt for automatic login unless the \f(CW\*(C`\-\-noauthenticate\*(C'\fR
option is specified.  (This may change; in particular, either automatic
authentication will be removed or all \*(L"authenticate\*(R" options will be added.)
.PP
When connected to a server, \fBcyradm\fR's prompt changes from \f(CW\*(C`cyradm>\*(C'\fR to
\&\f(CW\*(C`servername>\*(C'\fR, where \fIservername\fR is the fully qualified domain name
of the connected server.
.PP
aliases: \f(CW\*(C`connect\*(C'\fR, \f(CW\*(C`servername\*(C'\fR
.SS "setaclmailbox"
.IX Subsection "setaclmailbox"
\&\fBsetaclmailbox\fR \fImailbox\fR \fIid\fR \fIrights\fR [\fIid\fR \fIrights\fR ...]
.PP
Set ACLs on a mailbox.  The \s-1ACL\s0 may be one of the special strings \f(CW\*(C`none\*(C'\fR,
\&\f(CW\*(C`read\*(C'\fR (\f(CW\*(C`lrs\*(C'\fR), \f(CW\*(C`post\*(C'\fR (\f(CW\*(C`lrsp\*(C'\fR), \f(CW\*(C`append\*(C'\fR (\f(CW\*(C`lrsip\*(C'\fR), \f(CW\*(C`write\*(C'\fR
(\f(CW\*(C`lrswipkxte\*(C'\fR), \f(CW\*(C`delete\*(C'\fR (\f(CW\*(C`lrxte\*(C'\fR), or \f(CW\*(C`all\*(C'\fR (\f(CW\*(C`lrswipkxte\*(C'\fR), or
any combinations of the \s-1ACL\s0 codes:
.IP "\fBl\fR" 4
.IX Item "l"
Lookup (mailbox is visible to \s-1LIST/LSUB, SUBSCRIBE\s0 mailbox)
.IP "\fBr\fR" 4
.IX Item "r"
Read (\s-1SELECT/EXAMINE\s0 the mailbox, perform \s-1STATUS\s0)
.IP "\fBs\fR" 4
.IX Item "s"
Seen (set/clear \eSEEN flag via \s-1STORE,\s0 also set \eSEEN flag during \s-1APPEND/COPY/FETCH\s0 BODY[...])
.IP "\fBw\fR" 4
.IX Item "w"
Write flags other than \eSEEN and \eDELETED
.IP "\fBi\fR" 4
.IX Item "i"
Insert (\s-1APPEND, COPY\s0 destination)
.IP "\fBp\fR" 4
.IX Item "p"
Post (send mail to mailbox)
.IP "\fBk\fR" 4
.IX Item "k"
Create mailbox (\s-1CREATE\s0 new sub-mailboxes, parent for new mailbox in \s-1RENAME\s0)
.IP "\fBx\fR" 4
.IX Item "x"
Delete mailbox (\s-1DELETE\s0 mailbox, old mailbox name in \s-1RENAME\s0)
.IP "\fBt\fR" 4
.IX Item "t"
Delete messages (set/clear \eDELETED flag via \s-1STORE,\s0 also set \eDELETED flag during \s-1APPEND/COPY\s0)
.IP "\fBe\fR" 4
.IX Item "e"
Perform \s-1EXPUNGE\s0 and expunge as part of \s-1CLOSE\s0
.IP "\fBa\fR" 4
.IX Item "a"
Administer (\s-1SETACL/DELETEACL/GETACL/LISTRIGHTS\s0)
.PP
aliases: \f(CW\*(C`setacl\*(C'\fR, \f(CW\*(C`sam\*(C'\fR
.SS "setinfo"
.IX Subsection "setinfo"
\&\fBsetinfo\fR \fIattribute\fR \fIvalue\fR
.PP
Set server metadata.  A value of \*(L"none\*(R" will remove the attribute.
The currently supported attributes are:
.ie n .IP """motd"" \fImessage\fR" 4
.el .IP "\f(CWmotd\fR \fImessage\fR" 4
.IX Item "motd message"
Sets a \*(L"message of the day\*(R".  The message gets displayed as an \s-1ALERT\s0 upon
connection.
.ie n .IP """comment"" \fInote\fR" 4
.el .IP "\f(CWcomment\fR \fInote\fR" 4
.IX Item "comment note"
Sets a comment or description associated with the server.
.ie n .IP """admin"" \fIaddress\fR" 4
.el .IP "\f(CWadmin\fR \fIaddress\fR" 4
.IX Item "admin address"
Sets the administrator email address for the server.
.ie n .IP """shutdown"" \fImessage\fR" 4
.el .IP "\f(CWshutdown\fR \fImessage\fR" 4
.IX Item "shutdown message"
Sets a shutdown message.  The message gets displayed as an \s-1ALERT\s0 and
all users are disconnected from the server (subsequent logins are disallowed).
.ie n .IP """expire"" \fIdays\fR" 4
.el .IP "\f(CWexpire\fR \fIdays\fR" 4
.IX Item "expire days"
Sets the number of days after which messages will be expired from the
server (unless overridden by a mailbox annotation).
.ie n .IP """squat"" \fItrue|false\fR" 4
.el .IP "\f(CWsquat\fR \fItrue|false\fR" 4
.IX Item "squat true|false"
Indicates that all mailboxes should have a squat indexes created for
them (unless overridden by a mailbox annotation).
.SS "setmetadata"
.IX Subsection "setmetadata"
\&\fBsetmetadata\fR [\-\-private] mailbox [\fIannotation\fR] \fIvalue\fR
.PP
Set metadata on mailbox, where \fIannotation\fR is one of
[comment|expire|news2mail|pop3showafter|sharedseen|sieve|specialuse|
squat|/<explicit annotation>].
.PP
Note that \fIvalue\fR with a leading backslash must be escaped with an
additional backslash.  For example:
.Sp
.Vb 1
\&  setmetadata \-\-private Spam specialuse "\e\eJunk"
.Ve
.PP
Note, too, that \*(L"private\*(R" annotations are private to the user currently
authenticated as, not necessarily the owner of the mailbox.  To set
annotations for another user you must authorize as that user.
.PP
In addition to the use of optional flag \fB\-\-private\fR, one may use a more
explicit syntax, prefixing the annotation with '/shared/' or '/private/'
as in this example:
.Sp
.Vb 1
\&  setmetadata Spam /private/specialuse "\e\eJunk"
.Ve
.PP
aliases: \f(CW\*(C`setmd\*(C'\fR
.SS "setquota"
.IX Subsection "setquota"
\&\fBsetquota\fR \fIroot\fR \fIresource\fR \fIvalue\fR [\fIresource\fR \fIvalue\fR ...]
.PP
Set a quota on the specified root, which may or may not be an actual
mailbox. The \fIresources\fR understood by \fBCyrus\fR are \f(CW\*(C`STORAGE\*(C'\fR,
\&\f(CW\*(C`MESSAGE\*(C'\fR, \f(CW\*(C`X\-NUM\-FOLDERS\*(C'\fR and \f(CW\*(C`X\-ANNOTATION\-STORAGE\*(C'\fR.  The storage
units are, as defined in \s-1RFC 2087,\s0 groups of 1024 octets (i.e.
Kilobytes). The \fIvalue\fR may be the special string \f(CW\*(C`none\*(C'\fR which will
remove the quota.
.PP
aliases: \f(CW\*(C`sq\*(C'\fR
.SS "subscribe"
.IX Subsection "subscribe"
\&\fBsubscribe\fR \fImailbox\fR
.PP
Subscribe to the given mailbox.
.SS "unsubscribe"
.IX Subsection "unsubscribe"
\&\fBunsubscribe\fR \fImailbox\fR
.PP
Unsubscribe to the given mailbox.
.SS "version"
.IX Subsection "version"
\&\fBversion\fR
.PP
Display the version info of the current server.
.PP
aliases: \f(CW\*(C`ver\*(C'\fR
.SS "xfermailbox"
.IX Subsection "xfermailbox"
\&\fBxfermailbox\fR [\f(CW\*(C`\-\-partition\*(C'\fR \fIpartition\fR] \fImailbox\fR \fIserver\fR
.PP
\&\fBxfermailbox\fR \fImailbox\fR \fIserver\fR [\fIpartition\fR]
.PP
Transfer (relocate) the specified mailbox to a different server.
Both old-style and getopt-style usages are accepted; combining them will
produce an error.
.PP
aliases: \f(CW\*(C`xfer\*(C'\fR
.SH "NOTES"
.IX Header "NOTES"
GNU-style long options must be given in their entirety; Tcl-style options
may be abbreviated.
.PP
Tcl-style options are provided as a compatibility feature.  They will
probably go away in the future.
.PP
Multiple commands can be given on a line, separated by \f(CW\*(Aq;\*(Aq\fR characters.
.PP
All commands set an exit status, which at present is not useful.
.PP
Unknown commands are passed to a subshell for execution.
.PP
The Tcl version of \fBcyradm\fR is used for scripting as well as interactively.
While this is possible to a limited extent by use of the \f(CW\*(C`run\*(C'\fR method,
scripting would normally be done with \f(CW\*(C`Cyrus::IMAP::Admin\*(C'\fR, which is far
more flexible than either interactive \f(CW\*(C`cyradm\*(C'\fR or the Tcl scripting
mechanism for Cyrus.
.PP
\&\fBcyradm\fR understands \fB/bin/sh\fR\-style redirection:  any command can have
its standard or error output redirected, with all \fBsh\fR\-style redirections
(except \f(CW\*(C`<>\*(C'\fR) supported.  It does not currently understand pipes
or backgrounding.
.PP
If the \f(CW\*(C`Term::Readline::Perl\*(C'\fR or \f(CW\*(C`Term::Readline::GNU\*(C'\fR modules are
available, \fBcyradm\fR will use it.
.PP
An alias facility is implemented internally, but no access is currently
provided to it.  This will change, if only to allow some of the predefined
aliases to be removed if they conflict with useful shell commands.
.SH "AUTHOR"
.IX Header "AUTHOR"
Brandon S. Allbery, allbery@ece.cmu.edu
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Cyrus::IMAP::Admin,
Term::ReadLine,
\&\fBsh\fR\|(1), \fBperl\fR\|(1), \fBimapd\fR\|(8), \fBimapd.conf\fR\|(5), \fBreconstruct\fR\|(8)