diff options
| author | drebs <drebs@leap.se> | 2013-02-09 22:27:22 -0200 |
|---|---|---|
| committer | drebs <drebs@leap.se> | 2013-02-09 22:27:22 -0200 |
| commit | 46a3373295a683db9b66c233b07a7a948b8147bc (patch) | |
| tree | 410a47871bfd8654ddabbb53f3c29a89c1550e71 /docs/man/leap.1.rst | |
| parent | e726f3df7c7efbe4069846468ffdbed6829ccfc4 (diff) | |
| parent | b376948ccd59aa02022123102eaae359a536e4e6 (diff) | |
Merge branch 'develop' into feature/soledad-api
Diffstat (limited to 'docs/man/leap.1.rst')
| -rw-r--r-- | docs/man/leap.1.rst | 86 |
1 files changed, 86 insertions, 0 deletions
diff --git a/docs/man/leap.1.rst b/docs/man/leap.1.rst new file mode 100644 index 00000000..1ef5b3cc --- /dev/null +++ b/docs/man/leap.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 |