158cbc74df03eed7639e1381c1814c7664af6c1f
[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 If the "cli\_scheduler" user was not created, this will result in the
25 following error:
26
27 ::
28
29    ERROR: No backend user named "_cli_scheduler" was found! [Database: my_typo3_database]
30
31 If the user exists, you should see nothing, as the Scheduler doesn't
32 give any visual feedback while running.
33
34 .. _options:
35
36 Providing options to the shell script
37 """""""""""""""""""""""""""""""""""""
38
39 The shell scripts accepts a number of options which can be provided in any
40 order.
41
42 To run a specific scheduler task you need to provide the uid of the task:
43
44 ::
45
46    /usr/local/bin/php /home/bob/www/typo3/cli_dispatch.phpsh scheduler -i 8
47
48 The example will trigger the task with uid 8.
49
50 To run a task even if it is disabled, you need to provide the force option
51
52 ::
53
54    /usr/local/bin/php /home/bob/www/typo3/cli_dispatch.phpsh scheduler -i 8 -f
55
56 This will also run the task with uid 8 if it is disabled.