sourCEntral - mobile manpages

pdf

ERIC4-API

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.
−o filename or −−output=filename

Write the API information to the named file.

−R, −r or −−recursive

Perform a recursive search for Python files.

−x directory or −−exclude=directory

Specify a directory basename to be excluded. This option may be repeated multiple times.

−V or −−version

Show version information and exit.

−h or −−help

Show this help and exit.

SEE ALSO

eric4(1), eric4-helpviewer(1), eric4-qregexp(1), eric4-re(1), eric4-doc(1), eric4-unittest(1).

AUTHOR

This manual page was written by Torsten Marek <shlomme AT gmx DOT net>, for the Debian project (but may be used by others).

pdf