From: binhdvo <binhvo@gmail.com>
Date: Mon, 29 Nov 2021 19:10:43 +0000 (-0500)
Subject: Clarify documentation for -c (#2883)
X-Git-Tag: v1.5.1~1^2~52
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=7abebc847b5e3d1f4cd632289b1e6cdfc85cee8d;p=thirdparty%2Fzstd.git

Clarify documentation for -c (#2883)
---

diff --git a/contrib/pzstd/Options.cpp b/contrib/pzstd/Options.cpp
index 37292221b..90f9d571f 100644
--- a/contrib/pzstd/Options.cpp
+++ b/contrib/pzstd/Options.cpp
@@ -87,7 +87,7 @@ void usage() {
   std::fprintf(stderr, "  -V, --version          : display version number and exit\n");
   std::fprintf(stderr, "  -v, --verbose          : verbose mode; specify multiple times to increase log level (default:2)\n");
   std::fprintf(stderr, "  -q, --quiet            : suppress warnings; specify twice to suppress errors too\n");
-  std::fprintf(stderr, "  -c, --stdout           : force write to standard output, even if it is the console\n");
+  std::fprintf(stderr, "  -c, --stdout           : write to standard output (even if it is the console)\n");
 #ifdef UTIL_HAS_CREATEFILELIST
   std::fprintf(stderr, "  -r                     : operate recursively on directories\n");
 #endif
diff --git a/programs/README.md b/programs/README.md
index 02a83ca3c..5570f90c3 100644
--- a/programs/README.md
+++ b/programs/README.md
@@ -156,7 +156,7 @@ Arguments :
 
 Advanced arguments :
  -V     : display Version number and exit
- -c     : force write to standard output, even if it is the console
+ -c     : write to standard output (even if it is the console)
  -v     : verbose mode; specify multiple times to increase verbosity
  -q     : suppress warnings; specify twice to suppress errors too
 --no-progress : do not display the progress counter
diff --git a/programs/zstd.1 b/programs/zstd.1
index 63e8863c9..3dd8634df 100644
--- a/programs/zstd.1
+++ b/programs/zstd.1
@@ -111,7 +111,7 @@ This is also used during compression when using with \-\-patch\-from=\. In this
 .IP "\[ci]" 4
 \fB\-f\fR, \fB\-\-force\fR: disable input and output checks\. Allows overwriting existing files, input from console, output to stdout, operating on links, block devices, etc\.
 .IP "\[ci]" 4
-\fB\-c\fR, \fB\-\-stdout\fR: force write to standard output, even if it is the console
+\fB\-c\fR, \fB\-\-stdout\fR: write to standard output (even if it is the console)
 .IP "\[ci]" 4
 \fB\-\-[no\-]sparse\fR: enable / disable sparse FS support, to make files with many zeroes smaller on disk\. Creating sparse files may save disk space and speed up decompression by reducing the amount of disk I/O\. default: enabled when output is into a file, and disabled when output is stdout\. This setting overrides default and can force sparse mode over stdout\.
 .IP "\[ci]" 4
diff --git a/programs/zstd.1.md b/programs/zstd.1.md
index 94ef87869..ef37fef32 100644
--- a/programs/zstd.1.md
+++ b/programs/zstd.1.md
@@ -208,7 +208,7 @@ the last one takes effect.
     disable input and output checks. Allows overwriting existing files, input
     from console, output to stdout, operating on links, block devices, etc.
 * `-c`, `--stdout`:
-    force write to standard output, even if it is the console
+    write to standard output (even if it is the console)
 * `--[no-]sparse`:
     enable / disable sparse FS support,
     to make files with many zeroes smaller on disk.
diff --git a/programs/zstdcli.c b/programs/zstdcli.c
index 05c537b5e..a3f8ebab7 100644
--- a/programs/zstdcli.c
+++ b/programs/zstdcli.c
@@ -163,7 +163,7 @@ static void usage_advanced(const char* programName)
     DISPLAYOUT( "Advanced arguments : \n");
     DISPLAYOUT( " -V     : display Version number and exit \n");
 
-    DISPLAYOUT( " -c     : force write to standard output, even if it is the console \n");
+    DISPLAYOUT( " -c     : write to standard output (even if it is the console) \n");
 
     DISPLAYOUT( " -v     : verbose mode; specify multiple times to increase verbosity \n");
     DISPLAYOUT( " -q     : suppress warnings; specify twice to suppress errors too \n");