dovecot-2.2: man: Reworked some formatting requests.

dovecot at dovecot.org dovecot at dovecot.org
Sun Oct 19 19:34:22 UTC 2014


details:   http://hg.dovecot.org/dovecot-2.2/rev/dcfb0baba621
changeset: 17967:dcfb0baba621
user:      Pascal Volk <user at localhost.localdomain.org>
date:      Sun Oct 19 19:29:34 2014 +0000
description:
man: Reworked some formatting requests.

On some systems, for example SunOS 5.10, the example commands were cut off.

diffstat:

 doc/man/doveadm-altmove.1.in     |   8 +++++---
 doc/man/doveadm-auth.1.in        |   6 ++++--
 doc/man/doveadm-batch.1.in       |   8 +++++---
 doc/man/doveadm-deduplicate.1.in |  14 +++++++++-----
 doc/man/doveadm-expunge.1.in     |   8 +++++---
 doc/man/doveadm-flags.1.in       |  14 +++++++++-----
 doc/man/doveadm-mailbox.1.in     |  20 ++++++++++++++------
 doc/man/doveadm-move.1.in        |  10 ++++++----
 doc/man/doveadm-search.1.in      |  18 +++++++++++-------
 doc/man/doveadm-sync.1.in        |  16 +++++++++++-----
 doc/man/doveconf.1.in            |  28 ++++++++++++++++++++--------
 11 files changed, 99 insertions(+), 51 deletions(-)

diffs (truncated from 381 to 300 lines):

diff -r 086c70441f26 -r dcfb0baba621 doc/man/doveadm-altmove.1.in
--- a/doc/man/doveadm-altmove.1.in	Sun Oct 19 11:24:12 2014 -0700
+++ b/doc/man/doveadm-altmove.1.in	Sun Oct 19 19:29:34 2014 +0000
@@ -1,5 +1,5 @@
-.\" Copyright (c) 2010-2011 Dovecot authors, see the included COPYING file
-.TH DOVEADM\-ALTMOVE 1 "2011-09-15" "Dovecot v2.2" "Dovecot"
+.\" Copyright (c) 2010-2014 Dovecot authors, see the included COPYING file
+.TH DOVEADM\-ALTMOVE 1 "2014-10-19" "Dovecot v2.2" "Dovecot"
 .SH NAME
 doveadm\-altmove \- Move matching mails to the alternative storage (dbox\-only)
 .\"------------------------------------------------------------------------
@@ -81,7 +81,9 @@
 .fi
 .PP
 .nf
-.B doveadm altmove \-u johnd at example.com seen savedbefore 1w
+.ft B
+doveadm altmove \-u johnd at example.com seen savedbefore 1w
+.ft P
 .fi
 .\"------------------------------------------------------------------------
 @INCLUDE:reporting-bugs@
diff -r 086c70441f26 -r dcfb0baba621 doc/man/doveadm-auth.1.in
--- a/doc/man/doveadm-auth.1.in	Sun Oct 19 11:24:12 2014 -0700
+++ b/doc/man/doveadm-auth.1.in	Sun Oct 19 19:29:34 2014 +0000
@@ -1,5 +1,5 @@
 .\" Copyright (c) 2010-2014 Dovecot authors, see the included COPYING file
-.TH DOVEADM\-AUTH 1 "2014-08-30" "Dovecot v2.2" "Dovecot"
+.TH DOVEADM\-AUTH 1 "2014-10-19" "Dovecot v2.2" "Dovecot"
 .SH NAME
 doveadm\-auth \- Flush/lookup/test authentication data
 .\"------------------------------------------------------------------------
@@ -173,7 +173,9 @@
 192.0.2.143.
 .PP
 .nf
-.B doveadm auth test \-x service=imap \-x rip=192.0.2.143 john
+.ft B
+doveadm auth test \-x service=imap \-x rip=192.0.2.143 john
+.ft P
 Password:
 passdb: john auth succeeded
 extra fields:
diff -r 086c70441f26 -r dcfb0baba621 doc/man/doveadm-batch.1.in
--- a/doc/man/doveadm-batch.1.in	Sun Oct 19 11:24:12 2014 -0700
+++ b/doc/man/doveadm-batch.1.in	Sun Oct 19 19:29:34 2014 +0000
@@ -1,5 +1,5 @@
-.\" Copyright (c) 2013 Dovecot authors, see the included COPYING file
-.TH DOVEADM\-BATCH 1 "2013-11-17" "Dovecot v2.2" "Dovecot"
+.\" Copyright (c) 2013-2014 Dovecot authors, see the included COPYING file
+.TH DOVEADM\-BATCH 1 "2014-10-19" "Dovecot v2.2" "Dovecot"
 .SH NAME
 doveadm\-batch \- Execute multiple commands for multiple users
 .\"------------------------------------------------------------------------
@@ -79,7 +79,9 @@
 primary storage.
 .PP
 .nf
-.B doveadm batch \-u \(rs*@example.net : altmove seen savedbefore 30d : purge
+.ft B
+doveadm batch \-u \(rs*@example.net : altmove seen savedbefore 30d : purge
+.ft P
 .fi
 .\"------------------------------------------------------------------------
 @INCLUDE:reporting-bugs@
diff -r 086c70441f26 -r dcfb0baba621 doc/man/doveadm-deduplicate.1.in
--- a/doc/man/doveadm-deduplicate.1.in	Sun Oct 19 11:24:12 2014 -0700
+++ b/doc/man/doveadm-deduplicate.1.in	Sun Oct 19 19:29:34 2014 +0000
@@ -1,5 +1,5 @@
-.\" Copyright (c) 2013 Dovecot authors, see the included COPYING file
-.TH DOVEADM\-DEDUPLICATE 1 "2013-08-03" "Dovecot v2.2" "Dovecot"
+.\" Copyright (c) 2013-2014 Dovecot authors, see the included COPYING file
+.TH DOVEADM\-DEDUPLICATE 1 "2014-10-19" "Dovecot v2.2" "Dovecot"
 .SH NAME
 doveadm\-deduplicate \- expunge duplicate messages
 .\"------------------------------------------------------------------------
@@ -59,15 +59,19 @@
 mailbox.
 .sp
 .nf
-.B doveadm \-f table fetch \-u jane \(aqguid uid\(aq mailbox a_Box | sort
+.ft B
+doveadm \-f table fetch \-u jane \(aqguid uid\(aq mailbox a_Box | sort
+.ft P
 guid                             uid
 8aad0f0a30169f4bea620000ca356bad 18751
 8aad0f0a30169f4bea620000ca356bad 18756
 923e301ab9219b4b4f440000ca356bad 18748
 923e301ab9219b4b4f440000ca356bad 18753
 \&...
-.B doveadm deduplicate \-u jane mailbox a_Box
-.B doveadm \-f table fetch \-u jane \(aqguid uid\(aq mailbox a_Box | sort
+.ft B
+doveadm deduplicate \-u jane mailbox a_Box
+doveadm \-f table fetch \-u jane \(aqguid uid\(aq mailbox a_Box | sort
+.ft P
 guid                             uid
 8aad0f0a30169f4bea620000ca356bad 18751
 923e301ab9219b4b4f440000ca356bad 18748
diff -r 086c70441f26 -r dcfb0baba621 doc/man/doveadm-expunge.1.in
--- a/doc/man/doveadm-expunge.1.in	Sun Oct 19 11:24:12 2014 -0700
+++ b/doc/man/doveadm-expunge.1.in	Sun Oct 19 19:29:34 2014 +0000
@@ -1,5 +1,5 @@
-.\" Copyright (c) 2010-2013 Dovecot authors, see the included COPYING file
-.TH DOVEADM\-EXPUNGE 1 "2013-11-24" "Dovecot v2.2" "Dovecot"
+.\" Copyright (c) 2010-2014 Dovecot authors, see the included COPYING file
+.TH DOVEADM\-EXPUNGE 1 "2014-10-19" "Dovecot v2.2" "Dovecot"
 .SH NAME
 doveadm\-expunge \- Expunge messages matching given search query
 .\"------------------------------------------------------------------------
@@ -72,7 +72,9 @@
 there more than two weeks ago:
 .PP
 .nf
-.B doveadm expunge \-u jane.doe at example.org mailbox Spam savedbefore 2w
+.ft B
+doveadm expunge \-u jane.doe at example.org mailbox Spam savedbefore 2w
+.ft P
 .fi
 .\"------------------------------------------------------------------------
 @INCLUDE:reporting-bugs@
diff -r 086c70441f26 -r dcfb0baba621 doc/man/doveadm-flags.1.in
--- a/doc/man/doveadm-flags.1.in	Sun Oct 19 11:24:12 2014 -0700
+++ b/doc/man/doveadm-flags.1.in	Sun Oct 19 19:29:34 2014 +0000
@@ -1,5 +1,5 @@
-.\" Copyright (c) 2013 Dovecot authors, see the included COPYING file
-.TH DOVEADM\-FLAGS 1 "2013-08-02" "Dovecot v2.2" "Dovecot"
+.\" Copyright (c) 2013-2014 Dovecot authors, see the included COPYING file
+.TH DOVEADM\-FLAGS 1 "2014-10-19" "Dovecot v2.2" "Dovecot"
 .SH NAME
 doveadm\-flags \- add, remove or replace messages\(aq flags
 .\"------------------------------------------------------------------------
@@ -86,13 +86,17 @@
 List and manipulate the message flags of the message with uid 81563
 .sp
 .nf
-.B doveadm fetch \-u bob \(aquid flags\(aq mailbox dovecot uid 81563
+.ft B
+doveadm fetch \-u bob \(aquid flags\(aq mailbox dovecot uid 81563
+.ft P
 uid: 81563
 flags: \(rsAnswered \(rsSeen NonJunk
 
-.B doveadm flags \-u bob remove NonJunk mailbox dovecot uid 81563
-.B doveadm flags \-u bob add \(aq\(rsFlagged \(DoForwarded\(aq \
+.ft B
+doveadm flags \-u bob remove NonJunk mailbox dovecot uid 81563
+doveadm flags \-u bob add \(aq\(rsFlagged \(DoForwarded\(aq \
 mailbox dovecot uid 81563
+.ft P
 .fi
 .\"------------------------------------------------------------------------
 @INCLUDE:reporting-bugs@
diff -r 086c70441f26 -r dcfb0baba621 doc/man/doveadm-mailbox.1.in
--- a/doc/man/doveadm-mailbox.1.in	Sun Oct 19 11:24:12 2014 -0700
+++ b/doc/man/doveadm-mailbox.1.in	Sun Oct 19 19:29:34 2014 +0000
@@ -1,5 +1,5 @@
-.\" Copyright (c) 2010-2013 Dovecot authors, see the included COPYING file
-.TH DOVEADM\-MAILBOX 1 "2013-11-24" "Dovecot v2.2" "Dovecot"
+.\" Copyright (c) 2010-2014 Dovecot authors, see the included COPYING file
+.TH DOVEADM\-MAILBOX 1 "2014-10-19" "Dovecot v2.2" "Dovecot"
 .SH NAME
 doveadm\-mailbox \- Commands related to handling mailboxes
 .\"------------------------------------------------------------------------
@@ -260,7 +260,9 @@
 List subscribed mailboxes, beginning with \(aqdovecot\(aq, of user bob.
 .sp
 .nf
-.B doveadm mailbox list \-s \-u bob dovecot*
+.ft B
+doveadm mailbox list \-s \-u bob dovecot*
+.ft P
 dovecot
 dovecot/pigeonhole
 dovecot/pigeonhole/2.0
@@ -270,7 +272,9 @@
 Now have a look at the status of user bob\(aqs dovecot mailboxes.
 .sp
 .nf
-.B doveadm \-f table mailbox status \-u bob \(dqmessages vsize\(dq dovecot*
+.ft B
+doveadm \-f table mailbox status \-u bob \(dqmessages vsize\(dq dovecot*
+.ft P
 mailbox                                    messages vsize
 dovecot                                    20501    93968492
 dovecot/pigeonhole                         0        0
@@ -282,9 +286,13 @@
 vice versa.
 .sp
 .nf
-.B doveadm mailbox mutf7 \-7 \(dq~peter/mail/&U,BTFw\-/&ZeVnLIqe\-\(dq
+.ft B
+doveadm mailbox mutf7 \-7 \(dq~peter/mail/&U,BTFw\-/&ZeVnLIqe\-\(dq
+.ft P
 ~peter/mail/台北/日本語
-.B doveadm mailbox mutf7 ~peter/mail/台北/日本語
+.ft B
+doveadm mailbox mutf7 ~peter/mail/台北/日本語
+.ft P
 ~peter/mail/&U,BTFw\-/&ZeVnLIqe\-
 .fi
 .\"------------------------------------------------------------------------
diff -r 086c70441f26 -r dcfb0baba621 doc/man/doveadm-move.1.in
--- a/doc/man/doveadm-move.1.in	Sun Oct 19 11:24:12 2014 -0700
+++ b/doc/man/doveadm-move.1.in	Sun Oct 19 19:29:34 2014 +0000
@@ -1,5 +1,5 @@
-.\" Copyright (c) 2011-2013 Dovecot authors, see the included COPYING file
-.TH DOVEADM\-MOVE 1 "2013-11-23" "Dovecot v2.2" "Dovecot"
+.\" Copyright (c) 2011-2014 Dovecot authors, see the included COPYING file
+.TH DOVEADM\-MOVE 1 "2014-10-19" "Dovecot v2.2" "Dovecot"
 .SH NAME
 doveadm\-move \- Move messages matching the given search query into another
 mailbox
@@ -131,8 +131,10 @@
 into her archive.
 .PP
 .nf
-.B doveadm move \-u jane Archive/2011/09 mailbox INBOX BEFORE \(rs
-.B 2011\-10\-01 SINCE 01\-Sep\-2011
+.ft B
+doveadm move \-u jane Archive/2011/09 mailbox INBOX BEFORE \(rs
+2011\-10\-01 SINCE 01\-Sep\-2011
+.ft P
 .fi
 .\"------------------------------------------------------------------------
 @INCLUDE:reporting-bugs@
diff -r 086c70441f26 -r dcfb0baba621 doc/man/doveadm-search.1.in
--- a/doc/man/doveadm-search.1.in	Sun Oct 19 11:24:12 2014 -0700
+++ b/doc/man/doveadm-search.1.in	Sun Oct 19 19:29:34 2014 +0000
@@ -1,5 +1,5 @@
-.\" Copyright (c) 2010 Dovecot authors, see the included COPYING file
-.TH DOVEADM\-SEARCH 1 "2010-11-25" "Dovecot v2.2" "Dovecot"
+.\" Copyright (c) 2010-2014 Dovecot authors, see the included COPYING file
+.TH DOVEADM\-SEARCH 1 "2014-10-19" "Dovecot v2.2" "Dovecot"
 .SH NAME
 doveadm\-search \- Show a list of mailbox GUIDs and message UIDs matching \
 given search query.
@@ -86,7 +86,9 @@
 all messages, which contains the word \(dqtodo\(dq in the Subject: header.
 .PP
 .nf
-.B doveadm search \-u bob mailbox dovecot\(rs* subject todo
+.ft B
+doveadm search \-u bob mailbox dovecot\(rs* subject todo
+.ft P
 3a94c928d66ebe4bda04000015811c6a	8
 3a94c928d66ebe4bda04000015811c6a	25
 3a94c928d66ebe4bda04000015811c6a	45
@@ -98,10 +100,12 @@
 that have "todo" in subject, use:
 .PP
 .nf
-.B doveadm search \-u bob mailbox INBOX subject todo |
-.B while read guid uid; do
-.B \ \ doveadm fetch \-u bob body mailbox\-guid $guid uid $uid > msg.$uid
-.B done
+.ft B
+doveadm search \-u bob mailbox INBOX subject todo |
+while read guid uid; do
+\ \ doveadm fetch \-u bob body mailbox\-guid $guid uid $uid > msg.$uid
+done
+.ft P
 .fi
 .\"------------------------------------------------------------------------
 @INCLUDE:reporting-bugs@
diff -r 086c70441f26 -r dcfb0baba621 doc/man/doveadm-sync.1.in
--- a/doc/man/doveadm-sync.1.in	Sun Oct 19 11:24:12 2014 -0700
+++ b/doc/man/doveadm-sync.1.in	Sun Oct 19 19:29:34 2014 +0000
@@ -1,5 +1,5 @@
 .\" Copyright (c) 2014 Dovecot authors, see the included COPYING file
-.TH DOVEADM\-SYNC 1 "2014-10-05" "Dovecot v2.2" "Dovecot"
+.TH DOVEADM\-SYNC 1 "2014-10-19" "Dovecot v2.2" "Dovecot"
 .SH NAME
 doveadm\-sync \- Dovecot\(aqs two\-way mailbox synchronization utility
 .br
@@ -269,7 +269,9 @@
 .PP
 .RS
 .nf
-.B doveadm sync \-u username at example.com remote:server\-replica.example.com
+.ft B
+doveadm sync \-u username at example.com remote:server\-replica.example.com
+.ft P
 .fi
 .RE
 .PP
@@ -277,8 +279,10 @@
 .PP
 .RS
 .nf
-.B doveadm sync \-u username at example.com ssh \-i id_dsa.dovecot \(rs
-.B mailuser at example.com doveadm dsync\-server \-u username at example.com
+.ft B
+doveadm sync \-u username at example.com ssh \-i id_dsa.dovecot \(rs
+mailuser at example.com doveadm dsync\-server \-u username at example.com
+.ft P
 .fi
 .RE
 .\"------------------------------------------------------------------------
@@ -295,7 +299,9 @@


More information about the dovecot-cvs mailing list