diff options
| -rw-r--r-- | MANIFEST.in | 3 | ||||
| -rw-r--r-- | docs/man/bitmask.1.rst | 41 | ||||
| -rw-r--r-- | src/leap/bitmask/platform_init/locks.py | 4 | ||||
| -rw-r--r-- | src/leap/bitmask/util/requirement_checker.py | 5 |
4 files changed, 43 insertions, 10 deletions
diff --git a/MANIFEST.in b/MANIFEST.in index 6334ce45..926e1793 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -4,5 +4,8 @@ recursive-include docs api/* config/* dev/* man/* pkg/* testers/* user/* prune docs/_build prune docs/covhtml include versioneer.py +include LICENSE +include README.rst +include CHANGELOG include src/leap/bitmask/util/reqs.txt include src/leap/bitmask/crypto/tests/wrongcert.pem diff --git a/docs/man/bitmask.1.rst b/docs/man/bitmask.1.rst index 12c87a5d..7a1d2ae1 100644 --- a/docs/man/bitmask.1.rst +++ b/docs/man/bitmask.1.rst @@ -7,9 +7,9 @@ graphical client to control LEAP, the encrypted internet access toolkit. ------------------------------------------------------------------------ :Author: LEAP Encryption Access Project https://leap.se -:Date: 2013-01-30 +:Date: 2013-08-23 :Copyright: GPLv3+ -:Version: 0.2 +:Version: 0.3.1 :Manual section: 1 :Manual group: General Commands Manual @@ -34,20 +34,49 @@ general options **-h, --help** Print a help message and exit. -**-d, --debug** Launches client in debug mode, writing debug info to stdout. +**-l, --logfile=<file>** Writes log to file. + +**-s, --standalone** Makes Bitmask use standalone directories for configuration and binary searching. -**---logfile=<file>** Writes log to file. openvpn options --------------- -**--openvpn-verbosity** [0-5] Verbosity level for openvpn logs. +**--openvpn-verbosity** [0-5] Verbosity level for openvpn logs. + +debug options +------------- +**-d, --debug** Launches client in debug mode, writing debug info to stdout. + +**--danger** Bypasses the certificate check for bootstrap. This open the possibility of MITM attacks, so use only to debug providers in controlled environments, and never in production. + +ENCRYPTED MAIL +============== + +Bitmask now (since version 0.3.0) supports the encrypted mail service with providers that offer it. + +Mail client configuration +------------------------- + +To be able to use the mail services, you should configure your mail client to +talk to the following ports: + +**STMP**: localhost:2013 + +**IMAP**: localhost:1984 + +For the time being, we have successfully tested this functionality in thunderbird. + +Mail poll period +---------------- +If you want to change the default polling time for fetching mail, you can use +a environment variable: BITMASK_MAILCHECK_PERIOD WARNING ======= -This software is still in early alfa testing. So don't trust your life to it! +This software is still in its early phases of testing. So don't trust your life to it! At the current time, Bitmask is not compatible with ``openresolv``, but it works with ``resolvconf``. diff --git a/src/leap/bitmask/platform_init/locks.py b/src/leap/bitmask/platform_init/locks.py index ecfe3b1f..34f884dc 100644 --- a/src/leap/bitmask/platform_init/locks.py +++ b/src/leap/bitmask/platform_init/locks.py @@ -185,7 +185,7 @@ if platform_init.IS_WIN: Creates a lock based on the atomic nature of mkdir on Windows system calls. """ - LOCKBASE = os.path.join(gettempdir(), "leap-client-lock") + LOCKBASE = os.path.join(gettempdir(), "bitmask-lock") def __init__(self): """ @@ -353,7 +353,7 @@ def we_are_the_one_and_only(): _sys = platform.system() if _sys in ("Linux", "Darwin"): - locker = UnixLock('/tmp/leap-client.lock') + locker = UnixLock('/tmp/bitmask.lock') locker.get_lock() we_are_the_one = locker.locked_by_us if not we_are_the_one: diff --git a/src/leap/bitmask/util/requirement_checker.py b/src/leap/bitmask/util/requirement_checker.py index 1d9b9923..bd3c1412 100644 --- a/src/leap/bitmask/util/requirement_checker.py +++ b/src/leap/bitmask/util/requirement_checker.py @@ -51,8 +51,9 @@ def get_requirements(): # if we are running from the package if not develop: - requires_file_name = os.path.join('leap', 'util', 'reqs.txt') - dist_name = Requirement.parse('leap-client') + requires_file_name = os.path.join( + 'leap', 'bitmask', 'util', 'reqs.txt') + dist_name = Requirement.parse('bitmask') try: with resource_stream(dist_name, requires_file_name) as stream: |