File	Date	Author	Commit
bin	2014-10-04	Oleg Gryb	[38af45] version in help added
etc	2014-10-04	Oleg Gryb	[223f08] version 1.4 for sf.net
pfs_config	2014-10-04	Oleg Gryb	[223f08] version 1.4 for sf.net
.DS_Store	2014-10-04	Oleg Gryb	[223f08] version 1.4 for sf.net
.gitignore	2014-10-04	Oleg Gryb	[69c04a] gitignore
.project	2014-05-15	Gryb	[ef809c] first version
.pydevproject	2014-10-04	Oleg Gryb	[223f08] version 1.4 for sf.net
README	2014-10-04	Oleg Gryb	[38af45] version in help added
setup.py	2014-10-04	Oleg Gryb	[223f08] version 1.4 for sf.net
version.py	2014-10-04	Oleg Gryb	[223f08] version 1.4 for sf.net

Read Me

*** Author ***

Oleg Gryb 
oleg@gryb.info

*** Dependencies ***

     openssl (native) >= 1.0.1.g (http://www.openssl.org)
     cryptography >= 0.4 (https://github.com/pyca/pyopenssl)
     pyOpenSSL >= 0.14 (https://github.com/pyca/pyopenssl)
     python >= 2.7 (http://www.python.org/download/)

*** Native openssl and pyOpenSSL installation (on Mac) ***
    Most likely your openssl C lib is older than needed by pfs_checker.
    Use bin/build_openssl.sh script in the project tree to build the
    openssl lib version 1.0.1. 
    
    Move the built libs to /usr/lib:
    
    sudo cp *.dylib /usr/lib/.
    cd /usr/lib
    sudo unlink libcrypto.dylib
    sudo ln -s libcrypto.1.0.0.dylib libcrypto.dylib
    
    sudo unlink libssl.dylib
    sudo ln -s libssl.1.0.0.dylib libssl.dylib
    
    After this is done use pip to install cryptography:
    
    pip install cryptography 
    
    and lastly install pyOpenSSL - either by running setup.py
    or using pip.

*** pfs_checker installation ***

     1. mkdir pfs_checker
     2. cd pfs_checker 
     3. git clone ssh://gryb_info@git.code.sf.net/p/pfschecker/code .
     4. sudo python setup.py install 

*** Executables and Help ***

   For help type:
   
   pfs_checker.py -h 

*** Running ***

	pfs_checker has a default JSON config file that you can find at:
	pfs_checker/pfs_config/data/config.json
	This file will be installed along with the program during the setup
    A config and other options file can be provided on a command line
    as well, in which case they will override the default config's options.
    
    An HTML report will be generated in the current directory and called as
    statfile.html, but this name and location can be overwritten in a config
    file or in the command line options.
    
    To see details in the generated HTML report simply click on a colored
    bar in the graph. A table with details will be shown on the right.