diff --git a/dspace/docs/docbook/application.xml b/dspace/docs/docbook/application.xml index 001db514df..bdbb3cfccd 100644 --- a/dspace/docs/docbook/application.xml +++ b/dspace/docs/docbook/application.xml @@ -518,4 +518,55 @@ from/until/setSpec/offset 2003-01-01, has no 'until' date, is for collection hdl:1721.1/1234, and 300 records have already been sent to the harvester. (Actually, if the original OAI-PMH request doesn't specify a 'from' or 'until, OAICat fills them out automatically to '0000-00-00T00:00:00Z' and '9999-12-31T23:59:59Z' respectively. This means DSpace resumption tokens will always have from and until dates in them.) +
+ <anchor id="docbook-application.html-command-launcher" xreflabel="DSpace Command Launcher"/>DSpace Command Launcher + Introduced in Release 1.6, the DSpace Command Launcher brings together the various command and scripts into a standard-practice for running CLI runtime programs. +
+ Older Versions + Prior to Release 1.6, there were various scripts written that masked a more manual approach to running CLI programs. The user had to issue [dspace]/bin/dsrun and then java class that ran that program. With release 1.5, scripts were written to mask the [dspace]/bin/dsrun command. We have left the java class in the System Administration section since it does have value for debugging purposes and for those who wish to learn about DSpace + programming or wish to customize the code at any time. +
+
+ Command Launcher Structure + There are two components to the command launcher: the dspace script and the launcher.xml. The DSpace command calls a java class which in turn refers to launcher.xml that is stored in the [dspace]/config directory + launcher.xml is made of several components: + + + <command> begins the stanza for a comand + + + <name>name of command</name> the name of the command that you would use. + + + <description>the description of the command</description> + + + <step> </step> User arguments are parsed and tested. + + + <class><the java class that is being used to run the CLI program></class> + + + Prior to release 1.5 if one wanted to regenerate the browse index, one would have to issue the following commands manually: +[dspace]/bin/dsrun org.dspace.browse.IndexBrowse -f -r +[dspace]/bin/dsrun org.dspace.browse.ItemCounter +[dspace]/bin/dsrun org.dspace.search.DSIndexer + In release 1.5 a script was written and in release 1.6 the command [dspace]/bin/dspace index-init replaces the script. The stanza from launcher.xml show us how one can build more commands if needed: +<command> + <name>index-update</name> + <description>Update the search and browse indexes</description> + <step passuserargs="false"> + <class>org.dspace.browse.IndexBrowse</class> + <argument>-i</argument> + </step> + <step passuserargs="false"> + <class>org.dspace.browse.ItemCounter</class> + </step> + <step passuserargs="false"> + <class>org.dspace.search.DSIndexer</class> + </step> +</command> + . +
+