zim.main

package documentation
(source)

This module defines the main() function for executing the zim application. It also defines a number of command classes that implement specific commandline commands and an singleton application object that takes core of the process life cycle.
Module command This module is responsible for commandline parsing. It provides a base class for the commandline commands defined in zim.main
Module ipc This module is responsible for the inter-process communication (ipc) between zim instances.

From __init__.py:

Class ExportCommand Class implementing the --export command
Class GuiCommand Class implementing the --gui command and run the gtk interface
Class HelpCommand Class implementing the --help command
Class IndexCommand Class implementing the --index command
Class ManualCommand Like GuiCommand but always opens the manual
Class NotebookCommand Base class for commands that act on a notebook
Class NotebookLookupError Error when failing to locate a notebook
Class SearchCommand Class implementing the --search command
Class ServerCommand Class implementing the --server command and running the web server.
Class ServerGuiCommand Like ServerCommand but uses the graphical interface for the server defined in zim.gui.server.
Class VersionCommand Class implementing the --version command
Class ZimApplication This object is repsonsible for managing the life cycle of the application process.
Function build_command Parse all commandline options @returns: a Command object @raises UsageError: if args is not correct
Function main Run full zim application @returns: exit code (if error handled, else just raises)
Constant ZIM_APPLICATION Undocumented
Variable commands Undocumented
Variable logger Undocumented
logger = (source)

Undocumented

commands = (source)

Undocumented

def build_command(args, pwd=None): (source)
Parse all commandline options
Returns
a Command object
Raises
UsageErrorif args is not correct
ZIM_APPLICATION = (source)

Undocumented

Value
ZimApplication()
def main(*argv): (source)
Run full zim application
Returns
exit code (if error handled, else just raises)