bcachefs-tools/rust-src/mount/README.md
Kayla Firestack 1f8fc31ddc split mount into a library crate for rust reuse
update makefile to output shared library and rust build
fix default.nix to properly get the binary name for `ln`ing - move binary to main.rs
add rustfmt and gitignore files
move build.rs file into bch_bindgen for reuse between projects
add outputs to nix flake and checks
add mount.toml to makefile
2021-10-18 16:30:52 -04:00

63 lines
1.2 KiB
Markdown

Usage
=====
```
bcachefs-mount 0.1.0
Mount a bcachefs filesystem by its UUID
USAGE:
bcachefs-mount [OPTIONS] <uuid> <mountpoint>
FLAGS:
-h, --help
Prints help information
-V, --version
Prints version information
OPTIONS:
-o <options>
Mount options [default: ]
-p, --password <password>
Where the password would be loaded from.
Possible values are: "fail" - don't ask for password, fail if filesystem is encrypted; "wait" - wait for
password to become available before mounting; "ask" - prompt the user for password; [default: fail]
ARGS:
<uuid>
External UUID of the bcachefs filesystem
<mountpoint>
Where the filesystem should be mounted
```
Caveats
=======
* `--password ask` is not yet implemented, but you can use `--password wait`, and load the key with `bcachefs unlock`.
Build
=====
```sh
$ git submodule update --init --recursive
$ cargo build --release
```
Binary will be built in `target/release/bcachefs-mount`
Dependencies:
* rust
* blkid
* uuid
* liburcu
* libsodium
* zlib
* liblz4
* libzstd
* libkeyutils