INTRODUCTION
`------------

This file describes how to install dislocker onto your machine.



REQUIREMENTS
`------------

You need:
 - Package libssl-dev (debian) or openssl-devel (fedora);
 - Package libfuse-dev (debian), fuse-devel (fedora) or osxfuse (OSX), if you
   want to use FUSE;
 - A partition encrypted with BitLocker, from Windows Vista or 7.

Of course, you need a compiler (tested against gcc 4.6.2 and darwin10-4.2.1).

Note that the code expects FUSE 2.6, when using the decryption with FUSE (see
__RUN_FUSE and __RUN_FILE into the Makefile).


INSTALLING
`----------

First thing to do is to cd into the src/ directory. Then...

As you may know, the driver can be used in two ways: using FUSE or not. To
choose whether to use FUSE, edit the Makefile by hand, see __RUN_FUSE and
__RUN_FILE: one as to be at 1 whereas the other at 0. Running with __RUN_FILE
will decrypt your BitLocker volume into a file, so make sure you have enough
space left on your partition. The file will be a NTFS partition then.
Thus, make your choice of the use you'll have.

Then, type: `make` and `sudo make install` (or just the second one if you're
lazy).

The binary will be installed into `/usr/bin/' by default, edit the INSTALL_PATH
variable (into the Makefile) to change that before the `make install` command.

Once installed, see dislocker(1) for details on how to use it.



UNINSTALLING
`------------

I'm sure you don't want to do that. But if you're really forced by someone, just
type `make uninstall`.



PORTABILITY
`-----------

Globally, this was successfuly tested on Linux x86/x86_64. It won't work on
Windows and may not work on *BSD.

Precisely, the table below indicates distrib, version and arch:

+----------------------------------------------------+
| distrib/OS  | version |  arch  | Vista(v)/Seven(s) |
|-------------+---------+--------+-------------------|
| Fedora      |   14    | x86_64 |         s         |
| Fedora      |   15    | x86    |        vs         |
| Fedora      |   15    | x86_64 |        vs         |
| Fedora      |   16    | x86    |        vs         |
| Fedora      |   16    | x86_64 |        vs         |
| MacOSX      | 10.6.8  | i386   |        vs         |
+----------------------------------------------------+

Note: For MacOSX, it has been tested against OSXFUSE 2.3.8 and 2.3.9.

If your ditrib/OS isn't in that table, this doesn't imply that the driver
doesn't work for you. Test it and send me feedbacks, whether it works or not.

In any case, feel free to send comments and feedbacks to
<Romain[DOT]Coltel[AT]hsc[DOT]fr>.



NOTE
`----

In many directories included into the sources, there's a Makefile with rules to
build a standalone binary. To build these standalone binaries, cd to the
directory and type `make`, thus creating a binary which you can use to do some
process separately.

For instance, in the bek/ directory, if you type `make`, a binary named
`read_bekfile' will be compiled to read and display information of a given bek
file.

