archivemail.sgml: wrap examples in <informalexample>.

This commit is contained in:
Nikolaus Schulz 2007-11-03 00:51:23 +00:00
parent 3f5f591728
commit f582fd75c9
2 changed files with 27 additions and 0 deletions

View File

@ -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. will probably remove unprotected quotes or backslashes.
.SH "EXAMPLES" .SH "EXAMPLES"
.PP .PP
.PP
To archive all messages in the mailbox \fIdebian-user\fR that To archive all messages in the mailbox \fIdebian-user\fR that
are older than 180 days to a compressed mailbox called are older than 180 days to a compressed mailbox called
\fIdebian-user_archive.gz\fR in the current directory: \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 bash$ \fBarchivemail debian-user\fR
.fi .fi
.PP .PP
.PP
To archive all messages in the mailbox \fIdebian-user\fR that To archive all messages in the mailbox \fIdebian-user\fR that
are older than 180 days to a compressed mailbox called are older than 180 days to a compressed mailbox called
\fIdebian-user_October_2001.gz\fR (where the current month and \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 bash$ \fBarchivemail --suffix '_%B_%Y' debian-user\fR
.fi .fi
.PP .PP
.PP
To archive all messages in the mailbox \fIcm-melb\fR that To archive all messages in the mailbox \fIcm-melb\fR that
are older than the first of January 2002 to a compressed mailbox called are older than the first of January 2002 to a compressed mailbox called
\fIcm-melb_archive.gz\fR in the current directory: \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 bash$ \fBarchivemail --date'1 Jan 2002' cm-melb\fR
.fi .fi
.PP .PP
.PP
Exactly the same as the above example, using an ISO date format instead: Exactly the same as the above example, using an ISO date format instead:
.nf .nf
bash$ \fBarchivemail --date=2002-01-01 cm-melb\fR bash$ \fBarchivemail --date=2002-01-01 cm-melb\fR
.fi .fi
.PP .PP
.PP
To delete all messages in the mailbox \fIspam\fR that To delete all messages in the mailbox \fIspam\fR that
are older than 30 days: are older than 30 days:
@ -336,6 +341,7 @@ are older than 30 days:
bash$ \fBarchivemail --delete --days=30 spam\fR bash$ \fBarchivemail --delete --days=30 spam\fR
.fi .fi
.PP .PP
.PP
To archive all read messages in the mailbox \fIincoming\fR that To archive all read messages in the mailbox \fIincoming\fR that
are older than 180 days to a compressed mailbox called are older than 180 days to a compressed mailbox called
\fIincoming_archive.gz\fR in the current directory: \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 bash$ \fBarchivemail --preserve-unread incoming\fR
.fi .fi
.PP .PP
.PP
To archive all messages in the mailbox \fIreceived\fR that To archive all messages in the mailbox \fIreceived\fR that
are older than 180 days to an uncompressed mailbox called are older than 180 days to an uncompressed mailbox called
\fIreceived_archive\fR in the current directory: \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 bash$ \fBarchivemail --no-compress received\fR
.fi .fi
.PP .PP
.PP
To archive all mailboxes in the directory \fI$HOME/Mail\fR To archive all mailboxes in the directory \fI$HOME/Mail\fR
that are older than 90 days to compressed mailboxes in the that are older than 90 days to compressed mailboxes in the
\fI$HOME/Mail/Archive\fR directory: \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 bash$ \fBarchivemail -d90 -o $HOME/Mail/Archive $HOME/Mail/*\fR
.fi .fi
.PP .PP
.PP
To archive all mails older than 180 days from the given \fBIMAP\fR To archive all mails older than 180 days from the given \fBIMAP\fR
INBOX to a compressed mailbox INBOX_archive.gz in the INBOX to a compressed mailbox INBOX_archive.gz in the
\fI$HOME/Mail/Archive\fR directory, quoting the password and \fI$HOME/Mail/Archive\fR directory, quoting the password and

View File

@ -457,6 +457,7 @@ will probably remove unprotected quotes or backslashes.
<RefSect1> <RefSect1>
<Title>Examples</Title> <Title>Examples</Title>
<InformalExample>
<Para> <Para>
To archive all messages in the mailbox <filename>debian-user</filename> that To archive all messages in the mailbox <filename>debian-user</filename> that
are older than 180 days to a compressed mailbox called 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> <prompt>bash$ </prompt><userinput>archivemail debian-user</userinput>
</screen> </screen>
</Para> </Para>
</InformalExample>
<InformalExample>
<Para> <Para>
To archive all messages in the mailbox <filename>debian-user</filename> that To archive all messages in the mailbox <filename>debian-user</filename> that
are older than 180 days to a compressed mailbox called 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> <prompt>bash$ </prompt><userinput>archivemail --suffix '_%B_%Y' debian-user</userinput>
</screen> </screen>
</Para> </Para>
</InformalExample>
<InformalExample>
<Para> <Para>
To archive all messages in the mailbox <filename>cm-melb</filename> that 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 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> <prompt>bash$ </prompt><userinput>archivemail --date'1 Jan 2002' cm-melb</userinput>
</screen> </screen>
</Para> </Para>
</InformalExample>
<InformalExample>
<Para> <Para>
Exactly the same as the above example, using an ISO date format instead: Exactly the same as the above example, using an ISO date format instead:
<screen> <screen>
<prompt>bash$ </prompt><userinput>archivemail --date=2002-01-01 cm-melb</userinput> <prompt>bash$ </prompt><userinput>archivemail --date=2002-01-01 cm-melb</userinput>
</screen> </screen>
</Para> </Para>
</InformalExample>
<InformalExample>
<Para> <Para>
To delete all messages in the mailbox <filename>spam</filename> that To delete all messages in the mailbox <filename>spam</filename> that
are older than 30 days: are older than 30 days:
@ -499,7 +508,9 @@ are older than 30 days:
<prompt>bash$ </prompt><userinput>archivemail --delete --days=30 spam</userinput> <prompt>bash$ </prompt><userinput>archivemail --delete --days=30 spam</userinput>
</screen> </screen>
</Para> </Para>
</InformalExample>
<InformalExample>
<Para> <Para>
To archive all read messages in the mailbox <filename>incoming</filename> that To archive all read messages in the mailbox <filename>incoming</filename> that
are older than 180 days to a compressed mailbox called 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> <prompt>bash$ </prompt><userinput>archivemail --preserve-unread incoming</userinput>
</screen> </screen>
</Para> </Para>
</InformalExample>
<InformalExample>
<Para> <Para>
To archive all messages in the mailbox <filename>received</filename> that To archive all messages in the mailbox <filename>received</filename> that
are older than 180 days to an uncompressed mailbox called 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> <prompt>bash$ </prompt><userinput>archivemail --no-compress received</userinput>
</screen> </screen>
</Para> </Para>
</InformalExample>
<InformalExample>
<Para> <Para>
To archive all mailboxes in the directory <filename>$HOME/Mail</filename> To archive all mailboxes in the directory <filename>$HOME/Mail</filename>
that are older than 90 days to compressed mailboxes in the 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> <prompt>bash$ </prompt><userinput>archivemail -d90 -o $HOME/Mail/Archive $HOME/Mail/*</userinput>
</screen> </screen>
</Para> </Para>
</InformalExample>
<InformalExample>
<Para> <Para>
To archive all mails older than 180 days from the given <application/IMAP/ To archive all mails older than 180 days from the given <application/IMAP/
INBOX to a compressed mailbox INBOX_archive.gz in the 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> <Para>
Note the protected quotes. Note the protected quotes.
</Para> </Para>
</InformalExample>
</RefSect1> </RefSect1>
<RefSect1> <RefSect1>