[!!!][FEATURE] Migrate Scheduler Cli Controller to Symfony Command
[Packages/TYPO3.CMS.git] / typo3 / sysext / scheduler / Documentation / Installation / SchedulerShellScript / Index.rst
1 .. ==================================================
2 .. FOR YOUR INFORMATION
3 .. --------------------------------------------------
4 .. -*- coding: utf-8 -*- with BOM.
5
6 .. include:: ../../Includes.txt
7
8
9
10 .. _scheduler-shell-script:
11
12 The Scheduler shell script
13 ^^^^^^^^^^^^^^^^^^^^^^^^^^
14
15 The Scheduler provides a PHP shell script designed to be run using
16 TYPO3's command-line dispatcher. To try and run that script a first
17 time, type the following command (adapting the path to PHP and TYPO3
18 to match your system):
19
20 ::
21
22    /usr/local/bin/php /home/bob/www/typo3/cli_dispatch.phpsh scheduler
23
24
25 .. _options:
26
27 Providing options to the shell script
28 """""""""""""""""""""""""""""""""""""
29
30 The shell scripts accepts a number of options which can be provided in any
31 order.
32
33 To run a specific scheduler task you need to provide the uid of the task:
34
35 ::
36
37    /usr/local/bin/php /home/bob/www/typo3/cli_dispatch.phpsh scheduler --task=8
38
39 The example will trigger the task with uid 8.
40
41 To run a task even if it is disabled, you need to provide the force option
42
43 ::
44
45    /usr/local/bin/php /home/bob/www/typo3/cli_dispatch.phpsh scheduler --task=8 -f
46
47 This will also run the task with uid 8 if it is disabled.