blob: 87f68d13b727d5b62d47972c2e1c2e564d4f31e5 [file] [log] [blame] [view]
<!-- DO NOT EDIT THIS FILE DIRECTLY
This file is generated using clidoc by parsing the help output of this tool.
Please edit the help output or clidoc's processing of that output to make changes
to this file.
-->
# blobfs-compression
```none {: style="white-space: break-spaces;" .devsite-disable-click-to-copy}
Usage: blobfs-compression [--option1=value --option2 ...]
The tool will output the maximum possible compressed file size using the exact same
compression implementation in blobfs. The merkle tree used here is a non-compact merkle
tree as it contributes to a bigger size than a compact merkle tree.
```
__Options:__
```none {: style="white-space: break-spaces;" .devsite-disable-click-to-copy}
--source_file=/path/to/file
(required) the file to be compressed.
--compressed_file=/path/to/file
(optional) the compressed file output path (override if existing). Unless --type is specified, will contain compressed data with zero-padding at the end to ensure the compressed file size matches the size in stdout.
--type=TYPE
(optional) If specified, uses specified type for size calculation, and will output blob in delivery format. Output is only compressed if space is saved. Supported types:
1 - Type A: zstd-chunked, default compression level
--disable_size_alignment
Do not align compressed output with block size. Incompatible with --type.
--help
print this usage message.
--verbose
show debugging information.
```