Examples on the line following commands in the README

This commit is contained in:
Kevin MacMartin 2014-05-29 15:33:26 -04:00
parent f86db13d18
commit 9fb54c6786

View file

@ -5,9 +5,12 @@ A script that wraps **cryptsetup**, **mkfs** and **losetup** to make it easy to
## Usage ## ## Usage ##
* `cryptobox`: displays the list of commands * `cryptobox`: displays the list of commands
* `cryptobox c filename.img filesystem size-in-mb`: creates an image file with a given filesystem and size in megabytes. (eg: `cryptobox c myimg.img ext4 128`) * `cryptobox c filename.img filesystem size-in-mb`: creates an image file with a given filesystem and size in megabytes.
* `cryptobox m filename.img /mount/point`: mounts a given image file on a given directory. (eg: `cryptobox m myimg.img /mnt/cryptoimg`) * eg: `cryptobox c myimg.img ext4 128`
* `cryptobox u /mount/point`: unmounts an image file from a given directory. (eg: `cryptobox u /mnt/cryptoimg`) * `cryptobox m filename.img /mount/point`: mounts a given image file on a given directory.
* eg: `cryptobox m myimg.img /mnt/cryptoimg`
* `cryptobox u /mount/point`: unmounts an image file from a given directory.
* eg: `cryptobox u /mnt/cryptoimg`
## License ## ## License ##