Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve readme #5

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
README: use markdown list in EXTRAS
fkobi committed Jan 9, 2025

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
commit 79ec03c1b1f7cd8534007c8f50b4739f6dc2f3c5
59 changes: 22 additions & 37 deletions README.md
Original file line number Diff line number Diff line change
@@ -138,43 +138,28 @@ EXTRAS
The following are included in the "extra" folder. None of them are installed
by `make install`:

crond.rc
: This is an example rc script to start and stop crond. It could be placed in
/etc/rc.d or /etc/init.d in suitable systems.

crond.conf
: This contains user-modifiable settings for crond.rc. The sample crond.rc
expects to source this file from /etc/conf.d/crond.

run-cron
: This simple shell script is a bare-bones alternative to Debian's run-parts.

crond.service
: This is an example sysvinit service to start and stop crond. It
could be placed in /lib/systemd/system in suitable systems.

root.crontab
: This is an example crontab to install for the root user, or to install
in /etc/cron.d. It runs any executable scripts located in the directories /etc/cron.hourly,
/etc/cron.daily, /etc/cron.weekly, and /etc/cron.monthly at the appropriate times.
This example uses the run-cron script mentioned above, and relies on you to
create the /etc/cron.* directories.

prune-cronstamps
: crond never removes any files from your cronstamps directory. If usernames
are abandoned, or cron job names are abandoned, unused files will accumulate
there. This simple cronjob will prune any cronstamp files older than three months.
It will run weekly if placed in /etc/cron.d.

crond.logrotate
: This is an example to place in /etc/logrotate.d. This config file assumes you
run crond using -L /var/log/crond.log. If you run crond using syslog instead (the default),
you may prefer to configure the rotation of all your syslog-generated logs in a
single config file.

crontab.vim
: This makes vim handle backup files in way that doesn't interfere with crontab's security
model.
- `crond.rc`: This is an example rc script to start and stop crond.
It could be placed in `/etc/rc.d` or `/etc/init.d` in suitable systems.
- `crond.conf`: This contains user-modifiable settings for crond.rc.
The sample `crond.rc` expects to source this file from `/etc/conf.d/crond`.
- `run-cron`: This simple shell script is a bare-bones alternative to Debian's `run-parts`.
- `crond.service`: This is an example sysvinit service to start and stop crond.
It could be placed in `/lib/systemd/system` in suitable systems.
- `root.crontab`: This is an example crontab to install for the root user, or to install
in `/etc/cron.d`. It runs any executable scripts located in the directories
`/etc/cron.{hourly,daily,weekly,monthly}` at the appropriate times.
This example uses the `run-cron` script mentioned above, and relies on you to
create the /etc/cron.* directories.
- `prune-cronstamps`: `crond` never removes any files from your cronstamps directory.
If usernames are abandoned, or cron job names are abandoned, unused files will accumulate
there. This simple cronjob will prune any cronstamp files older than three months.
It will run weekly if placed in `/etc/cron.d`.
- `crond.logrotate`: This is an example to place in `/etc/logrotate.d`. This config file assumes you
run crond using `-L /var/log/crond.log`. If you run crond using `syslog` instead (the default),
you may prefer to configure the rotation of all your syslog-generated logs
in a single config file.
- `crontab.vim`: This makes vim handle backup files in way that doesn't interfere
with crontab's security model.


BUG REPORTS, SUBMISSIONS