summaryrefslogtreecommitdiffstats
path: root/doc/kcron/index.docbook
blob: 2198813927cb50d6d546b892a70fb911fddb84e4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
<?xml version="1.0" ?>
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" 
"dtd/kdex.dtd" [
  <!ENTITY kappname "&kcron;">
  <!ENTITY package "tdeadmin">
  <!ENTITY % English "INCLUDE" > <!-- change language only here -->
  <!ENTITY % addindex "IGNORE">
]>

<book lang="&language;">

<bookinfo>

<title>The &kcron; Handbook</title>

<authorgroup>

<author>
<firstname>Morgan</firstname>
<othername>N.</othername>
<surname>Sandquist</surname>
<affiliation><address><email>[email protected]</email></address>
</affiliation>
</author>

<othercredit role="developer">
<firstname>Gary</firstname>
<surname>Meyer</surname>
<affiliation><address><email>[email protected]</email></address>
</affiliation>
<contrib>Developer</contrib>
</othercredit>

<othercredit role="reviewer">
<firstname>Lauri</firstname>
<surname>Watts</surname>
<affiliation><address><email>[email protected]</email></address>
</affiliation>
<contrib>Reviewer</contrib>
</othercredit>

<!-- TRANS:ROLES_OF_TRANSLATORS -->

</authorgroup>

<copyright>
<year>2000</year>
<holder>Morgan N. Sandquist</holder>
</copyright>

<legalnotice>&FDLNotice;</legalnotice>

<date>2003-09-16</date>
<releaseinfo>3.1.91</releaseinfo>

<abstract><para>&kcron; is an application that schedules programs to be
run.</para></abstract>

<keywordset>
<keyword>KDE</keyword>
<keyword>tdeadmin</keyword>
<keyword>KCron</keyword>
<keyword>cron</keyword>
<keyword>crontab</keyword>
<keyword>scheduler</keyword>
</keywordset>


</bookinfo>

<chapter id="introduction">
<title>Introduction</title>

<para>&kcron; is an application for scheduling programs to run in the
background. It is a graphical user interface to <command>cron</command>,
the &UNIX; system scheduler.</para>

</chapter>

<chapter id="using-kcron">
<title>Using &kcron;</title>

<important><para>Don't forget to tell your system to start the
<filename>crond</filename> cron daemon first, or &kcron; won't
work.</para></important>

<sect1 id="kcron-start-up">
<title>&kcron; Start Up</title>

<para>When &kcron; starts you will see a summarized view of existing
scheduled tasks and associated environment variables. If you are running
as the root user, you will see these items for all users on the computer
as well as the system scheduled tasks. Each of the folders can be
expanded and contracted.</para>

<screenshot>
<screeninfo>&kcron; at start up.</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="kcronstart.png" format="PNG"/></imageobject>
<textobject><phrase>&kcron; at start up.</phrase></textobject>
</mediaobject>
</screenshot>

<sect2>
<title>Scheduled Tasks</title>

<para>Scheduled tasks appear under a <guilabel>Tasks</guilabel>
folder. For each scheduled task, the following are displayed:</para>

<variablelist>

<varlistentry>
<term><guilabel>Name</guilabel></term>
<listitem><para>Name to identify the scheduled task.</para></listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Value</guilabel></term>
<listitem><para>Program file and parameters.</para></listitem>
</varlistentry>
<varlistentry> 
<term><guilabel>Description</guilabel></term>
<listitem><para>Natural language description of scheduled
task.</para></listitem>
</varlistentry> 
</variablelist>

<para>If a task has been disabled, no program file and parameters will
appear, and the description will be disabled.</para>

</sect2>

<sect2>
<title>Environment Variables</title>

<para>Environment variables appear under a
<guilabel>Variables</guilabel> folder. For each environment variable,
the following are displayed: </para>

<variablelist>
<varlistentry>
<term><guilabel>Name</guilabel></term>
<listitem><para>Variable name.</para></listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Value</guilabel></term>
<listitem><para>Variable value.</para></listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Description</guilabel></term>
<listitem><para>Natural language description of variable.</para></listitem>
</varlistentry>
</variablelist>

<para>Environment variables appearing here will override any existing
environment variable for all scheduled tasks. If an environment variable
has been disabled, no value will appear and the description will be
disabled.</para>

<screenshot>
<screeninfo>&kcron; main window</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="kcron.png" format="PNG"/></imageobject>
<textobject><phrase>&kcron; main window</phrase></textobject>
</mediaobject>
</screenshot>

</sect2>
</sect1>

<sect1 id="new-task">
<title>Adding Scheduled Tasks</title>

<para>To create a new scheduled task, first select the
<guilabel>Tasks</guilabel> folder. Then select
<menuchoice><guimenu>Edit</guimenu> <guimenuitem>New...</guimenuitem>
</menuchoice>. Alternatively, you can use the
<mousebutton>right</mousebutton> mouse button menu and choose
<menuchoice><guimenuitem>New...</guimenuitem></menuchoice>, or simply
press <keycombo
action="simul"><keycap>Ctrl</keycap><keycap>N</keycap></keycombo>.</para>

<sect2>
<title>The <guilabel>Edit Task</guilabel> Dialog</title>

<screenshot>
<screeninfo><guilabel>Edit Task</guilabel> dialog.</screeninfo>
<mediaobject>
<imageobject><imagedata fileref="newtask.png" format="PNG"/></imageobject>
<textobject><phrase><guilabel>Edit Task</guilabel> dialog</phrase></textobject>
</mediaobject>
</screenshot>

<variablelist>
<varlistentry>
<term><guilabel>Comment</guilabel></term>
<listitem><para>Enter a description of the task to schedule.</para>
</listitem> 
</varlistentry>
<varlistentry>
<term><guilabel>Program</guilabel></term>
<listitem><para>Enter the name of the program. You can specify either a
relative path or absolute path. If you want to look up the program, click
<guibutton>Browse...</guibutton>.</para>
</listitem> 
</varlistentry>
<varlistentry>
<term><guibutton>Enabled</guibutton></term>
<listitem><para>To enable or disable the task, select or de-select
<guilabel>Enabled</guilabel>.</para>
</listitem>
</varlistentry>

<varlistentry>
<term><guilabel>Silent</guilabel></term>
<listitem>
<para>
Turns off logging of the command and the output from the command.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term><guilabel>Months</guilabel></term>
<listitem><para>Select the months during which the task is to be
scheduled.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Days of the Month</guilabel></term>
<listitem><para>Select the days of the month on which the task is to be
scheduled.</para>
</listitem> 
</varlistentry>
<varlistentry>
<term><guilabel>Days of the Week</guilabel></term>
<listitem><para>Select the days of the week on which the task is to be
scheduled.</para>
</listitem> 
</varlistentry>
<varlistentry>
<term><guilabel>Daily</guilabel></term>
<listitem><para>If you want to schedule the task to run daily, select
<guibutton>Run every day</guibutton>.</para>
</listitem> 
</varlistentry>
<varlistentry>
<term><guilabel>Hours</guilabel></term>
<listitem><para>Select the hours on which the task is to be
scheduled.</para></listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Minutes</guilabel></term>
<listitem><para>Select the minute at which the task is to be scheduled. &kcron;
does not support scheduling tasks at smaller than five minute intervals.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guibutton>OK</guibutton></term>
<listitem><para>Completes the creation of this task.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guibutton>Cancel</guibutton></term>
<listitem><para>Cancels the creation of this task.</para>
</listitem>
</varlistentry>
</variablelist>

<para>If you select both days of the month, and days of the week, the
task will run when either condition is met. For instance, if you select
the 1st and 15th, and select Sunday, the program will be run every 1st
and 15th of the selected months (regardless of day of week) as well as
every Sunday of the selected months (regardless of day of the
month).</para>

<para>The scheduled task is not actually set up until the
<filename>crontab</filename> has been saved.</para>

</sect2>
</sect1>

<sect1 id="manage-tasks">
<title>Managing Scheduled Tasks</title>

<para>As with creating new tasks, changes to tasks will not actually be
made until the <filename>crontab</filename> is saved.</para>

<sect2>
<title>Cutting Scheduled Tasks</title>

<para>To cut a scheduled task, first select the task to be cut. Then
select <menuchoice><guimenu>Edit</guimenu>
<guimenuitem>Cut</guimenuitem></menuchoice>.</para> <para>Alternatively,
you can use the <mousebutton>right</mousebutton> mouse button menu and
choose <menuchoice><guimenuitem>Cut</guimenuitem></menuchoice>, or
simply press <keycombo
action="simul"><keycap>Ctrl</keycap><keycap>X</keycap></keycombo>.</para>

</sect2>

<sect2>
<title>Copying Scheduled Tasks</title>

<para>To copy a scheduled task, first select the task to be copied. Then
select
<menuchoice><guimenu>Edit</guimenu><guimenuitem>Copy</guimenuitem></menuchoice>
.</para>

<para>Alternatively, you can use the <mousebutton>right</mousebutton> mouse
button menu and choose <menuchoice><guimenuitem>Copy</guimenuitem></menuchoice>,
or simply press <keycombo
action="simul"><keycap>Ctrl</keycap><keycap>C</keycap></keycombo>.</para>

</sect2>

<sect2>
<title>Pasting Scheduled Tasks</title>

<para>To paste a scheduled task, first a scheduled task must have
already been cut or copied to the clipboard. Once a scheduled task has
been cut or copied, paste will be enabled. Then select the
<guilabel>Tasks</guilabel> folder. Finally, select <menuchoice>
<guimenu>Edit</guimenu> <guimenuitem>Paste</guimenuitem>
</menuchoice>.</para>

<para> Alternatively, you can use the <mousebutton>right</mousebutton> mouse
button menu and choose
<menuchoice><guimenuitem>Paste</guimenuitem></menuchoice>, or simply press
<keycombo
action="simul"><keycap>Ctrl</keycap><keycap>V</keycap></keycombo>.</para>

</sect2>

<sect2>
<title>Modifying Scheduled Tasks</title>

<para>To modify a scheduled task, first select the task to be
modified. Then select
<menuchoice>
<guimenu>Edit</guimenu> <guimenuitem>Modify...</guimenuitem>
</menuchoice>.</para>

<para>Alternatively, you can use the <mousebutton>right</mousebutton>
mouse button menu and choose
<menuchoice><guimenuitem>Modify...</guimenuitem></menuchoice>, or simply
press <keycombo
action="simul"><keycap>Ctrl</keycap><keycap>O</keycap></keycombo>.  You
will see the <guilabel>Edit Task</guilabel> dialog, with which you would
modify the task as described <link linkend="new-task">above</link>.</para>

</sect2>

<sect2>
<title>Deleting Scheduled Tasks</title>

<para>To delete a scheduled task, first select the task to be
deleted. Then select <menuchoice> <guimenu>Edit</guimenu>
<guimenuitem>Delete</guimenuitem> </menuchoice>.</para>

<para>Alternatively, you can use the <mousebutton>right</mousebutton>
mouse button menu and choose <guimenuitem>Delete</guimenuitem>.</para>

</sect2>

<sect2>
<title>Enabling/Disabling Scheduled Tasks</title>

<para>To enable or disable a scheduled task, first select the disabled
task. Disabled tasks will have <guilabel>Disabled</guilabel> in their
descriptions. Then select <menuchoice> <guimenu>Edit</guimenu>
<guimenuitem>Enabled</guimenuitem> </menuchoice>.</para>

<para>Alternatively, you can use the <mousebutton>right</mousebutton>
mouse button menu and choose
<menuchoice><guimenuitem>Enabled</guimenuitem></menuchoice>.  Confirm
that the scheduled task's program name, parameters, and description are
correctly displayed.</para>

</sect2>

<sect2>
<title>Running Scheduled Tasks</title>

<para>To run a scheduled task immediately, first select the task.  Then
select <menuchoice> <guimenu>Edit</guimenu> <guimenuitem>Run
Now</guimenuitem> </menuchoice>.</para>

<para>Alternatively, you can use the <mousebutton>right</mousebutton>
mouse button menu and choose <menuchoice><guimenuitem>Run
Now</guimenuitem></menuchoice>.</para>

</sect2>
</sect1>

<sect1 id="new-variable">
<title>Adding Environment Variables</title>

<para>To create a new environment variable, first select the
<guilabel>Variables</guilabel> folder. Then select <menuchoice>
<guimenu>Edit</guimenu><guimenuitem>New...</guimenuitem>
</menuchoice>.</para>

<para>Alternatively, you can use the <mousebutton>right</mousebutton>
mouse button menu and choose
<menuchoice><guimenuitem>New...</guimenuitem></menuchoice>, or simply
press <keycombo
action="simul"><keycap>Ctrl</keycap><keycap>N</keycap></keycombo>.</para>

<sect2>
<title>The <guilabel>Edit Variable</guilabel> dialog</title>

<screenshot>
<screeninfo><guilabel>Edit Variable</guilabel> dialog.</screeninfo>
<mediaobject>
<imageobject><imagedata fileref="newvariable.png" format="PNG"/></imageobject>
<textobject><phrase><guilabel>Edit Variable</guilabel>
dialog.</phrase></textobject>
</mediaobject>
</screenshot>

<variablelist>
<varlistentry>
<term><guilabel>Variable</guilabel></term> 
<listitem><para>Enter the environment variable name. You can use the drop-down
list box to select from the most common environment variables used by scheduled
tasks. Those include:</para>

<variablelist>

<varlistentry>
<term><guimenuitem>HOME</guimenuitem></term>
<listitem><para>To be used instead of the default user's home
folder.</para></listitem>
</varlistentry>

<varlistentry>
<term><guimenuitem>MAILTO</guimenuitem></term>
<listitem><para>To send email output to an email address other than the user's
default email address.</para></listitem>
</varlistentry>

<varlistentry>
<term><guimenuitem>PATH</guimenuitem></term>
<listitem><para>To be used to search folders for program
files.</para></listitem>
</varlistentry>

<varlistentry>
<term><guimenuitem>SHELL</guimenuitem></term>
<listitem><para>To be used instead of the user's default
value.</para></listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Value</guilabel></term>
<listitem><para>Enter the environment variable value.</para></listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Comment</guilabel></term>
<listitem><para>Enter a description for the environment variable, such as its
purpose.</para></listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Enabled</guilabel></term>
<listitem>
<para>To enable or disable the variable, select or de-select
<guibutton>Enabled</guibutton>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guibutton>OK</guibutton></term>
<listitem>
<para>Completes the setting of this variable.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guibutton>Cancel</guibutton></term>
<listitem>
<para>Cancels the setting of this variable.</para>
</listitem>
</varlistentry>
</variablelist>

<para>The environment variable is not actually set up until the
<filename>crontab</filename> has been saved.</para>

</sect2>
</sect1>

<sect1 id="manage-variables">
<title>Managing Environment Variables</title>

<note><para>As with creating new variables, changes to variables will
not actually be made until the <filename>crontab</filename> is
saved.</para></note>

<sect2>
<title>Cutting Environment Variables</title>

<para>To cut an environment variable, first select the variable to be
cut. Then select <menuchoice><guimenu>Edit</guimenu>
<guimenuitem>Cut</guimenuitem> </menuchoice>.</para>

<para>Alternatively, you can use the <mousebutton>right</mousebutton>
mouse button menu and choose
<menuchoice><guimenuitem>Cut</guimenuitem></menuchoice>, or simply press
<keycombo
action="simul"><keycap>Ctrl</keycap><keycap>X</keycap></keycombo>.</para>

</sect2>

<sect2>
<title>Copying Environment Variables</title>

<para>To copy an environment variable, first select the variable to be
copied. Then select <menuchoice> <guimenu>Edit</guimenu>
<guimenuitem>Copy</guimenuitem> </menuchoice>.</para>

<para>Alternatively, you can use the <mousebutton>right</mousebutton>
mouse button menu and choose <guimenuitem>Copy</guimenuitem>, or simply
press <keycombo
action="simul"><keycap>Ctrl</keycap><keycap>C</keycap></keycombo>.</para>

</sect2>

<sect2>
<title>Pasting Environment Variables</title>

<para>To paste an environment variable, first an environment variable
must have already been cut or copied to the clipboard. Once an
environment variable has been cut or copied, paste will be enabled. Then
select the <guilabel>Variables</guilabel> folder. Finally, select
<menuchoice><guimenu>Edit</guimenu> <guimenuitem>Paste</guimenuitem>
</menuchoice>.</para>

<para>Alternatively, you can use the <mousebutton>right</mousebutton>
mouse button menu and choose
<menuchoice><guimenuitem>Paste</guimenuitem></menuchoice>, or simply
press <keycombo
action="simul"><keycap>Ctrl</keycap><keycap>V</keycap></keycombo>.</para>
</sect2>

<sect2>
<title>Modifying Environment Variables</title>

<para>To modify an environment variable, first select the variable to be
modified. Then select <menuchoice> <guimenu>Edit</guimenu>
<guimenuitem>Modify...</guimenuitem> </menuchoice>.  Alternatively, you
can use the <mousebutton>right</mousebutton> mouse button menu and
choose <guimenuitem>Modify...</guimenuitem>, or simply press <keycombo
action="simul"><keycap>Ctrl</keycap><keycap>O</keycap></keycombo>.  You
will see the <guilabel>Edit Variable</guilabel> dialog, in which you would
modify the variable as described <link linkend="new-variable">above</link>.</para>

</sect2>

<sect2>
<title>Deleting Environment Variables</title>

<para>To delete an environment variable, first select the variable to be
deleted. Then select
<menuchoice><guimenu>Edit</guimenu><guimenuitem>Delete</guimenuitem>
</menuchoice></para>

<para>Alternatively, you can use the <mousebutton>right</mousebutton> mouse
button menu and choose <guimenuitem>Delete</guimenuitem>.</para>

</sect2>

<sect2>
<title>Enabling/Disabling Environment Variables</title>

<para>To enable or disabled an environment variable, first select the
disabled variable. Disabled variables will have
<guilabel>Disabled</guilabel> in their descriptions. Then select
<menuchoice>
<guimenu>Edit</guimenu> <guimenuitem>Enabled</guimenuitem> </menuchoice>.</para>

<para>Alternatively, you can use the <mousebutton>right</mousebutton>
mouse button menu and choose
<menuchoice><guimenuitem>Enabled</guimenuitem></menuchoice>.  Confirm
that the environment variable's name and value are correctly
displayed.</para>

</sect2>
</sect1>

<sect1 id="saving-crontab">
<title>Saving the <filename>crontab</filename></title>

<para>Once all scheduled tasks and environment variables have been
created and/or properly modified, save the <filename>crontab</filename>
by selecting
<menuchoice>
<guimenu>File</guimenu> <guimenuitem>Save</guimenuitem> </menuchoice>.</para>

<para>Alternatively, you can simply press <keycombo
action="simul">&Ctrl;<keycap>S</keycap></keycombo>. Additions or changes
will not actually be made until this is done.</para>

</sect1>

<sect1 id="printing-crontab">
<title>Printing the <filename>crontab</filename></title>

<para>To print the <filename>crontab</filename> as it has been saved,
select <menuchoice> <guimenu>File</guimenu>
<guimenuitem>Print</guimenuitem> </menuchoice>.</para>


<!-- FIXME: New screenshot of expanded print dialog -->

<screenshot>
<screeninfo>Printing the <filename>crontab</filename>.</screeninfo>
<mediaobject>
<imageobject><imagedata fileref="print.png" format="PNG"/></imageobject>
<textobject><phrase>Printing the
<filename>crontab</filename>.</phrase></textobject>
</mediaobject>
</screenshot>

<para>The standard &kde; printer dialog will display.  If you select
<guilabel>Expand</guilabel> you will see that there are two extra
&kcron; specific options in the Print Dialog box.</para>

<variablelist>
<varlistentry>
<term><guilabel>Print Crontab</guilabel></term>
<listitem>
<para>Prints the <filename>crontab</filename> for the current user.</para>
</listitem>
</varlistentry>

<varlistentry>
<term><guilabel>Print All Users</guilabel></term>
<listitem>
<para>Prints the <filename>crontab</filename>s for all users.  This option is
enabled only for users with super-user privileges.</para>
</listitem>
</varlistentry>

</variablelist>

</sect1>
</chapter>

<chapter id="commands">
<title>Command Reference</title>

<sect1 id="kcron-mainwindow">
<title>The main &kcron; window</title>

<sect2>
<title>The <guimenu>File</guimenu> Menu</title>

<variablelist>
<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>S</keycap></keycombo>
</shortcut>
<guimenu>File</guimenu>
<guimenuitem>Save</guimenuitem>
</menuchoice></term>
<listitem>
<para><action>Saves changes</action> to the <filename>crontab</filename>.</para>
</listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<shortcut><keycombo 
action="simul">&Ctrl;<keycap>P</keycap></keycombo></shortcut> 
<guimenu>File</guimenu> <guimenuitem>Print...</guimenuitem>
</menuchoice></term>
<listitem>
<para><action>Prints</action> the <filename>crontab</filename>.</para>
</listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo>
</shortcut>
<guimenu>File</guimenu>
<guimenuitem>Quit</guimenuitem>
</menuchoice></term>
<listitem>
<para><action>Quits</action> &kcron;.</para>
</listitem>
</varlistentry>
</variablelist>

</sect2>
<sect2>
<title>The <guimenu>Edit</guimenu> Menu</title>

<variablelist>
<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>X</keycap></keycombo>
</shortcut>
<guimenu>Edit</guimenu>
<guimenuitem>Cut</guimenuitem> </menuchoice></term>
<listitem><para><action>Cut the selected task or
variable.</action></para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>C</keycap></keycombo>
</shortcut>
<guimenu>Edit</guimenu>
<guimenuitem>Copy</guimenuitem>
</menuchoice></term>
<listitem><para><action>Copy the selected task or 
variable.</action></para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>V</keycap></keycombo>
</shortcut>
<guimenu>Edit</guimenu>
<guimenuitem>Paste</guimenuitem>
</menuchoice></term>
<listitem><para><action>Paste a task or variable that has been cut or
copied.</action></para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo>
</shortcut>
<guimenu>Edit</guimenu>
<guimenuitem>New...</guimenuitem>
</menuchoice></term>
<listitem><para><action>Create a new task or
variable.</action></para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>O</keycap></keycombo>
</shortcut>
<guimenu>Edit</guimenu>
<guimenuitem>Modify...</guimenuitem>
</menuchoice></term>
<listitem><para><action>Modify the selected task or
variable.</action></para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Edit</guimenu>
<guimenuitem>Delete</guimenuitem>
</menuchoice></term>
<listitem><para><action>Delete the selected task or
variable.</action></para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Edit</guimenu>
<guimenuitem>Enabled</guimenuitem>
</menuchoice></term>
<listitem>
<para><action>Enable/disable the selected task or variable.</action></para>
</listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Edit</guimenu>
<guimenuitem>Run Now</guimenuitem>
</menuchoice></term>
<listitem><para><action>Run the selected task now.</action></para></listitem>
</varlistentry>
</variablelist>

</sect2>

<sect2>
<title>The <guimenu>Settings</guimenu> Menu</title>

<variablelist>
<varlistentry>
<term><menuchoice>
<guimenu>Settings</guimenu>
<guimenuitem>Show Toolbar</guimenuitem>
</menuchoice></term>
<listitem><para><action>Displays toolbar.</action></para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Settings</guimenu>
<guimenuitem>Show Statusbar</guimenuitem>
</menuchoice></term>
<listitem><para><action>Displays statusbar.</action></para></listitem>
</varlistentry>
</variablelist>

</sect2>

<sect2>
<title>The <guimenu>Help</guimenu> Menu</title>

&help.menu.documentation;

</sect2>
</sect1>
</chapter>

<chapter id="faq">
<title>Questions and Answers</title>

<qandaset id="questions-and-answers">
<qandaentry>
<question>
<para>Why aren't the changes I'm making to scheduled tasks and/or environment
variables taking effect?</para>
</question>
<answer><para>Additions or changes to scheduled tasks do not actually happen until the
<filename>crontab</filename> has been <link
linkend="saving-crontab">saved</link>.</para>
</answer>
</qandaentry>
</qandaset>
</chapter>

<chapter id="credits">

<title>Credits and License</title>

<para>&kcron;</para>

<para>Program copyright 2000 Gary Meyer <email>[email protected]</email></para>

<para>Documentation copyright 2000 Morgan N. Sandquist
<email>[email protected]</email></para>
<!-- TRANS:CREDIT_FOR_TRANSLATORS -->

&underFDL;

&underGPL;

</chapter>

<appendix id="installation">
<title>Installation</title>

<sect1 id="getting-kcron">
<title>How to obtain &kcron;</title>

&install.intro.documentation;

</sect1>

<sect1 id="requirements">
<title>Requirements</title>

<para>In order to successfully compile &kcron;, you need the following
libraries:</para>

<itemizedlist>
<listitem><para><command>cron</command>, such as
<command>vixie-cron</command>.  &kcron; uses the
<filename>crontab</filename> command to modify user's scheduled
tasks.</para></listitem>
<listitem><para>POSIX-compliant &UNIX;, such as provided by
glibc. &kcron; uses some standard &UNIX; system calls for localization of
dates and times</para></listitem> 
</itemizedlist>

</sect1>

<sect1 id="compilation">
<title>Compilation and Installation</title>

&install.compile.documentation;

</sect1>

</appendix>

&documentation.index; 
</book>