git-annex/doc/git-annex-assistant.mdwn
Joey Hess b184fc490a
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 15:00:13 -04:00

60 lines
1.2 KiB
Markdown

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