summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--docs/man/leap.183
1 files changed, 83 insertions, 0 deletions
diff --git a/docs/man/leap.1 b/docs/man/leap.1
new file mode 100644
index 00000000..aef24d85
--- /dev/null
+++ b/docs/man/leap.1
@@ -0,0 +1,83 @@
+.\" Man page generated from reStructeredText.
+.
+.TH LEAP-CLIENT 1 "2013-01-30" "0.2" "General Commands Manual"
+.SH NAME
+leap-client \- graphical client to control LEAP, the encrypted internet access toolkit.
+.
+.nr rst2man-indent-level 0
+.
+.de1 rstReportMargin
+\\$1 \\n[an-margin]
+level \\n[rst2man-indent-level]
+level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
+-
+\\n[rst2man-indent0]
+\\n[rst2man-indent1]
+\\n[rst2man-indent2]
+..
+.de1 INDENT
+.\" .rstReportMargin pre:
+. RS \\$1
+. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
+. nr rst2man-indent-level +1
+.\" .rstReportMargin post:
+..
+.de UNINDENT
+. RE
+.\" indent \\n[an-margin]
+.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.nr rst2man-indent-level -1
+.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
+..
+.SH SYNOPSIS
+.sp
+leap\-client [\-h] [\-d] [\-l [LOG FILE]] [\-\-openvpn\-verbosity [OPENVPN_VERB]]
+.SH DESCRIPTION
+.sp
+\fIleap\-client\fP is a graphical client to control LEAP, the encrypted internet access toolkit.
+.sp
+When launched, it places an icon in the system tray from where the LEAP services can be controlled.
+.SH OPTIONS
+.SS general options
+.sp
+\fB\-h, \-\-help\fP Print a help message and exit.
+.sp
+\fB\-d, \-\-debug\fP Launches client in debug mode, writing debug info to stdout.
+.sp
+\fB\-\-\-logfile=<file>\fP Writes log to file.
+.SS openvpn options
+.sp
+\fB\-\-openvpn\-verbosity\fP [0\-5] Verbosity level for openvpn logs.
+.SH WARNING
+.sp
+This software is still in early alfa testing. So don\(aqt trust your life to it!
+.sp
+At the current time, the LEAP Client is not compatible with \fBopenresolv\fP, but it works with \fBresolvconf\fP.
+.SH FILES
+.SS /etc/leap/resolv\-update
+.sp
+Post up/down script passed to openvpn. It writes /etc/resolv.conf to avoid dns leaks, and restores the original resolv.conf on exit.
+.SS /etc/leap/resolv\-head
+.SS /etc/leap/resolv\-tail
+.sp
+Custom entries that will appear in the written resolv.conf
+.SS /usr/share/polkit\-1/actions/net.openvpn.gui.leap.policy
+.sp
+PolicyKit policy file, used for granting access to openvpn without the need of entering a password each time.
+.SS ~/.config/leap/
+.sp
+Main config folder
+.SS ~/.config/leap/leap.conf
+.sp
+GUI options
+.SH BUGS
+.sp
+Please report any bugs to \fI\%https://leap.se/code\fP
+.SH AUTHOR
+LEAP Encryption Access Project https://leap.se
+.SH COPYRIGHT
+GPLv3+
+.\" Generated by docutils manpage writer.
+.\"
+.