From: Bimba Shrestha <bimbashrestha@fb.com>
Date: Sat, 4 Jan 2020 00:36:47 +0000 (-0800)
Subject: [doc] Adding -M# decompression operation modifier documentation (#1938)
X-Git-Tag: v1.4.5^2~126
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=ef1684f29a1757596147856294be90d274546f42;p=thirdparty%2Fzstd.git

[doc] Adding -M# decompression operation modifier documentation (#1938)

* Adding -M# operation modifier documentation

* Adding long name, typo and update desc
---

diff --git a/programs/zstd.1.md b/programs/zstd.1.md
index 6a63e978f..22a76c239 100644
--- a/programs/zstd.1.md
+++ b/programs/zstd.1.md
@@ -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.