kkyy
/
xmnt
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

docs: update readme

This commit is contained in:
Yiyang Kang 2022-10-07 03:55:07 +08:00
parent e90230175b
commit f2c842b7ba
Signed by: kkyy
GPG Key ID: 80FD317ECAF06CC3
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -8,7 +8,7 @@ I have encrypted partitions that I need to mount and unmount from time to time.
I use GPG to encrypt the keys for each partition, save them as `${uuid}.key` I use GPG to encrypt the keys for each partition, save them as `${uuid}.key`
With this tool, I can mount and unmount these partitions with one command. With `xmnt`, I can mount and unmount these partitions with one command.
## Usage ## Usage
@ -28,13 +28,13 @@ the key when necessary, then use the key to open `/dev/nvme0n1p2`, and mount it
on `/boot`. on `/boot`.
Directories for storing encryption keys are defined in Directories for storing encryption keys are defined in
`$XDG_CONFIG_HOME/xmnt/xmnt.yml`. The tool will recursively search these `$XDG_CONFIG_HOME/xmnt/xmnt.yml`. `xmnt` will recursively search these
directories for keys. directories for keys.
You can also use it without defining presets. See `--help` for detailed usage. You can also use it without defining presets. See `--help` for detailed usage.
## Supported partition types ## Supported partition types
- luks encrypted partitions (e.g. ext4). "plain" format is not supported. - luks encrypted partitions (e.g. ext4). luks "plain" format is not supported.
- regular unencrypted partitions - regular unencrypted partitions
- zfs datasets - zfs datasets (`keylocation=prompt`)