git-annex/doc/git-annex-assistant.mdwn

# NAME

git-annex assistant - automatically sync changes

# SYNOPSIS

git annex assistant

# DESCRIPTION

Watches for changes to files in the current directory and its subdirectories,
and automatically syncs them to other remotes.

# OPTIONS

* `--autostart`

  Automatically starts the assistant running in each repository listed
  in the file `~/.config/git-annex/autostart`

  This is typically started at boot, or when you log in.

* `--startdelay=N`

  Wait N seconds before running the startup scan. This process can
  be expensive and you may not want to run it immediately upon login.

  When --autostart is used, defaults to --startdelay=5.

* `--foreground`

  Avoid forking to the background.

* `--stop`

  Stop a running daemon in the current repository.

* `--autostop`

  The complement to --autostart; stops all running daemons in the
  repositories listed in the autostart file.

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

# SEE ALSO

[[git-annex]](1)

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

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

For more details about the git-annex assistant, see
<https://git-annex.branchable.com/assistant/>

# 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 assistant - automatically sync changes`

			`# SYNOPSIS`

			`git annex assistant`

			`# DESCRIPTION`

			`Watches for changes to files in the current directory and its subdirectories,`
			`and automatically syncs them to other remotes.`

			`# OPTIONS`

			* `--autostart`

			`Automatically starts the assistant running in each repository listed`
			in the file `~/.config/git-annex/autostart`

			`This is typically started at boot, or when you log in.`

			* `--startdelay=N`

			`Wait N seconds before running the startup scan. This process can`
Various typo fixes in doc/*.mdwn 2015-04-01 23:50:17 +00:00			`be expensive and you may not want to run it immediately upon login.`
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
meant to be in prev commit 2015-11-02 15:22:02 +00:00			`When --autostart is used, defaults to --startdelay=5.`

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			* `--foreground`

			`Avoid forking to the background.`

			* `--stop`

improve --stop docs 2015-05-01 17:41:53 +00:00			`Stop a running daemon in the current repository.`
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
assistant: Added --autostop to complement --autostart. 2015-05-01 17:53:45 +00:00			* `--autostop`

			`The complement to --autostart; stops all running daemons in the`
			`repositories listed in the autostart file.`

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			`* Also 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-watch]](1)`

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

			`For more details about the git-annex assistant, see`
			`<https://git-annex.branchable.com/assistant/>`

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.`