[TASK] Update documentation for scheduler options 65/43565/3
authorDaniel Siepmann <daniel.siepmann@typo3.org>
Fri, 25 Sep 2015 11:35:46 +0000 (13:35 +0200)
committerAndreas Fernandez <typo3@scripting-base.de>
Fri, 25 Sep 2015 13:43:02 +0000 (15:43 +0200)
Update the extension documentation to provide information about possible
options that can be provided while calling the scheduler script via
command line interface.

Resolves: #38506
Releases: master
Change-Id: I8372ec3ea83f8a18a05d0bb64e461341034fade0
Reviewed-on: http://review.typo3.org/43565
Reviewed-by: Philipp Gampe <philipp.gampe@typo3.org>
Tested-by: Philipp Gampe <philipp.gampe@typo3.org>
Reviewed-by: Andreas Fernandez <typo3@scripting-base.de>
Tested-by: Andreas Fernandez <typo3@scripting-base.de>
typo3/sysext/scheduler/Documentation/Installation/SchedulerShellScript/Index.rst

index 7409af3..158cbc7 100644 (file)
@@ -31,3 +31,26 @@ following error:
 If the user exists, you should see nothing, as the Scheduler doesn't
 give any visual feedback while running.
 
+.. _options:
+
+Providing options to the shell script
+"""""""""""""""""""""""""""""""""""""
+
+The shell scripts accepts a number of options which can be provided in any
+order.
+
+To run a specific scheduler task you need to provide the uid of the task:
+
+::
+
+   /usr/local/bin/php /home/bob/www/typo3/cli_dispatch.phpsh scheduler -i 8
+
+The example will trigger the task with uid 8.
+
+To run a task even if it is disabled, you need to provide the force option
+
+::
+
+   /usr/local/bin/php /home/bob/www/typo3/cli_dispatch.phpsh scheduler -i 8 -f
+
+This will also run the task with uid 8 if it is disabled.