From 2ad6aaf409b93b7dea41c9cc8d202a65cf87c7bc Mon Sep 17 00:00:00 2001 From: Daniel Siepmann <daniel.siepmann@typo3.org> Date: Fri, 25 Sep 2015 13:35:46 +0200 Subject: [PATCH] [TASK] Update documentation for scheduler options 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> --- .../SchedulerShellScript/Index.rst | 23 +++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/typo3/sysext/scheduler/Documentation/Installation/SchedulerShellScript/Index.rst b/typo3/sysext/scheduler/Documentation/Installation/SchedulerShellScript/Index.rst index 7409af382bf2..158cbc74df03 100644 --- a/typo3/sysext/scheduler/Documentation/Installation/SchedulerShellScript/Index.rst +++ b/typo3/sysext/scheduler/Documentation/Installation/SchedulerShellScript/Index.rst @@ -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. -- GitLab