diff options
author | kali <kali@leap.se> | 2013-01-30 05:26:00 +0900 |
---|---|---|
committer | kali <kali@leap.se> | 2013-01-30 06:23:28 +0900 |
commit | 32b9b16db7dfff461f4b60d668f7d21c10fe51e8 (patch) | |
tree | f217fcf7252735f11ac73a6dc94d2df103fa98aa | |
parent | ca6a1e9faf7ceb2c6833cfb7049672e996be8a38 (diff) |
add manpage in rst format
-rw-r--r-- | Makefile | 5 | ||||
-rw-r--r-- | docs/man/leap.1 | 34 | ||||
-rw-r--r-- | docs/man/leap.1.rst | 86 |
3 files changed, 88 insertions, 37 deletions
@@ -59,9 +59,8 @@ $(COMPILED_DIR)/ui_%.py : $(RESOURCE_DIR)/%.ui $(COMPILED_DIR)/%_rc.py : $(RESOURCE_DIR)/%.qrc $(PYRCC) $< -o $@ -deb: - @git tag -a debian/$(DEBVER) -m "..." - @debuild -us -uc -i.git +manpages: + rst2man docs/man/leap.1.rst docs/man/leap.1 apidocs: @sphinx-apidoc -o docs/api src/leap diff --git a/docs/man/leap.1 b/docs/man/leap.1 deleted file mode 100644 index aaa614bb..00000000 --- a/docs/man/leap.1 +++ /dev/null @@ -1,34 +0,0 @@ -.\" groff -man -Tascii foo.1 -.TH LEAP 1 "July 2012" leap "User manual" -.SH NAME -leap \- the internet encryption toolkit -.SH SYNOPSIS -.B leap -.RI [ OPTIONS ] -.SH DESCRIPTION -.B leap -allows to ... blah blah ... -.SH OPTIONS -.IP "-d, --debug" -Show additional information on the command line. -.IP "-h, --help" -Show information about the usage of the command. -.SH FILES -.TP -.I /usr/share/polkit-1/actions/net.openvpn.gui.leap.policy -The PolicyKit definitions of the privileges used by leap, e.g. to run openvpn as root. To change the privileges please have a look at -.BR PolicyKit.conf (1). -.SH DIAGNOSTICS -By default leaps logs to ... /dev/null. Furthermore you -can foobarize yourself. -.SH EXTRA TIPS -Trust your technolust! -.SH HOMEPAGE -http://leap.se -.SH BUGS -You can report bugs at the bugtracker site of leap: -http://leap.se/code -.SH AUTHOR -This manpage written by kali <kaliyuga at riseup dot net> for the debian package, but obviously can be used for any other distribution. -.SH SEE ALSO -.BR PolicyKit.conf (7) 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 |