System Settings/Task Scheduler: Difference between revisions

    From KDE UserBase Wiki
    (Marked this version for translation)
    (Marked this version for translation)
     
    (14 intermediate revisions by 4 users not shown)
    Line 2: Line 2:
    <translate>
    <translate>


    === General Information === <!--T:1-->
    == General Information == <!--T:1-->
    {|class="tablecenter vertical-centered"
    |[[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 for KDE workspaces.
    |}


    <!--T:2-->
    <!--T:31-->
    [[Image:Kcron-screenshot-de.png|thumb|300px|center|The Task Scheduler in Plasma 5]]
    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).


    === Usage === <!--T:3-->
    <!--T:32-->
    [[Image:Kcron-screenshot-de.png|thumb|300px|center|Task Scheduler in Plasma 5]]
     
    == Usage == <!--T:3-->


    <!--T:5-->
    <!--T:5-->
    Task Scheduler can be started by starting the '''System Settings''' application, and selecting <menuchoice>Startup and Shutdown -> Task Scheduler</menuchoice>.
    Task Scheduler can be started by starting the '''System Settings''' application.
    New tasks can be added and existing tasks edited or removed.
    Select <menuchoice>Startup and Shutdown</menuchoice> follwed by <menuchoice>Task Scheduler</menuchoice>.


    ==== Adding and Modifying tasks ==== <!--T:11-->
    === Adding and Modifying tasks === <!--T:11-->


    <!--T:12-->
    <!--T:12-->
    * 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.
    * 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-->
    <!--T:13-->
    Line 41: Line 40:


    <!--T:19-->
    <!--T:19-->
    * Using the buttons, choose when the command should be run. Not all parameters are required, those not needed may be left blank.
    * 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.
    ** Hours and Minutes are the time of day to run the task, not an interval.


    <!--T:20-->
    <!--T:24-->
    * When done, click <menuchoice>OK</menuchoice>. The task will be added and scheduled if enabled.
    * When done, click <menuchoice>OK</menuchoice>. The task will be added and scheduled if enabled.


    === Hints === <!--T:7-->
    <!--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-->
    <!--T:8-->
    Line 54: Line 86:
    <!--T:9-->
    <!--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).
    * 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-->
    <!--T:10-->
    [[Category:Desktop]]
    [[Category:System]]
    [[Category:System]]
    [[Category:Configuration]]
    </translate>
    </translate>

    Latest revision as of 08:22, 1 June 2019

    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.

    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