From 1ef5b43cead587b3962b4d633c5faa658471a912 Mon Sep 17 00:00:00 2001 From: Kali Kaneko Date: Mon, 19 May 2014 16:35:19 -0500 Subject: manpage source for bitmask-root --- docs/man/bitmask-root.1.rst | 54 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 54 insertions(+) create mode 100644 docs/man/bitmask-root.1.rst (limited to 'docs/man/bitmask-root.1.rst') 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 -- cgit v1.2.3 From 556c589dd470ed2b48b5421c38156333da78c369 Mon Sep 17 00:00:00 2001 From: Kali Kaneko Date: Thu, 5 Jun 2014 11:18:43 -0500 Subject: update manpages --- docs/man/bitmask-root.1.rst | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) (limited to 'docs/man/bitmask-root.1.rst') 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 -- cgit v1.2.3