components/python/logilab-common/logilab-common.3
changeset 6938 64f04bb4c3c3
parent 4814 c673d998018a
equal deleted inserted replaced
6936:b7d04c4c9133 6938:64f04bb4c3c3
     1 '\" te
     1 '\" te
     2 .\"
     2 .\"
     3 .\" Copyright (c) 2009, 2015, Oracle and/or its affiliates. All rights reserved.
     3 .\" Copyright (c) 2009, 2016, Oracle and/or its affiliates. All rights reserved.
     4 .\"
     4 .\"
     5 .\" logilab-common.3
     5 .\" logilab-common.3
     6 .\"
     6 .\"
     7 .TH logilab-common 3 "28 Apr 2015" "logilab-common 0.63.2"
     7 .TH logilab-common 3 "23 Aug 2016" "logilab-common 1.2.2"
     8 .SH NAME
     8 .SH NAME
     9 logilab-common \- Common Modules used by Logilab projects
     9 logilab-common \- Common Modules used by Logilab projects
    10 .SH DESCRIPTION
    10 .SH DESCRIPTION
    11 The
    11 The
    12 .I logilab-common
    12 .I logilab-common
    30 .LP
    30 .LP
    31 
    31 
    32 * `clcommands`, high-level classes to define command line programs handling different subcommands. It is based on `configuration` to get easy command line / configuration file handling.
    32 * `clcommands`, high-level classes to define command line programs handling different subcommands. It is based on `configuration` to get easy command line / configuration file handling.
    33 .LP
    33 .LP
    34 
    34 
    35 * `cli`, a base class for interactive programs using the command line.
       
    36 .LP
       
    37 
       
    38 * `configuration`, some classes to handle unified configuration from both command line (using optparse) and configuration file (using ConfigParser).
    35 * `configuration`, some classes to handle unified configuration from both command line (using optparse) and configuration file (using ConfigParser).
    39 .LP
       
    40 
       
    41 * `dbf`, read Visual Fox Pro DBF files.
       
    42 .LP
    36 .LP
    43 
    37 
    44 * `proc`, interface to Linux /proc.
    38 * `proc`, interface to Linux /proc.
    45 .LP
    39 .LP
    46 
    40 
   103 .LP
    97 .LP
   104 
    98 
   105 * `optik_ext`, defines some new option types (regexp, csv, color, date, etc.) for `optik` / `optparse`
    99 * `optik_ext`, defines some new option types (regexp, csv, color, date, etc.) for `optik` / `optparse`
   106 .LP
   100 .LP
   107 
   101 
   108 * `xmlrpcutils`, auth support for XML-RPC
       
   109 .LP
       
   110 
       
   111 
   102 
   112 .SH Modules extending some external modules
   103 .SH Modules extending some external modules
   113 .LP
       
   114 
       
   115 * `corbautils`, useful functions for use with the OmniORB_ CORBA library.
       
   116 .LP
       
   117 
       
   118 * `hg`, some Mercurial_ utility functions.
       
   119 .LP
       
   120 
       
   121 * `pdf_ext`, pdf and fdf file manipulations, with pdftk.
       
   122 .LP
       
   123 
       
   124 * `pyro_ext`, some Pyro_ utility functions.
       
   125 .LP
   104 .LP
   126 
   105 
   127 * `sphinx_ext`, Sphinx_ plugin defining a `autodocstring` directive.
   106 * `sphinx_ext`, Sphinx_ plugin defining a `autodocstring` directive.
   128 .LP
   107 .LP
   129 
   108 
   147 .LP
   126 .LP
   148 * `sphinxutils`: we won't go that way imo (i == syt)
   127 * `sphinxutils`: we won't go that way imo (i == syt)
   149 .LP
   128 .LP
   150 
   129 
   151 
   130 
   152 .SH Deprecated modules
       
   153 .LP
       
   154 
       
   155 These `logilab.common` modules are only for backward compatibility. They can go away at anytime.
       
   156 .LP
       
   157 
       
   158 * `optparser`: use `clcommands` instead
       
   159 .LP
       
   160 
       
   161 * `adbh`, `db`, `sqlgen`: see `logilab.database`_ instead
       
   162 .LP
       
   163 
       
   164 * `contexts`: content move to `shellutils`
       
   165 .LP
       
   166 
       
   167 * `html`: deprecated without replacement
       
   168 
       
   169 .LP
       
   170 
       
   171 .SH FILES
   131 .SH FILES
   172 .TP 2.2i
   132 .TP 2.2i
   173 .B /usr/lib/python2.7/vendor-packages/logilab/common
   133 .B /usr/lib/python2.7/vendor-packages/logilab/common
       
   134 .TP 2.2i
       
   135 .B /usr/lib/python3.4/vendor-packages/logilab/common
       
   136 .TP 2.2i
       
   137 .B /usr/lib/python3.5/vendor-packages/logilab/common
   174 logilab-common python modules
   138 logilab-common python modules
   175 
   139 
   176 .SH AUTHORS
   140 .SH AUTHORS
   177 Sylvain Thenault ([email protected])
   141 Sylvain Thenault ([email protected])
   178 
   142