2 commits - doc/kolab.1

[Jeroen van Meeuwen]

 doc/kolab.1 |   56 ++++++++++++++++++++++++++------------------------------
 1 file changed, 26 insertions(+), 30 deletions(-)

New commits:
commit ab379e09038f7af4e3ff08a56aec595884da4551
Author: Jeroen van Meeuwen (Kolab Systems) <vanmeeuwen at kolabsys.com>
Date:   Sun Nov 4 21:19:09 2012 +0000

    More layout enhancements

diff --git a/doc/kolab.1 b/doc/kolab.1
index cec5485..5a2f594 100644
--- a/doc/kolab.1
+++ b/doc/kolab.1
@@ -120,7 +120,8 @@ No environment variables impact the operations of
 .BI "acl-cleanup " "aci-subject"
 
 Clean up ACLs on mailboxes and mailfolders that refer to the ACI subject
-.IR aci-subject .
+.I aci-subject
+in any of the ACEs.
 
 .\" .TP
 .\" .BI "add-domain "
@@ -135,7 +136,7 @@ Clean up ACLs on mailboxes and mailfolders that refer to the ACI subject
 .\" Add a user
 .\" 
 .TP
-.BI "add-user-subscription" " " "[" "user" "" " " "[" pattern "]]"
+.BI "add-user-subscription " "user pattern"
 
 Subscribe
 .I user
@@ -152,8 +153,7 @@ Create a mailbox
 .I path
 set to
 .IR value ].
-
-.HP
+.PP
 .RS
 Valid metadata paths depend on the deployment. Metadata paths are prefixed by a METADATA namespace. See EXAMPLES for usage examples.
 .RE
@@ -277,8 +277,7 @@ on mailboxes matching
 .I pattern
 to
 .IR access-rights .
-
-.HP
+.PP
 .RS
 Should an ACE for
 .I aci-subject
@@ -297,8 +296,7 @@ Set the language for user
 .I user
 [to
 .IR language ].
-
-.HP
+.PP
 .RS
 .I language
 should be a language identifier such as 'en_US', or 'de_CH'.
@@ -329,8 +327,7 @@ Manually transfer
 .I mailbox
 to IMAP server
 .IR imap-server .
-
-.HP
+.PP
 .RS
 In a Cyrus IMAP Murder environment, using LDAP attribute value 'mailHost', transfers a mailbox from one IMAP server to another IMAP server. The client that runs
 .BR kolab (1)
@@ -349,8 +346,7 @@ Undelete mailbox
 .I mailbox
 [to target mailbox
 .IR target-mailbox ].
-
-.HP
+.PP
 .RS
 Undeletes (restores) the previously deleted mailbox
 .I mailbox
@@ -382,8 +378,7 @@ includes a set of sub-commands for Sieve script management.
 
 List the Sieve scripts for user
 .IR user .
-
-.HP
+.PP
 .RS
 Lists the names of the Sieve scripts for user
 .IR user ,
@@ -429,14 +424,14 @@ Patterns matching mailboxes currently accept two wildcard types:
 
 .TP
 .B "%"
-.HP
+.PP
 .RS
 Used to match one level of folders.
 .RE
 
 .TP
 .B "*"
-.HP
+.PP
 .RS
 Used to match all (sub-)levels of folders.
 .RE
@@ -452,8 +447,7 @@ Subscribe user john.doe at example.org to all mailboxes in the shared namespace:
 Create a new calendar folder "Private Calendar" for user john.doe at example.org:
 
 .B kolab create-mailbox --metadata=/shared/vendor/kolab/folder-type,event 'user/john.doe/Private Calendar at example.org'
-
-.HP
+.PP
 .RS
 .BR NOTE :
 The
@@ -481,7 +475,7 @@ List top-level mailboxes outside any particular authorization realm:
 List mailboxes for user john.doe at example.org:
 
 .B "kolab list-mailboxes user/john.doe/*@example.org"
-
+.PP
 .RS
 .BR NOTE :
 The mailbox user/john.doe at example.org itself is not included in the output for this example command.
@@ -490,15 +484,19 @@ The mailbox user/john.doe at example.org itself is not included in the output for t
 .SH DIAGNOSTICS
 
 .SH ADDITIONAL READING
+
 Additional documentation for Kolab Groupware is available on https://docs.kolab.org
 
 .SH BUGS
+
 You are kindly requested to log bugs against
 .B pykolab
 in https://issues.kolab.org
 
 .SH AUTHOR
+
 Jeroen van Meeuwen (Kolab Systems) <vanmeeuwen at kolabsys.com>
 
 .SH SEE ALSO
-.B kolab.conf(5)
+
+.BR kolab.conf (5),


commit cdb7f565452d607a9e3efc13fc0b3edb527ec198
Author: Jeroen van Meeuwen (Kolab Systems) <vanmeeuwen at kolabsys.com>
Date:   Sun Nov 4 19:41:48 2012 +0000

    Minor layout adjustments

diff --git a/doc/kolab.1 b/doc/kolab.1
index 5b5cfdb..cec5485 100644
--- a/doc/kolab.1
+++ b/doc/kolab.1
@@ -1,4 +1,4 @@
-.TH kolab 1 "November 4, 2012" "version 0.6" "USER COMMANDS"
+.TH kolab 1 "November 4, 2012" "pykolab 0.6" "USER COMMANDS"
 
 .SH NAME
 kolab \- command-line utility to interact with Kolab Groupware and Cyrus IMAP
@@ -34,7 +34,7 @@ and authorize itself as the user before issuing the LSUB command.
 .SH OPTIONS
 
 .TP
-.BI "\-c " "config-file"
+.BI "-c " "config-file"
 
 Use
 .I config-file
@@ -42,12 +42,11 @@ instead of the system-wide configuration file
 .IR /etc/kolab/kolab.conf .
 
 .TP
-.BI "\-d " "debug-level"
+.BI "-d " "debug-level"
 
 Set the debug level to
 .IR debug-level .
 The default is 0.
-
 .HP
 .RS
 Trace
@@ -59,19 +58,18 @@ to perform protocol tracing (on IMAP, HTTP, LDAP, SMTP, LMTP, MANAGESIEVE and ot
 .RE
 
 .TP
-.BI "\-h, \-\-help"
+.BI "-h, --help"
 
 Display a short help on usage, including commands and a brief description for each.
 
 .TP
-.BI "\-l, \-\-loglevel " "log-level"
+.BI "-l, --loglevel " "log-level"
 
 Set the
 .BR kolab (1)
 log level to
 .I log-level
 Valid log-levels include DEBUG, INFO, WARN, ERR, CRIT, EMERG.
-
 .HP
 .RS
 .BR NOTE :
@@ -79,12 +77,12 @@ Setting the debug level to non-zero implies setting a log level of DEBUG.
 .RE
 
 .TP
-.BI "\-q, \-\-quiet"
+.BI "-q, --quiet"
 
 Be quiet \- suppresses output like headers for columns
 
 .TP
-.BI "\-y, \-\-yes"
+.BI "-y, --yes"
 
 Answer yes to all questions (that ask for confirmation).
 
@@ -146,7 +144,7 @@ to the mailboxes matching
 See PATTERNS for more information on pattern matching.
 
 .TP
-.BI "cm, create-mailbox [" "\-\-metadata=path,value" "] " mailbox
+.BI "cm, create-mailbox [" "--metadata=path,value" "] " mailbox
 
 Create a mailbox
 .I mailbox