etc/agfw/gfwlist2pac/README.md

   1 GFWList2PAC
   2 ===========
   3
   4 [![PyPI version]][PyPI]
   5 [![Build Status]][Travis CI]
   6 [![Coverage Status]][Coverage]
   7
   8 Generate fast PAC file from gfwlist. Examples: [fast mode] / [precise mode].
   9
  10 Fast mode: use O(1) domain lookup
  11
  12 Precise mode: use adblock plus engine
  13
  14
  15 ### Usage
  16
  17     pip install gfwlist2pac
  18
  19     usage: gfwlist2pac [-h] [-i GFWLIST] -f PAC -p PROXY [--user-rule USER_RULE]
  20                    [--precise]
  21
  22     optional arguments:
  23       -h, --help            show this help message and exit
  24       -i GFWLIST, --input GFWLIST
  25                             path to gfwlist
  26       -f PAC, --file PAC    path to output pac
  27       -p PROXY, --proxy PROXY
  28                             the proxy parameter in the pac file, for example,
  29                             "SOCKS5 127.0.0.1:1080;"
  30       --user-rule USER_RULE
  31                             user rule file, which will be appended to gfwlist
  32       --precise             use adblock plus algorithm instead of O(1) lookup
  33
  34 ### Performance
  35
  36 The PAC generated by GFWList2PAC is 1900x faster than SwitchySharp.
  37
  38     Testing fast mode pac generated by gfwlist2pac
  39     avg: 0.50us
  40
  41     Testing precise mode pac generated by gfwlist2pac
  42     avg: 1.66us
  43
  44     Testing pac generated by switchysharp
  45     avg: 952.99us
  46
  47
  48 [Build Status]:    https://img.shields.io/travis/clowwindy/gfwlist2pac/master.svg?style=flat
  49 [Coverage Status]: https://jenkins.shadowvpn.org/result/gfwlist2pac
  50 [Coverage]:        https://jenkins.shadowvpn.org/job/gfwlist2pac/ws/htmlcov/index.html
  51 [Travis CI]:       https://travis-ci.org/clowwindy/gfwlist2pac
  52 [PyPI]:            https://pypi.python.org/pypi/gfwlist2pac
  53 [PyPI version]:    https://img.shields.io/pypi/v/gfwlist2pac.svg?style=flat
  54 [fast mode]:       https://github.com/clowwindy/gfwlist2pac/blob/master/test/proxy.pac
  55 [precise mode]:    https://github.com/clowwindy/gfwlist2pac/blob/master/test/proxy_abp.pac
  56
  57 ### Comment
  58
  59 根据[Travis CI记录](https://travis-ci.org/clowwindy/gfwlist2pac/builds)，本版本为和谐前的倒数第二版。
  60 没有抓取最新的[e310d6678e7af113ca3e0c012045cf5d06571faf](https://github.com/clowwindy/gfwlist2pac/commit/e310d6678e7af113ca3e0c012045cf5d06571faf)版:
  61
  62 ~~~~
  63 master Merge pull request #52 from alextsui0510/patch-2
  64 August 14, 2015 1:03:00
  65
  66 Pull Request #52 Url mistake
  67 Url mistake
  68 It should be "google.com.hk" here. Not "google.co.hk"
  69 ~~~~
  70
  71
  72 My Git Log for the "May 26, 2015 22:24:00" :
  73
  74 ~~~~
  75 commit 95bd4b3ae0a20013e9deb391edd382d990ca6077
  76 Merge: d4cbb49 300f54d
  77 Author: clowwindy <clowwindy@users.noreply.github.com>
  78 Date:   Tue May 26 07:20:35 2015 -0700
  79
  80     Merge pull request #51 from RobberPhex/python3_support
  81
  82     add python3 support
  83 ~~~~
  84
  85 于是乎，由Galaxy手工修改`gfwlist2pac/resources/builtin.txt`吧。
  86
  87 以上的说！