Difference between revisions of "System Settings/Task Scheduler"

(Marked this version for translation)
 
(29 intermediate revisions by 6 users not shown)
Line 1: Line 1:
{{Template:I18n/Language Navigation Bar|KCron}}
+
<languages />
=== General Information ===
+
<translate>
[[Image:Preferences-system.png|48px]] KCron is a tool for running applications in the background at regular intervals. It's a graphical interface to the Cron command.
 
KCron is a standard application that is prepackaged with KDE.
 
  
[[Image:Kcron-screenshot-de.png|thumb|300px|KCron in KDE4]]
+
== General Information == <!--T:1-->
  
=== Usage ===
+
<!--T:31-->
First define what variables your application needs and their values, then select your application. When this is done you select at which times your application should be run and you're all set.
+
Task Scheduler is a graphical front end to the standard "cron" utility. With it, commands (or "tasks") can be run at specific times, on a certain day or date, or at specific intervals (time between execution).
  
In {{KDE4}}
+
<!--T:32-->
KCron now is a module which could be found in "system settings > advanced > system section > task scheduler"
+
[[Image:Kcron-screenshot-de.png|thumb|300px|center|Task Scheduler in Plasma 5]]
  
In {{KDE3}}
+
== Usage == <!--T:3-->
KCron can be started using ALT+F2 or K-Menu.
 
  
=== Hints ===
+
<!--T:5-->
 +
Task Scheduler can be started by starting the '''System Settings''' application.
 +
Select <menuchoice>Startup and Shutdown</menuchoice> follwed by <menuchoice>Task Scheduler</menuchoice>.
 +
 
 +
=== Adding and Modifying tasks === <!--T:11-->
 +
 
 +
<!--T:12-->
 +
* Click <menuchoice>New Task...</menuchoice> to add a new task, or "Modify" to modify an existing task. The '''Add or modify existing task''' page will be displayed.
 +
 
 +
<!--T:13-->
 +
[[Image:kcron-task-dialog.png|thumb|300px|center|The "Add or modify task" page of SystemSettings]]
 +
 
 +
<!--T:14-->
 +
* Enter the command to be run. Click the folder icon to choose it from a dialog.
 +
 
 +
<!--T:15-->
 +
* Enter a comment (optional). This should be descriptive, explaining what the task will do as the command may not always be obvious.
 +
 
 +
<!--T:16-->
 +
* Click '''Enable this task''' to enable the task to run.
 +
 
 +
<!--T:17-->
 +
* Click '''Run at system bootup''' to enable the script to run each time the system is booted.
 +
 
 +
<!--T:18-->
 +
* Click '''Run every day''' to enable the script to run every day. This will automatically select the appropriate options.
 +
 
 +
<!--T:19-->
 +
* Using the buttons, choose when the command should be run. Not all parameters are required, those not needed may be left blank.</translate>
 +
<translate>
 +
<!--T:33-->
 +
** Hours and Minutes are the time of day to run the task, not an interval.
 +
 
 +
<!--T:24-->
 +
* When done, click <menuchoice>OK</menuchoice>. The task will be added and scheduled if enabled.
 +
 
 +
<!--T:25-->
 +
{{Tip|Click <menuchoice>Run Now</menuchoice> to run a task immediately after adding or modifying the task.}}
 +
 
 +
=== Removing a task === <!--T:20-->
 +
 
 +
<!--T:26-->
 +
To completely remove a task, select the task from the list and click the '''Delete''' button. This will permanently remove the task.
 +
 
 +
== Environment Variables == <!--T:21-->
 +
 
 +
<!--T:27-->
 +
Sometimes a task or multiple tasks need a specific variable set, it must be added in the '''Environment Variables''' section. The '''cron''' utility uses its own environment, system-wide and user-specific variables are not used. Click '''New Variable''' to add a new variable definition, or '''Modify''' to change an existing variable.
 +
 
 +
<!--T:28-->
 +
* Enter the name of the variable to use. This name:</translate>
 +
<translate>
 +
<!--T:34-->
 +
** Must consist of letters, digits, and underscore ('_') only</translate>
 +
<translate>
 +
<!--T:35-->
 +
** Must start with a letter</translate>
 +
<translate>
 +
<!--T:36-->
 +
** Should not be a reserved or commonly used system variable. See https://pubs.opengroup.org/onlinepubs/000095399/basedefs/xbd_chap08.html for more information
 +
 
 +
<!--T:29-->
 +
* The value the variable will contain. This can be a number or string.
 +
 
 +
<!--T:30-->
 +
* Enter a brief description of the variable.
 +
 
 +
== Hints == <!--T:7-->
 +
 
 +
<!--T:8-->
 
* All the files that are modified are located in the /etc/cron directory where there are numerous files to look at.
 
* All the files that are modified are located in the /etc/cron directory where there are numerous files to look at.
  
* The command-line tool to have a look at the currently installed cron-jobs is <i>crontab -l</i> (that's the letter L).
+
<!--T:9-->
 +
* The command-line tool that allows you to have a look at the currently installed cron-jobs is {{Input|1=crontab -l}} (that's the letter L).
 +
 
 +
==More Information== <!--T:22-->
 +
 
 +
<!--T:23-->
 +
* [https://docs.kde.org/stable5/en/kdeadmin/kcontrol5/kcron/index.html KDE official documentation]
 +
* [https://en.wikipedia.org/wiki/Cron Cron] (Wikipedia)
 +
* [https://wiki.archlinux.org/index.php/cron Cron] (Arch Linux wiki)
  
 +
<!--T:10-->
 +
[[Category:Desktop]]
 
[[Category:System]]
 
[[Category:System]]
[[Category:KDE3]]
+
[[Category:Configuration]]
 +
</translate>

Latest revision as of 08:22, 1 June 2019

Other languages:
English • ‎dansk • ‎español • ‎français • ‎italiano • ‎Ελληνικά • ‎русский • ‎українська • ‎中文(中国大陆)‎ • ‎中文(台灣)‎

General Information

Task Scheduler is a graphical front end to the standard "cron" utility. With it, commands (or "tasks") can be run at specific times, on a certain day or date, or at specific intervals (time between execution).

Task Scheduler in Plasma 5

Usage

Task Scheduler can be started by starting the System Settings application. Select Startup and Shutdown follwed by Task Scheduler.

Adding and Modifying tasks

  • Click New Task... to add a new task, or "Modify" to modify an existing task. The Add or modify existing task page will be displayed.
The "Add or modify task" page of SystemSettings
  • Enter the command to be run. Click the folder icon to choose it from a dialog.
  • Enter a comment (optional). This should be descriptive, explaining what the task will do as the command may not always be obvious.
  • Click Enable this task to enable the task to run.
  • Click Run at system bootup to enable the script to run each time the system is booted.
  • Click Run every day to enable the script to run every day. This will automatically select the appropriate options.
  • Using the buttons, choose when the command should be run. Not all parameters are required, those not needed may be left blank.
    • Hours and Minutes are the time of day to run the task, not an interval.
  • When done, click OK. The task will be added and scheduled if enabled.
Ktip.png
Tip
Click Run Now to run a task immediately after adding or modifying the task.


Removing a task

To completely remove a task, select the task from the list and click the Delete button. This will permanently remove the task.

Environment Variables

Sometimes a task or multiple tasks need a specific variable set, it must be added in the Environment Variables section. The cron utility uses its own environment, system-wide and user-specific variables are not used. Click New Variable to add a new variable definition, or Modify to change an existing variable.

  • The value the variable will contain. This can be a number or string.
  • Enter a brief description of the variable.

Hints

  • All the files that are modified are located in the /etc/cron directory where there are numerous files to look at.
  • The command-line tool that allows you to have a look at the currently installed cron-jobs is
    crontab -l
    (that's the letter L).

More Information


This page was last edited on 1 June 2019, at 08:22. Content is available under Creative Commons License SA 4.0 unless otherwise noted.
-->