summaryrefslogtreecommitdiff
path: root/docs/man/bitmask-root.1.rst
diff options
context:
space:
mode:
authorKali Kaneko <kali@leap.se>2014-06-05 11:18:43 -0500
committerKali Kaneko <kali@leap.se>2014-06-05 11:22:02 -0500
commit556c589dd470ed2b48b5421c38156333da78c369 (patch)
treeb2ab43b1708009b7ac424ef96e3114a64b956189 /docs/man/bitmask-root.1.rst
parentd550c15da5eed6c51735fcc0ef50bf004dd9e0e6 (diff)
update manpages
Diffstat (limited to 'docs/man/bitmask-root.1.rst')
-rw-r--r--docs/man/bitmask-root.1.rst17
1 files changed, 12 insertions, 5 deletions
diff --git a/docs/man/bitmask-root.1.rst b/docs/man/bitmask-root.1.rst
index 7ed53aa9..c18cc4d6 100644
--- a/docs/man/bitmask-root.1.rst
+++ b/docs/man/bitmask-root.1.rst
@@ -7,23 +7,24 @@ privileged helper for bitmask, the encrypted internet access toolkit.
------------------------------------------------------------------------
:Author: LEAP Encryption Access Project https://leap.se
-:Date: 2014-05-19
+:Date: 2014-06-05
:Copyright: GPLv3+
-:Version: 0.5.1
+:Version: 0.5.2
:Manual section: 1
:Manual group: General Commands Manual
SYNOPSIS
========
-bitmask-root [openvpn | firewall | isup ] [start | stop] [ARGS]
+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.
+It is used to start or stop openvpn and the bitmask firewall. To operate, it
+needs to be executed with root privileges.
OPTIONS
@@ -33,7 +34,9 @@ openvpn
--------
**start** [ARGS] Starts openvpn. All args are passed to openvpn, and
- filtered against a list of allowed args.
+ filtered against a list of allowed args. If the next
+ argument is `restart`, the firewall will not be teared
+ down in the case of errors lauching openvpn.
**stop** Stops openvpn.
@@ -46,6 +49,10 @@ firewall
**stop** Stops the firewall.
+version
+--------
+
+**version** Prints the `bitmask-root` version string.
BUGS