diff options
Diffstat (limited to 'Documentation')
-rw-r--r-- | Documentation/lei-lcat.pod | 10 | ||||
-rw-r--r-- | Documentation/lei-q.pod | 11 |
2 files changed, 19 insertions, 2 deletions
diff --git a/Documentation/lei-lcat.pod b/Documentation/lei-lcat.pod index 656df489..b7887b6c 100644 --- a/Documentation/lei-lcat.pod +++ b/Documentation/lei-lcat.pod @@ -20,9 +20,19 @@ Message-ID or link from surrounding text (e.g., a "Link: $URL" line). =head1 OPTIONS The following options, described in L<lei-q(1)>, are supported. +One deviation from L<lei-q(1)> is the default output format is +C<-f text> when writing to stdout. =over +=item --format=FORMAT + +=item -f FORMAT + +Most commonly C<text> (the default) or C<reply> to +display the message(s) in a format suitable for trimming +and sending as a email reply. + =item --[no-]remote =item --no-local diff --git a/Documentation/lei-q.pod b/Documentation/lei-q.pod index 69a6cdf2..1d9e66cd 100644 --- a/Documentation/lei-q.pod +++ b/Documentation/lei-q.pod @@ -60,7 +60,7 @@ Default: C<-> (stdout) Format of results to stdout. This option exists as a convenient way to specify the format for the default stdout destination. -C<text>, C<json>, C<jsonl>, or C<concatjson> are all supported, +C<reply>, C<text>, C<json>, C<jsonl>, or C<concatjson> are all supported, as are the various mbox variants described in L</--output>. When a format isn't specified, it's chosen based on the @@ -72,7 +72,7 @@ preferred when not writing to stdout. =item --no-color -Disable color (for C<--format=text>). +Disable color (for C<-f reply> and C<-f text>). =item --pretty @@ -241,6 +241,13 @@ Default: C<auto> =back +=head1 TIPS + +C<-f reply> is intended to aid in turning a cover letter +into a reply (since using C<git format-patch --in-reply-to=...> +is tedious). Results (including "From " lines) should be edited +and trimmed in your favorite C<$EDITOR> before sending. + =head1 CONTACT Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org> |