Llewellyn/Tomb
1
0
Fork 0
mirror of https://github.com/Llewellynvdm/Tomb.git synced 2025-02-13 00:58:32 +00:00
Code Issues Packages Projects Releases Wiki Activity

manual completed also with other tomb- commands

Browse Source
This commit is contained in:
Jaromil 2011-01-26 16:16:50 +01:00
parent 5a9f754eae
commit 85fe9295bd
6 changed files with 56 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
configure.ac
View File

@ -93,6 +93,7 @@ dnl alphabetic order on dir/subdir, but Makefile sorts before everything
AC_CONFIG_FILES([
Makefile
src/Makefile
doc/Makefile
share/Makefile
])
AC_OUTPUT

5
doc/Makefile.am Normal file
View File

@ -0,0 +1,5 @@
man_MANS = tomb.1 tomb-open.1 tomb-status.1 tomb-askpass.1
EXTRA_DIST = Luks_on_disk_format.pdf New_methods_in_HD_encryption.pdf TKS1-draft.pdf

1
doc/tomb-askpass.1 Symbolic link
View File

@ -0,0 +1 @@
tomb.1

1
doc/tomb-open.1 Symbolic link
View File

@ -0,0 +1 @@
tomb.1

1
doc/tomb-status.1 Symbolic link
View File

@ -0,0 +1 @@
tomb.1

76
doc/tomb.1
View File

@ -4,7 +4,14 @@
Tomb \- the Crypto Undertaker
.SH SYNOPSIS
.B tomb [options] command [file] [mountpoint]
.B
.IP "tomb [options] command [file] [mountpoint]"
.B
.IP "tomb-open [file]"
.B
.IP "tomb-status mountpoint"
.B
.IP "tomb-askpass [file]"
.SH DESCRIPTION
@ -12,17 +19,49 @@ Tomb is a simple commandline tool for encrypted storage and it comes
complete with programs to facilitate its operation by desktop users.
Tomb generates encrypted storage files to be opened and closed using
their associated key files, which are also protected with a password
choosen by the user. A tomb is like a locked folder that can be safely
transported and hidden in a filesystem; its keys can be kept separate,
for instance keeping the tomb file on your computer harddisk and the
key files on a USB stick.
their associated keyfiles, which are also protected with a password
choosen by the user.
A tomb is like a locked folder that can be safely transported and
hidden in a filesystem; its keys can be kept separate, for instance
keeping the tomb file on your computer harddisk and the key files on a
USB stick.
When specified, \fIfile\fR is the name of the tomb to be created or
opened, while \fImountpoint\fR is an existing directory where its
contents should be made accessible.
For simplified use, the command \fItomb-open\fR can be used to start a
wizard that guides users in the creation of a new tomb or, if the
\fIfile\fR argument is specified, to open a tomb and make it
accessible in a default location under the /media folder.
The other commands \fItomb-status\fR and \fItomb-askpass\fR are mostly
for internal use (they are called by tomb with the right arguments)
and serve the purpose of communicating with the user via the graphical
interface.
The auxiliary programs \fI
.SH COMMANDS
.B
.IP "create"
Create a new encrypted storage \fIfile\fR and its keys
.B
.IP "open"
Opens an existing tomb \fIfile\fR. The \fImountpoint\fR where the tomb
will be made accessible can be specified, if not the default is to
create a directory named like the tomb inside /media.
.B
.IP "close"
Closes a currently open tomb. When \fIfile\fR is specified, it should
point to the /dev/mapper name used to mount the tomb; if \fIfile\fR is
not specified and only one tomb is open, then it will be closed; if
multiple tombs are open, the command will list them on the terminal.
.SH OPTIONS
.B
.B
.IP "-s \fI<MBytes>\fR"
When creating a tomb, this option must be used to specify the size of
@ -48,29 +87,8 @@ Display a help text and quit
Display version and quit
.SH COMMANDS
.B
.IP "create"
Create a new encrypted storage \fIfile\fR and its keys
.B
.IP "open"
Opens an existing tomb \fIfile\fR. The \fImountpoint\fR where the tomb
will be made accessible can be specified, if not the default is to
create a directory named like the tomb inside /media.
.B
.IP "close"
Closes a currently open tomb. When \fIfile\fR is specified, it should
point to the /dev/mapper name used to mount the tomb; if \fIfile\fR is
not specified and only one tomb is open, then it will be closed; if
multiple tombs are open, the command will list them on the terminal.
.SH BUGS
Everyone is encouraged to test this software and report bugs!
Please use the web page http://bugs.dyne.org
Please report bugs on the tracker at http://bugs.dyne.org
Get in touch with developers via mail using this web page
http://dyne.org/contact or via chat on http://irc.dyne.org