summaryrefslogtreecommitdiff
path: root/docs/man/leap-client.1.rst
diff options
context:
space:
mode:
authorkali <kali@leap.se>2013-05-03 02:59:22 +0900
committerkali <kali@leap.se>2013-05-03 02:59:22 +0900
commit96eaddedd7f09fcbcc390aedd7078aeecfa4c885 (patch)
tree90cd8f5de56207be3a2863dfd728189339f2931c /docs/man/leap-client.1.rst
parent90cac3e4a992a513db96b6c126fdd5259e881d0f (diff)
updated documentation
* documentation reviewed after rewrite, ready for 0.2.1 * updated docstrings format to fit sphinx autodoc
Diffstat (limited to 'docs/man/leap-client.1.rst')
-rw-r--r--docs/man/leap-client.1.rst86
1 files changed, 86 insertions, 0 deletions
diff --git a/docs/man/leap-client.1.rst b/docs/man/leap-client.1.rst
new file mode 100644
index 00000000..1ef5b3cc
--- /dev/null
+++ b/docs/man/leap-client.1.rst
@@ -0,0 +1,86 @@
+===========
+leap-client
+===========
+
+------------------------------------------------------------------------
+graphical client to control LEAP, the encrypted internet access toolkit.
+------------------------------------------------------------------------
+
+:Author: LEAP Encryption Access Project https://leap.se
+:Date: 2013-01-30
+:Copyright: GPLv3+
+:Version: 0.2
+:Manual section: 1
+:Manual group: General Commands Manual
+
+SYNOPSIS
+========
+
+leap-client [-h] [-d] [-l [LOG FILE]] [--openvpn-verbosity [OPENVPN_VERB]]
+
+DESCRIPTION
+===========
+
+*leap-client* 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.
+
+**-d, --debug** Launches client in debug mode, writing debug info to stdout.
+
+**---logfile=<file>** Writes log to file.
+
+openvpn options
+---------------
+
+**--openvpn-verbosity** [0-5] Verbosity level for openvpn logs.
+
+
+WARNING
+=======
+
+This software is still in early alfa testing. So don't trust your life to it!
+
+At the current time, the LEAP Client 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
+---------------------
+
+Custom entries that will appear in the written resolv.conf
+
+/usr/share/polkit-1/actions/net.openvpn.gui.leap.policy
+-------------------------------------------------------
+
+PolicyKit policy file, used for granting access to openvpn without the need of entering a password each time.
+
+~/.config/leap/
+---------------
+
+Main config folder
+
+~/.config/leap/leap.conf
+------------------------
+
+GUI options
+
+BUGS
+====
+
+Please report any bugs to https://leap.se/code