From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on dcvr.yhbt.net X-Spam-Level: X-Spam-ASN: X-Spam-Status: No, score=-4.0 required=3.0 tests=ALL_TRUSTED,BAYES_00 shortcircuit=no autolearn=ham autolearn_force=no version=3.4.2 Received: from localhost (dcvr.yhbt.net [127.0.0.1]) by dcvr.yhbt.net (Postfix) with ESMTP id C98D91FA13 for ; Wed, 28 Apr 2021 04:51:07 +0000 (UTC) From: Eric Wong To: meta@public-inbox.org Subject: [PATCH 3/3] doc: lei q: split --output and --format, note "text" Date: Wed, 28 Apr 2021 04:51:07 +0000 Message-Id: <20210428045107.9699-4-e@80x24.org> In-Reply-To: <20210428045107.9699-1-e@80x24.org> References: <20210428045107.9699-1-e@80x24.org> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit List-Id: 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(-) 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