summaryrefslogtreecommitdiff
path: root/docs/client/user-running.md
diff options
context:
space:
mode:
authorKali Kaneko <kali@futeisha.org>2013-09-25 12:28:21 -0400
committerKali Kaneko <kali@futeisha.org>2013-09-25 12:28:21 -0400
commit652879ef39b5a94fba50f8c78524e71e040e8b5b (patch)
tree8492d6cd4c1576d849d6496874b62b33d41a733f /docs/client/user-running.md
parent19f0917b007e83ade0a4de290d194964f027a35b (diff)
update client docs
This are the most important pages in the bitmask documentation. I have converted .rst files using pandoc, since the .rst does not seem to be supported like the README says. I have added @nav_title and @title headers.
Diffstat (limited to 'docs/client/user-running.md')
-rw-r--r--docs/client/user-running.md45
1 files changed, 45 insertions, 0 deletions
diff --git a/docs/client/user-running.md b/docs/client/user-running.md
new file mode 100644
index 0000000..79fd58f
--- /dev/null
+++ b/docs/client/user-running.md
@@ -0,0 +1,45 @@
+@nav_title = 'Running'
+@title = 'Running Bitmask'
+
+Running
+=======
+
+This document covers how to launch Bitmask. Also know as, where the
+magic happens.
+
+Launching Bitmask
+-----------------
+
+After a successful installation, there should be a launcher called
+bitmask somewhere in your path:
+
+ % bitmask
+
+The first time you launch it, it should launch the first run wizard that
+will guide you through the mostly automatic configuration 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>*
+
+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:
+
+ $ 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:
+
+ $ bitmask --debug --logfile /tmp/leap.log
+
+I want all the options!
+-----------------------
+
+To see all the available command line options:
+
+ $ bitmask --help