summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/config/files.rst2
-rw-r--r--docs/dev/environment.rst14
-rw-r--r--docs/dev/internals.rst2
-rw-r--r--docs/dev/internationalization.rst20
-rw-r--r--docs/dev/tests.rst4
-rw-r--r--docs/man/bitmask.1.rst (renamed from docs/man/leap-client.1.rst)14
-rw-r--r--docs/testers/howto.rst30
-rw-r--r--docs/user/install.rst14
-rw-r--r--docs/user/intro.rst16
-rw-r--r--docs/user/running.rst20
10 files changed, 68 insertions, 68 deletions
diff --git a/docs/config/files.rst b/docs/config/files.rst
index 0f4abead..70d3bff8 100644
--- a/docs/config/files.rst
+++ b/docs/config/files.rst
@@ -3,7 +3,7 @@
Configuration Files
===================
-This document covers the different configuration files used by the LEAP Client.
+This document covers the different configuration files used by Bitmask.
leap.conf
---------
diff --git a/docs/dev/environment.rst b/docs/dev/environment.rst
index 010ccc83..7ce536f9 100644
--- a/docs/dev/environment.rst
+++ b/docs/dev/environment.rst
@@ -3,7 +3,7 @@
Setting up a development environment
====================================
-This document covers how to get an enviroment ready to contribute code to the LEAP Client.
+This document covers how to get an enviroment ready to contribute code to Bitmask.
Cloning the repo
----------------
@@ -13,12 +13,12 @@ Cloning the repo
::
- git clone git://leap.se/leap_client
+ git clone git://leap.se/bitmask
git checkout develop
Base Dependencies
------------------
-Leap client depends on these libraries:
+Bitmask depends on these libraries:
* `python 2.6 or 2.7`
* `qt4` libraries (see also :ref:`Troubleshooting PySide install <pysidevirtualenv>` about how to install inside your virtualenv)
@@ -100,10 +100,10 @@ You can install python dependencies with ``pip``. If you do it inside your worki
Copy script files
-----------------
-The openvpn invocation expects some files to be in place. If you have not installed `leap-client` from a debian package, you must copy these files manually by now::
+The openvpn invocation expects some files to be in place. If you have not installed `bitmask` from a debian package, you must copy these files manually by now::
$ sudo mkdir -p /etc/leap
- $ sudo cp pkg/linux/resolv-update /etc/leap
+ $ sudo cp pkg/linux/resolv-update /etc/leap
.. _policykit:
@@ -111,9 +111,9 @@ Running openvpn without root privileges
---------------------------------------
In linux, we are using ``policykit`` to be able to run openvpn without root privileges, and a policy file is needed to be installed for that to be possible.
-The setup script tries to install the policy file when installing the client system-wide, so if you have installed the client in your global site-packages at least once it should have copied this file for you.
+The setup script tries to install the policy file when installing bitmask system-wide, so if you have installed bitmask in your global site-packages at least once it should have copied this file for you.
-If you *only* are running the client from inside a virtualenv, you will need to copy this file by hand::
+If you *only* are running bitmask from inside a virtualenv, you will need to copy this file by hand::
$ sudo cp pkg/linux/polkit/net.openvpn.gui.leap.policy /usr/share/polkit-1/actions/
diff --git a/docs/dev/internals.rst b/docs/dev/internals.rst
index 8bb19211..e43868f3 100644
--- a/docs/dev/internals.rst
+++ b/docs/dev/internals.rst
@@ -3,7 +3,7 @@
Internals
=========
-This section covers briefly the internal organization of the LEAP Client source tree.
+This section covers briefly the internal organization of Bitmask source tree.
.. note::
diff --git a/docs/dev/internationalization.rst b/docs/dev/internationalization.rst
index 8c584fdd..f9f522b9 100644
--- a/docs/dev/internationalization.rst
+++ b/docs/dev/internationalization.rst
@@ -3,15 +3,15 @@
Internationalization
====================
-This part of the documentation covers the localization and translation of LEAP Client.
+This part of the documentation covers the localization and translation of Bitmask.
Because we want to *bring fire to the people*, in as many countries and languages as possible.
-Translating the LEAP Client PySide Application
---------------------------------------------
+Translating Bitmask PySide Application
+--------------------------------------
.. raw:: html
- <div><a target="_blank" style="text-decoration:none; color:black; font-size:66%" href="https://www.transifex.com/projects/p/leap-client/resource/leap-client/" title="See more information on Transifex.com">Top translations: leap-client » leap-client</a><br/><img border="0" src="https://www.transifex.com/projects/p/leap-client/resource/leap-client/chart/image_png"/><br/><a target="_blank" href="https://www.transifex.com/"><img border="0" src="https://ds0k0en9abmn1.cloudfront.net/static/charts/images/tx-logo-micro.646b0065fce6.png"/></a></div>
+ <div><a target="_blank" style="text-decoration:none; color:black; font-size:66%" href="https://www.transifex.com/projects/p/bitmask/resource/bitmask/" title="See more information on Transifex.com">Top translations: bitmask » bitmask</a><br/><img border="0" src="https://www.transifex.com/projects/p/bitmask/resource/bitmask/chart/image_png"/><br/><a target="_blank" href="https://www.transifex.com/"><img border="0" src="https://ds0k0en9abmn1.cloudfront.net/static/charts/images/tx-logo-micro.646b0065fce6.png"/></a></div>
For translators
@@ -21,7 +21,7 @@ For translators
as internal notes.
-We are using `transifex <http://transifex.com/projects/p/leap-client>`_ to coordinate translation efforts. If you want to contribute, just sign up there and ...
+We are using `transifex <http://transifex.com/projects/p/bitmask>`_ to coordinate translation efforts. If you want to contribute, just sign up there and ...
.. note::
... and what??
@@ -61,11 +61,11 @@ You need ``pyside-lupdate`` and ``lrelease`` for these steps. To get it, in debi
If you do not already have it, install the ``transifex-client`` from the cheese shop::
- pip install transifex-client
+ pip install transifex-client
You can learn more about the transifex-client `here <http://help.transifex.com/features/client/index.html>`_.
-**1.** Add any new source files to the project file, ``data/leap_client.pro``. *We should automate this with some templating, it's tedious.*
+**1.** Add any new source files to the project file, ``data/bitmask.pro``. *We should automate this with some templating, it's tedious.*
**2.** Update the source .ts file ``data/ts/en_US.ts``.::
@@ -80,7 +80,7 @@ You can learn more about the transifex-client `here <http://help.transifex.com/f
**5.** *Et voila!* Get updated .ts files for each language from ``Transifex``. For instance, to pull updated spanish translations::
$ tx pull -l es
- Pulling new translations for resource leap-client.leap-client (source: data/ts/en_US.ts)
+ Pulling new translations for resource bitmask.bitmask (source: data/ts/en_US.ts)
-> es: data/translations/es.ts
Done.
@@ -89,7 +89,7 @@ Note that there is a configuration option in ``.tx/config`` for setting the mini
**6.** Generate .qm files from the updated .ts files::
- $ make translations
+ $ make translations
and yes, it's the same command than in step 2. One less thing to remember :)
@@ -101,7 +101,7 @@ and yes, it's the same command than in step 2. One less thing to remember :)
If you want to try it, just set your LANG environment variable::
- $ LANG=es_ES leap-client
+ $ LANG=es_ES bitmask
Translating the Documentation
diff --git a/docs/dev/tests.rst b/docs/dev/tests.rst
index 7f5fbaaf..d55c206a 100644
--- a/docs/dev/tests.rst
+++ b/docs/dev/tests.rst
@@ -39,8 +39,8 @@ Hint: colorized output
Install ``rednose`` locally, export the ``NOSE_REDNOSE`` variable, and give your eyes a rest :)::
- (leap_client)% pip install rednose
- (leap_client)% export NOSE_REDNOSE=1
+ (bitmask)% pip install rednose
+ (bitmask)% export NOSE_REDNOSE=1
Testing all the supported python versions
-----------------------------------------
diff --git a/docs/man/leap-client.1.rst b/docs/man/bitmask.1.rst
index 1ef5b3cc..12c87a5d 100644
--- a/docs/man/leap-client.1.rst
+++ b/docs/man/bitmask.1.rst
@@ -1,6 +1,6 @@
-===========
-leap-client
-===========
+=======
+bitmask
+=======
------------------------------------------------------------------------
graphical client to control LEAP, the encrypted internet access toolkit.
@@ -16,12 +16,12 @@ graphical client to control LEAP, the encrypted internet access toolkit.
SYNOPSIS
========
-leap-client [-h] [-d] [-l [LOG FILE]] [--openvpn-verbosity [OPENVPN_VERB]]
+bitmask [-h] [-d] [-l [LOG FILE]] [--openvpn-verbosity [OPENVPN_VERB]]
DESCRIPTION
===========
-*leap-client* is a graphical client to control LEAP, the encrypted internet access toolkit.
+*bitmask* is a graphical client to control LEAP, the encrypted internet access toolkit.
When launched, it places an icon in the system tray from where the LEAP services can be controlled.
@@ -49,14 +49,14 @@ WARNING
This software is still in early alfa testing. So don't trust your life to it!
-At the current time, the LEAP Client is not compatible with ``openresolv``, but it works with ``resolvconf``.
+At the current time, Bitmask is not compatible with ``openresolv``, but it works with ``resolvconf``.
FILES
=====
/etc/leap/resolv-update
-----------------------
-Post up/down script passed to openvpn. It writes /etc/resolv.conf to avoid dns leaks, and restores the original resolv.conf on exit.
+Post up/down script passed to openvpn. It writes /etc/resolv.conf to avoid dns leaks, and restores the original resolv.conf on exit.
/etc/leap/resolv-head
---------------------
diff --git a/docs/testers/howto.rst b/docs/testers/howto.rst
index a3f8da09..dde893d1 100644
--- a/docs/testers/howto.rst
+++ b/docs/testers/howto.rst
@@ -34,19 +34,19 @@ Bootstrap script
This will fetch the *develop* branch. If you want to test another branch, just change it in the line starting with *pip install...*. Alternatively, bug kali so she add an option branch to a decent script.
.. note::
- This script could make use of the after_install hook. Read http://pypi.python.org/pypi/virtualenv/
+ This script could make use of the after_install hook. Read http://pypi.python.org/pypi/virtualenv/
Download and source the following script in the parent folder where you want your testing build to be downloaded. For instance, to `/tmp/`:
.. code-block:: bash
cd /tmp
- wget https://raw.github.com/leapcode/leap_client/develop/pkg/scripts/leap_client_bootstrap.sh
+ wget https://raw.github.com/leapcode/bitmask/develop/pkg/scripts/leap_client_bootstrap.sh
source leap_client_bootstrap.sh
-Tada! If everything went well, you should be able to run the client by typing::
+Tada! If everything went well, you should be able to run bitmask by typing::
- bin/leap-client
+ bin/bitmask
Noticed that your prompt changed? That was *virtualenv*. Keep reading...
@@ -54,7 +54,7 @@ Activating the virtualenv
^^^^^^^^^^^^^^^^^^^^^^^^^
The above bootstrap script has fetched latest code inside a virtualenv, which is an isolated, *virtual* python local environment that avoids messing with your global paths. You will notice you are *inside* a virtualenv because you will see a modified prompt reminding it to you (*leap-client-testbuild* in this case).
-Thus, if you forget to *activate your virtualenv*, the client will not run from the local path, and it will be looking for something else in your global path. So, **you have to remember to activate your virtualenv** each time that you open a new shell and want to execute the code you are testing. You can do this by typing::
+Thus, if you forget to *activate your virtualenv*, bitmask will not run from the local path, and it will be looking for something else in your global path. So, **you have to remember to activate your virtualenv** each time that you open a new shell and want to execute the code you are testing. You can do this by typing::
$ source bin/activate
@@ -65,11 +65,11 @@ Refer to :ref:`Working with virtualenv <virtualenv>` to learn more about virtual
Copying config files
^^^^^^^^^^^^^^^^^^^^
-If you have never installed the ``leap-client`` globally, **you need to copy some files to its proper path before running it for the first time** (you only need to do this once). This, unless the virtualenv-based operations, will need root permissions. See :ref:`copy script files <copyscriptfiles>` and :ref:`running openvpn without root privileges <policykit>` sections for more info on this. In short::
+If you have never installed ``bitmask`` globally, **you need to copy some files to its proper path before running it for the first time** (you only need to do this once). This, unless the virtualenv-based operations, will need root permissions. See :ref:`copy script files <copyscriptfiles>` and :ref:`running openvpn without root privileges <policykit>` sections for more info on this. In short::
$ sudo cp pkg/linux/polkit/net.openvpn.gui.leap.policy /usr/share/polkit-1/actions/
$ sudo mkdir -p /etc/leap
- $ sudo cp pkg/linux/resolv-update /etc/leap
+ $ sudo cp pkg/linux/resolv-update /etc/leap
Local config files
^^^^^^^^^^^^^^^^^^^
@@ -83,8 +83,8 @@ Pulling latest changes
You should be able to cd into the downloaded repo and pull latest changes::
- (leap-client-testbuild)$ cd src/leap-client
- (leap-client-testbuild)$ git pull origin develop
+ (bitmask-testbuild)$ cd src/bitmask
+ (bitmask-testbuild)$ git pull origin develop
However, as a tester you are encouraged to run the whole bootstrap process from time to time to help us catching install and versioniing bugs too.
@@ -95,13 +95,13 @@ When we have a release candidate for the supported platforms (Debian stable, Ubu
Testing the status of translations
----------------------------------
-We need translators! You can go to `transifex <https://www.transifex.com/projects/p/leap-client/>`_, get an account and start contributing.
+We need translators! You can go to `transifex <https://www.transifex.com/projects/p/bitmask/>`_, get an account and start contributing.
-If you want to check the current status of the client localization in a language other than the one set in your machine, you can do it with a simple trick (under linux). For instance, do::
+If you want to check the current status of bitmask localization in a language other than the one set in your machine, you can do it with a simple trick (under linux). For instance, do::
- $ lang=es_ES leap-client
+ $ lang=es_ES bitmask
-for running LEAP Client with the spanish locales.
+for running Bitmask with the spanish locales.
Reporting bugs
--------------
@@ -110,6 +110,6 @@ Reporting bugs
There is a great text on the art of bug reporting, that can be found `online <http://www.chiark.greenend.org.uk/~sgtatham/bugs.html>`_.
-.. TODO add a line with ref. to running the client in debug mode...
+.. TODO add a line with ref. to running Bitmask in debug mode...
-We use the `LEAP Client Bug Tracker <https://leap.se/code/projects/eip-client>`_, although you can also use `Github issues <https://github.com/leapcode/leap_client/issues>`_.
+We use the `Bitmask Bug Tracker <https://leap.se/code/projects/eip-client>`_, although you can also use `Github issues <https://github.com/leapcode/bitmask/issues>`_.
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