From 83df78de12bf04ffe5906d520399dc891d167f73 Mon Sep 17 00:00:00 2001 From: Eric Wong Date: Wed, 28 Apr 2021 04:51:07 +0000 Subject: doc: lei q: split --output and --format, note "text" I guess --format makes sense for stdout, after all; and I'm enjoying "-f text" quite a bit, so far. --- Documentation/lei-q.pod | 26 +++++++++++++++----------- 1 file changed, 15 insertions(+), 11 deletions(-) (limited to 'Documentation') diff --git a/Documentation/lei-q.pod b/Documentation/lei-q.pod index 2b9936b8..bf7a5f70 100644 --- a/Documentation/lei-q.pod +++ b/Documentation/lei-q.pod @@ -42,15 +42,11 @@ C or C. URLs requiring authentication must use L and/or L to fill in the username and password. -The prefix can instead specify the format of the output: C, -C, C, C, C, C, C, or -C. 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. +A prefix can specify the format of the output: C, +C, C, C, C. For a description of +mail formats, see L. -=for comment -TODO: Provide description of formats? +C is the default for an existing directory or non-existing path. Default: C<-> (stdout) @@ -58,9 +54,17 @@ Default: C<-> (stdout) =item -f FORMAT -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. +Format of results to stdout. This option exists as a convenient +way to specify the format for the default stdout destination. +C, C, C, or C are all supported, +as are the various mbox variants described in L. + +When a format isn't specified, it's chosen based on the +L destination or prefix. C is used for the +default destination (stdout). + +Using a C prefix with the C<--output> destination is +preferred when not writing to stdout. =item --pretty -- cgit v1.2.3-24-ge0c7