Border-Check/doc

================================================================
Introduction:
==============================

Border Check (BC) is a browser extension that illustrates the physical and political realities of the internet's infrastructure using free software tools.

As one surfs the net, data packets are sent from the user's computer to the target server. These data packets go on a journey hopping from server to server, potentially crossing multiple countries, until the packets reach the desired website. In each of the countries that are passed different laws and practices can apply to the data, influencing whether or not authorities can inspect, store or modify that data.

In realtime BC lets you know which countries you surf through as you browse the web. Additionally BC will illustrate this process on a world map and (where available) provide you with contextualizing information on that country's laws and practices regarding your data.

Currently supporting the following browsers on OSX and Unix systems:
Firefox, Chromium, Chrome, Safari

================================================================
Options and features: v0.1
==============================
 
bc [OPTIONS] 

Options:
  --version             show program's version number and exit
  -h, --help            show this help message and exit
  -d, --debug           debug mode
  --xml=EXPORT_XML      export traces to xml (ex: --xml foo.xml)
  --bh=BROWSER_HISTORY  set browser's history path
  -b BROWSER            set browser manually: F = Firefox / C = Chrome / S = Safari / Ch = Chromium 

================================================================
Examples of usage:
==============================
* Normal BC run:

$ python bc
-------------------
* Debug mode:

$ python bc --debug 
-------------------
* Export 'hopping' results to xml:

$ python bc --xml "mytravel.xml" 
-------------------
* Use Firefox browser:

$ python bc -b F
-------------------
* Use Chromium browser:

$ python bc -b Ch 
-------------------
* Set browser's history path manually, on Galeon/Unix:

$ python bc --bh ".galeon/mozilla/galeon/places.sqlite" 
-------------------
* Set browser's history path manually, on Chrome/OSx:

$ python bc --bh "Library/Application Support/Google/Chrome/Default/History" 
-------------------
* Set browser's history path manually, on Safari/OSx:

$ python bc --bh "Library/Safari/History.plist" 
-------------------
* Set browser's history path manually, on Firefox/Unix:

$ python bc --bh "Library/Safari/History.plist" 
-------------------