Skip to content
Snippets Groups Projects
Commit dab61cc8 authored by Sybille Peters's avatar Sybille Peters Committed by Georg Ringer
Browse files

[DOCS] Document multiple --task options for scheduler

Document change "Feature: #87451 - scheduler:run command accepts
multiple task options".

The scheduler command now accepts multiple --task options.

Resolves: #90394
Releases: master
Change-Id: Ie0f7973cab01db88f4df0cb4cd87a194bf4914b1
Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/63270


Tested-by: default avatarDaniel Goerz <daniel.goerz@posteo.de>
Tested-by: default avatarBjörn Jacob <bjoern.jacob@tritum.de>
Tested-by: default avatarTYPO3com <noreply@typo3.com>
Tested-by: default avatarGeorg Ringer <georg.ringer@gmail.com>
Reviewed-by: default avatarDaniel Goerz <daniel.goerz@posteo.de>
Reviewed-by: default avatarBjörn Jacob <bjoern.jacob@tritum.de>
Reviewed-by: default avatarGeorg Ringer <georg.ringer@gmail.com>
parent 62f3ffe9
Branches
Tags
No related merge requests found
......@@ -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
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment