git-annex/doc/git-annex-registerurl.mdwn
Joey Hess 2b940f7725
registerurl, unregisterurl: Added --remote option
This serves two purposes. --remote=web bypasses other special remotes that
claim the url, same as addurl --raw. And, specifying some other remote
allows making sure that an url is claimed by the remote you expect,
which makes then using setpresentkey not be fragile.

Sponsored-By: the NIH-funded NICEMAN (ReproNim TR&D3) project
2023-04-05 15:54:41 -04:00

75 lines
1.9 KiB
Markdown

# NAME
git-annex registerurl - registers an url for a key
# SYNOPSIS
git annex registerurl `[key url]`
# DESCRIPTION
This plumbing-level command can be used to register urls where a
key can be downloaded from.
No verification is performed of the url's contents.
Normally the key is a git-annex formatted key. However, to make it easier
to use this to add urls, if the key cannot be parsed as a key, and is a
valid url, an URL key is constructed from the url.
Registering an url makes content be treated as being present in the web
special remote, unless some other special remote claims the url.
# OPTIONS
* `--remote=name|uuid`
Indicate that the url is expected to be claimed by the specified remote.
If some other remote claims the url instead, registering it will fail.
Note that `--remote=web` will prevent any other remote from claiming
the url.
* `--batch`
In batch input mode, lines are read from stdin, and each line
should contain a key and url, separated by a single space.
For backwards compatability with old git-annex before this option
was added, when no key and url pair are specified on the command line,
batch input is used, the same as if the --batch option were
specified. It is however recommended to use --batch.
* `-z`
When in batch mode, the input is delimited by nulls instead of the usual
newlines.
(Note that for this to be used, you have to explicitly enable batch mode
with `--batch`)
* `--json`
Enable JSON output. This is intended to be parsed by programs that use
git-annex. Each line of output is a JSON object.
* `--json-error-messages`
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)
[[git-annex-addurl]](1)
[[git-annex-unregisterurl]](1)
# AUTHOR
Joey Hess <id@joeyh.name>
Warning: Automatically converted into a man page by mdwn2man. Edit with care.