org.corpus_tools.pepper.cli.PepperStarter.COMMAND Enum Reference

Public Member Functions
String	getName ()
String	getAbbreviation ()
String	getParameters ()
String	getDescription ()

Public Attributes
	VERSION =("version", "v", "no arguments", "prints pepper version")
	PRINT_DEPS
	UPDATE
	LIST_ALL =("list", "l", null, "A table with information about all available Pepper modules.")
	LIST =("list", "l", "module name", "A table with information about the passed Pepper module.")
	CONF =("conf", "co", null, "Shows the configuration for current Pepper instance.")
	HELP =("help", "h", null, "Prints this help.")
	SELFTEST
	FITNESS
	EXIT =("exit", "e", null, "Exits Pepper.")
	CONVERT
	OSGI
	INSTALL_START
	REMOVE
	START_OSGI =("start-osgi", "start", null, "Starts the OSGi environment (the plugin system of Pepper).")
	STOP_OSGI =("stop-osgi", "stop", null, "Stops the OSGi environment (the plugin system of Pepper).")
	CLEAN
	DEBUG =("debug", "d", null, "Switches on/off the debug output.")
	REPEAT

Member Data Documentation

CLEAN

org.corpus_tools.pepper.cli.PepperStarter.COMMAND.CLEAN

Initial value:

=(
                                "clean", "cl", null, "Cleans the current Pepper instance and especially removes the OSGi workspace.")

CONVERT

org.corpus_tools.pepper.cli.PepperStarter.COMMAND.CONVERT

Initial value:

=("convert", "c", "workflow file",
                                "If no workflow file is passed, Pepper opens a conversion wizard, which helps you through the definition of a workflow proecess. If a 'worklow file' is passed, this file is loaded and the described workflow will be started.")

FITNESS

org.corpus_tools.pepper.cli.PepperStarter.COMMAND.FITNESS

Initial value:

=("fitness", "f", null,
                                "Checks the fitness of each registered Pepper module. "
                                        + "The fitness check tests features of a module that are "
                                        + "necessary to run a module and features which should be "
                                        + "implemented. Modules having the status \"HEALTHY\" should "
                                        + "be possible to run, having the status \"FIT\" means they "
                                        + "also passed the more rigid tests. Modules that have a "
                                        + "\"CRITICAL\" health status are very likely to cause problems.")

INSTALL_START

org.corpus_tools.pepper.cli.PepperStarter.COMMAND.INSTALL_START

Initial value:

=(
                                                "install_start", "is", "module path",
                                                "Installs the Pepper module located at 'module path' and starts it.")

OSGI

org.corpus_tools.pepper.cli.PepperStarter.COMMAND.OSGI

Initial value:

=("osgi", "o", null,
                                "Opens a console to access the underlying OSGi environment, if OSGi is used.")

PRINT_DEPS

org.corpus_tools.pepper.cli.PepperStarter.COMMAND.PRINT_DEPS

Initial value:

=("dependencies", "deps",
                                "Bundle id or GROUP_ID::ARTIFACT_ID::VERSION::MAVEN_REPOSITORY_URL or plugin names split by space; parameter all prints dependencies for all plugins",
                                "displays all dependencies of the specified component")

REMOVE

org.corpus_tools.pepper.cli.PepperStarter.COMMAND.REMOVE

Initial value:

=("remove", "re", "bundle name",
                                "Removes all Pepper modules, being contained in the bundle with name 'bundle name'. To find out the bundle name open the osgi console and list all bundles. ")

REPEAT

org.corpus_tools.pepper.cli.PepperStarter.COMMAND.REPEAT

Initial value:

=("repeat", "r", null,
                                "Repeats the last command.")

SELFTEST

org.corpus_tools.pepper.cli.PepperStarter.COMMAND.SELFTEST

Initial value:

=("self-test", "st", null,
                                "Tests if the Pepper framework is in runnable mode or if any problems are detected, either in Pepper itself or in any registered Pepper module.")

UPDATE

org.corpus_tools.pepper.cli.PepperStarter.COMMAND.UPDATE

Initial value:

=("update", "u", "module name or location",
                                "Updates the pepper module(s). Parameter \"all\" updates all modules listed in modules.xml.")