git.sesse.net Git - bcachefs-tools-debian/blob - rust-src/README.md

   1 Usage
   2 =====
   3
   4 ```
   5 bcachefs-mount 0.1.0
   6 Mount a bcachefs filesystem by its UUID
   7
   8 USAGE:
   9     bcachefs-mount [OPTIONS] <uuid> <mountpoint>
  10
  11 FLAGS:
  12     -h, --help
  13             Prints help information
  14
  15     -V, --version
  16             Prints version information
  17
  18
  19 OPTIONS:
  20     -o <options>
  21             Mount options [default: ]
  22
  23     -p, --password <password>
  24             Where the password would be loaded from.
  25
  26             Possible values are: "fail" - don't ask for password, fail if filesystem is encrypted; "wait" - wait for
  27             password to become available before mounting; "ask" -  prompt the user for password; [default: fail]
  28
  29 ARGS:
  30     <uuid>
  31             External UUID of the bcachefs filesystem
  32
  33     <mountpoint>
  34             Where the filesystem should be mounted
  35 ```
  36
  37 Caveats
  38 =======
  39
  40 * `--password ask` is not yet implemented, but you can use `--password wait`, and load the key with `bcachefs unlock`.
  41
  42 Build
  43 =====
  44
  45 ```sh
  46 $ git submodule update --init --recursive
  47 $ cargo build --release
  48 ```
  49
  50 Binary will be built in `target/release/bcachefs-mount`
  51
  52 Dependencies:
  53
  54 * rust
  55 * blkid
  56 * uuid
  57 * liburcu
  58 * libsodium
  59 * zlib
  60 * liblz4
  61 * libzstd
  62 * libkeyutils