diff options
Diffstat (limited to 'doxygen/man/man3/setup.3')
| -rw-r--r-- | doxygen/man/man3/setup.3 | 154 |
1 files changed, 154 insertions, 0 deletions
diff --git a/doxygen/man/man3/setup.3 b/doxygen/man/man3/setup.3 new file mode 100644 index 0000000..5a3e607 --- /dev/null +++ b/doxygen/man/man3/setup.3 @@ -0,0 +1,154 @@ +.TH "setup" 3 "Fri Sep 9 2011" "Cmd2" \" -*- nroff -*- +.ad l +.nh +.SH NAME +setup \- +.SH SYNOPSIS +.br +.PP +.SS "Functions" + +.in +1c +.ti -1c +.RI "def \fBfind_packages\fP" +.br +.in -1c +.SS "Variables" + +.in +1c +.ti -1c +.RI "string \fBauthor\fP = 'Catherine Devlin'" +.br +.ti -1c +.RI "string \fBauthor_email\fP = 'catherine\&.devlin@gmail\&.com'" +.br +.ti -1c +.RI "list \fBclassifiers\fP" +.br +.ti -1c +.RI "string \fBdescription\fP = 'Extra features for standard library's cmd module'" +.br +.ti -1c +.RI "list \fBinstall_requires\fP = ['pyparsing>=1\&.5\&.6']" +.br +.ti -1c +.RI "string \fBkeywords\fP = 'command prompt console cmd'" +.br +.ti -1c +.RI "string \fBlicense\fP = 'MIT'" +.br +.ti -1c +.RI "string \fBlong_description\fP" +.br +.ti -1c +.RI "string \fBname\fP = 'cmd2'" +.br +.ti -1c +.RI "list \fBpy_modules\fP = ['cmd2']" +.br +.ti -1c +.RI "string \fBurl\fP = 'http://packages\&.python\&.org/cmd2/'" +.br +.ti -1c +.RI "\fBuse_2to3\fP = True," +.br +.ti -1c +.RI "string \fBversion\fP = '0\&.6\&.4'" +.br +.in -1c +.SH "Function Documentation" +.PP +.SS "def setup::find_packages ()" +.PP +Definition at line 6 of file setup\&.py'\&. +.PP +.nf +6 +7 def find_packages(): + return ['sqlpython'] +.fi +.SH "Variable Documentation" +.PP +.SS "string \fBsetup::author\fP = 'Catherine Devlin'" +.PP +Definition at line 18 of file setup\&.py'\&. +.SS "string \fBsetup::author_email\fP = 'catherine\&.devlin@gmail\&.com'" +.PP +Definition at line 19 of file setup\&.py'\&. +.SS "list \fBsetup::classifiers\fP"\fBInitial value:\fP +.PP +.nf +1 [ +2 'Development Status :: 4 - Beta', +3 'Environment :: Console', +4 'Operating System :: OS Independent', +5 'Intended Audience :: Developers', +6 'Intended Audience :: System Administrators', +7 'Programming Language :: Python', +8 'License :: OSI Approved :: MIT License', +9 'Topic :: Software Development :: Libraries :: Python Modules', +10 ] +.fi +.PP +Definition at line 51 of file setup\&.py'\&. +.SS "string \fBsetup::description\fP = 'Extra features for standard library's cmd module'" +.PP +Definition at line 20 of file setup\&.py'\&. +.SS "\fBsetup::install_requires\fP = ['pyparsing>=1\&.5\&.6']" +.PP +Definition at line 10 of file setup\&.py'\&. +.SS "string \fBsetup::keywords\fP = 'command prompt console cmd'" +.PP +Definition at line 22 of file setup\&.py'\&. +.SS "string \fBsetup::license\fP = 'MIT'" +.PP +Definition at line 21 of file setup\&.py'\&. +.SS "string \fBsetup::long_description\fP"\fBInitial value:\fP +.PP +.nf +1 '''Enhancements for standard library's cmd module\&. +2 +3 Drop-in replacement adds several features for command-prompt tools: +4 +5 * Searchable command history (commands: 'hi', 'li', 'run') +6 * Load commands from file, save to file, edit commands in file +7 * Multi-line commands +8 * Case-insensitive commands +9 * Special-character shortcut commands (beyond cmd's '@' and '!') +10 * Settable environment parameters +11 * Parsing commands with flags +12 * > (filename), >> (filename) redirect output to file +13 * < (filename) gets input from file +14 * bare >, >>, < redirect to/from paste buffer +15 * accepts abbreviated commands when unambiguous +16 * `py` enters interactive Python console +17 * test apps against sample session transcript (see example/example\&.py) +18 +19 Useable without modification anywhere cmd is used; simply import cmd2\&.Cmd in place of cmd\&.Cmd\&. +20 +21 Running `2to3 <http://docs\&.python\&.org/library/2to3\&.html>` against ``cmd2\&.py`` +22 generates working, Python3-based code\&. +23 +24 See docs at http://packages\&.python\&.org/cmd2/ +25 ''' +.fi +.PP +Definition at line 25 of file setup\&.py'\&. +.SS "string \fBsetup::name\fP = 'cmd2'" +.PP +Definition at line 12 of file setup\&.py'\&. +.SS "list \fBsetup::py_modules\fP = ['cmd2']" +.PP +Definition at line 14 of file setup\&.py'\&. +.SS "string \fBsetup::url\fP = 'http://packages\&.python\&.org/cmd2/'" +.PP +Definition at line 23 of file setup\&.py'\&. +.SS "\fBsetup::use_2to3\fP = True," +.PP +Definition at line 15 of file setup\&.py'\&. +.SS "string \fBsetup::version\fP = '0\&.6\&.4'" +.PP +Definition at line 13 of file setup\&.py'\&. +.SH "Author" +.PP +Generated automatically by Doxygen for Cmd2 from the source code'\&. |