summaryrefslogtreecommitdiff
path: root/docs/man/bitmask.1.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/man/bitmask.1.rst')
-rw-r--r--docs/man/bitmask.1.rst41
1 files changed, 35 insertions, 6 deletions
diff --git a/docs/man/bitmask.1.rst b/docs/man/bitmask.1.rst
index 12c87a5d..7a1d2ae1 100644
--- a/docs/man/bitmask.1.rst
+++ b/docs/man/bitmask.1.rst
@@ -7,9 +7,9 @@ graphical client to control LEAP, the encrypted internet access toolkit.
------------------------------------------------------------------------
:Author: LEAP Encryption Access Project https://leap.se
-:Date: 2013-01-30
+:Date: 2013-08-23
:Copyright: GPLv3+
-:Version: 0.2
+:Version: 0.3.1
:Manual section: 1
:Manual group: General Commands Manual
@@ -34,20 +34,49 @@ general options
**-h, --help** Print a help message and exit.
-**-d, --debug** Launches client in debug mode, writing debug info to stdout.
+**-l, --logfile=<file>** Writes log to file.
+
+**-s, --standalone** Makes Bitmask use standalone directories for configuration and binary searching.
-**---logfile=<file>** Writes log to file.
openvpn options
---------------
-**--openvpn-verbosity** [0-5] Verbosity level for openvpn logs.
+**--openvpn-verbosity** [0-5] Verbosity level for openvpn logs.
+
+debug options
+-------------
+**-d, --debug** Launches client in debug mode, writing debug info to stdout.
+
+**--danger** Bypasses the certificate check for bootstrap. This open the possibility of MITM attacks, so use only to debug providers in controlled environments, and never in production.
+
+ENCRYPTED MAIL
+==============
+
+Bitmask now (since version 0.3.0) supports the encrypted mail service with providers that offer it.
+
+Mail client configuration
+-------------------------
+
+To be able to use the mail services, you should configure your mail client to
+talk to the following ports:
+
+**STMP**: localhost:2013
+
+**IMAP**: localhost:1984
+
+For the time being, we have successfully tested this functionality in thunderbird.
+
+Mail poll period
+----------------
+If you want to change the default polling time for fetching mail, you can use
+a environment variable: BITMASK_MAILCHECK_PERIOD
WARNING
=======
-This software is still in early alfa testing. So don't trust your life to it!
+This software is still in its early phases of testing. So don't trust your life to it!
At the current time, Bitmask is not compatible with ``openresolv``, but it works with ``resolvconf``.