summaryrefslogtreecommitdiff
path: root/docs/man
diff options
context:
space:
mode:
Diffstat (limited to 'docs/man')
-rw-r--r--docs/man/bitmask-root.1.rst54
-rw-r--r--docs/man/bitmask.1.rst22
2 files changed, 62 insertions, 14 deletions
diff --git a/docs/man/bitmask-root.1.rst b/docs/man/bitmask-root.1.rst
new file mode 100644
index 00000000..7ed53aa9
--- /dev/null
+++ b/docs/man/bitmask-root.1.rst
@@ -0,0 +1,54 @@
+============
+bitmask-root
+============
+
+------------------------------------------------------------------------
+privileged helper for bitmask, the encrypted internet access toolkit.
+------------------------------------------------------------------------
+
+:Author: LEAP Encryption Access Project https://leap.se
+:Date: 2014-05-19
+:Copyright: GPLv3+
+:Version: 0.5.1
+:Manual section: 1
+:Manual group: General Commands Manual
+
+SYNOPSIS
+========
+
+bitmask-root [openvpn | firewall | isup ] [start | stop] [ARGS]
+
+DESCRIPTION
+===========
+
+*bitmask-root* is a privileged helper for bitmask.
+
+It is used to start or stop openvpn and the bitmask firewall.
+
+
+OPTIONS
+=======
+
+openvpn
+--------
+
+**start** [ARGS] Starts openvpn. All args are passed to openvpn, and
+ filtered against a list of allowed args.
+
+**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.
+
+
+
+BUGS
+====
+
+Please report any bugs to https://leap.se/code
diff --git a/docs/man/bitmask.1.rst b/docs/man/bitmask.1.rst
index ed4f7133..38da64af 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-08-23
+:Date: 2014-05-19
:Copyright: GPLv3+
-:Version: 0.3.1
+:Version: 0.5.1
:Manual section: 1
:Manual group: General Commands Manual
@@ -80,26 +80,20 @@ WARNING
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``.
FILES
=====
-/etc/leap/resolv-update
------------------------
-Post up/down script passed to openvpn. It writes /etc/resolv.conf to avoid dns leaks, and restores the original resolv.conf on exit.
-/etc/leap/resolv-head
----------------------
-/etc/leap/resolv-tail
----------------------
+/usr/share/polkit-1/actions/se.leap.bitmask.policy
+-------------------------------------------------------
-Custom entries that will appear in the written resolv.conf
+PolicyKit policy file, used for granting access to bitmask-root without the need of entering a password each time.
-/usr/share/polkit-1/actions/net.openvpn.gui.leap.policy
--------------------------------------------------------
+/usr/sbin/bitmask-root
+------------------------
-PolicyKit policy file, used for granting access to openvpn without the need of entering a password each time.
+Helper to launch and stop openvpn and the bitmask firewall.
~/.config/leap/
---------------