]> git.ipfire.org Git - thirdparty/zstd.git/commitdiff
[doc] Adding -M# decompression operation modifier documentation (#1938)
authorBimba Shrestha <bimbashrestha@fb.com>
Sat, 4 Jan 2020 00:36:47 +0000 (16:36 -0800)
committerYann Collet <Cyan4973@users.noreply.github.com>
Sat, 4 Jan 2020 00:36:47 +0000 (16:36 -0800)
* Adding -M# operation modifier documentation

* Adding long name, typo and update desc

programs/zstd.1.md

index 6a63e978fae6681274248d6d7e2f49f18e1db8a5..22a76c239e29beb03b6cc125f4d4dcf9709b26c3 100644 (file)
@@ -122,6 +122,11 @@ the last one takes effect.
 
     Note: If `windowLog` is set to larger than 27, `--long=windowLog` or
     `--memory=windowSize` needs to be passed to the decompressor.
+* `-M#`, `--memory=#`:
+    Set a memory usage limit for decompression. By default, Zstandard uses 128 MB
+    as the maximum amount of memory the decompressor is allowed to use, but you can
+    override this manually if need be in either direction (ie. you can increase or
+    decrease it).
 * `-T#`, `--threads=#`:
     Compress using `#` working threads (default: 1).
     If `#` is 0, attempt to detect and use the number of physical CPU cores.