]> git.proxmox.com Git - ceph.git/blob - ceph/src/zstd/contrib/experimental_dict_builders/randomDictBuilder/README.md
import 15.2.0 Octopus source
[ceph.git] / ceph / src / zstd / contrib / experimental_dict_builders / randomDictBuilder / README.md
1 Random Dictionary Builder
2
3 ### Permitted Arguments:
4 Input File/Directory (in=fileName): required; file/directory used to build dictionary; if directory, will operate recursively for files inside directory; can include multiple files/directories, each following "in="
5 Output Dictionary (out=dictName): if not provided, default to defaultDict
6 Dictionary ID (dictID=#): nonnegative number; if not provided, default to 0
7 Maximum Dictionary Size (maxdict=#): positive number; in bytes, if not provided, default to 110KB
8 Size of Randomly Selected Segment (k=#): positive number; in bytes; if not provided, default to 200
9
10 ###Running Test:
11 make test
12
13
14 ###Usage:
15 To build a random dictionary with the provided arguments: make ARG= followed by arguments
16
17
18 ### Examples:
19 make ARG="in=../../../lib/dictBuilder out=dict100 dictID=520"
20 make ARG="in=../../../lib/dictBuilder in=../../../lib/compress"