spd-say: Clarify the behavior of --pipe-mode

Fixes #855
brailcom · Sep 6, 2023 · a400bc9 · a400bc9
1 parent 1a97e88
commit a400bc9
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 5 deletions.
diff --git a/doc/spd-say.html b/doc/spd-say.html
diff --git 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
@@ -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 "));