etc/agfw/gfwlist2pac/README.rst

   1 GFWList2PAC
   2 ===========
   3
   4 |PyPI version| |Build Status| |Coverage Status|
   5
   6 Generate fast PAC file from gfwlist. Examples: `fast
   7 mode <https://github.com/clowwindy/gfwlist2pac/blob/master/test/proxy.pac>`__
   8 / `precise
   9 mode <https://github.com/clowwindy/gfwlist2pac/blob/master/test/proxy_abp.pac>`__.
  10
  11 Fast mode: use O(1) domain lookup
  12
  13 Precise mode: use adblock plus engine
  14
  15 Usage
  16 ~~~~~
  17
  18 ::
  19
  20     pip install gfwlist2pac
  21
  22     usage: gfwlist2pac [-h] [-i GFWLIST] -f PAC -p PROXY [--user-rule USER_RULE]
  23                    [--precise]
  24
  25     optional arguments:
  26       -h, --help            show this help message and exit
  27       -i GFWLIST, --input GFWLIST
  28                             path to gfwlist
  29       -f PAC, --file PAC    path to output pac
  30       -p PROXY, --proxy PROXY
  31                             the proxy parameter in the pac file, for example,
  32                             "SOCKS5 127.0.0.1:1080;"
  33       --user-rule USER_RULE
  34                             user rule file, which will be appended to gfwlist
  35       --precise             use adblock plus algorithm instead of O(1) lookup
  36
  37 Performance
  38 ~~~~~~~~~~~
  39
  40 The PAC generated by GFWList2PAC is 1900x faster than SwitchySharp.
  41
  42 ::
  43
  44     Testing fast mode pac generated by gfwlist2pac
  45     avg: 0.50us
  46
  47     Testing precise mode pac generated by gfwlist2pac
  48     avg: 1.66us
  49
  50     Testing pac generated by switchysharp
  51     avg: 952.99us
  52
  53 .. |PyPI version| image:: https://img.shields.io/pypi/v/gfwlist2pac.svg?style=flat
  54    :target: https://pypi.python.org/pypi/gfwlist2pac
  55 .. |Build Status| image:: https://img.shields.io/travis/clowwindy/gfwlist2pac/master.svg?style=flat
  56    :target: https://travis-ci.org/clowwindy/gfwlist2pac
  57 .. |Coverage Status| image:: http://192.81.132.184/result/gfwlist2pac
  58    :target: http://192.81.132.184/job/gfwlist2pac/ws/htmlcov/index.html