summaryrefslogtreecommitdiff
path: root/docs/man/bitmask-root.1.rst
diff options
context:
space:
mode:
authorKali Kaneko (leap communications) <kali@leap.se>2016-08-30 11:25:27 -0400
committerKali Kaneko (leap communications) <kali@leap.se>2016-08-30 11:25:35 -0400
commita9b4554156bac38cd3ca1162326ce9cf554f9b50 (patch)
tree21dacea8338235181b214fa233f93fdff3c0b022 /docs/man/bitmask-root.1.rst
parent22eec36ff81ae2ec2b924087ed6253894b92278a (diff)
[pkg] add some relevant docs
Diffstat (limited to 'docs/man/bitmask-root.1.rst')
-rw-r--r--docs/man/bitmask-root.1.rst74
1 files changed, 74 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