Merge pull request #54 from fulldecent/patch-1

Update markdown formatting for documentation
This commit is contained in:
Valient Gough 2015-02-27 21:06:59 -08:00
commit 7537360de8

View File

@ -1,4 +1,4 @@
For notes about internationalization, see README-NLS. For notes about internationalization, see [README-NLS](README-NLS).
EncFS is a program which provides an encrypted virtual filesystem for Linux EncFS is a program which provides an encrypted virtual filesystem for Linux
using the FUSE kernel module ( see http://sourceforge.net/projects/avf to using the FUSE kernel module ( see http://sourceforge.net/projects/avf to
@ -9,24 +9,27 @@ user-mode and acts as a transparent encrypted filesystem.
Usage Usage
----- -----
- To see command line options, see the man page for [encfs](encfs/encfs.pod) - To see command line options, see the man page for `[encfs](encfs/encfs.pod)`
and [encfsctl](encfs/encfsctl.pod), or for and `[encfsctl](encfs/encfsctl.pod)`, or for
brief usage message, run the programs without an argument (or '-h'): brief usage message, run the programs without an argument (or `-h`):
% encfs -h
% man encfs encfs -h
man encfs
- To create a new encrypted filesystem: - To create a new encrypted filesystem:
% encfs [source dir] [destination mount point]
encfs [source dir] [destination mount point]
eg.: "encfs ~/.crypt ~/crypt". Both directories should already exist, eg.: `encfs ~/.crypt ~/crypt`. Both directories should already exist,
although Encfs will ask if it can create them if they do not. If the although Encfs will ask if it can create them if they do not. If the
"~/.crypt" directory does not already contain encrypted filesystem data, `~/.crypt` directory does not already contain encrypted filesystem data,
then the user is prompted for a password for the new encryption directory. then the user is prompted for a password for the new encryption directory.
The encrypted files will be stored in ~/.crypt, and plaintext access will be The encrypted files will be stored in `~/.crypt`, and plaintext access will be
through ~/crypt through `~/crypt`
- To mount an existing filesystem: - To mount an existing filesystem:
% encfs [source dir] [destination mount point]
encfs [source dir] [destination mount point]
This works just like creating a new filesystem. If the Encfs control file This works just like creating a new filesystem. If the Encfs control file
is found in the directory, then an attempt is made to mount an existing is found in the directory, then an attempt is made to mount an existing
@ -40,7 +43,7 @@ Technology
- Encfs uses algorithms from third-party libraries (OpenSSL is the default) to - Encfs uses algorithms from third-party libraries (OpenSSL is the default) to
encrypt data and filenames. encrypt data and filenames.
- a user supplied password is used to decrypt a volume key, and the volume key - A user supplied password is used to decrypt a volume key, and the volume key
is used for encrypting all file names and contents. This makes it possible is used for encrypting all file names and contents. This makes it possible
to change the password without needing to re-encrypt all files. to change the password without needing to re-encrypt all files.
@ -115,7 +118,7 @@ Backward Compatibility
Utility Utility
------- -------
In addition to the "encfs" main program, a utility "encfsctl" has been In addition to the `encfs` main program, a utility `encfsctl` has been
provided which can perform some operations on encfs filesystems. Encfsctl provided which can perform some operations on encfs filesystems. Encfsctl
can display information about the filesystem for the curious (the encryption can display information about the filesystem for the curious (the encryption
algorithm used, key length, block size), and more importantly it can also algorithm used, key length, block size), and more importantly it can also