1
0
mirror of https://github.com/hsoft/collapseos.git synced 2024-11-20 20:28:06 +11:00
collapseos/tools/cfspack/README.md
2019-06-02 16:35:41 -04:00

30 lines
833 B
Markdown

# cfspack
A tool/library to pack files into a CFS blob and unpack a CFS blob into
a directory.
## Usage
To pack a directory into a CFS blob, run:
cfspack /path/to/directory
The blob is spit to stdout. If there are subdirectories, they will be prefixes
to the filenames under it.
`cfspack` takes an optional second argument, a "fnmatch" pattern. If specified,
only files patching the pattern will be included.
If path is a file, a CFS with a single file will be spit and its name will
exclude the directory part of that filename.
The program errors out if a file name is too long (> 26 bytes) or too big
(> 0x10000 - 0x20 bytes).
To unpack a blob to a directory:
cfsunpack /path/to/dest < blob
If destination exists, files are created alongside existing ones. If a file to
unpack already exists, it is overwritten.