ctl_mboxlist.8.html [plain text]
<!-- Creator : groff version 1.18.1.1 -->
<!-- CreationDate: Wed Feb 7 14:01:44 2007 -->
<html>
<head>
<meta name="generator" content="groff -Thtml, see www.gnu.org">
<meta name="Content-Style" content="text/css">
<title>CTL_MBOXLIST</title>
</head>
<body>
<h1 align=center>CTL_MBOXLIST</h1>
<a href="#NAME">NAME</a><br>
<a href="#SYNOPSIS">SYNOPSIS</a><br>
<a href="#DESCRIPTION">DESCRIPTION</a><br>
<a href="#OPTIONS">OPTIONS</a><br>
<a href="#FILES">FILES</a><br>
<a href="#SEE ALSO">SEE ALSO</a><br>
<hr>
<a name="NAME"></a>
<h2>NAME</h2>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td>
<td width="89%">
<p>ctl_mboxlist − perform operations on the mailbox
list database</p>
</td>
</table>
<a name="SYNOPSIS"></a>
<h2>SYNOPSIS</h2>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td>
<td width="89%">
<p><b>ctl_mboxlist</b> [ <b>−C</b> <i>config-file</i>
] <b>−d</b> [ <b>−x</b> ] [ <b>−p</b>
<i>partition</i> ] [ <b>−f</b> <i>filename</i>
]<b><br>
ctl_mboxlist</b> [ <b>−C</b> <i>config-file</i> ]
<b>−u</b> [ <b>−f</b> <i>filename</i> ]<b><br>
ctl_mboxlist</b> [ <b>−C</b> <i>config-file</i> ]
<b>−m</b> [ <b>−a</b> ] [ <b>−w</b> ]<br>
[ <b>−f</b> <i>filename</i> ]</p>
</td>
</table>
<a name="DESCRIPTION"></a>
<h2>DESCRIPTION</h2>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td>
<td width="89%">
<p><i>Ctl_mboxlist</i> is used to perform various
administrative operations on the mailbox list database.</p>
<!-- INDENTATION -->
<p><i>Ctl_mboxlist</i> reads its configuration options out
of the <i>imapd.conf</i>(5) file unless specified otherwise
by <b>-C</b>. The <i>configdirectory</i> option is used to
determine the default location of the mailbox list
database.</p>
</td>
</table>
<a name="OPTIONS"></a>
<h2>OPTIONS</h2>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td>
<td width="89%">
<p><b>−C</b> <i>config-file</i></p></td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="21%"></td>
<td width="77%">
<p>Read configuration options from <i>config-file</i>.</p>
</td>
</table>
<!-- TABS -->
<table width="100%" border=0 rules="none" frame="void"
cols="4" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="13%"></td>
<td width="2%">
<p><b>−d</b></p>
</td>
<td width="5%"></td>
<td width="77%">
<p>Dump the contents of the database to standard output in
a portable flat-text format. NOTE: In Cyrus versions 2.2.13
and earlier, the dump format did not include the mailbox
type flags, breaking remote mailboxes (frontends, mupdate
master, unified backends) when undumped.</p>
</td>
<tr valign="top" align="left">
<td width="13%"></td>
<td width="2%">
<p><b>−x</b></p>
</td>
<td width="5%"></td>
<td width="77%">
<p>When performing a dump, remove the mailboxes dumped from
the mailbox list (mostly useful when specified with -p)</p>
</td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td>
<td width="89%">
<p><b>−p</b> <i>partition</i></p></td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="21%"></td>
<td width="77%">
<p>When performing a dump, dump only thise mailboxes that
live on <i>partition</i></p>
</td>
</table>
<!-- TABS -->
<table width="100%" border=0 rules="none" frame="void"
cols="4" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="4%">
<p><b>−u</b></p>
</td>
<td width="5%"></td>
<td width="77%">
<p>Load the contents of the database from standard input.
The input MUST be in the format output using the
<b>−d</b> option. NOTE: Both the old and new formats
can be loaded, but the old format will break remote
mailboxes.</p>
</td>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="4%">
<p><b>−m</b></p>
</td>
<td width="5%"></td>
<td width="77%">
<p>For backend servers in the Cyrus Murder, synchronize the
local mailbox list file with the MUPDATE server.</p>
</td>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="4%">
<p><b>−a</b></p>
</td>
<td width="5%"></td>
<td width="77%">
<p>When used with -m, assume the local mailboxes file is
authoritiative, that is, only change the mupdate server, do
not delete any local mailboxes. USE THIS OPTION WITH CARE,
as it allows namespace collisions into the murder.</p>
</td>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="4%">
<p><b>−w</b></p>
</td>
<td width="5%"></td>
<td width="77%">
<p>When used with -m, print out what would be done but do
not perform the operations.</p>
</td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td>
<td width="89%">
<p><b>−f</b> <i>filename</i></p></td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="21%"></td>
<td width="77%">
<p>Use the database specified by <i>filename</i> instead of
the default
(<i>configdirectory</i><b>/mailboxes.db</b>).</p>
</td>
</table>
<a name="FILES"></a>
<h2>FILES</h2>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td>
<td width="89%">
<p><b>/etc/imapd.conf</b></p></td>
</table>
<a name="SEE ALSO"></a>
<h2>SEE ALSO</h2>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td>
<td width="89%">
<p><b>imapd.conf(5)</b>, <b>master(8)</b></p>
</td>
</table>
<hr>
</body>
</html>