summaryrefslogtreecommitdiff
path: root/docs/user
diff options
context:
space:
mode:
Diffstat (limited to 'docs/user')
-rw-r--r--docs/user/install.rst14
-rw-r--r--docs/user/intro.rst16
-rw-r--r--docs/user/running.rst20
3 files changed, 25 insertions, 25 deletions
diff --git a/docs/user/install.rst b/docs/user/install.rst
index 0467ba8b..da1d914c 100644
--- a/docs/user/install.rst
+++ b/docs/user/install.rst
@@ -3,7 +3,7 @@
Installation
============
-This part of the documentation covers the installation of the LEAP Client.
+This part of the documentation covers the installation of Bitmask.
We assume that you want to get it properly installed before being able to use it.
.. note::
@@ -16,9 +16,9 @@ Distribute & Pip
.. warning:: The package in the cheese shop is from the stable, `0.2.0` release, which is now outdated. You are encouraged to install the development version instead.
-Installing LEAP Client is as simple as using `pip <http://www.pip-installer.org/>`_ for the already released versions ::
+Installing Bitmask is as simple as using `pip <http://www.pip-installer.org/>`_ for the already released versions ::
- $ pip install leap-client
+ $ pip install bitmask
Debian package
--------------
@@ -40,20 +40,20 @@ Add the archive to your sources.list::
# apt-get update
# apt-get install leap-keyring
-And then you can happily install leap-client::
+And then you can happily install bitmask::
- apt-get install leap-client
+ apt-get install bitmask
Show me the code!
-----------------
You can get the code from LEAP public git repository ::
- $ git clone git://leap.se/leap_client
+ $ git clone git://leap.se/bitmask
Or from the github mirror ::
- $ git clone git://github.com/leapcode/leap_client.git
+ $ git clone git://github.com/leapcode/bitmask.git
Once you have grabbed a copy of the sources, you can install it into your site-packages easily ::
diff --git a/docs/user/intro.rst b/docs/user/intro.rst
index 9461d5f2..22ad9356 100644
--- a/docs/user/intro.rst
+++ b/docs/user/intro.rst
@@ -3,15 +3,15 @@
Introduction
============
-The LEAP Client
----------------
+Bitmask
+-------
.. if yoy change this, change it also in the index.rst
-The **LEAP Client** is a :ref:`GPL3 Licensed <gpl3>` multiplatform client, written in python using PySide, that supports the features offered by :ref:`the LEAP Platform <leapplatform>`. Currently is being tested on Linux, support for OSX and Windows will come soon.
+**Bitmask** is a :ref:`GPL3 Licensed <gpl3>` multiplatform client, written in python using PySide, that supports the features offered by :ref:`the LEAP Platform <leapplatform>`. Currently is being tested on Linux, support for OSX and Windows will come soon.
Features
^^^^^^^^
-The LEAP Client allows to easily secure communications.
+Bitmask allows to easily secure communications.
- Provider selection
- User registration
@@ -78,22 +78,22 @@ GPLv3 License
.. image:: gpl.*
-The LEAP Client is released under the terms of the `GNU GPL version 3`_ or later.
+Bitmask is released under the terms of the `GNU GPL version 3`_ or later.
::
- The LEAP Client is free software: you can redistribute it and/or modify
+ Bitmask is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
- The LEAP Client is distributed in the hope that it will be useful,
+ Bitmask is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
- along with the LEAP Client. If not, see http://www.gnu.org/licenses/.
+ along with Bitmask. If not, see http://www.gnu.org/licenses/.
.. _`GNU GPL version 3`: http://www.gnu.org/licenses/gpl.txt
diff --git a/docs/user/running.rst b/docs/user/running.rst
index 43f3e87c..da83e9ef 100644
--- a/docs/user/running.rst
+++ b/docs/user/running.rst
@@ -3,13 +3,13 @@
Running
==================
-This document covers 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.
@@ -21,13 +21,13 @@ The first time you launch it, it should launch the first run wizard that will gu
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.
@@ -35,10 +35,10 @@ If you ask for it, you can also have all that debug info in a beautiful file rea
.. not working...
.. If you want to increment the level of verbosity passed to openvpn, you can do::
-.. $ leap-client --openvpn-verbosity 4
+.. $ bitmask --openvpn-verbosity 4
Options
------------
To see all the available command line options::
- $ leap-client --help
+ $ bitmask --help