summaryrefslogtreecommitdiff
path: root/docs/user/running.rst
diff options
context:
space:
mode:
authorTomas Touceda <chiiph@leap.se>2013-05-07 16:08:55 -0300
committerTomas Touceda <chiiph@leap.se>2013-05-07 16:08:55 -0300
commit4cc3c7d3f0d63d97df0d40c3e2d0941c5e069eb9 (patch)
treedfabf2a91cd8466b572539b73d38273eef733339 /docs/user/running.rst
parent76641e028f4a8b6c5c89ad0e9ff4bfecc075d678 (diff)
parente6b7d52d827109d6fc8d79a28e8d46964e1ad94c (diff)
Merge remote-tracking branch 'kali/feature/update-docs' into develop
Diffstat (limited to 'docs/user/running.rst')
-rw-r--r--docs/user/running.rst44
1 files changed, 44 insertions, 0 deletions
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