updated README with recent help screen

This commit is contained in:
Jaromil 2017-04-16 13:06:33 +02:00
parent f9dc9ed5a7
commit 7241eb0fd1

View File

@ -15,7 +15,7 @@
[![software by Dyne.org](https://www.dyne.org/wp-content/uploads/2015/12/software_by_dyne.png)](http://www.dyne.org)
Updates on website: https://www.dyne.org/software/tomb
More information and updates on website: https://www.dyne.org/software/tomb
Get the stable .tar.gz signed release for production use!
@ -65,12 +65,12 @@ For the instructions on how to get started using Tomb, see [INSTALL](INSTALL.md)
Commands:
// Creation:
dig create a new empty TOMB file of size -s in MB
dig create a new empty TOMB file of size -s in MiB
forge create a new KEY file and set its password
lock installs a lock on a TOMB to use it with KEY
// Operations on tombs:
open open an existing TOMB (-k specify KEY file)
open open an existing TOMB (-k KEY file or - for stdin)
index update the search indexes of tombs
search looks for filenames matching text patterns
list list of open TOMBs and information on them
@ -87,16 +87,19 @@ For the instructions on how to get started using Tomb, see [INSTALL](INSTALL.md)
// Steganography:
bury hide a KEY inside a JPEG image (for use with -k)
exhume extract a KEY from a JPEG image (prints to stout)
exhume extract a KEY from a JPEG image (prints to stdout)
Options:
-s size of the tomb file when creating/resizing one (in MB)
-s size of the tomb file when creating/resizing one (in MiB)
-k path to the key to be used ('-k -' to read from stdin)
-n don't process the hooks found in tomb
-o mount options used to open (default: rw,noatime,nodev)
-o options passed to commands: open, lock, forge (see man)
-f force operation (i.e. even if swap is active)
--kdf generate passwords armored against dictionary attacks
-g use a GnuPG key to encrypt a tomb key
-r provide GnuPG recipients (separated by coma)
-R provide GnuPG hidden recipients (separated by coma)
--kdf forge keys armored against dictionary attacks
-h print this help
-v print version, license and list of available ciphers
@ -190,8 +193,6 @@ some are developed by Dyne.org, but some also by third parties.
- [pass-tomb](https://github.com/roddhjav/pass-tomb) is a console based wrapper of the excellent password keeping program [pass](https://www.passwordstore.org) that helps to keep the whole tree of password encrypted inside a tomb. It is written in Bash.
- [OpenTomb](https://sourceforge.net/projects/opentomb/files/) is just an open-source community maintained version of Tomb Raider and we just wish we'd have anything to do with it... ;^)
If you are writing a project supporting tomb volumes or wrapping tomb, let us know!