1FCRONDYN(1) FCRONDYN(1)
2
3
4
6 fcrondyn - dialog dyn-amically with a running fcron daemon
7
9 fcrondyn [ -c file ] [ -i ]
10
11
12 fcrondyn [ -c file ] -x command
13
14
15 fcrondyn [ -h ]
16
17
19 Fcrondyn is a user tool intended to interact with a running fcron dae‐
20 mon. It can, for instance, list user's jobs loaded by fcron, run one of
21 them, renice a running job, send a signal to a running job, etc.
22
24 -i Run fcrondyn in interactive mode. fcrondyn is also run in inter‐
25 active mode when no option is given.
26
27 -x command
28 Run command and returns immediately. See below for syntax and a
29 list of commands.
30
31 -c file
32 Make fcrondyn use config file file instead of default config
33 file /usr/local/etc/fcron.conf. To interact with a running fcron
34 process, fcrondyn must use the same config file as the process.
35 That way, several fcron processes can run simultaneously on an
36 only system.
37
38 -d Run in debug mode. In this mode, many informational messages
39 will be output in order to check if anything went wrong.
40
41 -h Display a brief description of the options.
42
43 -V Display an informational message about fcrondyn, including its
44 version and the license under which it is distributed.
45
47 Fcrondyn's command syntax is the following:
48
49
50 command arg1 arg2 [...]
51
52 An argument of a fcrondyn command is of one of the following type:
53 "ARGUMENT TYPES OF FCRONDYN'S COMMANDS"
54
55 user A valid user name.
56
57 jobid A job id given by one of fcrondyn's ls* commands (i.e. an inte‐
58 ger).
59
60 sig A signal number, or its name (case does not matter). For
61 instance, "term" or "15".
62
63 niceval
64 A job priority value. A niceval is an integer from -20 (highest
65 priority) to 19 (lowest) (only root is allowed to use a negative
66 value with this option).
67
68 Last, but not least, the following commands are recognized (optional
69 arguments are between []): "VALID FCRONDYN'S COMMANDS"
70
71 help
72
73 h Print an help message about fcrondyn's commands.
74
75 quit
76
77 q In interactive mode, quit fcrondyn.
78
79 ls [user]
80 List all jobs of user. When ls is run by root, all users are
81 listed unless a user name is given as argument. See below for
82 some explanations about the fields used by ls* commands.
83
84 ls_lavgq [user]
85 Same as ls, but list only the jobs which are in the load-average
86 queue (i.e. which are waiting for a lower load average to be
87 run).
88
89 ls_serialq [user]
90 Same as ls, but list only the jobs which are in the serial queue
91 (i.e. which are waiting for other jobs to be finished).
92
93 ls_exeq [user]
94 Same as ls, but list only the jobs which are running.
95
96 detail jobid
97 Print details about a job. jobid is the one given by ls.
98
99 runnow jobid
100 Instead of waiting for the next scheduled execution time, run
101 the job now. The next execution time is changed as if the job
102 had run on schedule.
103
104 run jobid
105 Run the job now. Its next execution time is not changed.
106
107 kill sig jobid
108 Send a signal to a running job.
109
110 renice niceval jobid
111 Change the priority of a running job. "FIELDS USED BY DETAIL
112 AND LS* COMMANDS"
113
114 ID Job's unique identification number.
115
116 USER User who owns this job.
117
118 PID The pid of the running job.
119
120 INDEX Index of the job in the serial queue (i.e. it will be run when
121 all the jobs of an inferior index have been run)
122
123 R&Q The job has this number instances of the given task which are
124 either running or queued in the serial or lavg queue.
125
126 OPTIONS
127 List of main options which are set for the task. L for the jobs
128 which run only under a given system Load average (option lavg,
129 lavg1, lavg5 and lavg15), LO (Load average Once) if only at most
130 one instance of the task can be in the load average queue at a
131 given time (option lavgonce), S for serialized jobs (option
132 serial), SO for the jobs which will be serialized only for the
133 next execution (Serial Once), and ES if several instances of the
134 same job can run simultaneously (option exesev).
135
136 LAVG 3 values, corresponding to the 1, 5, and 15-minute (in this
137 order) system load average values below which the job will be
138 run, otherwise it will be queued until the system load average
139 is appropriate (see lavg option).
140
141 UNTIL Field corresponding to the until option.
142
143 STRICT Field corresponding to the strict option. Y for yes, N for no.
144
145 SCHEDULE
146 Next run is scheduled at this time and date. Please note that
147 fcrondyn prints the next execution time and date in the time
148 zone of the system where fcron is running, and not the time zone
149 which can be defined for using option timezone.
150
151 CMD The command that will be executed.
152
154 Fcrondyn returns 0 on normal exit and 1 on error.
155
157 Should be POSIX compliant.
158
160 /usr/local/etc/fcron.conf
161 Configuration file for fcron, fcrontab and fcrondyn: contains
162 paths (spool dir, pid file) and default programs to use (editor,
163 shell, etc). See fcron.conf(5) for more details.
164
165 /usr/local/etc/fcron.allow
166 Users allowed to use fcrontab and fcrondyn (one name per line,
167 special name "all" acts for everyone)
168
169 /usr/local/etc/fcron.deny
170 Users who are not allowed to use fcrontab and fcrondyn (same
171 format as allow file)
172
173 /usr/local/etc/pam.d/fcron (or /usr/local/etc/pam.conf)
174 PAM configuration file for fcron. Take a look at pam(8) for more
175 details.
176
178 fcrontab(1),
179
180 fcrondyn(1),
181
182 fcrontab(5),
183
184 fcron.conf(5),
185
186 fcron(8).
187
188 If you're learning how to use fcron from scratch, I suggest that you
189 read the HTML version of the documentation (if your are not reading it
190 right now! :) ): the content is the same, but it is easier to navigate
191 thanks to the hyperlinks.
192
194 Thibault Godouet <fcron@free.fr>
195
196
197
19806/03/2007 03 juin 2007 FCRONDYN(1)