hard-problems: listed other projects similar to soledad
[leap_doc.git] / docs / client / user-running.md
1 @nav_title = 'Running'
2 @title = 'Running Bitmask'
3
4 Running
5 =======
6
7 This document covers how to launch Bitmask. Also know as, where the
8 magic happens.
9
10 Launching Bitmask
11 -----------------
12
13 After a successful installation, there should be a launcher called
14 bitmask somewhere in your path:
15
16     % bitmask
17
18 The first time you launch it, it should launch the first run wizard that
19 will guide you through the mostly automatic configuration of the LEAP
20 Services.
21
22 > **note**
23 >
24 > You will need to enter a valid test provider running the LEAP
25 > Platform. You can use the LEAP test service, *<https://bitmask.net>*
26
27 Debug mode
28 ----------
29
30 If you are happy having lots of output in your terminal, you will like
31 to know that you can run bitmask in debug mode:
32
33     $ bitmask --debug
34
35 If you ask for it, you can also have all that debug info in a beautiful
36 file ready to be attached to your bug reports:
37
38     $ bitmask --debug --logfile /tmp/leap.log
39
40 I want all the options!
41 -----------------------
42
43 To see all the available command line options:
44
45     $ bitmask --help