From: Thibault Godouet Date: Fri, 12 Sep 2003 20:56:05 +0000 (+0000) Subject: changed indentation X-Git-Tag: ver2_9_4~30 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=26c1a3e5168f6509c05763de2c2016ae8536057f;p=thirdparty%2Ffcron.git changed indentation --- diff --git a/doc/en/fcrontab.1.sgml b/doc/en/fcrontab.1.sgml index fe49764..be9a7f6 100644 --- a/doc/en/fcrontab.1.sgml +++ b/doc/en/fcrontab.1.sgml @@ -8,230 +8,231 @@ Foundation. A copy of the license is included in gfdl.sgml. --> - + - - - fcrontab - 1 - Fcron &version; development release)]]> - &date; - - - fcrontab - manipulate per-user fcrontab files - + + + fcrontab 1 + Fcron &version; development release)]]> + &date; + + + fcrontab manipulate per-user fcrontab + files + - - - fcrontab - -c file - -n - file + + + fcrontab -c + file -n file - user - -u user + user -u + user - - - fcrontab - -c file - -n + + + fcrontab -c + file -n - -l - -r - -e - -z + -l -r -e -z - user - -u user + user -u + user - - - fcrontab - -h - - + + + fcrontab -h + + - - Description - &Fcrontab; is the program intended to install, edit, list and -remove the tables used by &fcron;(8) daemon. As -&fcron; internally uses a non-human readable format (this is needed because -&fcron; saves more informations than the user gives, for example the time and -date of next execution), the user cannot edit directly his &fcrontabf; (the one -used by &fcron;). - When a user installs a &fcrontabf;, the source file is saved in -the spool directory (&fcrontabsdir;) to allow future -editions, a formatted file is generated for the &fcron; daemon, which is -signaled once about ten seconds before the next minute for all changes made -previously. The daemon is not signaled immediately to keep ill disposed users -from blocking the daemon by installing &fcrontabf;s over and over. We will call -"fcrontab" the source file of the &fcrontabf; in the -following. - A user can install a &fcrontabf; if he is listed in the -&etc;/&fcron.allow; and not (unless by the keyword all) -listed in &etc;/&fcron.deny; (see section "files" below). If neither -fcron.allow nor fcron.deny exist, -all users are allowed. None of these files have to exist, but if they do, the -deny file takes precedence. - The first form of the command is used to install a new &fcrontabf; -file, from any named file or from standard input if the pseudo-filename "-" is -given, replacing the previous one (if any) : each user can have only one -&fcrontabf;. - For instance, root can create a systemwide fcrontab file, say -/etc/fcrontab, and run "fcrontab -/etc/fcrontab" to install the new version after each change -of the file. Or (s)he can create a new fcrontab running a simple -"fcrontab", and then maintain it using -"fcrontab ". Same considerations apply to -a non privileged user. - + + Description &Fcrontab; is the program intended to + install, edit, list and remove the tables used by &fcron;(8) daemon. As &fcron; internally + uses a non-human readable format (this is needed because &fcron; + saves more informations than the user gives, for example the time + and date of next execution), the user cannot edit directly his + &fcrontabf; (the one used by &fcron;). When a user + installs a &fcrontabf;, the source file is saved in the spool + directory (&fcrontabsdir;) to allow future + editions, a formatted file is generated for the &fcron; daemon, + which is signaled once about ten seconds before the next minute for + all changes made previously. The daemon is not signaled immediately + to keep ill disposed users from blocking the daemon by installing + &fcrontabf;s over and over. We will call + "fcrontab" the source file of the &fcrontabf; + in the following. A user can install a &fcrontabf; if + he is listed in the &etc;/&fcron.allow; and not + (unless by the keyword all) listed in + &etc;/&fcron.deny; (see section "files" below). If neither + fcron.allow nor fcron.deny + exist, all users are allowed. None of these files have to exist, but + if they do, the deny file takes precedence. The first + form of the command is used to install a new &fcrontabf; file, from + any named file or from standard input if the pseudo-filename "-" is + given, replacing the previous one (if any) : each user can have only + one &fcrontabf;. For instance, root can create a + systemwide fcrontab file, say /etc/fcrontab, + and run "fcrontab + /etc/fcrontab" to install the new version after + each change of the file. Or (s)he can create a new fcrontab running + a simple "fcrontab", and then maintain it using + "fcrontab ". Same + considerations apply to a non privileged user. + - - Options - + + Options + - user - - Specify the user whose &fcrontabf; will be managed, -or "&sysfcrontab;" for the system fcrontab. -Should only be used by root. If not given, the &fcrontabf; file of the user -invoking &fcrontab; will be handled. It may be useful since the -su(8) command may confuse &fcrontab;. -the 'user' in the synopsys is equivalent to a -' user'. - - + user + + Specify the user whose &fcrontabf; will be managed, or + "&sysfcrontab;" for the system fcrontab. Should only be + used by root. If not given, the &fcrontabf; file of the + user invoking &fcrontab; will be handled. It may be useful + since the su(8) command may + confuse &fcrontab;. the + 'user' in the synopsys is equivalent + to a ' + user'. + - - - List user's current &fcrontabf; to standard -output. - + + + List user's current &fcrontabf; to standard + output. + - - - Edit user's current &fcrontabf; using either the -editor specified by the environment variable VISUAL, or -EDITOR if VISUAL is not set. If none or them are -set, &editor; will be used. - + + + Edit user's current &fcrontabf; using either the editor + specified by the environment variable + VISUAL, or EDITOR if + VISUAL is not set. If none or them are set, + &editor; will be used. + - - - Remove user's &fcrontabf;. - + + + Remove user's &fcrontabf;. + - - - Reinstall user's &fcrontabf; from its source code. All -informations &fcron; may have kept in the binary &fcrontabf; (such as the last -execution time and date) will be forgotten. - + + + Reinstall user's &fcrontabf; from its source code. All + informations &fcron; may have kept in the binary + &fcrontabf; (such as the last execution time and date) will + be forgotten. + - - - Ignore previous version. If this option is not given, -&fcron; will try to keep as much information as possible between old and new -version of the &fcrontabf; (time and date of next execution, if job is in serial -queue, etc) if the line hasn't been modified (same fields, same shell -command). - + + + Ignore previous version. If this option is not given, + &fcron; will try to keep as much information as possible + between old and new version of the &fcrontabf; (time and + date of next execution, if job is in serial queue, etc) if + the line hasn't been modified (same fields, same shell + command). + - file - - Make &fcrontab; use config file -file instead of default config file -&etc;/&fcron.conf.location;. To interact with a running -&fcron; process, &fcrontab; must use the same config file as the process. That -way, several &fcron; processes can run simultaneously on an only system. - + file + + Make &fcrontab; use config file + file instead of default config + file &etc;/&fcron.conf.location;. To + interact with a running &fcron; process, &fcrontab; must + use the same config file as the process. That way, several + &fcron; processes can run simultaneously on an only + system. + - - - Run in debug mode. In this mode, many informational -messages will be output in order to check if anything went wrong. - + + + Run in debug mode. In this mode, many informational + messages will be output in order to check if anything went + wrong. + - - - Display a brief description of the options. - + + + Display a brief description of the options. + - - - Display an informational message about &fcrontab;, -including its version and the license under which it is distributed. - + + + Display an informational message about &fcrontab;, + including its version and the license under which it is + distributed. + - - + + - - Return values - &Fcrontab; returns &exitok; on normal exit and &exiterr; on -error. - + + Return values &Fcrontab; returns &exitok; on + normal exit and &exiterr; on error. + - - Conforming to - Should be POSIX compliant. - + + Conforming to Should be POSIX compliant. + - - Files - + + Files + - &etc;/&fcron.conf.location; - - Configuration file for &fcron;, &fcrontab; and -&fcrondyn; : contains paths (spool dir, pid file) and default programs to use -(editor, shell, etc). See &fcron.conf;(5) -for more details. - + &etc;/&fcron.conf.location; + + Configuration file for &fcron;, &fcrontab; and + &fcrondyn; : contains paths (spool dir, pid file) and + default programs to use (editor, shell, etc). See &fcron.conf;(5) for more + details. + - &etc;/&fcron.allow; - - Users allowed to use &fcrontab; and &fcrondyn; (one -name per line, special name "all" acts for everyone) - + &etc;/&fcron.allow; + + Users allowed to use &fcrontab; and &fcrondyn; (one name + per line, special name "all" acts for everyone) + - &etc;/&fcron.deny; - - Users who are not allowed to use &fcrontab; and -&fcrondyn; (same format as allow file) - + &etc;/&fcron.deny; + + Users who are not allowed to use &fcrontab; and + &fcrondyn; (same format as allow file) + - &etc;/pam.d/fcron (or -&etc;/pam.conf) - - PAM configuration file for -&fcron;. Take a look at pam(8) for more details. - + &etc;/pam.d/fcron (or + &etc;/pam.conf) + + PAM configuration file for + &fcron;. Take a look at pam(8) for more details. + - - + + - &manpage-foot; + &manpage-foot; - + - + @@ -265,7 +265,7 @@ below). The third type of &fcrontabf;'s entries begin by a "%", followed by a keyword from one of 3 different lists, and optional options. - "*ly" keywords + *ly keywords Those keywords are : hourly @@ -282,6 +282,7 @@ to run a command once between Monday and Sunday each week. fields (as defined in "Entries based on time and date" (see above)) to specify when the command should be run during each time interval : + Needed time fields for each keyword @@ -311,10 +312,11 @@ each time interval :
+ - "mid*ly" keywords + mid*ly keywords They are similar to the "*ly" ones : midhourly @@ -345,7 +347,7 @@ below). - "*s" keywords + *s keywords They are : mins @@ -391,8 +393,8 @@ a whole line immediately after an exclamation mark (!), while it is done after a "&", a "%" or a "@" depending on the type of scheduling in the second case. Note that an option declaration in a schedule overrides the global declaration of that same option. - Options are separated by comas (,) and their arguments, if -any, are placed in parentheses ("(" and ")") and separated by comas. No spaces + Options are separated by commas (,) and their arguments, if +any, are placed in parentheses ("(" and ")") and separated by commas. No spaces are allowed. A declaration of options is of the form
option[(arg1[,arg2][...])][,option[(arg1[...])]][...] @@ -400,7 +402,7 @@ are allowed. A declaration of options is of the form where option is either the name of an option or its abbreviation. The options are (default value in parentheses) : - Valid options in a &fcrontabf; (alphabetically) + Valid options in a &fcrontabf; bootrun @@ -715,7 +717,7 @@ linkend="uptent">lines based on elapsed system up time, fcron's option - A boolean argument can be inexistent, in which + A boolean argument can be non-existent, in which case parentheses are not used and it means true; the string "true", "yes" or 1 to mean true; and the string "false", "no" or 0 to mean false. See above for explanations about