Merge branch 'develop' into feature/soledad-api

4 files changed, 204 insertions, 1 deletions

diff --git a/docs/dev/workflow.rst b/docs/dev/workflow.rst
index 3f773712..5ceccca4 100644
--- a/docs/dev/workflow.rst
+++ b/docs/dev/workflow.rst
@@ -5,4 +5,37 @@ Development Workflow
 
 This section documents the workflow that the LEAP project team follows and expects for the code contributions.
 
-XXX
+Code formatting
+---------------
+In one word: `PEP8`_.
+
+`autopep8` might be your friend. or eat your code.
+
+.. _`PEP8`: http://www.python.org/dev/peps/pep-0008/
+.. _`autopep8`: http://pypi.python.org/pypi/autopep8
+
+Dependencies
+------------
+If you introduce a new dependency, please add it under ``pkg/requirements`` or ``pkg/test-requirements`` as appropiate, under the proper module section.
+
+Git flow
+--------
+See `A successful git branching model <http://nvie.com/posts/a-successful-git-branching-model/>`_ for more information. The slight modification we make is that release tags are made in the release branch before getting merged to master, rather than getting tagged in master.
+
+.. image:: https://leap.se/code/attachments/13/git-branching-model.png
+
+The author of the aforementioned post has also a handy pdf version of it: `branching_model.pdf`_ 
+
+A couple of tools that help to follow this process are  `git-flow`_ and `git-sweep`_.
+
+.. _`branching_model.pdf`: https://leap.se/code/attachments/14/Git-branching-model.pdf
+.. _`git-flow`: https://github.com/nvie/gitflow
+.. _`git-sweep`: http://pypi.python.org/pypi/git-sweep
+
+Merge into integration branch
+-----------------------------
+All code ready to be merged into the integration branch is expected to:
+
+* Have tests
+* Be documented
+* Pass existing tests: do **run_tests.sh** and **tox -v**. All feature branches are automagically built by our `buildbot farm <http://lemur.leap.se:8010/grid>`_. So please check your branch is green before merging it it to `develop`. Rebasing against the current tip of the integration when possible is preferred in order to keep a clean history.
diff --git a/docs/index.rst b/docs/index.rst
index a57e030f..3e1a603f 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -41,6 +41,7 @@ If you want to contribute to the project, we wrote this for you.
 
    dev/environment
    dev/tests
+   dev/workflow
    dev/resources
    dev/internationalization
 
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.
+.\" 
+.
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