third_party/python_gflags/README

   1 This repository contains a python implementation of the Google commandline
   2 flags module.
   3
   4  GFlags defines a *distributed* command line system, replacing systems like
   5  getopt(), optparse and manual argument processing. Rather than an application
   6  having to define all flags in or near main(), each python module defines flags
   7  that are useful to it.  When one python module imports another, it gains
   8  access to the other's flags.
   9
  10  It includes the ability to define flag types (boolean, float, interger, list),
  11  autogeneration of help (in both human and machine readable format) and reading
  12  arguments from a file. It also includes the ability to automatically generate
  13  man pages from the help flags.
  14
  15 Documentation for implementation is at the top of gflags.py file.
  16
  17 To install the python module, run
  18    python ./setup.py install
  19
  20 When you install this library, you also get a helper application,
  21 gflags2man.py, installed into /usr/local/bin.  You can run gflags2man.py to
  22 create an instant man page, with all the commandline flags and their docs, for
  23 any C++ or python program you've written using the gflags library.