Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

eric4_api(1) [debian man page]

ERIC4_API(1)						      General Commands Manual						      ERIC4_API(1)

eric4_api - eric4 API generator SYNOPSIS
eric4_api [options] files... where files can be be either Python modules, package directories or ordinary directories. DESCRIPTION
This manual page documents briefly the eric4_api command. This manual page was written for the Debian distribution because the original program does not have a manual page. eric4_api scans Python source code to generate API descriptions files which are used to as tooltips and autocompletion suggestions by the QScintilla editor widget in eric4. OPTIONS
These programs follow the usual GNU command line syntax, with long options starting with two dashes (`-'). A summary of options is included below. For a complete description, see the Info files. -b name or --base name Use the given name as the name of the base package. -h or --help Show this help and exit. -o filename or --output=filename Write the API information to the named file. A '%L' placeholder is replaced by the language of the API file (see --language). --oldstyle Generate API files for QScintilla prior to 1.7. -p or --private Include private methods and functions. -R, -r or --recursive Perform a recursive search for Python files. -t ext or --extension = ext Add the given extension to the list of file extensions. This option may be given multiple times. -V or --version Show version information and exit. -x directory or --exclude=directory Specify a directory basename to be excluded. This option may be repeated multiple times. --exclude-file=pattern Specify a filename pattern of files to be excluded. This option may be repeated multiple times. -l language or --language=language Generate an API file for the given programming language. Supported programming languages are: * Python * Python3 * Ruby The default is 'Python'. This option may be repeated multiple times. SEE ALSO
eric4(1), eric4_compare(1), eric4_configure(1), eric4_diff(1), eric4_doc(1), eric4_editor(1), eric4_helpviewer(1), eric4_iconeditor(1), eric4_plugininstall(1), eric4_pluginrepository(1), eric4_pluginuninstall(1), eric4_qregexp(1), eric4_re(1), eric4_sqlbrowser(1), eric4_tray(1), eric4_trpreviewer(1), eric4_uipreviewer(1), eric4_unittest(1), eric4_webbrowser(1) AUTHOR
This manual page was written by Torsten Marek <>, for the Debian project (but may be used by others). January 31, 2010 ERIC4_API(1)

Check Out this Related Man Page

SIP(1)                                                        General Commands Manual                                                       SIP(1)

sip - generates C++/Python bindings SYNOPSIS
sip [-h] [-V] [-a file] [-c dir] [-d file] [-e] [-g] [-I dir] [-j #] [-k] [-m file] [-o] [-p module] [-P] [-r] [-s suffix] [-t tag] [-w] [-x feature] [-z file] [file] DESCRIPTION
sip takes a set of specification files and generates C++ code, documentation and build files. The format of the needed specification file is similar to a C++ header. sip includes run-time support for the generated code. OPTIONS
-h Show summary of options. -V Display the sip version number -a file The name of the QScintilla API file. If not indicated, it will not be generated. -b file The name of the build file. If not indicated, it will not be generated. -c dir The name of the directory where generated source file will be put. If not indicated, no code will be generated. -d file The name of the documentation file. If not indicated, no documentation will be generated. -e Enable support for exceptions. Disabled by default. -g Always release and reaquire the GIL. -I dir Directory where sip can search for included files. -j number Splits the generated code in number files (1 by default). This flag was added for parallel compilation on SMP machines. -m file The name of the XML export file. If not indicated, the file will not be generated. -p module Give the name of the consolidated module this module should be a part of. -P Enable the protected/public hack. -r Enable tracing on generated code. -s suffix The suffix used for generated C or C++ files (".c" or ".cpp" if none specified) -t tag The primary version to tag generate code for. You only can specify those defined with a %Timeline directive. If you don't specify one, sip will generate the latest available. -w Enable warning messages -x feature Disable a feature -z file The name of a file containing additional command line flags file The name of the file containing the specification. If you skip it, sip will expect to be fed by stdin. AUTHOR
This manual page was written by Ricardo Javier Cardenes Medina <> and Torsten Marek <>, for the Debian GNU/Linux system (but may be used by others). 2010/02/02 SIP(1)
Man Page