diff options
Diffstat (limited to 'docs/user/running.rst')
| -rw-r--r-- | docs/user/running.rst | 34 |
1 files changed, 19 insertions, 15 deletions
diff --git a/docs/user/running.rst b/docs/user/running.rst index 35ec1f6d..da83e9ef 100644 --- a/docs/user/running.rst +++ b/docs/user/running.rst @@ -3,38 +3,42 @@ Running ================== -This document dovers how to launch the LEAP Client. +This document covers how to launch Bitmask. -Launching the client --------------------- -After a successful installation, there should be a launcher called leap-client somewhere in your path:: +Launching Bitmask +----------------- +After a successful installation, there should be a launcher called `bitmask` somewhere in your path:: - % leap-client + % bitmask +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:: +If you are happy having lots of output in your terminal, you will like to know that you can run bitmask in debug mode:: - $ leap-client --debug + $ bitmask --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 + $ bitmask --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. +.. 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 +.. not working... +.. If you want to increment the level of verbosity passed to openvpn, you can do:: +.. $ bitmask --openvpn-verbosity 4 Options ------------ To see all the available command line options:: - $ leap-client --help + $ bitmask --help |