about summary refs log tree commit homepage
path: root/Documentation/lei-lcat.pod
diff options
context:
space:
mode:
authorEric Wong <e@80x24.org>2021-09-11 08:33:19 +0000
committerEric Wong <e@80x24.org>2021-09-11 21:12:40 +0000
commitaa500f0243133f2e9e0c912eea3497e52ebc1903 (patch)
treef3f996a118afe5cc9014ac5a793f3285ffae4d25 /Documentation/lei-lcat.pod
parent57fed2e4b78ed394db38ac6d9b9227722d546d98 (diff)
downloadpublic-inbox-aa500f0243133f2e9e0c912eea3497e52ebc1903.tar.gz
When composing replies in "git format-patch" cover letters,
I'd been relying on "lei q -f text ...", but that still requires
several steps to make it suitable for composing a reply:

	* s/^/> / to quote the body
	* drop existing In-Reply-To+References
	* s/^Message-ID:/In-Reply-To:/;
	* add an attribute line
	...

"lei q -f reply" takes care of most of that and users will
only have to trim "From " lines, unnecessary results and
over-quoted text (and trimming is likely less error-prone
than doing all the steps above manually).

This should also be a good replacement for
"git format-patch --in-reply-to=...", since copying long
Message-IDs can be error-prone (and this lets you include
quoted text in replies).
Diffstat (limited to 'Documentation/lei-lcat.pod')
-rw-r--r--Documentation/lei-lcat.pod10
1 files changed, 10 insertions, 0 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