aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorNikolaus Schulz <microschulz@web.de>2007-11-03 00:51:23 +0000
committerNikolaus Schulz <microschulz@web.de>2007-11-03 00:51:23 +0000
commitf582fd75c98007a7f123a4d6bcca07d9d1c98a3a (patch)
tree0c9099ab56584e361ca574842b9dd4a60ac3aa47
parent3f5f591728cae9723bee6e2a9fa4cfc7538f7a42 (diff)
downloadarchivemail-f582fd75c98007a7f123a4d6bcca07d9d1c98a3a.tar.gz
archivemail-f582fd75c98007a7f123a4d6bcca07d9d1c98a3a.tar.bz2
archivemail-f582fd75c98007a7f123a4d6bcca07d9d1c98a3a.zip
archivemail.sgml: wrap examples in <informalexample>.
-rw-r--r--archivemail.19
-rw-r--r--archivemail.sgml18
2 files changed, 27 insertions, 0 deletions
diff --git a/archivemail.1 b/archivemail.1
index 4e9b298..86800bb 100644
--- a/archivemail.1
+++ b/archivemail.1
@@ -298,6 +298,7 @@ Note that quoting only a substring will not work, and be aware that your shell
will probably remove unprotected quotes or backslashes.
.SH "EXAMPLES"
.PP
+.PP
To archive all messages in the mailbox \fIdebian-user\fR that
are older than 180 days to a compressed mailbox called
\fIdebian-user_archive.gz\fR in the current directory:
@@ -306,6 +307,7 @@ are older than 180 days to a compressed mailbox called
bash$ \fBarchivemail debian-user\fR
.fi
.PP
+.PP
To archive all messages in the mailbox \fIdebian-user\fR that
are older than 180 days to a compressed mailbox called
\fIdebian-user_October_2001.gz\fR (where the current month and
@@ -315,6 +317,7 @@ year is April, 2002) in the current directory:
bash$ \fBarchivemail --suffix '_%B_%Y' debian-user\fR
.fi
.PP
+.PP
To archive all messages in the mailbox \fIcm-melb\fR that
are older than the first of January 2002 to a compressed mailbox called
\fIcm-melb_archive.gz\fR in the current directory:
@@ -323,12 +326,14 @@ are older than the first of January 2002 to a compressed mailbox called
bash$ \fBarchivemail --date'1 Jan 2002' cm-melb\fR
.fi
.PP
+.PP
Exactly the same as the above example, using an ISO date format instead:
.nf
bash$ \fBarchivemail --date=2002-01-01 cm-melb\fR
.fi
.PP
+.PP
To delete all messages in the mailbox \fIspam\fR that
are older than 30 days:
@@ -336,6 +341,7 @@ are older than 30 days:
bash$ \fBarchivemail --delete --days=30 spam\fR
.fi
.PP
+.PP
To archive all read messages in the mailbox \fIincoming\fR that
are older than 180 days to a compressed mailbox called
\fIincoming_archive.gz\fR in the current directory:
@@ -344,6 +350,7 @@ are older than 180 days to a compressed mailbox called
bash$ \fBarchivemail --preserve-unread incoming\fR
.fi
.PP
+.PP
To archive all messages in the mailbox \fIreceived\fR that
are older than 180 days to an uncompressed mailbox called
\fIreceived_archive\fR in the current directory:
@@ -352,6 +359,7 @@ are older than 180 days to an uncompressed mailbox called
bash$ \fBarchivemail --no-compress received\fR
.fi
.PP
+.PP
To archive all mailboxes in the directory \fI$HOME/Mail\fR
that are older than 90 days to compressed mailboxes in the
\fI$HOME/Mail/Archive\fR directory:
@@ -360,6 +368,7 @@ that are older than 90 days to compressed mailboxes in the
bash$ \fBarchivemail -d90 -o $HOME/Mail/Archive $HOME/Mail/*\fR
.fi
.PP
+.PP
To archive all mails older than 180 days from the given \fBIMAP\fR
INBOX to a compressed mailbox INBOX_archive.gz in the
\fI$HOME/Mail/Archive\fR directory, quoting the password and
diff --git a/archivemail.sgml b/archivemail.sgml
index e1f5d43..a83999c 100644
--- a/archivemail.sgml
+++ b/archivemail.sgml
@@ -457,6 +457,7 @@ will probably remove unprotected quotes or backslashes.
<RefSect1>
<Title>Examples</Title>
+<InformalExample>
<Para>
To archive all messages in the mailbox <filename>debian-user</filename> that
are older than 180 days to a compressed mailbox called
@@ -465,7 +466,9 @@ are older than 180 days to a compressed mailbox called
<prompt>bash$ </prompt><userinput>archivemail debian-user</userinput>
</screen>
</Para>
+</InformalExample>
+<InformalExample>
<Para>
To archive all messages in the mailbox <filename>debian-user</filename> that
are older than 180 days to a compressed mailbox called
@@ -475,7 +478,9 @@ year is April, 2002) in the current directory:
<prompt>bash$ </prompt><userinput>archivemail --suffix '_%B_%Y' debian-user</userinput>
</screen>
</Para>
+</InformalExample>
+<InformalExample>
<Para>
To archive all messages in the mailbox <filename>cm-melb</filename> that
are older than the first of January 2002 to a compressed mailbox called
@@ -484,14 +489,18 @@ are older than the first of January 2002 to a compressed mailbox called
<prompt>bash$ </prompt><userinput>archivemail --date'1 Jan 2002' cm-melb</userinput>
</screen>
</Para>
+</InformalExample>
+<InformalExample>
<Para>
Exactly the same as the above example, using an ISO date format instead:
<screen>
<prompt>bash$ </prompt><userinput>archivemail --date=2002-01-01 cm-melb</userinput>
</screen>
</Para>
+</InformalExample>
+<InformalExample>
<Para>
To delete all messages in the mailbox <filename>spam</filename> that
are older than 30 days:
@@ -499,7 +508,9 @@ are older than 30 days:
<prompt>bash$ </prompt><userinput>archivemail --delete --days=30 spam</userinput>
</screen>
</Para>
+</InformalExample>
+<InformalExample>
<Para>
To archive all read messages in the mailbox <filename>incoming</filename> that
are older than 180 days to a compressed mailbox called
@@ -508,7 +519,9 @@ are older than 180 days to a compressed mailbox called
<prompt>bash$ </prompt><userinput>archivemail --preserve-unread incoming</userinput>
</screen>
</Para>
+</InformalExample>
+<InformalExample>
<Para>
To archive all messages in the mailbox <filename>received</filename> that
are older than 180 days to an uncompressed mailbox called
@@ -517,7 +530,9 @@ are older than 180 days to an uncompressed mailbox called
<prompt>bash$ </prompt><userinput>archivemail --no-compress received</userinput>
</screen>
</Para>
+</InformalExample>
+<InformalExample>
<Para>
To archive all mailboxes in the directory <filename>$HOME/Mail</filename>
that are older than 90 days to compressed mailboxes in the
@@ -526,7 +541,9 @@ that are older than 90 days to compressed mailboxes in the
<prompt>bash$ </prompt><userinput>archivemail -d90 -o $HOME/Mail/Archive $HOME/Mail/*</userinput>
</screen>
</Para>
+</InformalExample>
+<InformalExample>
<Para>
To archive all mails older than 180 days from the given <application/IMAP/
INBOX to a compressed mailbox INBOX_archive.gz in the
@@ -540,6 +557,7 @@ that are older than 90 days to compressed mailboxes in the
<Para>
Note the protected quotes.
</Para>
+</InformalExample>
</RefSect1>
<RefSect1>