[CalendarServer-changes] [901] CalendarServer/trunk/doc

[source_changes at macosforge.org]

Revision: 901
          http://trac.macosforge.org/projects/calendarserver/changeset/901
Author:   dreid at apple.com
Date:     2006-12-22 16:47:35 -0800 (Fri, 22 Dec 2006)

Log Message:
-----------
update the caldavd man page and add a man page for caladmin

Modified Paths:
--------------
    CalendarServer/trunk/doc/caldavd.8

Added Paths:
-----------
    CalendarServer/trunk/doc/caladmin.8

Added: CalendarServer/trunk/doc/caladmin.8
===================================================================
--- CalendarServer/trunk/doc/caladmin.8	                        (rev 0)
+++ CalendarServer/trunk/doc/caladmin.8	2006-12-23 00:47:35 UTC (rev 901)
@@ -0,0 +1,73 @@
+.\"
+.\" Copyright (c) 2006 Apple Computer, Inc. All rights reserved.
+.\"
+.\" Licensed under the Apache License, Version 2.0 (the "License");
+.\" you may not use this file except in compliance with the License.
+.\" You may obtain a copy of the License at
+.\"
+.\"     http://www.apache.org/licenses/LICENSE-2.0
+.\"
+.\" Unless required by applicable law or agreed to in writing, software
+.\" distributed under the License is distributed on an "AS IS" BASIS,
+.\" WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.\" See the License for the specific language governing permissions and
+.\" limitations under the License.
+.\"
+.\" DRI: David Reid, dreid at apple.com
+.\"
+.\" The following requests are required for all man pages.
+.Dd December 22, 2006
+.Dt CALADMIN 8
+.Os
+.Sh NAME
+.Nm caladmin
+.Nd Calendar Server Administrative Interface
+.Sh SYNOPSIS
+.Nm
+.Op Fl -c Ar caldavd.plist
+.Op Fl -f Ar format
+.Op Fl Ar -help
+.Op Fl -o Ar options
+.Ao Ar command Ac
+.Sh DESCRIPTION
+.Nm
+is an administrative tool for the Darwin Calendar Server.  It provides
+several types of statistics for the Calendar Server and some common 
+administrative operations.
+.Pp
+.Sh OPTIONS
+.Bl -tag -width flag
+.It Fl -help
+Display usage information.
+.It Fl c, Fl -config=
+Path to the configuration file for the server you wish to inspect or 
+manipulate.
+.It Fl f, Fl -format=
+The format you would like the output in.  Common formats are 'plain'
+and 'plist'.
+.It Fl o, Fl -option=
+Options for the formatter.
+.El
+.Sh COMMANDS
+.Bl -tag -width flag
+.It group
+.It user
+.It resource
+Each of these commands prints statistics for each user, group, or
+resource.  Statistics may include but are not limited to, quota and
+disk usage statistics.
+.It purge
+This can be used to keep your store from becoming unnecessarily large
+by deleting old events.
+.It stats
+Generate some overall usage statistics for the server.
+.It logs
+Analyze the log file to gather even more.
+.El
+.Sh HISTORY
+.Nm
+was first introduced as part of Darwin 9 and Mac OS 10.5.
+.Sh BUGS
+This version of
+.Nm
+is still in development and testing.

Modified: CalendarServer/trunk/doc/caldavd.8
===================================================================
--- CalendarServer/trunk/doc/caldavd.8	2006-12-22 23:16:05 UTC (rev 900)
+++ CalendarServer/trunk/doc/caldavd.8	2006-12-23 00:47:35 UTC (rev 901)
@@ -16,16 +16,19 @@
 .\" DRI: Wilfredo Sanchez, wsanchez at apple.com
 .\"
 .\" The following requests are required for all man pages.
-.Dd June 16, 2006
-.Dt CALDAVD 1
+.Dd December 22, 2006
+.Dt CALDAVD 8
 .Os
 .Sh NAME
 .Nm caldavd
 .Nd Calendar Server Control Interface
 .Sh SYNOPSIS
 .Nm
-.Op Fl v
-.Ar command
+.Op Fl hX 
+.Op Fl u Ar username
+.Op Fl g Ar groupname
+.Op Fl T Ar twistd
+.Op Fl f Ar caldavd.plist
 .Sh DESCRIPTION
 .Nm
 is a front end to the Darwin Calendar Server.  The Darwin Calendar
@@ -33,19 +36,21 @@
 and CalDAV protocols.
 .Pp
 .Nm
-is a simple tool for starting, stopping, and restarting the server. It
-takes a single argument, (
-.Ar command )
-which describes the desired action.
-.Sh COMMANDS
-The allows commands are:
+is a simple tool for starting the server.
+.Sh OPTIONS
 .Bl -tag -width flag
-.It Ar start
-Starts the server.
-.It Ar stop
-Stops the server.
-.It Ar restart
-Restarts the server.  If the server is not running, simply starts the server.
+.It Fl h
+Displays usage information
+.It Fl X
+Starts the server but does not daemonize it.
+.It Fl u Ar username
+Drops privileges to the given username.
+.It Fl g Ar groupname
+Drops privileges to the given groupname.
+.It Fl f Ar caldavd.plist
+Specifies the path of the configuration file to read.
+.It Fl T Ar twistd
+Specifies the path to the twistd binary.
 .El
 .Sh FILES
 .Bl -tag -width flag

-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.macosforge.org/pipermail/calendarserver-changes/attachments/20061222/2e0268b1/attachment.html