]> git.ipfire.org Git - thirdparty/zstd.git/commitdiff
Moving documentation and elaborating
authorBimba Shrestha <bimbashrestha@fb.com>
Fri, 31 Jan 2020 01:54:42 +0000 (17:54 -0800)
committerBimba Shrestha <bimbashrestha@fb.com>
Fri, 31 Jan 2020 01:54:42 +0000 (17:54 -0800)
programs/zstd.1.md

index 5997ed6a59f111ff2ea542db037785b867c2224d..7dcc90339be85878b3d39c2b017ce2625b0d30b6 100644 (file)
@@ -248,6 +248,14 @@ If the value of `ZSTD_CLEVEL` is not a valid integer, it will be ignored with a
 `ZSTD_CLEVEL` just replaces the default compression level (`3`).
 It can be overridden by corresponding command line arguments.
 
+### Misc. arguments
+
+* `--show-default-cparams`:
+    Shows the default compresssion parameters that will be used for a
+    particular src file. If the provided src file is not a regular file
+    (eg. named pipe), the cli will just output the default paramters.
+    That is, the parameters that are used when the src size is
+    unknown.
 
 DICTIONARY BUILDER
 ------------------
@@ -363,11 +371,6 @@ Compression of small files similar to the sample set will be greatly improved.
 
     `zstd --train-legacy=selectivity=8 FILEs`
 
-* `--show-default-cparams`:
-    Shows the default compresssion parameters that will be used for a
-    particular src file. If the provided src file is not a regular file
-    (eg. named pipe), the cli will just output the default paramters.
-
 
 BENCHMARK
 ---------