itMerge pull request #208 from Narrat/man-page - tomb - the crypto undertaker Err parazyd.org 70 hgit clone git://parazyd.org/tomb.git URL:git://parazyd.org/tomb.git parazyd.org 70 1Log /git/tomb/log.gph parazyd.org 70 1Files /git/tomb/files.gph parazyd.org 70 1Refs /git/tomb/refs.gph parazyd.org 70 1README /git/tomb/file/README.md.gph parazyd.org 70 1LICENSE /git/tomb/file/COPYING.gph parazyd.org 70 i--- Err parazyd.org 70 1commit 83c1653840a0a6ea2be967a86171a5e3363c831f /git/tomb/commit/83c1653840a0a6ea2be967a86171a5e3363c831f.gph parazyd.org 70 1parent b8447dbf24731c4ca26307efaaf27b4b085a6b0b /git/tomb/commit/b8447dbf24731c4ca26307efaaf27b4b085a6b0b.gph parazyd.org 70 hAuthor: Jaromil URL:mailto:jaromil@dyne.org parazyd.org 70 iDate: Thu, 9 Jul 2015 02:54:20 +0200 Err parazyd.org 70 i Err parazyd.org 70 iMerge pull request #208 from Narrat/man-page Err parazyd.org 70 i Err parazyd.org 70 iMan-Page: Small fixes Err parazyd.org 70 iDiffstat: Err parazyd.org 70 i M doc/tomb.1 | 43 ++++++++++++++++++------------- Err parazyd.org 70 i Err parazyd.org 70 i1 file changed, 25 insertions(+), 18 deletions(-) Err parazyd.org 70 i--- Err parazyd.org 70 1diff --git a/doc/tomb.1 b/doc/tomb.1 /git/tomb/file/doc/tomb.1.gph parazyd.org 70 it@@ -52,7 +52,7 @@ system. Err parazyd.org 70 i .IP "lock" Err parazyd.org 70 i Initializes and locks an empty tomb (made with \fIdig\fR) using a key Err parazyd.org 70 i (made with \fIforge\fR), making it ready for usage. After this Err parazyd.org 70 i-operation, the tomb can only be open in possession of the key and Err parazyd.org 70 i+operation, the tomb can only be opened in possession of the key and Err parazyd.org 70 i knowing its password. As in any other command requiring a key, the Err parazyd.org 70 i option \fI-k\fR should be used to specify a key file. The \fI-o\fR Err parazyd.org 70 i option can be used to specify the cipher specification: default is Err parazyd.org 70 it@@ -65,15 +65,16 @@ LUKS and Ext4), then set the key in its first LUKS slot. Err parazyd.org 70 i Opens an existing \fI.tomb\fR (first argument) using a key (\fI-k\fR), Err parazyd.org 70 i if a second argument is given it will indicate the \fImountpoint\fR Err parazyd.org 70 i where the tomb should be made accessible, else the tomb is mounted in Err parazyd.org 70 i-a directory inside /media. The option \fI-o\fR can be used to pass Err parazyd.org 70 i-mount(8) options (default: rw,noatime,nodev). Err parazyd.org 70 i+a directory inside /media (if not available it uses /run/media/$USER). Err parazyd.org 70 i+The option \fI-o\fR can be used to pass mount(8) options Err parazyd.org 70 i+(default: rw,noatime,nodev). Err parazyd.org 70 i Err parazyd.org 70 i .B Err parazyd.org 70 i .IP "list" Err parazyd.org 70 i List all the tombs found open, including information about the time Err parazyd.org 70 i they were opened and the hooks that they mounted. If the first Err parazyd.org 70 i argument is present, then shows only the tomb named that way or Err parazyd.org 70 i-returns an error if its not found. If the option Err parazyd.org 70 i+returns an error if it's not found. If the option Err parazyd.org 70 i \fI--get-mountpoint\fR is used then print a simple list of currently Err parazyd.org 70 i open tomb mountpoint paths. Err parazyd.org 70 i Err parazyd.org 70 it@@ -105,9 +106,9 @@ the tomb is in use by running processes (to force close, see Err parazyd.org 70 i Err parazyd.org 70 i .B Err parazyd.org 70 i .IP "slam" Err parazyd.org 70 i-Closes a tomb like the command \fIclose\fR does, but it doesn't fails Err parazyd.org 70 i+Closes a tomb like the command \fIclose\fR does, but it doesn't fail Err parazyd.org 70 i even if the tomb is in use by other application processes: it looks Err parazyd.org 70 i-for them and violently kills \-9 each of them. This command may Err parazyd.org 70 i+for and violently kills \-9 each of them. This command may Err parazyd.org 70 i provoke unsaved data loss, but assists users to face surprise Err parazyd.org 70 i situations. Err parazyd.org 70 i Err parazyd.org 70 it@@ -133,7 +134,7 @@ key and the second and last argument the tomb file. Err parazyd.org 70 i .IP "resize" Err parazyd.org 70 i Increase the size of a tomb file to the amount specified by the Err parazyd.org 70 i \fI-s\fR option, which is the new size in megabytes (MiB). Full access to the tomb using Err parazyd.org 70 i-a key (\fI-k\fR) and its password is requires. Tombs can only grow and Err parazyd.org 70 i+a key (\fI-k\fR) and its password is required. Tombs can only grow and Err parazyd.org 70 i can never be made smaller. This command makes use of the cryptsetup Err parazyd.org 70 i resize feature and the resize2fs command: its much more practical than Err parazyd.org 70 i creating a new tomb and moving everything into it. Err parazyd.org 70 it@@ -141,7 +142,7 @@ creating a new tomb and moving everything into it. Err parazyd.org 70 i .B Err parazyd.org 70 i .IP "engrave" Err parazyd.org 70 i This command transforms a tomb key into an image that can be printed Err parazyd.org 70 i-on paper and phisically stored as backup, i.e. hidden in a book. It Err parazyd.org 70 i+on paper and physically stored as backup, i.e. hidden in a book. It Err parazyd.org 70 i Renders a QRCode of the tomb key, still protected by its password: a Err parazyd.org 70 i PNG image (extension \fI.qr.png\fR) will be created in the current Err parazyd.org 70 i directory and can be later printed (fits an A4 or Letter format). To Err parazyd.org 70 it@@ -192,7 +193,7 @@ Force flag, currently used to override swap checks, might be Err parazyd.org 70 i overriding more wimpy behaviours in future, but make sure you know Err parazyd.org 70 i what you are doing if you force an operation. Err parazyd.org 70 i .B Err parazyd.org 70 i-.IP "-s \fI\fR" Err parazyd.org 70 i+.IP "-s \fI\fR" Err parazyd.org 70 i When digging or resizing a tomb, this option must be used to specify Err parazyd.org 70 i the \fIsize\fR of the new file to be created. Units are megabytes (MiB). Err parazyd.org 70 i .B Err parazyd.org 70 it@@ -228,7 +229,7 @@ wrappers and testing suite. Err parazyd.org 70 i .B Err parazyd.org 70 i .IP "--use-urandom" Err parazyd.org 70 i Use an inferior quality random source to improve the speed of key Err parazyd.org 70 i-generation at the cost of security (neede for the testing suite). Err parazyd.org 70 i+generation at the cost of security (needed for the testing suite). Err parazyd.org 70 i .B Err parazyd.org 70 i .IP "--sudo-pwd " Err parazyd.org 70 i Use string as password when needed for privilege escalation via sudo. Err parazyd.org 70 it@@ -275,8 +276,8 @@ example: Err parazyd.org 70 i .B Err parazyd.org 70 i .IP "post-hooks" Err parazyd.org 70 i This hook file gets executed as user by tomb right after opening it; Err parazyd.org 70 i-it should be a regular shell script, starting with a shell bang. Tomb Err parazyd.org 70 i-executes this hook as user (dropping root priviledges) and giving it Err parazyd.org 70 i+it should be a regular shell script, starting with a shebang. Tomb Err parazyd.org 70 i+executes this hook as user (dropping root privileges) and giving it Err parazyd.org 70 i two arguments: "$1" is "open" or "close" depending from the tomb Err parazyd.org 70 i command given, "$2" is the full path to the mountpoint where the tomb Err parazyd.org 70 i is open. Err parazyd.org 70 it@@ -308,7 +309,7 @@ the DISPLAY environment var. Err parazyd.org 70 i .SH SWAP Err parazyd.org 70 i Err parazyd.org 70 i On execution of certain commands Tomb will complain about swap memory Err parazyd.org 70 i-on disk when that is presend and \fIabort if your system has swap Err parazyd.org 70 i+on disk when present and \fIabort if your system has swap Err parazyd.org 70 i activated\fR. You can disable this behaviour using the Err parazyd.org 70 i \fI--force\fR. Before doing that, however, you may be interested in Err parazyd.org 70 i knowing the risks of doing so: Err parazyd.org 70 it@@ -346,7 +347,7 @@ Open a Tomb using the key from a remote SSH shell, without saving any Err parazyd.org 70 i local copy of it: Err parazyd.org 70 i Err parazyd.org 70 i .EX Err parazyd.org 70 i- ssh user@my.shell.net 'cat .secrets/tomb.key' | tomb open secret.tomb -k - Err parazyd.org 70 i+ ssh user@my.shell.net 'cat .secrets/tomb.key' | tomb open secret.tomb -k - Err parazyd.org 70 i .EE Err parazyd.org 70 i Err parazyd.org 70 i .IP \(bu Err parazyd.org 70 it@@ -447,15 +448,21 @@ notice are preserved on all copies. Err parazyd.org 70 i Err parazyd.org 70 i The most recent version of Tomb sourcecode and up to date Err parazyd.org 70 i documentation is available for download from its website on Err parazyd.org 70 i-\fIhttp://tomb.dyne.org\fR. Err parazyd.org 70 i+\fIhttps://tomb.dyne.org\fR. Err parazyd.org 70 i Err parazyd.org 70 i .SH SEE ALSO Err parazyd.org 70 i Err parazyd.org 70 i .B Err parazyd.org 70 i .IP cryptsetup(8) Err parazyd.org 70 i Err parazyd.org 70 i-GnuPG website on http://www.gnupg.org Err parazyd.org 70 i+GnuPG website: Err parazyd.org 70 i+.br Err parazyd.org 70 i+https://www.gnupg.org Err parazyd.org 70 i Err parazyd.org 70 i-DM-Crypt website on http://www.saout.de/misc/dm-crypt Err parazyd.org 70 i+DM-Crypt website: Err parazyd.org 70 i+.br Err parazyd.org 70 i+https://gitlab.com/cryptsetup/cryptsetup/wikis/DMCrypt Err parazyd.org 70 i Err parazyd.org 70 i-LUKS website, http://code.google.com/p/cryptsetup Err parazyd.org 70 i+LUKS website: Err parazyd.org 70 i+.br Err parazyd.org 70 i+https://gitlab.com/cryptsetup/cryptsetup/wikis/home Err parazyd.org 70 .