<html>
<head>
<meta content="text/html; charset=ISO-8859-1"
http-equiv="Content-Type">
</head>
<body bgcolor="#FFFFFF" text="#000000">
On 05/13/2015 04:33 AM, Bron Gondwana wrote:<br>
<blockquote
cite="mid:1431509619.832983.267538249.218210C4@webmail.messagingengine.com"
type="cite">
<title></title>
<div>Doxygen would be fine.<br>
</div>
<div> </div>
<div> </div>
<div>On Wed, May 13, 2015, at 09:24 AM, Chris Davies wrote:<br>
</div>
<blockquote type="cite">
<div>Adding the Cyrus mailing list as I can't remember who the
other documentation person is.<br>
</div>
<div> </div>
<div>Do you think something like <a moz-do-not-send="true"
href="http://www.stack.nl/%7Edimitri/doxygen/index.html">Doxygen</a>
would be of use for the Cyrus project? it can generate HTML
docs and man pages.<br>
</div>
<div>I haven't downloaded it yet but it claims to do what we
need.<br>
</div>
</blockquote>
</blockquote>
<br>
Chris,<br>
The current documentation, in the cyrus-docs branch, is in <a
href="http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html">reStructured
Text</a>. <br>
<br>
There's a page up on the wiki which describes what I have used to
get up and working with this existing collection of files:<br>
<a class="moz-txt-link-freetext" href="https://git.cyrus.foundation/w/documentation_desktop_tools/">https://git.cyrus.foundation/w/documentation_desktop_tools/</a><br>
<br>
<blockquote
cite="mid:1431509619.832983.267538249.218210C4@webmail.messagingengine.com"
type="cite">
<blockquote type="cite">
<div>On Wed, 13 May 2015, at 05:08 PM, Chris Davies wrote:<br>
</div>
<blockquote type="cite">
<div>Just trying to figure out how Cyrus works and exploring
the admin tools:<br>
</div>
<blockquote>
<div> </div>
<div><a moz-do-not-send="true"
href="https://docs.cyrus.foundation/imap/admin.html">https://docs.cyrus.foundation/imap/admin.html</a>
<br>
</div>
<div> </div>
<div>"The ctl_deliver program outputs a list of files and/or
directories that it expects to exist, but that in fact do
not."<br>
</div>
<div> </div>
<div>"The ctl_mboxlist program outputs a list of files
and/or directories that it expects to exist, but that in
fact do not."<br>
</div>
<div> </div>
<div>"The cvt_cyrusdb program outputs a list of files and/or
directories that it expects to exist, but that in fact do
not."<br>
</div>
<div> </div>
<div>"The cyr_dbtool program outputs a list of files and/or
directories that it expects to exist, but that in fact do
not."<br>
</div>
</blockquote>
</blockquote>
</blockquote>
<div> </div>
<div>Yeah, maybe not.<br>
</div>
</blockquote>
<br>
To be fair, these are all in the "Work-in-progress" section of the
page, which includes this disclaimer:<br>
<blockquote><b>For the following parts of the documentation, while
they are a work-in-
progress, you may already have better documentation on your
system, in
the form of actual man-pages.</b></blockquote>
We are in the process of fixing all of this. For example, a recent
commit, <a href="https://git.cyrus.foundation/D31">D31</a>, is
ready to land, and contains updates to the ctl_cyrusdb(8),
chk_cyrus(8) and unexpunge(8) man pages (these being in cyrus-imap
branch, in the /man/ directory).<br>
<br>
Another issue with which we're contending, and which was discussed
recently on IRC, is that there's two versions (at least) of some of
this stuff, in cyrus-docs/source/imap/admin/commands and in
cyrus-imap/man. I'm currently working to harmonize these two
versions so we can dump one or the other.<br>
<br>
One of the reasons to get access control working again on the old
site, <a class="moz-txt-link-abbreviated" href="http://www.cyrusimap.org">www.cyrusimap.org</a>, is to at least allow that to serve as an
intermediary resource until the new site gets up to snuff. All of
the commands you list, above, are fully documented here:<br>
<a class="moz-txt-link-freetext" href="http://www.cyrusimap.org/docs/cyrus-imapd/2.4.17/man.php">http://www.cyrusimap.org/docs/cyrus-imapd/2.4.17/man.php</a><br>
<br>
But, we know that the branches for newer releases (2.5*) there are
broken, so for now stick with the 2.4.17 until we can get the rest
fixed.<br>
<br>
Cheers,<br>
-nic (on IRC as 'onlight')<br>
<br>
<blockquote
cite="mid:1431509619.832983.267538249.218210C4@webmail.messagingengine.com"
type="cite">
<div> </div>
<blockquote type="cite">
<blockquote type="cite">
<div>
<div>Bron, Who was the other person working on
documentation?<br>
</div>
</div>
</blockquote>
</blockquote>
<div> </div>
<div>Simon Amor. Who is on this list I'm pretty sure. He's
^Simon^ in IRC.<br>
</div>
<div><br>
Bron.<br>
</div>
<div> </div>
<div id="sig567075">
<div class="signature">--<br>
</div>
<div class="signature">Bron Gondwana<br>
</div>
<div class="signature"><a class="moz-txt-link-abbreviated" href="mailto:brong@fastmail.fm">brong@fastmail.fm</a><br>
</div>
<div class="signature"> </div>
</div>
<div> </div>
</blockquote>
<br>
<pre class="moz-signature" cols="72">--
Nic Bernstein <a class="moz-txt-link-abbreviated" href="mailto:nic@onlight.com">nic@onlight.com</a>
Onlight, Inc. <a class="moz-txt-link-abbreviated" href="http://www.onlight.com">www.onlight.com</a>
1442 N Farwell Ave., Suite 600 v. 414.272.4477
Milwaukee, Wisconsin 53202
</pre>
</body>
</html>