From 947be25f8249b7822edfd1cae2822fc05b7cfccc Mon Sep 17 00:00:00 2001 From: Nikolaus Schulz Date: Tue, 5 Jul 2011 23:43:12 +0200 Subject: Fix whitespace and formatting of the manpage XML source --- archivemail.xml | 396 ++++++++++++++++++++++++++++++++++---------------------- 1 file changed, 238 insertions(+), 158 deletions(-) (limited to 'archivemail.xml') diff --git a/archivemail.xml b/archivemail.xml index 3a3126e..e312370 100644 --- a/archivemail.xml +++ b/archivemail.xml @@ -59,51 +59,52 @@ archivemail is a tool for archiving and compressing old email in mailboxes. -By default it will read the mailbox MAILBOX, moving messages -that are older than the specified number of days (180 by default) to a -&mbox;-format mailbox in the same directory that is compressed -with &gzip;. +By default it will read the mailbox MAILBOX, moving +messages that are older than the specified number of days (180 by default) to +a &mbox;-format mailbox in the same directory that is compressed with &gzip;. It can also just delete old email rather than archive it. -By default, archivemail derives the archive filename from the -mailbox name by appending an _archive suffix to the mailbox -name. For example, if you run archivemail on a mailbox called -exsouthrock, the archive will be created with the -filename exsouthrock_archive.gz. +By default, archivemail derives the archive filename from +the mailbox name by appending an _archive suffix to the +mailbox name. For example, if you run archivemail on a +mailbox called exsouthrock, the archive will be created +with the filename exsouthrock_archive.gz. This default behavior can be overridden with command line options, choosing a custom suffix, a prefix, or a completely custom name for the archive. archivemail supports reading IMAP, -Maildir, MH and mbox-format -mailboxes, but always writes mbox-format archives. +Maildir, MH and +mbox-format mailboxes, but always writes +mbox-format archives. - Messages that are flagged important are not archived or deleted unless - explicitly requested with the option. - Also, archivemail can be configured not to archive unread mail, or - to only archive messages larger than a specified size. +Messages that are flagged important are not archived or deleted unless +explicitly requested with the option. +Also, archivemail can be configured not to archive unread +mail, or to only archive messages larger than a specified size. To archive an IMAP-format mailbox, use the format -imap://username:password@server/mailbox - to specify the mailbox. -archivemail will expand wildcards in IMAP mailbox -names according to RFC 3501, which says: -The character "*" is a wildcard, and matches zero or more characters at this +imap://username:password@server/mailbox to specify +the mailbox. +archivemail will expand wildcards in +IMAP mailbox names according to +RFC 3501, which says: The +character "*" is a wildcard, and matches zero or more characters at this position. The character "%" is similar to "*", but it does not match a hierarchy delimiter. You can omit the password from the URL; use the - option to make archivemail read the -password from a file, or alternatively just enter it upon request. -If the option is set, archivemail does not -look for a password in the URL, and the colon is not considered a -delimiter. + option to make archivemail read +the password from a file, or alternatively just enter it upon request. +If the option is set, archivemail +does not look for a password in the URL, and the colon is +not considered a delimiter. Substitute imap with imaps, and archivemail will establish a secure SSL connection. @@ -119,8 +120,8 @@ See below for more IMAP peculiarities. -Archive messages older than NUM days. -The default is 180. This option is incompatible with the +Archive messages older than NUM +days. The default is 180. This option is incompatible with the option below. @@ -140,9 +141,9 @@ This option is incompatible with the option above. -Use the directory name PATH to store the -mailbox archives. The default is the same directory as the mailbox to be -read. +Use the directory name PATH to +store the mailbox archives. The default is the same directory as the mailbox +to be read. @@ -171,8 +172,8 @@ For IMAP wizards. Prefix NAME to the archive name. NAME is expanded by the &python; function time.strftime(), which means that you can specify special -directives in NAME to make an archive named after the archive -cut-off date. +directives in NAME to make an archive named after +the archive cut-off date. See the discussion of the option for a list of valid strftime() directives. The default is not to add a prefix. @@ -183,70 +184,139 @@ The default is not to add a prefix. -Use the suffix NAME to create the filename used for archives. -The default is _archive, unless a prefix is specified. +Use the suffix NAME to create the filename used for +archives. The default is _archive, unless a prefix is +specified. - -Like a prefix, the suffix NAME is expanded by the &python; -function time.strftime() with the archive cut-off date. -time.strftime() understands the following directives: - +Like a prefix, the suffix NAME is expanded by the +&python; function time.strftime() with the archive +cut-off date. time.strftime() understands the following +directives: %a - Locale's abbreviated weekday name. + + Locale's abbreviated weekday name. + + %A - Locale's full weekday name. + + Locale's full weekday name. + + %b - Locale's abbreviated month name. + + Locale's abbreviated month name. + + %B - Locale's full month name. + + Locale's full month name. + + %c - Locale's appropriate date and time representation. + + Locale's appropriate date and time representation. + + %d - Day of the month as a decimal number [01,31]. + + Day of the month as a decimal number [01,31]. + + %H - Hour (24-hour clock) as a decimal number [00,23]. + + Hour (24-hour clock) as a decimal number [00,23]. + + %I - Hour (12-hour clock) as a decimal number [01,12]. + + Hour (12-hour clock) as a decimal number [01,12]. + + %j - Day of the year as a decimal number [001,366]. + + Day of the year as a decimal number [001,366]. + + %m - Month as a decimal number [01,12]. + + Month as a decimal number [01,12]. + + %M - Minute as a decimal number [00,59]. + + Minute as a decimal number [00,59]. + + %p - Locale's equivalent of either AM or PM. + + Locale's equivalent of either AM or PM. + + %S - Second as a decimal number [00,61]. (1) + + Second as a decimal number [00,61]. (1) + + %U - Week number of the year (Sunday as the first day of the week) as a decimal number [00,53]. All days in a new year preceding the first Sunday are considered to be in week 0. + + Week number of the year (Sunday as the first day of the week) + as a decimal number [00,53]. All days in a new year preceding + the first Sunday are considered to be in week 0. + + %w - Weekday as a decimal number [0(Sunday),6]. + + Weekday as a decimal number [0(Sunday),6]. + + %W - Week number of the year (Monday as the first day of the week) as a decimal number [00,53]. All days in a new year preceding the first Sunday are considered to be in week 0. + + Week number of the year (Monday as the first day of the week) + as a decimal number [00,53]. All days in a new year preceding + the first Sunday are considered to be in week 0. + + %x - Locale's appropriate date representation. + + Locale's appropriate date representation. + + %X - Locale's appropriate time representation. + + Locale's appropriate time representation. + + %y - Year without century as a decimal number [00,99]. + + Year without century as a decimal number [00,99]. + + %Y - Year with century as a decimal number. + + Year with century as a decimal number. + + %Z - Time zone name (or by no characters if no time zone exists). + + Time zone name (or by no characters if no time zone exists). + + %% - A literal % character. + + A literal % character. + + - -Use NAME as the archive name, ignoring the name -of the mailbox that is archived. +Use NAME as the archive name, +ignoring the name of the mailbox that is archived. Like prefixes and suffixes, NAME is expanded by time.strftime() with the archive cut-off date. Because it hard-codes the archive name, this option cannot be used when @@ -257,8 +327,8 @@ archiving multiple mailboxes. -Only archive messages that are NUM bytes or -greater. +Only archive messages that are NUM +bytes or greater. @@ -275,11 +345,11 @@ useful for testing to see how many messages would have been archived. -Do not archive any messages that have not yet been read. archivemail -determines if a message in a mbox-format or -MH-format mailbox has been read by looking at the -Status header (if it exists). If the status -header is equal to RO or +Do not archive any messages that have not yet been read. +archivemail determines if a message in a +mbox-format or MH-format mailbox has +been read by looking at the Status header (if it exists). +If the status header is equal to RO or OR then archivemail assumes the message has been read. archivemail determines if a maildir @@ -300,8 +370,8 @@ When archiving a message from a mailbox not in mbox format, by default archivemail mangles such lines by prepending a > to them, since mail user agents might otherwise interpret these lines as message separators. -Messages from mbox folders are never mangled. See &mbox; for more -information. +Messages from mbox folders are never mangled. See &mbox; +for more information. @@ -322,8 +392,8 @@ Delete rather than archive old mail. Use this option with caution! Copy rather than archive old mail. Creates an archive, but the archived messages are not deleted from the originating mailbox, which is left unchanged. -This is a complement to the option, and mainly useful for -testing purposes. +This is a complement to the option, and mainly +useful for testing purposes. Note that multiple passes will create duplicates, since messages are blindly appended to an existing archive. @@ -380,12 +450,14 @@ Reports lots of extra debugging information about what is going on. -Set IMAP debugging level. This makes archivemail dump its -conversation with the IMAP server and some internal IMAP -processing to stdout. Higher values for NUM give more -elaborate output. Set NUM to 4 to see all exchanged -IMAP commands. (Actually, NUM is just passed -literally to imaplib.Debug.) +Set IMAP debugging level. This makes +archivemail dump its conversation with the +IMAP server and some internal IMAP +processing to stdout. Higher values for +NUM give more elaborate output. Set +NUM to 4 to see all exchanged +IMAP commands. (Actually, NUM +is just passed literally to imaplib.Debug.) @@ -394,8 +466,8 @@ literally to imaplib.Debug.) Turns on quiet mode. Do not print any statistics about how many messages were -archived. This should be used if you are running archivemail from -cron. +archived. This should be used if you are running +archivemail from cron. @@ -411,7 +483,8 @@ Display the version of archivemail and exit. -Display brief summary information about how to run archivemail. +Display brief summary information about how to run +archivemail. @@ -420,80 +493,85 @@ Display brief summary information about how to run archivemail Notes + archivemail requires &python; version 2.3 or later. -When reading an mbox-format mailbox, archivemail will -create a lockfile with the extension .lock so that -&procmail; will not deliver to the mailbox while it is being processed. It will -also create an advisory lock on the mailbox using &lockf;. -The archive is locked in the same way when it is updated. -archivemail will also complain and abort if a 3rd-party modifies the -mailbox while it is being read. +When reading an mbox-format mailbox, +archivemail will create a lockfile with the extension +.lock so that &procmail; will not +deliver to the mailbox while it is being processed. It will also create an +advisory lock on the mailbox using &lockf;. The archive is locked in the same +way when it is updated. +archivemail will also complain and abort if a 3rd-party +modifies the mailbox while it is being read. -archivemail will always attempt to preserve the -last-access and last-modify times of the input mailbox. Archive -mailboxes are always created with a mode of 0600. -If archivemail finds a pre-existing archive mailbox it -will append rather than overwrite that archive. -archivemail will refuse to operate on mailboxes that are symbolic -links. +archivemail will always attempt to preserve the last-access +and last-modify times of the input mailbox. Archive mailboxes are always +created with a mode of 0600. +If archivemail finds a pre-existing archive mailbox it will +append rather than overwrite that archive. +archivemail will refuse to operate on mailboxes that are +symbolic links. -archivemail attempts to find the delivery date of a message by -looking for valid dates in the following headers, in order of precedence: +archivemail attempts to find the delivery date of a message +by looking for valid dates in the following headers, in order of precedence: Delivery-date, Received, Resent-Date and Date. -If it cannot find any valid date in these headers, it -will use the last-modified file timestamp on MH and +If it cannot find any valid date in these headers, it will use the +last-modified file timestamp on MH and Maildir format mailboxes, or the date on the From_ line on mbox-format mailboxes. - When archiving mailboxes with leading dots in the name, - archivemail will strip the dots off the archive name, so - that the resulting archive file is not hidden. - This is not done if the or - option is used. - Should there really be mailboxes distinguished only by leading dots in the - name, they will thus be archived to the same archive file by default. +When archiving mailboxes with leading dots in the name, +archivemail will strip the dots off the archive name, so +that the resulting archive file is not hidden. +This is not done if the or + option is used. +Should there really be mailboxes distinguished only by leading dots in the +name, they will thus be archived to the same archive file by default. - A conversion from other formats to &mbox; will silently overwrite existing - Status and X-Status message headers. +A conversion from other formats to &mbox; will silently overwrite existing +Status and X-Status message headers. <acronym>IMAP</acronym> -When archivemail processes an IMAP folder, all messages -in that folder will have their \Recent flag unset, and they will -probably not show up as new in your user agent later on. +When archivemail processes an IMAP +folder, all messages in that folder will have their \Recent +flag unset, and they will probably not show up as new in your +user agent later on. There is no way around this, it's just how IMAP works. -This does not apply, however, if you run archivemail with the options - or . +This does not apply, however, if you run archivemail with +the options or . -archivemail relies on server-side searches to determine the messages -that should be archived. -When matching message dates, IMAP servers refer to server internal -message dates, and these may differ from both delivery time of a message and -its Date header. +archivemail relies on server-side searches to determine the +messages that should be archived. +When matching message dates, IMAP servers refer to server +internal message dates, and these may differ from both delivery time of a +message and its Date header. Also, there exist broken servers which do not implement server side searches. <acronym>IMAP</acronym> <acronym>URL</acronym>s -archivemail's IMAP URL parser was written -with the RFC 2882 (Internet Message Format) rules for -the local-part of email addresses in mind. -So, rather than enforcing an URL-style encoding of non-ascii -and reserved characters, it allows to double-quote the username and password. +archivemail's IMAP +URL parser was written with the RFC 2882 +(Internet Message Format) rules for the +local-part of email addresses in mind. +So, rather than enforcing an URL-style encoding of +non-ascii and reserved characters, it allows to +double-quote the username and password. If your username or password contains the delimiter characters @ or :, just quote it like this: imap://"username@bogus.com":"password"@imap.bogus.com/mailbox. @@ -513,14 +591,13 @@ wildcards in mailbox names. archivemail tries to be smart when handling mailbox paths. -In particular, it will automatically add an IMAP NAMESPACE -prefix to the mailbox path if necessary; and if you are archiving a subfolder, -you can use the slash as a path separator instead of the IMAP server's -internal representation. +In particular, it will automatically add an IMAP +NAMESPACE prefix to the mailbox path if necessary; and if +you are archiving a subfolder, you can use the slash as a path separator +instead of the IMAP server's internal representation. - @@ -562,7 +639,8 @@ are older than the first of January 2002 to a compressed mailbox called -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: bash$ archivemail --date=2002-01-01 cm-melb @@ -614,26 +692,27 @@ that are older than 90 days to compressed mailboxes in the - To archive all mails older than 180 days from the given IMAP - INBOX to a compressed mailbox INBOX_archive.gz in the - $HOME/Mail/Archive directory, quoting the password and - reading it from the environment variable PASSWORD: +To archive all mails older than 180 days from the given +IMAP INBOX to a compressed mailbox +INBOX_archive.gz in the +$HOME/Mail/Archive directory, quoting the password and +reading it from the environment variable PASSWORD: bash$ archivemail -o $HOME/Mail/Archive imaps://user:'"'$PASSWORD'"'@example.org/INBOX - Note the protected quotes. +Note the protected quotes. - To archive all mails older than 180 days in subfolders of foo on the given IMAP - server to corresponding archives in the current working directory, reading - the password from the file ~/imap-pass.txt: +To archive all mails older than 180 days in subfolders of foo on the given IMAP +server to corresponding archives in the current working directory, reading the +password from the file ~/imap-pass.txt: bash$ archivemail --pwfile=~/imap-pass.txt imaps://user@example.org/foo/* @@ -644,8 +723,8 @@ that are older than 90 days to compressed mailboxes in the Tips -Probably the best way to run archivemail is from your &crontab; -file, using the option. +Probably the best way to run archivemail is from your +&crontab; file, using the option. Don't forget to try the and perhaps the option for non-destructive testing. @@ -660,11 +739,11 @@ Don't forget to try the and perhaps the Bugs -If an IMAP mailbox path contains slashes, the archive filename -will be derived from the basename of the mailbox. -If the server's folder separator differs from the Unix slash and is used in the -IMAP URL, however, the whole path will be considered -the basename of the mailbox. +If an IMAP mailbox path contains slashes, the archive +filename will be derived from the basename of the mailbox. +If the server's folder separator differs from the Unix slash and is used in +the IMAP URL, however, the whole path +will be considered the basename of the mailbox. E.g. the two URLs imap://user@example.com/folder/subfolder and imap://user@example.com/folder.subfolder will be @@ -673,17 +752,18 @@ archived in subfolder_archive.gz and might refer to the same IMAP mailbox. -archivemail does not support reading MMDF or -Babyl-format mailboxes. In fact, it will probably think it is -reading an mbox-format mailbox and cause all sorts of problems. +archivemail does not support reading +MMDF or Babyl-format mailboxes. In fact, +it will probably think it is reading an mbox-format mailbox +and cause all sorts of problems. -archivemail is still too slow, but if you are running from &crontab; -you won't care. Archiving maildir-format mailboxes should be -a lot quicker than mbox-format mailboxes since it is less -painful for the original mailbox to be reconstructed after selective message -removal. +archivemail is still too slow, but if you are running from +&crontab; you won't care. Archiving maildir-format +mailboxes should be a lot quicker than mbox-format +mailboxes since it is less painful for the original mailbox to be +reconstructed after selective message removal. @@ -706,8 +786,8 @@ removal. Author - This manual page was written by Paul Rodger <paul at paulrodger dot -com>. Updated and supplemented by Nikolaus Schulz + This manual page was written by Paul Rodger <paul at paulrodger +dot com>. Updated and supplemented by Nikolaus Schulz microschulz@web.de -- cgit v1.2.3