summaryrefslogtreecommitdiff
path: root/rust-src/README.md
blob: e4700f6b3af062bab8f32e1437edb65284be15a2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
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