git-annex/doc/git-annex-schedule.mdwn

# NAME

git-annex schedule - get or set scheduled jobs

# SYNOPSIS

git annex schedule `repository [expression]`

# DESCRIPTION

The [[git-annex-assistant]](1) daemon can be configured to run scheduled jobs.
This is similar to cron and anacron (and you can use them if you prefer),
but has the advantage of being integrated into git-annex, and so being able
to e.g., fsck a repository on a removable drive when the drive gets
connected.

When run with an expression, configures scheduled jobs to run at a
particular time. This can be used to make the assistant periodically run
incremental fscks.

When run without an expression, outputs the current scheduled jobs for
the repository.

# EXPRESSIONS

These actions are available: "fsck self", "fsck UUID" (where UUID
is the UUID of a remote to fsck). After the action comes the duration
to allow the action to run, and finally the schedule of when to run it.
  
To schedule multiple jobs, separate them with "; ".
  
  Some examples:
  
	fsck self 30m every day at any time
	fsck self 1h every month at 3 AM
	fsck self 1h on day 1 of every month at any time
	fsck self 1h every week divisible by 2 at any time

# OPTIONS

* The [[git-annex-common-options]](1) can be used.

# SEE ALSO

[[git-annex]](1)

[[git-annex-assistant]](1)

[[git-annex-expire]](1)

# AUTHOR

Joey Hess <id@joeyh.name>

Warning: Automatically converted into a man page by mdwn2man. Edit with care.
splitting up the man page Common command man pages all split out and often expanded. A few sections split out into their own pages. Still need to do all the other commands.. 2015-03-23 19:36:10 +00:00			`# NAME`

			`git-annex schedule - get or set scheduled jobs`

			`# SYNOPSIS`

			git annex schedule `repository [expression]`

			`# DESCRIPTION`

			`The [[git-annex-assistant]](1) daemon can be configured to run scheduled jobs.`
			`This is similar to cron and anacron (and you can use them if you prefer),`
			`but has the advantage of being integrated into git-annex, and so being able`
			`to e.g., fsck a repository on a removable drive when the drive gets`
			`connected.`

			`When run with an expression, configures scheduled jobs to run at a`
			`particular time. This can be used to make the assistant periodically run`
			`incremental fscks.`

			`When run without an expression, outputs the current scheduled jobs for`
			`the repository.`

			`# EXPRESSIONS`

			`These actions are available: "fsck self", "fsck UUID" (where UUID`
			`is the UUID of a remote to fsck). After the action comes the duration`
			`to allow the action to run, and finally the schedule of when to run it.`

			`To schedule multiple jobs, separate them with "; ".`

			`Some examples:`

fix man page example formatting 2015-05-09 18:27:45 +00:00			`fsck self 30m every day at any time`
			`fsck self 1h every month at 3 AM`
			`fsck self 1h on day 1 of every month at any time`
			`fsck self 1h every week divisible by 2 at any time`
splitting up the man page Common command man pages all split out and often expanded. A few sections split out into their own pages. Still need to do all the other commands.. 2015-03-23 19:36:10 +00:00
split out common options to its own page and mention it on each subcommand page Sometimes users would get confused because an option they were looking for was not mentioned on a subcommand's man page, and they had not noticed that the main git-annex man page had a list of common options. This change lets each subcommand mention the common options, similarly to how the matching options are handled. This commit was sponsored by Svenne Krap on Patreon. 2021-05-10 19:00:13 +00:00			`# OPTIONS`

			`* The [[git-annex-common-options]](1) can be used.`

splitting up the man page Common command man pages all split out and often expanded. A few sections split out into their own pages. Still need to do all the other commands.. 2015-03-23 19:36:10 +00:00			`# SEE ALSO`

			`[[git-annex]](1)`

expand manpages cross-references significantly i found that most man pages only had references to the main git-annex manpage, which i stillfind pretty huge and hard to navigate through. i tried to sift through all the man pages and add cross-references between relevant pages. my general rule of thumb is that links should be both ways unless one of the pages is a more general page that would become ridiculously huge if all backlinks would be added (git-annex-preferred-content comes to mind). i have also make the links one per line as this is how it was done in the metadata pages so far. i did everything but the plumbing, utility and test commands, although some of those are linked from the other commands so cross-links were added there as well. 2015-05-29 16:12:55 +00:00			`[[git-annex-assistant]](1)`

			`[[git-annex-expire]](1)`

splitting up the man page Common command man pages all split out and often expanded. A few sections split out into their own pages. Still need to do all the other commands.. 2015-03-23 19:36:10 +00:00			`# AUTHOR`

			`Joey Hess <id@joeyh.name>`

			`Warning: Automatically converted into a man page by mdwn2man. Edit with care.`