diff --git a/typo3/sysext/scheduler/Documentation/Installation/SchedulerShellScript/Index.rst b/typo3/sysext/scheduler/Documentation/Installation/SchedulerShellScript/Index.rst index 25abcfb2d67a51b7e93c973cd6c5073d8a76dbaf..74d5f0fe2353fa0768be75a9b50b3e1bda1b9141 100644 --- a/typo3/sysext/scheduler/Documentation/Installation/SchedulerShellScript/Index.rst +++ b/typo3/sysext/scheduler/Documentation/Installation/SchedulerShellScript/Index.rst @@ -9,49 +9,85 @@ .. _scheduler-shell-script: -The Scheduler shell script -^^^^^^^^^^^^^^^^^^^^^^^^^^ +========================== +The scheduler shell script +========================== -The Scheduler provides a PHP shell script designed to be run using +The scheduler provides a PHP shell script designed to be run using TYPO3's command-line dispatcher. To try and run that script a first -time, type the following command (adapting the path to TYPO3 -to match your system and add the full path to the php interpreter -in front of the command if php is not on the search path): +time, type the following command. -:: +On a Composer based system:: - /home/user/www/typo3/sysext/core/bin/typo3 scheduler:run - /usr/local/bin/php /home/user/www/typo3/sysext/core/bin/typo3 scheduler:run + bin/typo3 scheduler:run -If your installation is a composer based instance you can use this command line -in your installation directory: -:: +On a system without Composer (adapt the path to TYPO3 +to match your system):: + + typo3/sysext/core/bin/typo3 scheduler:run + +You might have to add the full path to the PHP interpreter +in front of the command if PHP is not on the search path:: + + /usr/local/bin/php typo3/sysext/core/bin/typo3 scheduler:run - bin/typo3 scheduler:run - /usr/local/bin/php bin/typo3 scheduler:run +In the following examples, we will use the path to `typo3` for systems +with Composer. -.. _options: +Show help +========= + +In order to show help:: + + bin/typo3 scheduler:run --help + + +.. _scheduler-shell-script-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: +`--task (-i)` +------------- + +To run a specific scheduler task you need to provide the uid of the task:: -:: + bin/typo3 scheduler:run --task=8 + +or + + bin/typo3 scheduler:run -i 8 - /home/user/www/typo3/sysext/core/bin/typo3 scheduler:run --task=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 +.. versionadded:: 10.3 + + It is possible to run several tasks:: + + bin/typo3 scheduler:run --task=8 --task=2 + + The tasks will be executed in the order in which they are provided. -:: +`--f` +----- - /home/user/www/typo3/sysext/core/bin/typo3 scheduler:run --task=8 -f +To run a task even if it is disabled (or not scheduled to be run yet), +you need to provide the force option:: + + bin/typo3 scheduler:run --task=8 -f This will also run the task with uid 8 if it is disabled. + +`--v` +----- + +A single -v flag will output errors only. Two -vv flags will also output additional +information:: + + bin/typo3 scheduler:run --task=8 -v