[CalendarServer-changes] [8521] CalendarServer/trunk/doc
source_changes at macosforge.org
source_changes at macosforge.org
Fri Jan 13 11:55:52 PST 2012
Revision: 8521
http://trac.macosforge.org/projects/calendarserver/changeset/8521
Author: wsanchez at apple.com
Date: 2012-01-13 11:55:50 -0800 (Fri, 13 Jan 2012)
Log Message:
-----------
cosmetic
Modified Paths:
--------------
CalendarServer/trunk/doc/caldavd.8
CalendarServer/trunk/doc/calendarserver_bootstrap_database.8
CalendarServer/trunk/doc/calendarserver_command_gateway.8
CalendarServer/trunk/doc/calendarserver_export.8
CalendarServer/trunk/doc/calendarserver_manage_principals.8
CalendarServer/trunk/doc/calendarserver_migrate_resources.8
CalendarServer/trunk/doc/calendarserver_monitor_notifications.8
CalendarServer/trunk/doc/calendarserver_purge_attachments.8
CalendarServer/trunk/doc/calendarserver_purge_events.8
CalendarServer/trunk/doc/calendarserver_purge_principals.8
Modified: CalendarServer/trunk/doc/caldavd.8
===================================================================
--- CalendarServer/trunk/doc/caldavd.8 2012-01-13 19:41:56 UTC (rev 8520)
+++ CalendarServer/trunk/doc/caldavd.8 2012-01-13 19:55:50 UTC (rev 8521)
@@ -1,5 +1,5 @@
.\"
-.\" Copyright (c) 2006-2008 Apple Inc. All rights reserved.
+.\" Copyright (c) 2006-2012 Apple 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.
@@ -19,7 +19,7 @@
.Os
.Sh NAME
.Nm caldavd
-.Nd Darwin Calendar Server Control Interface
+.Nd Calendar Server Control Interface
.Sh SYNOPSIS
.Nm
.Op Fl hX
@@ -30,9 +30,9 @@
.Op Fl f Ar caldavd.plist
.Sh DESCRIPTION
.Nm
-is a front end to the Darwin Calendar Server. The Darwin Calendar
-Server is provides a calendaring service based on the CalDAV protocol,
-which is in turn based on HTTP and WebDAV.
+is a front end to the Calendar Server. Calendar Server is provides a
+calendaring service based on the CalDAV protocol, which is in turn
+based on HTTP and WebDAV.
.Pp
.Nm
is a simple tool for starting the server.
@@ -43,7 +43,8 @@
.It Fl X
Starts the server but does not daemonize it.
.It Fl L
-Sends error logging output to stdout rather than the file specified in caldavd.plist.
+Sends error logging output to stdout rather than the file specified in
+caldavd.plist.
.It Fl u Ar username
Drops privileges to the given username.
.It Fl g Ar groupname
@@ -72,12 +73,11 @@
.Sh SEE ALSO
.Xr httpd 8
.Sh STANDARDS
-Darwin Calendar Server is intended to comply with RFC 2445
-(iCalendar), RFC 2446 (iTIP), RFC 2447 (iMIP), RFC 2612 (HTTP), RFC
-2617 (HTTP Authentication), RFC 4559 (SPNEGO), RFC 2518 (WebDAV), RFC
-3744 (WebDAV ACL), RFC 5397 (WebDAV Current Principal Extension), RFC
-4791 (CalDAV), and draft-desruisseaux-caldav-sched-06 (CalDAV
-Scheduling).
+Calendar Server is intended to comply with RFC 2445 (iCalendar), RFC
+2446 (iTIP), RFC 2447 (iMIP), RFC 2612 (HTTP), RFC 2617 (HTTP
+Authentication), RFC 4559 (SPNEGO), RFC 2518 (WebDAV), RFC 3744
+(WebDAV ACL), RFC 5397 (WebDAV Current Principal Extension), RFC 4791
+(CalDAV), and draft-desruisseaux-caldav-sched-06 (CalDAV Scheduling).
.Sh HISTORY
.Nm
-was first introduced as part of Darwin 9 and Mac OS 10.5.
+was first introduced as part of Mac OS X Server 10.5.
Modified: CalendarServer/trunk/doc/calendarserver_bootstrap_database.8
===================================================================
--- CalendarServer/trunk/doc/calendarserver_bootstrap_database.8 2012-01-13 19:41:56 UTC (rev 8520)
+++ CalendarServer/trunk/doc/calendarserver_bootstrap_database.8 2012-01-13 19:55:50 UTC (rev 8521)
@@ -1,5 +1,5 @@
.\"
-.\" Copyright (c) 2011 Apple Inc. All rights reserved.
+.\" Copyright (c) 2011-2012 Apple 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.
@@ -19,14 +19,15 @@
.Os
.Sh NAME
.Nm calendarserver_bootstrap_database
-.Nd Darwin Calendar Server database bootstrap utility
+.Nd Calendar Server database bootstrap utility
.Sh SYNOPSIS
.Nm
.Op Fl -verbose
.Op Fl -help
.Sh DESCRIPTION
.Nm
-is a tool which creates the Postgres user Calendar Server will use to connect, creates a database, and installs the schema.
+is a tool which creates the Postgres user Calendar Server will use to
+connect, creates a database, and installs the schema.
.Pp
.Nm
should be run as root.
Modified: CalendarServer/trunk/doc/calendarserver_command_gateway.8
===================================================================
--- CalendarServer/trunk/doc/calendarserver_command_gateway.8 2012-01-13 19:41:56 UTC (rev 8520)
+++ CalendarServer/trunk/doc/calendarserver_command_gateway.8 2012-01-13 19:55:50 UTC (rev 8521)
@@ -1,5 +1,5 @@
.\"
-.\" Copyright (c) 2006-2010 Apple Inc. All rights reserved.
+.\" Copyright (c) 2006-2012 Apple 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.
@@ -19,22 +19,23 @@
.Os
.Sh NAME
.Nm calendarserver_command_gateway
-.Nd Darwin Calendar Server Manager Gateway
+.Nd Calendar Server manager gateway
.Sh SYNOPSIS
.Nm
.Op Fl -config Ar file
.Sh DESCRIPTION
.Nm
-is a gateway between Apple OS X Server Admin and the calendar server, and is not
-meant to be run by end users. It processes commands in plist form from stdin
-and writes results in plist form to stdout.
+is a gateway between Apple OS X Server Admin and the calendar server,
+and is not meant to be run by end users. It processes commands in
+plist form from stdin and writes results in plist form to stdout.
.Pp
.Sh OPTIONS
.Bl -tag -width flag
.It Fl h, -help
Displays usage information
.It Fl f, -config Ar FILE
-Use the Calendar Server configuration specified in the given file. Defaults to /etc/caldavd/caldavd.plist.
+Use the Calendar Server configuration specified in the given file.
+Defaults to /etc/caldavd/caldavd.plist.
.El
.Pp
.Sh FILES
Modified: CalendarServer/trunk/doc/calendarserver_export.8
===================================================================
--- CalendarServer/trunk/doc/calendarserver_export.8 2012-01-13 19:41:56 UTC (rev 8520)
+++ CalendarServer/trunk/doc/calendarserver_export.8 2012-01-13 19:55:50 UTC (rev 8521)
@@ -1,5 +1,5 @@
.\"
-.\" Copyright (c) 2006-2008 Apple Inc. All rights reserved.
+.\" Copyright (c) 2006-2012 Apple 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.
@@ -19,7 +19,7 @@
.Os
.Sh NAME
.Nm calendarserver_export
-.Nd Darwin Calendar Server Export Tool
+.Nd Calendar Server export tool
.Sh SYNOPSIS
.Nm
.Op Fl f Ar config_file
@@ -32,7 +32,7 @@
.Nm
is a tool that generates a single iCalendar file containing all of the
iCalendar components found from all specified input sources, providing
-server administrators a means by which to export data from the Darwin
+server administrators a means by which to export data from the
Calandar Server into a format that can be viewed and/or manipulated by
other tools. Multiple input sources may be specified; the resulting
iCalendar data will contain the combined data from all sources.
Modified: CalendarServer/trunk/doc/calendarserver_manage_principals.8
===================================================================
--- CalendarServer/trunk/doc/calendarserver_manage_principals.8 2012-01-13 19:41:56 UTC (rev 8520)
+++ CalendarServer/trunk/doc/calendarserver_manage_principals.8 2012-01-13 19:55:50 UTC (rev 8521)
@@ -1,5 +1,5 @@
.\"
-.\" Copyright (c) 2006-2009 Apple Inc. All rights reserved.
+.\" Copyright (c) 2006-2012 Apple 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.
@@ -19,7 +19,7 @@
.Os
.Sh NAME
.Nm calendarserver_manage_principals
-.Nd Darwin Calendar Server principal management utility
+.Nd Calendar Server principal management utility
.Sh SYNOPSIS
.Nm
.Op Fl -config Ar file
@@ -43,9 +43,9 @@
.Sh DESCRIPTION
.Nm
is a tool for accessing and manipulating information regarding
-principals on a Darwin Calendar Server. Principals represent any form
-of actor that can access the server, such as users, groups, locations
-and resources.
+principals on a Calendar Server. Principals represent any form of
+actor that can access the server, such as users, groups, locations and
+resources.
.Pp
.Nm
should be run as a user with the same priviledges as the Calendar
@@ -80,7 +80,8 @@
.It Fl v, -verbose
Displays debugging information
.It Fl f, -config Ar FILE
-Use the Calendar Server configuration specified in the given file. Defaults to /etc/caldavd/caldavd.plist.
+Use the Calendar Server configuration specified in the given file.
+Defaults to /etc/caldavd/caldavd.plist.
.El
.Sh ACTIONS
.Bl -tag -width flag
@@ -96,7 +97,8 @@
.It Fl -list-principals Ar type
List all of the principals of the given type.
.It Fl -search Ar search-string
-Search for principals whose name or email address contains the search string.
+Search for principals whose name or email address contains the search
+string.
.It Fl -list-read-proxies
List the read proxies.
.It Fl -list-write-proxies
@@ -120,10 +122,13 @@
.It Fl -get-auto-schedule
Get the automatic scheduling state.
.It Fl -add Ar locations|resources full-name [record-name] [GUID]
-Add a new location or resource. Record name and GUID are optional. If GUID is not specified, one will be generated. If record name is not specified, the record name will be set to the GUID.
+Add a new location or resource. Record name and GUID are optional. If
+GUID is not specified, one will be generated. If record name is not
+specified, the record name will be set to the GUID.
.El
.Sh EXAMPLES
-Add Alice and Bob as read proxies for Joe and display the list of Joe's proxies:
+Add Alice and Bob as read proxies for Joe and display the list of
+Joe's proxies:
.Pp
.Dl "calendarserver_manage_principals --add-read-proxy users:alice --add-read-proxy users:bob --list-proxies users:joe"
.Pp
Modified: CalendarServer/trunk/doc/calendarserver_migrate_resources.8
===================================================================
--- CalendarServer/trunk/doc/calendarserver_migrate_resources.8 2012-01-13 19:41:56 UTC (rev 8520)
+++ CalendarServer/trunk/doc/calendarserver_migrate_resources.8 2012-01-13 19:55:50 UTC (rev 8521)
@@ -1,5 +1,5 @@
.\"
-.\" Copyright (c) 2006-2010 Apple Inc. All rights reserved.
+.\" Copyright (c) 2006-2012 Apple 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.
@@ -19,7 +19,7 @@
.Os
.Sh NAME
.Nm calendarserver_migrate_resources
-.Nd Darwin Calendar Server resource and location migration utility
+.Nd Calendar Server resource and location migration utility
.Sh SYNOPSIS
.Nm
.Op Fl -config Ar file
@@ -27,7 +27,8 @@
.Op Fl -help
.Sh DESCRIPTION
.Nm
-is a tool for migrating resource and location records from OpenDirectory into the calendar server's internal directory.
+is a tool for migrating resource and location records from
+OpenDirectory into the calendar server's internal directory.
.Pp
.Nm
should be run as a user with the same priviledges as the Calendar
@@ -38,9 +39,11 @@
.It Fl h, -help
Display usage information
.It Fl f, -config Ar FILE
-Use the Calendar Server configuration specified in the given file. Defaults to /etc/caldavd/caldavd.plist.
+Use the Calendar Server configuration specified in the given file.
+Defaults to /etc/caldavd/caldavd.plist.
.It Fl v, -verbose
-Print progress information including the names of resources and locations being migrated.
+Print progress information including the names of resources and
+locations being migrated.
.El
.Sh FILES
.Bl -tag -width flag
Modified: CalendarServer/trunk/doc/calendarserver_monitor_notifications.8
===================================================================
--- CalendarServer/trunk/doc/calendarserver_monitor_notifications.8 2012-01-13 19:41:56 UTC (rev 8520)
+++ CalendarServer/trunk/doc/calendarserver_monitor_notifications.8 2012-01-13 19:55:50 UTC (rev 8521)
@@ -1,5 +1,5 @@
.\"
-.\" Copyright (c) 2011 Apple Inc. All rights reserved.
+.\" Copyright (c) 2012 Apple 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.
@@ -19,7 +19,7 @@
.Os
.Sh NAME
.Nm calendarserver_monitor_notifications
-.Nd Darwin Calendar Server push notification monitor
+.Nd Calendar Server push notification monitor
.Sh SYNOPSIS
.Nm
.Op Fl -admin Ar username
@@ -33,7 +33,14 @@
.Ar username
.Sh DESCRIPTION
.Nm
-is a tool for making sure XMPP push notifications are working properly. Given a username and password it will connect to the calendar server and determine which pubsub node(s) correspond to that user's calendar home, as well as those of any user which has delegated calendar access. Next it will subscribe to those nodes and await notifications, printing them to stdout. An administrator can monitor the push notifications for another user by passing the --admin option. Exit by hitting Control-C.
+is a tool for making sure XMPP push notifications are working
+properly. Given a username and password it will connect to the
+calendar server and determine which pubsub node(s) correspond to that
+user's calendar home, as well as those of any user which has delegated
+calendar access. Next it will subscribe to those nodes and await
+notifications, printing them to stdout. An administrator can monitor
+the push notifications for another user by passing the --admin option.
+Exit by hitting Control-C.
.Pp
.Sh OPTIONS
.Bl -tag -width flag
@@ -42,13 +49,19 @@
.It Fl h, -help
Display usage information.
.It Fl f, -config Ar FILE
-Use the Calendar Server configuration specified in the given file. Defaults to /etc/caldavd/caldavd.plist.
+Use the Calendar Server configuration specified in the given file.
+Defaults to /etc/caldavd/caldavd.plist.
.It Fl H, -host Ar HOSTNAME
-Connect to the specified calendar server. If not passed on the command line, the host name is looked up in the configuration file.
+Connect to the specified calendar server. If not passed on the
+command line, the host name is looked up in the configuration file.
.It Fl n, -node Ar NODENAME
-Bypass the auto-discovery of pubsub nodes and specify one explicitly. Useful on calendar servers which don't support the push-transports DAV property. When using this option, the host and port options instead refer to the XMPP server host and port numbers.
+Bypass the auto-discovery of pubsub nodes and specify one explicitly.
+Useful on calendar servers which don't support the push-transports DAV
+property. When using this option, the host and port options instead
+refer to the XMPP server host and port numbers.
.It Fl p, -port Ar NUMBER
-Connect to the specified port number. If not passed on the command line, the port number is looked up in the configuration file.
+Connect to the specified port number. If not passed on the command
+line, the port number is looked up in the configuration file.
.It Fl s, -ssl
Use https to connect to calendar server (default is http).
.It Fl v, -verbose
Modified: CalendarServer/trunk/doc/calendarserver_purge_attachments.8
===================================================================
--- CalendarServer/trunk/doc/calendarserver_purge_attachments.8 2012-01-13 19:41:56 UTC (rev 8520)
+++ CalendarServer/trunk/doc/calendarserver_purge_attachments.8 2012-01-13 19:55:50 UTC (rev 8521)
@@ -1,5 +1,5 @@
.\"
-.\" Copyright (c) 2006-2011 Apple Inc. All rights reserved.
+.\" Copyright (c) 2006-2012 Apple 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.
@@ -19,7 +19,7 @@
.Os
.Sh NAME
.Nm calendarserver_purge_attachments
-.Nd Darwin Calendar Server orphaned attachments clean-up utility
+.Nd Calendar Server orphaned attachments clean-up utility
.Sh SYNOPSIS
.Nm
.Op Fl -config Ar file
@@ -28,7 +28,8 @@
.Op Fl -help
.Sh DESCRIPTION
.Nm
-is a tool for removing attachments that are no longer referenced by any calendar events.
+is a tool for removing attachments that are no longer referenced by
+any calendar events.
.Pp
.Nm
should be run as a user with the same priviledges as the Calendar
@@ -39,9 +40,11 @@
.It Fl h, -help
Display usage information
.It Fl f, -config Ar FILE
-Use the Calendar Server configuration specified in the given file. Defaults to /etc/caldavd/caldavd.plist.
+Use the Calendar Server configuration specified in the given file.
+Defaults to /etc/caldavd/caldavd.plist.
.It Fl n, -dry-run
-Calculate and display how many orphaned attachments would be removed, but don't actually remove them.
+Calculate and display how many orphaned attachments would be removed,
+but don't actually remove them.
.It Fl v, -verbose
Print progress information.
.El
Modified: CalendarServer/trunk/doc/calendarserver_purge_events.8
===================================================================
--- CalendarServer/trunk/doc/calendarserver_purge_events.8 2012-01-13 19:41:56 UTC (rev 8520)
+++ CalendarServer/trunk/doc/calendarserver_purge_events.8 2012-01-13 19:55:50 UTC (rev 8521)
@@ -1,5 +1,5 @@
.\"
-.\" Copyright (c) 2006-2010 Apple Inc. All rights reserved.
+.\" Copyright (c) 2006-2012 Apple 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.
@@ -19,7 +19,7 @@
.Os
.Sh NAME
.Nm calendarserver_purge_events
-.Nd Darwin Calendar Server event clean-up utility
+.Nd Calendar Server event clean-up utility
.Sh SYNOPSIS
.Nm
.Op Fl -config Ar file
@@ -29,7 +29,11 @@
.Op Fl -help
.Sh DESCRIPTION
.Nm
-is a tool for removing old events from the calendar server. By default, events older than 365 days are removed, but the user can specify the number of days in the past to use as a cut-off. Repeating events that have any occurrences after the cut-off day are not removed.
+is a tool for removing old events from the calendar server. By
+default, events older than 365 days are removed, but the user can
+specify the number of days in the past to use as a cut-off. Repeating
+events that have any occurrences after the cut-off day are not
+removed.
.Pp
.Nm
should be run as a user with the same priviledges as the Calendar
@@ -40,11 +44,13 @@
.It Fl h, -help
Display usage information
.It Fl f, -config Ar FILE
-Use the Calendar Server configuration specified in the given file. Defaults to /etc/caldavd/caldavd.plist.
+Use the Calendar Server configuration specified in the given file.
+Defaults to /etc/caldavd/caldavd.plist.
.It Fl d, -days Ar NUMBER
Specify how many days in the past to retain. Defaults to 365 days.
.It Fl n, -dry-run
-Calculate and display how many events would be removed, but don't actually remove them.
+Calculate and display how many events would be removed, but don't
+actually remove them.
.It Fl v, -verbose
Print progress information.
.El
Modified: CalendarServer/trunk/doc/calendarserver_purge_principals.8
===================================================================
--- CalendarServer/trunk/doc/calendarserver_purge_principals.8 2012-01-13 19:41:56 UTC (rev 8520)
+++ CalendarServer/trunk/doc/calendarserver_purge_principals.8 2012-01-13 19:55:50 UTC (rev 8521)
@@ -1,5 +1,5 @@
.\"
-.\" Copyright (c) 2006-2010 Apple Inc. All rights reserved.
+.\" Copyright (c) 2006-2012 Apple 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.
@@ -19,7 +19,7 @@
.Os
.Sh NAME
.Nm calendarserver_purge_principals
-.Nd Darwin Calendar Server deprovisioned user clean-up utility
+.Nd Calendar Server deprovisioned user clean-up utility
.Sh SYNOPSIS
.Nm
.Op Fl -completely
@@ -31,7 +31,9 @@
.Op guid ...
.Sh DESCRIPTION
.Nm
-is a tool for removing one or more principals' future events, proxy assignments, and contacts from the calendar server. By default, events in the past are retained, but any ongoing events are canceled.
+is a tool for removing one or more principals' future events, proxy
+assignments, and contacts from the calendar server. By default,
+events in the past are retained, but any ongoing events are canceled.
.Pp
.Nm
should be run as a user with the same priviledges as the Calendar
@@ -44,9 +46,11 @@
.It Fl c, -completely
Delete/cancel all events
.It Fl f, -config Ar FILE
-Use the Calendar Server configuration specified in the given file. Defaults to /etc/caldavd/caldavd.plist.
+Use the Calendar Server configuration specified in the given file.
+Defaults to /etc/caldavd/caldavd.plist.
.It Fl n, -dry-run
-Calculate and display how many events and contacts would be removed, but don't actually remove them.
+Calculate and display how many events and contacts would be removed,
+but don't actually remove them.
.It Fl v, -verbose
Print progress information.
.El
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.macosforge.org/pipermail/calendarserver-changes/attachments/20120113/854d8b6d/attachment-0001.html>
More information about the calendarserver-changes
mailing list