From 5c0eb246d468454de9e84dca0d08c813459a5a6d Mon Sep 17 00:00:00 2001
From: kali <kali@leap.se>
Date: Wed, 19 Dec 2012 07:45:02 +0900
Subject: documentation update!

reSTructured (no pun intended) the sphinx docs,
and trimmed README
---
 docs/user/running.rst | 40 ++++++++++++++++++++++++++++++++++++++++
 1 file changed, 40 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..35ec1f6d
--- /dev/null
+++ b/docs/user/running.rst
@@ -0,0 +1,40 @@
+.. _running:
+
+Running
+==================
+
+This document dovers 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
+
+
+.. _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
+
+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