Getting Started
===============

Supported distros
------------

Mcron is currently packaged for Alpine Linux:

.. code-block:: sh

	$ doas apk add mcron
	$ doas rc-service mcron start

Manual installation
------------

Mcron depends on the Hare toolsuite: `hare`, `hare-ev`, `scdoc`, `tzdata`

.. code-block:: sh

	$ git clone https://git.sr.ht/~stacyharper/mcron
	$ doas make install -C mcron

You have to create a "mcron" group:

.. code-block:: sh

	$ doas addgroup -S mcron

Then the service daemon must be run as root. Doing so depends on your service manager.

Usage
-----

Add your user to the "mcron" group, to start editing your crontab file:

.. code-block:: sh

	$ doas adduser <username> mcron

You might need to logout then login to refresh your shell current groups. Then you can use the cli:

.. code-block:: sh

	$ mcrontab -e # Edit your user crontab with EDITOR
	$ mcrontab -l # Output the user crontab
	$ mcrontab -r # Drop the user crontab
	$ mcrontab -f # Replace the user crontab with file (- for stdin)
	$ man mcrontab # Futher detail