cryptobox/README.md

# Cryptobox #

A script that wraps **cryptsetup**, **mkfs** and **losetup** to make it easy to create, mount and unmount encrypted image files using LUKS.

## Usage ##

* `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 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 ##

This script is open source and licensed under the [GPLv3](http://www.gnu.org/copyleft/gpl.html).
Updated README to markdown and started improving the script 2014-05-28 20:56:12 -04:00			`# Cryptobox #`

			`A script that wraps cryptsetup, mkfs and losetup to make it easy to create, mount and unmount encrypted image files using LUKS.`

			`## Usage ##`

Made commands easier to read in the README 2014-05-29 15:31:59 -04:00			* `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 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`)
Updated README to markdown and started improving the script 2014-05-28 20:56:12 -04:00
			`## License ##`

			`This script is open source and licensed under the [GPLv3](http://www.gnu.org/copyleft/gpl.html).`