DBFS/docs/HELP.txt
2022-07-08 19:21:43 -04:00

67 lines
2.2 KiB
Plaintext

<Arguments>
--help
Display usage and version information about this application.
--run
Attempt to mount and run the database file system as
configured. This is blocking and is optimized to run via
systemd but can still run without systemd if desired.
--blk-size <numeric-value-in-bytes>
Use this option along --run if initializing the filesystem
for the first time. this parameter will adjust the block
size of the file system. The smaller the blk_size, the
greater the compression effect will take hold; however,
with that comes higher overhead because more hash values
will need to be calculated per file and more blocks per
file read will need to be fetched. This is ignored if a
filesystem already exist in the database, it will instead
use the blk_size value already stored in the database.
If not given, a default value of 16777216 is used.
--config <path-to-json-file>
Use this option to point to a json formatted file to
configure the application's behaviour upon mounting the
database file system. If not present, it will use the
default config file location.
--config-help
Display details about the json config file and the
various elements it uses to change application behaviour.
--list-db-drvs
List all QT based database drivers the application
currently supports. Any value returned by this command
line argument can then be used in "db_drv" inside of the
config file to pick which type of database you desire to
use.
--list-datasets
List all datasets (forks and snapshots) currently in the
database.
--fork <--src name> <--dst name>
This creates a new fork of the given dataset in <src>
with the new name given in <dst>. A fork is basically a
copy of the <src> dataset that is re-writable.
--snapshot <--src name> <--dst name>
This creates a new snapshot of the given dataset in
<src> with the new name given in <dst>. A snapshot is
basically a copy of the <src> dataset that is read-only
--rm-dataset <name>
This removes the given dataset name from the database.
The origin dataset 'root' cannot be removed.