Merge branch 'master' of feistymeow.org:feisty_meow
[feisty_meow.git] / infobase / configuration / cron / aa_cron_defaults.crontab
1
2 #[aa cron defaults]
3 #
4 # cron default bits to add at top of crontab...
5 # by fred t. hamster, GNU GPL v3 license.
6
7 # every one of the crontab examples in feisty meow depends on the the stanzas
8 # below.  (unfortunately there is no way to include cron files in other cron
9 # files, so the functional parts here should just be pasted directly into the
10 # user's crontab at the top.)
11
12 # set a user name for writing unique log files.  this is important because
13 # cron doesn't have the normal variable 'USER' defined.  cron does define
14 # HOME, which is pretty lucky for us...
15 # please change the name to the user running the cronjob, or to whatever
16 # unique string you'd like to use:
17 CRONUSER=FILL-CRONUSER-HERE
18
19 # set the shell to bash.  (not the default for some cron implementations.)
20 SHELL=/bin/bash
21
22 # set the top-level folder for feisty meow here; important because cron gets
23 # almost nothing from the user's environment.  this folder needs to be updated
24 # for your own particular install location.
25 FEISTY_MEOW_APEX=/opt/feistymeow.org/feisty_meow
26 #FEISTY_MEOW_APEX=$HOME/feisty_meow
27
28 # crontab miniature docs:
29 #
30 # below is the short form key to the crontab positional entries for times:
31 #     m h dom mon dow command
32 #
33 # below is a longer form that spells out the meaning of each position:
34 #     minute(s) hour(s) dayOfMonth(s) month(s) dayOfWeek(s) command
35 #
36 # each field is optionally plural because cron allows each of the positions to
37 # indicate multiple values.  generally it is simpler and sufficient to have a
38 # single value in the field, but there are also good reasons that some tasks
39 # would have a more complicated formula (such as, "every couple of days" rather
40 # than "every day").
41 #
42 # the wildcard '*' indicates that every valid value is okay for that field.
43 # the wildcard form of a crontab line is this: "* * * * * command"
44 # that "command" will execute every single minute.
45
46 # the guts of the crontab would follow below.  this usually is a set of valid
47 # crontab lines that spell the time or times for commands to be executed.  my
48 # crontabs usually have from 3 to 8 entries because i tend to atomicize the
49 # tasks, rather than writing big complicated multi-purpose scripts.  not saying
50 # that's always better, it's just how i roll (my crontabs)...
51 #
52 # also, it is fine to have a really long command with multiple sub-commands;
53 # just put it inside parentheses to group a bunch of commands together.  there
54 # are many examples of doing this in the other crontab examples in this folder.
55 #
56 # further, it's often important to send the output from the cron job to an
57 # output location.  doing this keeps cron from sending you a lot of emails
58 # with cron job output on some systems.  you can use the normal output
59 # redirection operators to do this (e.g. '>', '2>', '&>', '>>' and '&>>').
60 # /dev/null works as an output target if you don't ever want to see the
61 # results from your cron jobs.  i usually prefer to write log files in the
62 # /tmp directory with the ${CRONUSER} variable added in the file name.
63 # below is a live example which we almost always include, so it's embedded
64 # here for convenience.
65
66 #[nechung fortune]
67 # runs every minute and recreates a fortune for thunderbird signature.
68 # a lot of the detail below is to get the feisty meow environment loaded for
69 # the new_sig command.
70 * * * * * (source $FEISTY_MEOW_APEX/scripts/core/launch_feisty_meow.sh; perl $FEISTY_MEOW_SCRIPTS/text/new_sig.pl) &>>/tmp/${CRONUSER}-cron-nechung_fortune.log
71
72