Login or Register to Ask a Question and Join Our Community

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)

NAME

       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 <shlomme@gmx.net>, for the Debian project (but may be used by others).

								 January  31, 2010						      ERIC4_API(1)

Check Out this Related Man Page

CYTHON(1)							   User Commands							 CYTHON(1)

NAME

       Cython - compile Cython code (.pyx) into C to build a Python extension

SYNOPSIS

       cython [options] sourcefile.{pyx,py} ...

DESCRIPTION

       Cython (http://cython.org) is a compiler for code written in the Cython language.  Cython is based on Pyrex by Greg Ewing.

OPTIONS

       -V, --version
	      Display version number of cython compiler

       -l, --create-listing
	      Write error messages to a listing file

       -I, --include-dir <directory>
	      Search for include files in named directory (multiple include directories are allowed).

       -o, --output-file <filename>
	      Specify name of generated C file

       -t, --timestamps
	      Only compile newer source files

       -f, --force
	      Compile all source files (overrides implied -t)

       -q, --quiet
	      Don't print module names in recursive mode

       -v, --verbose
	      Be verbose, print file names on multiple compilation

       -p, --embed-positions
	      If specified, the positions in Cython files of each function definition is embedded in its docstring.

       --cleanup <level>
	      Release interned objects on python exit, for memory debugging.  Level indicates aggressiveness, default 0 releases nothing.

       -w, --working <directory>
	      Sets the working directory for Cython (the directory modules are searched from)

       --gdb  Output debug information for cygdb

       -D, --no-docstrings
	      Strip docstrings from the compiled module.

       -a, --annotate
	      Produce a colorized HTML version of the source.

       --line-directives
	      Produce #line directives pointing to the .pyx source

       --cplus
	      Output a C++ rather than C file.

       --embed[=<method_name>]
	      Generate a main() function that embeds the Python interpreter.

       -2     Compile based on Python-2 syntax and code semantics.

       -3     Compile based on Python-3 syntax and code semantics.

       --fast-fail
	      Abort the compilation on the first error

       --warning-error, -Werror
	      Make all warnings into errors

       --warning-extra, -Wextra
	      Enable extra warnings

       -X, --directive <name>=<value>[,<name=value,...] Overrides a compiler directive

Cython version 0.15.1						   January 2012 							 CYTHON(1)
Man Page