Skip to content

Commit

Permalink
Merge pull request #46 from pelayogmp/patch-1
Browse files Browse the repository at this point in the history
USAGE.md Minor formatting fixes
  • Loading branch information
fancycode committed Jun 20, 2017
2 parents 996570e + c51ab6c commit 420dcc5
Showing 1 changed file with 17 additions and 8 deletions.
25 changes: 17 additions & 8 deletions doc/USAGE.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,51 +32,60 @@ For compression, additional parameters can be specified

## Other available parameters are:

###dictionary
### dictionary

Dictionary size (Range 0-28, Default: 23 (8MB))

The maximum value for dictionary size is 256 MB = 2^28 bytes.
Dictionary size is calculated as DictionarySize = 2^N bytes.
For decompressing file compressed by LZMA method with dictionary
size D = 2^N you need about D bytes of memory (RAM).

###fastBytes
### fastBytes

Range 5-255, default 128

Usually big number gives a little bit better compression ratio and slower
compression process.

###literalContextBits
### literalContextBits

Range 0-8, default 3

Sometimes literalContextBits=4 gives gain for big files.

###literalPosBits
### literalPosBits

Range 0-4, default 0

This switch is intended for periodical data when period is equal 2^N.
For example, for 32-bit (4 bytes) periodical data you can use
literalPosBits=2. Often it's better to set literalContextBits=0, if you
change the literalPosBits switch.

###posBits
### posBits

Range 0-4, default 2

This switch is intended for periodical data when period is equal 2^N.

###algorithm
### algorithm

Compression mode 0 = fast, 1 = normal, 2 = max (Default: 2)

The lower the number specified for algorithm, the faster compression will
perform.

###multithreading
### multithreading

Use multithreading if available? (Default yes)

Currently, multithreading is only available on Windows platforms.

###eos
### eos

Should the `End Of Stream` marker be written? (Default yes)

You can save some bytes if the marker is omitted, but the total uncompressed
size must be stored by the application and used when decompressing:

Expand Down

0 comments on commit 420dcc5

Please sign in to comment.