From a400bc9942679d660c861111f9f24cc3102c76f2 Mon Sep 17 00:00:00 2001
From: Samuel Thibault <samuel.thibault@ens-lyon.org>
Date: Wed, 6 Sep 2023 21:11:43 +0200
Subject: [PATCH] spd-say: Clarify the behavior of --pipe-mode

Fixes #855
---
 doc/spd-say.html          | 4 ++--
 doc/spd-say.texi          | 4 ++--
 src/clients/say/options.c | 3 ++-
 3 files changed, 6 insertions(+), 5 deletions(-)

diff --git a/doc/spd-say.html b/doc/spd-say.html
index f5805ebc4..b481b3513 100644
--- a/doc/spd-say.html
+++ b/doc/spd-say.html
@@ -108,8 +108,8 @@ <h2 class="chapter" id="General">1 General</h2>
 <dd><p>Set SSML mode on (default: off).  The text contains SSML markup.
 </p></dd>
 <dt><code class="code">-e or --pipe-mode</code></dt>
-<dd><p>Set pipe mode on (default: off).  Reads text from stdin, writes to stdout, and also
-sends to Speech Dispatcher.
+<dd><p>Set pipe mode on (default: off).  Read text to be spoken on stdin, write it on stdout unchanged, and the
+corresponding speech through Speech Dispatcher.
 </p></dd>
 <dt><code class="code">-w or --wait</code></dt>
 <dd><p>Wait till the end of speaking the message. In this mode, spd-say returns only after
diff --git a/doc/spd-say.texi b/doc/spd-say.texi
index 4784eb764..45b4ff760 100644
--- a/doc/spd-say.texi
+++ b/doc/spd-say.texi
@@ -104,8 +104,8 @@ Spell the message.
 @item -x or --ssml
 Set SSML mode on (default: off).  The text contains SSML markup.
 @item -e or --pipe-mode
-Set pipe mode on (default: off).  Reads text from stdin, writes to stdout, and also
-sends to Speech Dispatcher.
+Set pipe mode on (default: off).  Read text to be spoken on stdin, write it on stdout unchanged, and the
+corresponding speech through Speech Dispatcher.
 @item -w or --wait
 Wait till the end of speaking the message. In this mode, spd-say returns only after
 the message is fully spoken on the speakers or after it gets discarded.
diff --git a/src/clients/say/options.c b/src/clients/say/options.c
index 6f74316c5..3416552dc 100644
--- a/src/clients/say/options.c
+++ b/src/clients/say/options.c
@@ -129,7 +129,8 @@ void options_print_help(char *argv[])
 	printf("\n");
 
 	printf("  -e, --pipe-mode                 ");
-	printf(_("Pipe from stdin to stdout plus Speech Dispatcher\n"));
+	printf(_("Read text to be spoken on stdin, write it on stdout unchanged, and the\n"));
+	printf(_("corresponding speech through Speech Dispatcher.\n"));
 
 	printf("  -P, --priority                  ");
 	printf(_("Set priority of the message "));