summaryrefslogtreecommitdiff
path: root/docs/client/user-guide.md
blob: bfcb3b87969d97be215cc5f5034eb84c53aaece3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
@nav_title = "User Guide"
@title = "Client User Guide"

Installation
==================

Note: currently, this does not completely work. See [testing](testing)

You can get the code from LEAP public git repository

    git clone https://leap.se/git/leap_client

Or from the github mirror

    git clone https://github.com/leapcode/leap_client.git

Once you have grabbed a copy of the sources, you can install it into your site-packages easily

    $ python setup.py install


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

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

> 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