From 96eaddedd7f09fcbcc390aedd7078aeecfa4c885 Mon Sep 17 00:00:00 2001
From: kali <kali@leap.se>
Date: Fri, 3 May 2013 02:59:22 +0900
Subject: updated documentation

* documentation reviewed after rewrite, ready for 0.2.1
* updated docstrings format to fit sphinx autodoc
---
 docs/user/running.rst | 44 ++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 44 insertions(+)
 create mode 100644 docs/user/running.rst

(limited to 'docs/user/running.rst')

diff --git a/docs/user/running.rst b/docs/user/running.rst
new file mode 100644
index 00000000..43f3e87c
--- /dev/null
+++ b/docs/user/running.rst
@@ -0,0 +1,44 @@
+.. _running:
+
+Running
+==================
+
+This document covers how to launch the LEAP Client.
+
+Launching the client
+--------------------
+After a successful installation, there should be a launcher called `leap-client` somewhere in your path::
+
+  % leap-client
+
+The first time you launch it, it should launch the first run wizard that will guide you through the setup of the LEAP Services.
+
+.. note::
+
+   You will need to enter a valid test provider running the LEAP Platform. You can use the LEAP test service, *https://bitmask.net*
+
+.. _debugmode:
+
+Debug mode
+----------
+If you are happy having lots of output in your terminal, you will like to know that you can run the client in debug mode::
+
+  $ leap-client --debug
+  
+If you ask for it, you can also have all that debug info in a beautiful file ready to be attached to your bug reports::
+
+  $ leap-client --debug --logfile /tmp/leap.log
+
+.. warning 
+.. the following is broken since it will clutter your stdout with all the commands sent to the management interface.
+   See bug #1232
+
+.. not working...
+.. If you want to increment the level of verbosity passed to openvpn, you can do::
+.. $ leap-client --openvpn-verbosity 4
+
+Options
+------------
+To see all the available command line options::
+
+  $ leap-client --help
-- 
cgit v1.2.3