summaryrefslogtreecommitdiff
path: root/docs/man
diff options
context:
space:
mode:
Diffstat (limited to 'docs/man')
-rw-r--r--docs/man/bitmask-root.1.rst74
-rw-r--r--docs/man/bitmask.1.rst111
2 files changed, 185 insertions, 0 deletions
diff --git a/docs/man/bitmask-root.1.rst b/docs/man/bitmask-root.1.rst
new file mode 100644
index 0000000..b25a336
--- /dev/null
+++ b/docs/man/bitmask-root.1.rst
@@ -0,0 +1,74 @@
+============
+bitmask-root
+============
+
+------------------------------------------------------------------------
+privileged helper for bitmask, the encrypted internet access toolkit.
+------------------------------------------------------------------------
+
+:Author: LEAP Encryption Access Project https://leap.se
+:Date: 2015-11-03
+:Copyright: GPLv3+
+:Version: 0.9.1
+:Manual section: 1
+:Manual group: General Commands Manual
+
+SYNOPSIS
+========
+
+bitmask-root [openvpn | firewall | version] [start | stop | isup] [ARGS]
+
+DESCRIPTION
+===========
+
+*bitmask-root* is a privileged helper for bitmask.
+
+It is used to start or stop openvpn and the bitmask firewall. To operate, it
+needs to be executed with root privileges.
+
+
+OPTIONS
+=======
+
+openvpn
+--------
+
+**start** [ARGS] Starts openvpn. All args are passed to openvpn, and
+ filtered against a list of allowed args. If the next
+ argument is `restart`, the firewall will not be torn
+ down in the case of errors launching openvpn.
+
+**stop** Stops openvpn.
+
+
+firewall
+--------
+
+**start** [GATEWAYS] Starts the firewall. GATEWAYS is a list of EIP
+ gateways to allow in the firewall.
+
+**stop** Stops the firewall.
+
+**isup** Check if the firewall is up.
+
+
+fw-email
+--------
+
+**start** UID Starts the email firewall. UID is the user name or unix
+ id that will have access to the email.
+
+**stop** Stops the email firewall.
+
+**isup** Check if the email firewall is up.
+
+version
+--------
+
+**version** Prints the `bitmask-root` version string.
+
+
+BUGS
+====
+
+Please report any bugs to https://leap.se/code/projects/report-issues
diff --git a/docs/man/bitmask.1.rst b/docs/man/bitmask.1.rst
new file mode 100644
index 0000000..0970b44
--- /dev/null
+++ b/docs/man/bitmask.1.rst
@@ -0,0 +1,111 @@
+=======
+bitmask
+=======
+
+------------------------------------------------------------------------
+graphical client to control LEAP, the encrypted internet access toolkit.
+------------------------------------------------------------------------
+
+:Author: The LEAP Encryption Access Project https://leap.se
+:Date: 2015-11-03
+:Copyright: GPLv3+
+:Version: 0.9.1
+:Manual section: 1
+:Manual group: General Commands Manual
+
+SYNOPSIS
+========
+
+bitmask [-h] [-d] [-l [LOG FILE]] [--openvpn-verbosity [OPENVPN_VERB]]
+
+DESCRIPTION
+===========
+
+*bitmask* is a graphical client to control LEAP, the encrypted internet access toolkit.
+
+When launched, it places an icon in the system tray from where the LEAP services can be controlled.
+
+
+OPTIONS
+=======
+
+general options
+---------------
+
+**-h, --help** Print a help message and exit.
+
+**-l, --logfile=<file>** Writes log to file.
+
+**-s, --standalone** Makes Bitmask use standalone directories for configuration and binary searching.
+
+**-V, --version** Displays Bitmask version and exits.
+
+
+openvpn options
+---------------
+
+**--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 its early phases of testing. So don't trust your life to it!
+
+
+FILES
+=====
+
+
+/usr/share/polkit-1/actions/se.leap.bitmask.policy
+-------------------------------------------------------
+
+PolicyKit policy file, used for granting access to bitmask-root without the need of entering a password each time.
+
+/usr/sbin/bitmask-root
+------------------------
+
+Helper to launch and stop openvpn and the bitmask firewall.
+
+~/.config/leap/
+---------------
+
+Main config folder
+
+~/.config/leap/leap.conf
+------------------------
+
+GUI options
+
+BUGS
+====
+
+Please report any bugs to https://leap.se/code/projects/report-issues