mirrors/git-annex
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions

split out common options to its own page and mention it on each subcommand page

Browse source 
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.
This commit is contained in:
Joey Hess 2021-05-10 15:00:13 -04:00
parent 8ab04788ef
commit b184fc490a
No known key found for this signature in database
GPG key ID: DB12DB0FF05F8F38
100 changed files with 437 additions and 127 deletions
Download patch file Download diff file Expand all files Collapse all files

2
doc/git-annex-add.mdwn
View file

@ -106,6 +106,8 @@ annexed content, and other symlinks.
Makes the `--batch` input be delimited by nulls instead of the usual
newlines.
* Also the [[git-annex-common-options]](1) can be used.
# SEE ALSO
[[git-annex]](1)

4
doc/git-annex-addunused.mdwn
View file

@ -13,6 +13,10 @@ as listed by the last `git annex unused`.
The files will have names starting with "unused."
# OPTIONS
* The [[git-annex-common-options]](1) can be used.
# SEE ALSO
[[git-annex]](1)

2
doc/git-annex-addurl.mdwn
View file

@ -130,6 +130,8 @@ be used to get better filenames.
Messages that would normally be output to standard error are included in
the json instead.
* Also the [[git-annex-common-options]](1) can be used.
# CAVEATS
If annex.largefiles is configured, and does not match a file, `git annex

2
doc/git-annex-adjust.mdwn
View file

@ -109,6 +109,8 @@ and will also propagate commits back to the original branch.
set the `annex.adjustedbranchrefresh` config. Or use `git-annex sync
--content`, which updates the branch after transferring content.
* Also the [[git-annex-common-options]](1) can be used.
# SEE ALSO
[[git-annex]](1)

2
doc/git-annex-assistant.mdwn
View file

@ -40,6 +40,8 @@ and automatically syncs them to other remotes.
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)

2
doc/git-annex-calckey.mdwn
View file

@ -34,6 +34,8 @@ For example, to force use of the SHA1 backend:
Makes the `--batch` input be delimited by nulls instead of the usual
newlines.
* Also the [[git-annex-common-options]](1) can be used.
# SEE ALSO
[[git-annex]](1)

2
doc/git-annex-checkpresentkey.mdwn
View file

@ -27,6 +27,8 @@ the special exit code 100 is used, and an error message is output to stderr.
read from stdin, and a line is output with "1" if the key is verified to
be present, and "0" otherwise.
* Also the [[git-annex-common-options]](1) can be used.
# SEE ALSO
[[git-annex]](1)

136
doc/git-annex-common-options.mdwn Normal file
View file

@ -0,0 +1,136 @@
# NAME
git-annex-common-options - options supported by all git-annex commands
# DESCRIPTION
These common options are accepted by all git-annex commands, and
may not be explicitly listed on their individual man pages.
(Many commands also accept the [[git-annex-matching-options]](1).)
# OPTIONS
* `--force`
Force unsafe actions, such as dropping a file's content when no other
source of it can be verified to still exist, or adding ignored files.
Use with care.
* `--fast`
Avoid some expensive operations normally performed by a command.
What is avoided depends on the command, see individual command's man
pages for details.
* `--quiet`
Avoid the default verbose display of what is done; only show errors.
* `--verbose`
Enable verbose display.
* `--debug`
Display debug messages.
* `--no-debug`
Disable display of debug messages.
* `--debugfilter=name[,name..]`
When debug message display has been enabled by `--debug`, this filters
the debug messages that are displayed to ones coming from modules with
the specified names.
To find the names of modules, see the full debug output, which includes
the module name, eg "(Utility.Process)"
The full module name does not need to be
specified when using this, a substring of the name will do.
For example, `--debugfilter=Process,External` will display debugging
output when git-annex runs processes, and when it communicates with
external special remotes.
* `--numcopies=n`
Overrides the numcopies setting.
Note that setting numcopies to 0 is very unsafe.
* `--mincopies=n`
Overrides the mincopies setting.
Note that setting mincopies to 0 is very unsafe.
* `--time-limit=time`
Limits how long a git-annex command runs. The time can be something
like "5h", or "30m" or even "45s" or "10d".
Note that git-annex may continue running a little past the specified
time limit, in order to finish processing a file.
Also, note that if the time limit prevents git-annex from doing all it
was asked to, it will exit with a special code, 101.
* `--semitrust=repository`
* `--untrust=repository`
Overrides trust settings for a repository. May be specified more than once.
The repository should be specified using the name of a configured remote,
or the UUID or description of a repository.
* `--trust=repository`
This used to override trust settings for a repository, but now will
not do so, because trusting a repository can lead to data loss,
and data loss is now only enabled when using the `--force` option.
* `--trust-glacier`
This used to override trust settings for Glacier special remotes,
but now will not do so, because it could lead to data loss,
and data loss is now only enabled when using the `--force` option.
* `--backend=name`
Specifies which key-value backend to use. This can be used when
adding a file to the annex, or migrating a file. Once files
are in the annex, their backend is known and this option is not
necessary.
* `--user-agent=value`
Overrides the User-Agent to use when downloading files from the web.
* `--notify-finish`
Caused a desktop notification to be displayed after each successful
file download and upload.
(Only supported on some platforms, e.g. Linux with dbus. A no-op when
not supported.)
* `--notify-start`
Caused a desktop notification to be displayed when a file upload
or download has started, or when a file is dropped.
* `-c name=value`
Overrides git configuration settings. May be specified multiple times.
# SEE ALSO
[[git-annex]](1)
# AUTHOR
Joey Hess <id@joeyh.name>
Warning: Automatically converted into a man page by mdwn2man. Edit with care.

16
doc/git-annex-config.mdwn
View file

@ -100,6 +100,22 @@ looks for these.
So, changes to the value in the git-annex branch won't affect a
repository once it has been initialized.
# OPTIONS
* `--set name value`
Set a value.
* `--get name`
Get a value.
* `--unset`
Unset a value.
* Also the [[git-annex-common-options]](1) can be used.
# EXAMPLE
Suppose you want to prevent git annex sync from committing changes

2
doc/git-annex-contentlocation.mdwn
View file

@ -23,6 +23,8 @@ present in the local repository, nothing is output, and it exits nonzero.
Note that if a key's content is not present, an empty line is output to
stdout instead.
* Also the [[git-annex-common-options]](1) can be used.
# SEE ALSO
[[git-annex]](1)

2
doc/git-annex-copy.mdwn
View file

@ -112,6 +112,8 @@ Paths of files or directories to operate on can be specified.
Messages that would normally be output to standard error are included in
the json instead.
* Also the [[git-annex-common-options]](1) can be used.
# SEE ALSO
[[git-annex]](1)

10
doc/git-annex-dead.mdwn
View file

@ -4,7 +4,7 @@ git-annex dead - hide a lost repository or key
# SYNOPSIS
git annex dead `[repository ...] [--key key]`
git annex dead `[repository ...] [--key somekey]`
# DESCRIPTION
@ -22,6 +22,14 @@ from complaining about it; `--all` will not operate on the key anymore.
(To undo, add the key's content back to the repository,
by using eg, `git-annex reinject`.)
# OPTIONS
* `--key=somekey`
Use to specify a key that is dead.
* Also the [[git-annex-common-options]](1) can be used.
# SEE ALSO
[[git-annex]](1)

4
doc/git-annex-describe.mdwn
View file

@ -18,6 +18,10 @@ Repository descriptions are displayed by git-annex in various places.
They are most useful when git-annex knows about a repository, but there is
no git remote corresponding to it.
# OPTIONS
* The [[git-annex-common-options]](1) can be used.
# SEE ALSO
[[git-annex]](1)

7
doc/git-annex-diffdriver.mdwn
View file

@ -26,6 +26,13 @@ to it. Note the trailing "--", which is required.
For example, set `GIT_EXTERNAL_DIFF=git-annex diffdriver -- j-c-diff --`
# OPTIONS
Normally "--" followed by the diff driver command, its options,
and another "--"
Also the [[git-annex-common-options]](1) can be used.
# SEE ALSO
[[git-annex]](1)

2
doc/git-annex-drop.mdwn
View file

@ -125,6 +125,8 @@ Paths of files or directories to drop can be specified.
Messages that would normally be output to standard error are included in
the json instead.
* Also the [[git-annex-common-options]](1) can be used.
# SEE ALSO
[[git-annex]](1)

2
doc/git-annex-dropkey.mdwn
View file

@ -34,6 +34,8 @@ exist; using it can easily result in data loss.
Messages that would normally be output to standard error are included in
the json instead.
* Also the [[git-annex-common-options]](1) can be used.
# SEE ALSO
[[git-annex]](1)

2
doc/git-annex-dropunused.mdwn
View file

@ -28,6 +28,8 @@ Or, specify "all" to drop all unused data.
the last repository that is storing their content. Data loss can
result from using this option.
* Also the [[git-annex-common-options]](1) can be used.
# SEE ALSO
[[git-annex]](1)

4
doc/git-annex-enable-tor.mdwn
View file

@ -21,6 +21,10 @@ After this command is run, `git annex remotedaemon` can be run to serve the
tor hidden service, and then `git-annex p2p --gen-address` can be run to
give other users access to your repository via the tor hidden service.
# OPTIONS
* The [[git-annex-common-options]](1) can be used.
# SEE ALSO
[[git-annex]](1)

7
doc/git-annex-enableremote.mdwn
View file

@ -57,6 +57,13 @@ to be done to get it enabled.
has found didn't work before and gave up on using, setting
`remote.<name>.annex-ignore`.)
# OPTIONS
Most options are not prefixed by a dash, and set parameters of the remote,
as shown above.
Also, the [[git-annex-common-options]](1) can be used.
# SEE ALSO
[[git-annex]](1)

2
doc/git-annex-examinekey.mdwn
View file

@ -74,6 +74,8 @@ that can be determined purely by looking at the key.
In order to also provide the name of a file associated with the key, the
line can be in the format "$key $file"
* Also the [[git-annex-common-options]](1) can be used.
# SEE ALSO
[[git-annex]](1)

2
doc/git-annex-expire.mdwn
View file

@ -48,6 +48,8 @@ expired.
The first version of git-annex that recorded fsck activity was
5.20150405.
* Also the [[git-annex-common-options]](1) can be used.
# SEE ALSO
[[git-annex]](1)

2
doc/git-annex-export.mdwn
View file

@ -113,6 +113,8 @@ so the overwritten modification is not lost.)
Messages that would normally be output to standard error are included in
the json instead.
* Also the [[git-annex-common-options]](1) can be used.
# EXAMPLE
git annex initremote myremote type=directory directory=/mnt/myremote \

2
doc/git-annex-find.mdwn
View file

@ -77,6 +77,8 @@ finds files in the current directory and its subdirectories.
Makes the `--batch` input be delimited by nulls instead of the usual
newlines.
* Also the [[git-annex-common-options]](1) can be used.
# SEE ALSO
[[git-annex]](1)

2
doc/git-annex-fix.mdwn
View file

@ -24,6 +24,8 @@ configured by annex.thin.
The [[git-annex-matching-options]](1)
can be used to specify files to fix.
* Also the [[git-annex-common-options]](1) can be used.
# SEE ALSO
[[git-annex]](1)

2
doc/git-annex-forget.mdwn
View file

@ -26,6 +26,8 @@ git to push the branch to any git repositories not running git-annex.)
Also prune references to repositories that have been marked as dead.
* Also the [[git-annex-common-options]](1) can be used.
# SEE ALSO
[[git-annex]](1)

2
doc/git-annex-fromkey.mdwn
View file

@ -47,6 +47,8 @@ to do that.
Enable JSON output. This is intended to be parsed by programs that use
git-annex. Each line of output is a JSON object.
* Also the [[git-annex-common-options]](1) can be used.
# SEE ALSO
[[git-annex]](1)

2
doc/git-annex-fsck.mdwn
View file

@ -117,6 +117,8 @@ better format.
normally displays all the files it's checking even when there is no
problem with them.
* Also the [[git-annex-common-options]](1) can be used.
# SEE ALSO
[[git-annex]](1)

4
doc/git-annex-fuzztest.mdwn
View file

@ -12,6 +12,10 @@ Generates random changes to files in the current repository,
for use in testing the assistant. This is dangerous, so it will not
do anything unless --forced.
# OPTIONS
* The [[git-annex-common-options]](1) can be used.
# SEE ALSO
[[git-annex]](1)

2
doc/git-annex-get.mdwn
View file

@ -133,6 +133,8 @@ be specified.
Messages that would normally be output to standard error are included in
the json instead.
* Also the [[git-annex-common-options]](1) can be used.
# SEE ALSO
[[git-annex]](1)

4
doc/git-annex-group.mdwn
View file

@ -18,6 +18,10 @@ settings. See <https://git-annex.branchable.com/preferred_content/standard_group
A repository can be in multiple groups at the same time.
# OPTIONS
* The [[git-annex-common-options]](1) can be used.
# SEE ALSO
[[git-annex]](1)

4
doc/git-annex-groupwanted.mdwn
View file

@ -25,6 +25,10 @@ Note that there must be exactly one groupwanted expression configured
amoung all the groups that a repository is in; if there's more than one,
none of them will be used.
# OPTIONS
* The [[git-annex-common-options]](1) can be used.
# SEE ALSO
[[git-annex]](1)

2
doc/git-annex-import.mdwn
View file

@ -205,6 +205,8 @@ and `--reinject-duplicates` documentation below.
Messages that would normally be output to standard error are included in
the json instead.
* Also the [[git-annex-common-options]](1) can be used.
# CAVEATS
Note that using `--deduplicate` or `--clean-duplicates` with the WORM

2
doc/git-annex-importfeed.mdwn
View file

@ -95,6 +95,8 @@ resulting in the new url being downloaded to such a filename.
url to a file that would be ignored. This makes such files be added
despite any ignores.
* Also the [[git-annex-common-options]](1) can be used.
# SEE ALSO
[[git-annex]](1)

2
doc/git-annex-info.mdwn
View file

@ -51,6 +51,8 @@ for the local repository and all known annexed files.
can be used to select the files in the directory that are included
in the statistics.
* Also the [[git-annex-common-options]](1) can be used.
# EXAMPLES
Suppose you want to run "git annex get .", but

2
doc/git-annex-init.mdwn
View file

@ -53,6 +53,8 @@ to the user who tries to run git-annex init.
Only enable any special remotes that were configured with
autoenable=true, do not otherwise initialize anything.
* Also the [[git-annex-common-options]](1) can be used.
# SEE ALSO
[[git-annex]](1)

2
doc/git-annex-initremote.mdwn
View file

@ -80,6 +80,8 @@ want to use `git annex renameremote`.
branch. The special remote will only be usable from the repository where
it was created.
* Also the [[git-annex-common-options]](1) can be used.
# COMMON CONFIGURATION PARAMETERS
* `encryption`

2
doc/git-annex-inprogress.mdwn
View file

@ -49,6 +49,8 @@ some file formats can be usefully streamed in this way.
The [[git-annex-matching-options]](1)
can be used to specify files to access.
* Also the [[git-annex-common-options]](1) can be used.
# EXIT STATUS
If any of the requested items are not currently being downloaded,

2
doc/git-annex-list.mdwn
View file

@ -23,6 +23,8 @@ files. This is similar to `git annex whereis` but a more compact display.
The [[git-annex-matching-options]](1)
can be used to specify files to list.
* Also the [[git-annex-common-options]](1) can be used.
# SEE ALSO
[[git-annex]](1)

2
doc/git-annex-lock.mdwn
View file

@ -33,6 +33,8 @@ can commit.
Messages that would normally be output to standard error are included in
the json instead.
* Also the [[git-annex-common-options]](1) can be used.
# SEE ALSO
[[git-annex]](1)

2
doc/git-annex-log.mdwn
View file

@ -50,6 +50,8 @@ false, information may not have been committed to the branch yet.
In this mode, the names of files are not available and keys are displayed
instead.
* Also the [[git-annex-common-options]](1) can be used.
# SEE ALSO
[[git-annex]](1)

2
doc/git-annex-lookupkey.mdwn
View file

@ -28,6 +28,8 @@ nothing is output, and it exits nonzero.
Makes the `--batch` input be delimited by nulls instead of the usual
newlines.
* Also the [[git-annex-common-options]](1) can be used.
# SEE ALSO
[[git-annex]](1)

2
doc/git-annex-map.mdwn
View file

@ -39,6 +39,8 @@ on that host.
Don't display the generated Graphviz file, but save it for later use.
* Also the [[git-annex-common-options]](1) can be used.
# SEE ALSO
[[git-annex]](1)

2
doc/git-annex-matchexpression.mdwn
View file

@ -53,6 +53,8 @@ For example, this will exit 0:
Tell what the mime encoding of the file is. Only needed when using
--largefiles with a mimeencoding= expression.
* Also the [[git-annex-common-options]](1) can be used.
# SEE ALSO
[[git-annex]](1)

4
doc/git-annex-merge.mdwn
View file

@ -20,6 +20,10 @@ branch before merging it.
When annex.resolvemerge is set to false, merge conflict resolution
will not be done.
# OPTIONS
* The [[git-annex-common-options]](1) can be used.
# SEE ALSO
[[git-annex]](1)

2
doc/git-annex-metadata.mdwn
View file

@ -162,6 +162,8 @@ the modified file.
Note that file matching options do not affect the files that are
processed when in batch mode.
* Also the [[git-annex-common-options]](1) can be used.
# EXAMPLES
To set some tags on a file and also its author:

2
doc/git-annex-migrate.mdwn
View file

@ -37,6 +37,8 @@ it's best to run migrate in all of them.
The [[git-annex-matching-options]](1)
can be used to specify files to migrate.
* Also the [[git-annex-common-options]](1) can be used.
# SEE ALSO
[[git-annex]](1)

4
doc/git-annex-mincopies.mdwn
View file

@ -31,6 +31,10 @@ bare minimum you're comfortable with. Setting mincopies to a large
number, rather than setting numcopies will in some cases prevent
droping content in entirely safe situations.
# OPTIONS
* The [[git-annex-common-options]](1) can be used.
# SEE ALSO
[[git-annex]](1)

2
doc/git-annex-mirror.mdwn
View file

@ -82,6 +82,8 @@ contents. Use [[git-annex-sync]](1) for that.
Messages that would normally be output to standard error are included in
the json instead.
* Also the [[git-annex-common-options]](1) can be used.
# SEE ALSO
[[git-annex]](1)

2
doc/git-annex-move.mdwn
View file

@ -112,6 +112,8 @@ Paths of files or directories to operate on can be specified.
Messages that would normally be output to standard error are included in
the json instead.
* Also the [[git-annex-common-options]](1) can be used.
# SEE ALSO
[[git-annex]](1)

2
doc/git-annex-multicast.mdwn
View file

@ -59,6 +59,8 @@ The uftp program is used for multicast.
git annex multicast send -U-R -U50000
* Also the [[git-annex-common-options]](1) can be used.
# EXAMPLE
Suppose a teacher wants to multicast files to students in a classroom.

4
doc/git-annex-numcopies.mdwn
View file

@ -28,6 +28,10 @@ repositories, git-annex may violate the numcopies setting. It still
guarantees at least 1 copy is preserved. This can be configured by
using [[git-annex-mincopies]](1)
# OPTIONS
* The [[git-annex-common-options]](1) can be used.
# SEE ALSO
[[git-annex]](1)

2
doc/git-annex-p2p.mdwn
View file

@ -63,6 +63,8 @@ services.
Specify a name to use when setting up a git remote with `--link`
or `--pair`.
* Also the [[git-annex-common-options]](1) can be used.
# SEE ALSO
[[git-annex]](1)

4
doc/git-annex-post-receive.mdwn
View file

@ -17,6 +17,10 @@ for repositories that have an adjusted branch checked
out. The hook updates the work tree when run in such a repository,
the same as running `git-annex merge` would.
# OPTIONS
* The [[git-annex-common-options]](1) can be used.
# SEE ALSO
[[git-annex]](1)

4
doc/git-annex-pre-commit.mdwn
View file

@ -17,6 +17,10 @@ point to annexed content.
When in a view, updates metadata to reflect changes
made to files in the view.
# OPTIONS
* The [[git-annex-common-options]](1) can be used.
# SEE ALSO
[[git-annex]](1)

4
doc/git-annex-readpresentkey.mdwn
View file

@ -17,6 +17,10 @@ It exits 0 if the key is recorded to be present and 1 if not.
Note that this does not do an active check to verify if the key
is present. To do such a check, use [[git-annex-checkpresentkey]](1)
# OPTIONS
* The [[git-annex-common-options]](1) can be used.
# SEE ALSO
[[git-annex]](1)

2
doc/git-annex-registerurl.mdwn
View file

@ -37,6 +37,8 @@ valid url, an URL key is constructed from the url.
(Note that for this to be used, you have to explicitly enable batch mode
with `--batch`)
* Also the [[git-annex-common-options]](1) can be used.
# SEE ALSO
[[git-annex]](1)

4
doc/git-annex-reinit.mdwn
View file

@ -23,6 +23,10 @@ correctly.
Like `git annex init`, this attempts to enable any special remotes
that are configured with autoenable=true.
# OPTIONS
* The [[git-annex-common-options]](1) can be used.
# SEE ALSO
[[git-annex]](1)

2
doc/git-annex-reinject.mdwn
View file

@ -54,6 +54,8 @@ needing to specify the dest file.
Specify the key-value backend to use when checking if a file is known
with the `--known` option.
* Also the [[git-annex-common-options]](1) can be used.
# SEE ALSO
[[git-annex]](1)

2
doc/git-annex-rekey.mdwn
View file

@ -31,6 +31,8 @@ Multiple pairs of file and key can be given in a single command line.
Makes the `--batch` input be delimited by nulls instead of the usual
newlines.
* Also the [[git-annex-common-options]](1) can be used.
# SEE ALSO
[[git-annex]](1)

14
doc/git-annex-remotedaemon.mdwn
View file

@ -31,13 +31,15 @@ will avoid fetching changes from that remote.
* `--foreground`
Don't fork to the background, and communicate on stdin/stdout using a
simple textual protocol. The assistant runs the remotedaemon this way.
Don't fork to the background, and communicate on stdin/stdout using a
simple textual protocol. The assistant runs the remotedaemon this way.
Commands in the protocol include LOSTNET, which tells the remotedaemon
that the network connection has been lost, and causes it to stop any TCP
connctions. That can be followed by RESUME when the network connection
comes back up.
Commands in the protocol include LOSTNET, which tells the remotedaemon
that the network connection has been lost, and causes it to stop any TCP
connctions. That can be followed by RESUME when the network connection
comes back up.
* Also the [[git-annex-common-options]](1) can be used.
# SEE ALSO

4
doc/git-annex-renameremote.mdwn
View file

@ -26,6 +26,10 @@ by `git annex enableremote`. It does not update the git config stanza
for the special remote to use the new name, but of course you can edit
the git config if you want to rename it there.
# OPTIONS
* The [[git-annex-common-options]](1) can be used.
# SEE ALSO
[[git-annex]](1)

2
doc/git-annex-repair.mdwn
View file

@ -44,6 +44,8 @@ to make sure that the git-annex branch reflects reality.
Enable repair actions that involve deleting data that has been
lost due to git repository corruption.
* Also the [[git-annex-common-options]](1) can be used.
# SEE ALSO
[[git-annex]](1)

4
doc/git-annex-required.mdwn
View file

@ -26,6 +26,10 @@ need to be removed with `git annex drop --force`.
Also, `git-annex fsck` will warn about required contents that are not
present.
# OPTIONS
* The [[git-annex-common-options]](1) can be used.
# NOTES
The `required` command was added in git-annex 5.20150420.

4
doc/git-annex-resolvemerge.mdwn
View file

@ -55,6 +55,10 @@ version. The `bar` file remains deleted. The user can later examine the
variant of the file and either rename it back to `bar`, or decide to delete
it too.
# OPTIONS
* The [[git-annex-common-options]](1) can be used.
# SEE ALSO
[[git-annex]](1)

2
doc/git-annex-rmurl.mdwn
View file

@ -26,6 +26,8 @@ present in the web special remote.
Makes the `--batch` input be delimited by nulls instead of the usual
newlines.
* Also the [[git-annex-common-options]](1) can be used.
# SEE ALSO
[[git-annex]](1)

4
doc/git-annex-schedule.mdwn
View file

@ -36,6 +36,10 @@ To schedule multiple jobs, separate them with "; ".
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)

4
doc/git-annex-semitrust.mdwn
View file

@ -13,6 +13,10 @@ Returns a repository to the default semi trusted state.
Repositories can be specified using their remote name, their
description, or their UUID. For the current repository, use "here".
# OPTIONS
* The [[git-annex-common-options]](1) can be used.
# SEE ALSO
[[git-annex]](1)

4
doc/git-annex-setkey.mdwn
View file

@ -14,6 +14,10 @@ be set to the specified file. The file is moved into the annex.
It's generally a better idea to use [[git-annex-reinject]](1) instead of
this command.
# OPTIONS
* The [[git-annex-common-options]](1) can be used.
# SEE ALSO
[[git-annex]](1)

2
doc/git-annex-setpresentkey.mdwn
View file

@ -21,6 +21,8 @@ not present.
Enables batch mode, in which lines are read from stdin.
The line format is "key uuid [1|0]"
* Also the [[git-annex-common-options]](1) can be used.
# SEE ALSO
[[git-annex]](1)

2
doc/git-annex-shell.mdwn
View file

@ -109,6 +109,8 @@ to git-annex-shell are:
git-annex uses this to specify the UUID of the repository it was expecting
git-annex-shell to access, as a sanity check.
* Also the [[git-annex-common-options]](1) can be used.
* -- fields=val fields=val.. --
Additional fields may be specified this way, to retain compatibility with

4
doc/git-annex-smudge.mdwn
View file

@ -51,6 +51,10 @@ and post-merge. However, a few git commands, notably `git stash` and
you can manually run `git annex smudge --update` to update the working
tree.
# OPTIONS
* The [[git-annex-common-options]](1) can be used.
# SEE ALSO
[[git-annex]](1)

2
doc/git-annex-status.mdwn
View file

@ -31,6 +31,8 @@ modified (M), added but not committed (A), and type changed/unlocked (T).
Messages that would normally be output to standard error are included in
the json instead.
* Also the [[git-annex-common-options]](1) can be used.
# SEE ALSO
[[git-annex]](1)

2
doc/git-annex-sync.mdwn
View file

@ -175,6 +175,8 @@ have the same value as the currently checked out branch.
around and still has the change in it. Cleaning up the `synced/` branches
prevents that problem.
* Also the [[git-annex-common-options]](1) can be used.
# SEE ALSO
[[git-annex]](1)

2
doc/git-annex-testremote.mdwn
View file

@ -43,6 +43,8 @@ is limited to checking various properties of downloading from it.
Tune the base size of generated objects. The default is 1MiB.
* Also the [[git-annex-common-options]](1) can be used.
# SEE ALSO
[[git-annex]](1)

2
doc/git-annex-transferkey.mdwn
View file

@ -26,6 +26,8 @@ transferred.
Provides a hint about the name of the file associated with the key.
(This name is only used in progress displays.)
* Also the [[git-annex-common-options]](1) can be used.
# SEE ALSO
[[git-annex]](1)

4
doc/git-annex-transferkeys.mdwn
View file

@ -16,6 +16,10 @@ It is a long-running process, which is fed instructions about the keys
to transfer using an internal stdio protocol, which is
intentionally not documented (as it may change at any time).
# OPTIONS
* The [[git-annex-common-options]](1) can be used.
# SEE ALSO
[[git-annex]](1)

4
doc/git-annex-transferrer.mdwn
View file

@ -13,6 +13,10 @@ It is a long-running process, which is fed instructions about
what to transfer using an internal stdio protocol, which is
intentionally not documented (as it may change at any time).
# OPTIONS
* The [[git-annex-common-options]](1) can be used.
# SEE ALSO
[[git-annex]](1)

4
doc/git-annex-trust.mdwn
View file

@ -21,6 +21,10 @@ and so the drop proceeds. Then `git-annex drop` is run on repository B,
which trusts A to still contain the content, so the drop succeeds. Now
the content has been lost.
# OPTIONS
* The [[git-annex-common-options]](1) can be used.
# SEE ALSO
[[git-annex]](1)

2
doc/git-annex-unannex.mdwn
View file

@ -33,6 +33,8 @@ case you should use `git annex drop` instead, and you can also
The [[git-annex-matching-options]](1)
can be used to specify files to unannex.
* Also the [[git-annex-common-options]](1) can be used.
# SEE ALSO
[[git-annex]](1)

4
doc/git-annex-undo.mdwn
View file

@ -22,6 +22,10 @@ undo command.
Note that this does not undo get/drop of a file's content; it only
operates on the file tree committed to git.
# OPTIONS
* The [[git-annex-common-options]](1) can be used.
# SEE ALSO
[[git-annex]](1)

4
doc/git-annex-ungroup.mdwn
View file

@ -10,6 +10,10 @@ git annex ungroup `repository groupname`
Removes a repository from a group.
# OPTIONS
* The [[git-annex-common-options]](1) can be used.
# SEE ALSO
[[git-annex]](1)

4
doc/git-annex-uninit.mdwn
View file

@ -12,6 +12,10 @@ Use this to stop using git annex. It will unannex every file in the
repository, and remove all of git-annex's other data, leaving you with a
git repository plus the previously annexed files.
# OPTIONS
* The [[git-annex-common-options]](1) can be used.
# SEE ALSO
[[git-annex]](1)

2
doc/git-annex-unlock.mdwn
View file

@ -60,6 +60,8 @@ repository. So, enable annex.thin with care.
Messages that would normally be output to standard error are included in
the json instead.
* Also the [[git-annex-common-options]](1) can be used.
# SEE ALSO
[[git-annex]](1)

2
doc/git-annex-unregisterurl.mdwn
View file

@ -26,6 +26,8 @@ as being present in the web special remote.
When in batch mode, the input is delimited by nulls instead of the usual
newlines.
* Also the [[git-annex-common-options]](1) can be used.
# SEE ALSO
[[git-annex]](1)

4
doc/git-annex-untrust.mdwn
View file

@ -14,6 +14,10 @@ at any time.
Repositories can be specified using their remote name, their
description, or their UUID. To untrust the current repository, use "here".
# OPTIONS
* The [[git-annex-common-options]](1) can be used.
# SEE ALSO
[[git-annex]](1)

2
doc/git-annex-unused.mdwn
View file

@ -42,6 +42,8 @@ For example, to move all unused data to origin:
The git configuration annex.used-refspec can be used to configure
this in a more permanent fashion.
* Also the [[git-annex-common-options]](1) can be used.
# REFSPEC FORMAT
The refspec format for --used-refspec is a colon-separated list of

2
doc/git-annex-upgrade.mdwn
View file

@ -31,6 +31,8 @@ allow archives to be taken offline for years and later used.
Only do whatever automatic upgrade can be done, don't necessarily
upgrade to the latest version. This is used internally by git-annex.
* Also the [[git-annex-common-options]](1) can be used.
# SEE ALSO
[[git-annex]](1)

4
doc/git-annex-vadd.mdwn
View file

@ -17,6 +17,10 @@ change it to year/author/tag.
So will `vadd year=2014 year=2013`, but limiting the years in view
to only those two.
# OPTIONS
* The [[git-annex-common-options]](1) can be used.
# SEE ALSO
[[git-annex]](1)

4
doc/git-annex-vcycle.mdwn
View file

@ -13,6 +13,10 @@ When a view involves nested subdirectories, this cycles the order.
For example, when the view is by year/author/tag, `vcycle` will switch
it to author/tag/year.
# OPTIONS
* The [[git-annex-common-options]](1) can be used.
# SEE ALSO
[[git-annex]](1)

2
doc/git-annex-version.mdwn
View file

@ -25,6 +25,8 @@ built. Therefore, "5.20150320-gdd35cf3" is a daily build, and
Causes only git-annex's version to be output, and nothing else.
* Also the [[git-annex-common-options]](1) can be used.
# SEE ALSO
[[git-annex]](1)

4
doc/git-annex-vfilter.mdwn
View file

@ -11,6 +11,10 @@ git annex vfilter `[tag ...] [field=value ...] [!tag ...] [field!=value ...]`
Filters the current view to only the files that have the
specified field values and tags.
# OPTIONS
* The [[git-annex-common-options]](1) can be used.
# SEE ALSO
[[git-annex]](1)

4
doc/git-annex-vicfg.mdwn
View file

@ -15,6 +15,10 @@ and when it exits, stores any changes made back to the git-annex branch.
Unlike git config settings, these configuration settings can be seen
by all clones of the repository.
# OPTIONS
* The [[git-annex-common-options]](1) can be used.
# SEE ALSO
[[git-annex]](1)

4
doc/git-annex-view.mdwn
View file

@ -36,6 +36,10 @@ field or tag, specify field!=value or !tag. Globs can also be used here,
so `field!="*"` will enter a view containing only files that do not have
the field set to any value.
# OPTIONS
* The [[git-annex-common-options]](1) can be used.
# SEE ALSO
[[git-annex]](1)

4
doc/git-annex-vpop.mdwn
View file

@ -13,6 +13,10 @@ Or, from the first view back to original branch.
The optional number tells how many views to pop.
# OPTIONS
* The [[git-annex-common-options]](1) can be used.
# SEE ALSO
[[git-annex]](1)

4
doc/git-annex-wanted.mdwn
View file

@ -18,6 +18,10 @@ For example:
Without an expression, displays the current preferred content setting
of the repository.
# OPTIONS
* The [[git-annex-common-options]](1) can be used.
# SEE ALSO
[[git-annex]](1)

2
doc/git-annex-watch.mdwn
View file

@ -32,6 +32,8 @@ files that it does not match will instead be added with `git add`.
Stop a running daemon in the current repository.
* Also the [[git-annex-common-options]](1) can be used.
# SEE ALSO
[[git-annex]](1)

2
doc/git-annex-webapp.mdwn
View file

@ -28,6 +28,8 @@ it opens a browser window.
Set annex.listen in the git config to make the webapp always
listen on an address.
* Also the [[git-annex-common-options]](1) can be used.
# USING HTTPS
When using the webapp on a remote computer, you'll almost certainly

2
doc/git-annex-whereis.mdwn
View file

@ -97,6 +97,8 @@ received from remotes.
The same applies when the url variable is used and a file has multiple
recorded urls.
* Also the [[git-annex-common-options]](1) can be used.
# SEE ALSO
[[git-annex]](1)

120
doc/git-annex.mdwn
View file

@ -753,126 +753,6 @@ In addition to all the commands listed above, more commands can be added to
git-annex by dropping commands named like "git-annex-foo" into a directory
in the PATH.
# COMMON OPTIONS
These common options are accepted by all git-annex commands, and
may not be explicitly listed on their individual man pages.
(Many commands also accept the [[git-annex-matching-options]](1).)
* `--force`
Force unsafe actions, such as dropping a file's content when no other
source of it can be verified to still exist, or adding ignored files.
Use with care.
* `--fast`
Enable less expensive, but also less thorough versions of some commands.
What is avoided depends on the command.
* `--quiet`
Avoid the default verbose display of what is done; only show errors.
* `--verbose`
Enable verbose display.
* `--debug`
Display debug messages.
* `--no-debug`
Disable display of debug messages.
* `--debugfilter=name[,name..]`
When debug message display has been enabled by `--debug`, this filters
the debug messages that are displayed to ones coming from modules with
the specified names.
To find the names of modules, see the full debug output, which includes
the module name, eg "(Utility.Process)"
The full module name does not need to be
specified when using this, a substring of the name will do.
For example, `--debugfilter=Process,External` will display debugging
output when git-annex runs processes, and when it communicates with
external special remotes.
* `--numcopies=n`
Overrides the numcopies setting.
Note that setting numcopies to 0 is very unsafe.
* `--mincopies=n`
Overrides the mincopies setting.
Note that setting mincopies to 0 is very unsafe.
* `--time-limit=time`
Limits how long a git-annex command runs. The time can be something
like "5h", or "30m" or even "45s" or "10d".
Note that git-annex may continue running a little past the specified
time limit, in order to finish processing a file.
Also, note that if the time limit prevents git-annex from doing all it
was asked to, it will exit with a special code, 101.
* `--semitrust=repository`
* `--untrust=repository`
Overrides trust settings for a repository. May be specified more than once.
The repository should be specified using the name of a configured remote,
or the UUID or description of a repository.
* `--trust=repository`
This used to override trust settings for a repository, but now will
not do so, because trusting a repository can lead to data loss,
and data loss is now only enabled when using the `--force` option.
* `--trust-glacier`
This used to override trust settings for Glacier special remotes,
but now will not do so, because it could lead to data loss,
and data loss is now only enabled when using the `--force` option.
* `--backend=name`
Specifies which key-value backend to use. This can be used when
adding a file to the annex, or migrating a file. Once files
are in the annex, their backend is known and this option is not
necessary.
* `--user-agent=value`
Overrides the User-Agent to use when downloading files from the web.
* `--notify-finish`
Caused a desktop notification to be displayed after each successful
file download and upload.
(Only supported on some platforms, e.g. Linux with dbus. A no-op when
not supported.)
* `--notify-start`
Caused a desktop notification to be displayed when a file upload
or download has started, or when a file is dropped.
* `-c name=value`
Overrides git configuration settings. May be specified multiple times.
# CONFIGURATION
Like other git commands, git-annex is configured via `.git/config`.

2
doc/todo/fsck_option_to_only_show_broken.mdwn
View file

@ -3,3 +3,5 @@
A simple solution to this could be an fsck option which skips printing ok'd (and perhaps also dead) keys, i.e. `--no-ok` and `--no-dead`.
[[!meta title="mention common options on per-command man pages"]]
> common option man page and references [[done]] --[[Joey]]