summaryrefslogtreecommitdiff
path: root/docs/user/running.rst
diff options
context:
space:
mode:
authorkali <kali@leap.se>2013-02-15 09:31:51 +0900
committerkali <kali@leap.se>2013-02-15 09:31:51 +0900
commit9cea9c8a34343f8792d65b96f93ae22bd8685878 (patch)
tree9f512367b1d47ced5614702a00f3ff0a8fe746d7 /docs/user/running.rst
parent7159734ec6c0b76fc7f3737134cd22fdaaaa7d58 (diff)
parent1032e07a50c8bb265ff9bd31b3bb00e83ddb451e (diff)
Merge branch 'release/v0.2.0'
Conflicts: README.txt
Diffstat (limited to 'docs/user/running.rst')
-rw-r--r--docs/user/running.rst40
1 files changed, 40 insertions, 0 deletions
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