Documentation/lei-import.pod | 10 ++++++---- Documentation/lei-overview.pod | 4 ++-- Documentation/lei-q.pod | 20 ++++++++++++++------ diff --git a/Documentation/lei-import.pod b/Documentation/lei-import.pod index 14ca2d45d6d8bfa17f85a95046a2acda05fbf9d2..2051e6bc86c5fd36b441f01ced436bc8745d5fd2 100644 --- a/Documentation/lei-import.pod +++ b/Documentation/lei-import.pod @@ -11,8 +11,10 @@ =head1 DESCRIPTION Import messages into the local storage of L. C is a -source of messages: a directory (Maildir) or a file (whose format is -specified via C<--format>). +source of messages: a directory (Maildir) or a file. For a regular +file, the location must have a CformatE:> prefix specifying +one of the following formats: C, C, C, +C, or C. TODO: Update when URL support is added. @@ -22,8 +24,8 @@ =over =item -f MAIL_FORMAT, --format=MAIL_FORMAT -Message input format: C, C, C, C, -C. +Message input format. Unless messages are given on C, using a +format prefix with C is preferred. =item --stdin diff --git a/Documentation/lei-overview.pod b/Documentation/lei-overview.pod index 840d011b27adb088851fe376962f93497b9a168e..62b62280ad2ddd69f28c4b401eb8a0270ffd250b 100644 --- a/Documentation/lei-overview.pod +++ b/Documentation/lei-overview.pod @@ -16,7 +16,7 @@ =head2 EXAMPLES =over -=item $ lei import --format=mboxrd t.mbox +=item $ lei import mboxrd:t.mbox Import the messages from an mbox into the local storage. @@ -64,7 +64,7 @@ Do the same, but also report unmatched messages that are in the same thread as a matched message. -=item $ lei q -t -o t.mbox -f mboxcl2 --mua=mutt s:lei s:skeleton +=item $ lei q -t -o mboxcl2:t.mbox --mua=mutt s:lei s:skeleton Write mboxcl2-formatted results to t.mbox and enter mutt to view the file by invoking C. diff --git a/Documentation/lei-q.pod b/Documentation/lei-q.pod index c8df6fc7244bfae68673b2506d7917f47f5d2317..75fdc613579cdc18d28f5589b4038eda65fb850b 100644 --- a/Documentation/lei-q.pod +++ b/Documentation/lei-q.pod @@ -26,17 +26,25 @@ Read search terms from stdin. =item -o MFOLDER, --output=MFOLDER, --mfolder=MFOLDER -Destination for results (e.g., C or - for stdout). +Destination for results (e.g., C or +C). The format can be specified by adding a +CformatE:> prefix with any of these values: C, +C, C, C, C, C, C, or +C. + +TODO: Provide description of formats? + +When a format isn't specified, it's chosen based on the destination. +C is used for the default destination (stdout), and C +is used for an existing directory or non-existing path. Default: - =item -f FORMAT, --format=FORMAT -Format of results: C, C, C, C, -C, C, C, or C. The default format -used depends on C<--output>. - -TODO: Provide description of formats? +Format of results. This option exists as a convenient way to specify +the format for the default stdout destination. Using a C +prefix with the C<--output> destination is preferred otherwise. =item --pretty