Llewellyn/Tomb
1
0
Fork 0
mirror of https://github.com/Llewellynvdm/Tomb.git synced 2024-11-12 07:46:28 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #208 from Narrat/man-page

Browse Source 
Man-Page: Small fixes
This commit is contained in:
Jaromil 2015-07-09 02:54:20 +02:00
commit 83c1653840
1 changed files with 25 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
doc/tomb.1
View File

@ -52,7 +52,7 @@ system.
.IP "lock" .IP "lock"
Initializes and locks an empty tomb (made with \fIdig\fR) using a key Initializes and locks an empty tomb (made with \fIdig\fR) using a key
(made with \fIforge\fR), making it ready for usage. After this (made with \fIforge\fR), making it ready for usage. After this
operation, the tomb can only be open in possession of the key and operation, the tomb can only be opened in possession of the key and
knowing its password. As in any other command requiring a key, the knowing its password. As in any other command requiring a key, the
option \fI-k\fR should be used to specify a key file. The \fI-o\fR option \fI-k\fR should be used to specify a key file. The \fI-o\fR
option can be used to specify the cipher specification: default is option can be used to specify the cipher specification: default is
@ -65,15 +65,16 @@ LUKS and Ext4), then set the key in its first LUKS slot.
Opens an existing \fI.tomb\fR (first argument) using a key (\fI-k\fR), Opens an existing \fI.tomb\fR (first argument) using a key (\fI-k\fR),
if a second argument is given it will indicate the \fImountpoint\fR if a second argument is given it will indicate the \fImountpoint\fR
where the tomb should be made accessible, else the tomb is mounted in where the tomb should be made accessible, else the tomb is mounted in
a directory inside /media. The option \fI-o\fR can be used to pass a directory inside /media (if not available it uses /run/media/$USER).
mount(8) options (default: rw,noatime,nodev). The option \fI-o\fR can be used to pass mount(8) options
(default: rw,noatime,nodev).
.B .B
.IP "list" .IP "list"
List all the tombs found open, including information about the time List all the tombs found open, including information about the time
they were opened and the hooks that they mounted. If the first they were opened and the hooks that they mounted. If the first
argument is present, then shows only the tomb named that way or argument is present, then shows only the tomb named that way or
returns an error if its not found. If the option returns an error if it's not found. If the option
\fI--get-mountpoint\fR is used then print a simple list of currently \fI--get-mountpoint\fR is used then print a simple list of currently
open tomb mountpoint paths. open tomb mountpoint paths.
@ -105,9 +106,9 @@ the tomb is in use by running processes (to force close, see
.B .B
.IP "slam" .IP "slam"
Closes a tomb like the command \fIclose\fR does, but it doesn't fails Closes a tomb like the command \fIclose\fR does, but it doesn't fail
even if the tomb is in use by other application processes: it looks even if the tomb is in use by other application processes: it looks
for them and violently kills \-9 each of them. This command may for and violently kills \-9 each of them. This command may
provoke unsaved data loss, but assists users to face surprise provoke unsaved data loss, but assists users to face surprise
situations. situations.
@ -133,7 +134,7 @@ key and the second and last argument the tomb file.
.IP "resize" .IP "resize"
Increase the size of a tomb file to the amount specified by the Increase the size of a tomb file to the amount specified by the
\fI-s\fR option, which is the new size in megabytes (MiB). Full access to the tomb using \fI-s\fR option, which is the new size in megabytes (MiB). Full access to the tomb using
a key (\fI-k\fR) and its password is requires. Tombs can only grow and a key (\fI-k\fR) and its password is required. Tombs can only grow and
can never be made smaller. This command makes use of the cryptsetup can never be made smaller. This command makes use of the cryptsetup
resize feature and the resize2fs command: its much more practical than resize feature and the resize2fs command: its much more practical than
creating a new tomb and moving everything into it. creating a new tomb and moving everything into it.
@ -141,7 +142,7 @@ creating a new tomb and moving everything into it.
.B .B
.IP "engrave" .IP "engrave"
This command transforms a tomb key into an image that can be printed This command transforms a tomb key into an image that can be printed
on paper and phisically stored as backup, i.e. hidden in a book. It on paper and physically stored as backup, i.e. hidden in a book. It
Renders a QRCode of the tomb key, still protected by its password: a Renders a QRCode of the tomb key, still protected by its password: a
PNG image (extension \fI.qr.png\fR) will be created in the current PNG image (extension \fI.qr.png\fR) will be created in the current
directory and can be later printed (fits an A4 or Letter format). To directory and can be later printed (fits an A4 or Letter format). To
@ -228,7 +229,7 @@ wrappers and testing suite.
.B .B
.IP "--use-urandom" .IP "--use-urandom"
Use an inferior quality random source to improve the speed of key Use an inferior quality random source to improve the speed of key
generation at the cost of security (neede for the testing suite). generation at the cost of security (needed for the testing suite).
.B .B
.IP "--sudo-pwd <string>" .IP "--sudo-pwd <string>"
Use string as password when needed for privilege escalation via sudo. Use string as password when needed for privilege escalation via sudo.
@ -275,8 +276,8 @@ example:
.B .B
.IP "post-hooks" .IP "post-hooks"
This hook file gets executed as user by tomb right after opening it; This hook file gets executed as user by tomb right after opening it;
it should be a regular shell script, starting with a shell bang. Tomb it should be a regular shell script, starting with a shebang. Tomb
executes this hook as user (dropping root priviledges) and giving it executes this hook as user (dropping root privileges) and giving it
two arguments: "$1" is "open" or "close" depending from the tomb two arguments: "$1" is "open" or "close" depending from the tomb
command given, "$2" is the full path to the mountpoint where the tomb command given, "$2" is the full path to the mountpoint where the tomb
is open. is open.
@ -308,7 +309,7 @@ the DISPLAY environment var.
.SH SWAP .SH SWAP
On execution of certain commands Tomb will complain about swap memory On execution of certain commands Tomb will complain about swap memory
on disk when that is presend and \fIabort if your system has swap on disk when present and \fIabort if your system has swap
activated\fR. You can disable this behaviour using the activated\fR. You can disable this behaviour using the
\fI--force\fR. Before doing that, however, you may be interested in \fI--force\fR. Before doing that, however, you may be interested in
knowing the risks of doing so: knowing the risks of doing so:
@ -447,15 +448,21 @@ notice are preserved on all copies.
The most recent version of Tomb sourcecode and up to date The most recent version of Tomb sourcecode and up to date
documentation is available for download from its website on documentation is available for download from its website on
\fIhttp://tomb.dyne.org\fR. \fIhttps://tomb.dyne.org\fR.
.SH SEE ALSO .SH SEE ALSO
.B .B
.IP cryptsetup(8) .IP cryptsetup(8)
GnuPG website on http://www.gnupg.org GnuPG website:
.br
https://www.gnupg.org
DM-Crypt website on http://www.saout.de/misc/dm-crypt DM-Crypt website:
.br
https://gitlab.com/cryptsetup/cryptsetup/wikis/DMCrypt
LUKS website, http://code.google.com/p/cryptsetup LUKS website:
.br
https://gitlab.com/cryptsetup/cryptsetup/wikis/home