1d1054faa6
Added -z option to git-annex commands that use --batch, useful for supporting filenames containing newlines. It only controls input to --batch, the output will still be line delimited unless --json or etc is used to get some other output. While git often makes -z affect both input and output, I don't like trying them together, and making it affect output would have been a significant complication, and also git-annex output is generally not intended to be machine parsed, unless using --json or a format option. Commands that take pairs like "file key" still separate them with a space in --batch mode. All such commands take care to support filenames with spaces when parsing that, so there was no need to change it, and it would have needed significant changes to the batch machinery to separate tose with a null. To make fromkey and registerurl support -z, I had to give them a --batch option. The implicit batch mode they enter when not provided with input parameters does not support -z as that would have complicated option parsing. Seemed better to move these toward using the same --batch as everything else, though the implicit batch mode can still be used. This commit was sponsored by Ole-Morten Duesund on Patreon.
119 lines
2.8 KiB
Markdown
119 lines
2.8 KiB
Markdown
# NAME
|
|
|
|
git-annex drop - remove content of files from repository
|
|
|
|
# SYNOPSIS
|
|
|
|
git annex drop `[path ...]`
|
|
|
|
# DESCRIPTION
|
|
|
|
Drops the content of annexed files from this repository, when
|
|
possible.
|
|
|
|
git-annex will refuse to drop content if it cannot verify it is
|
|
safe to do so.
|
|
|
|
# OPTIONS
|
|
|
|
* `--from=remote`
|
|
|
|
Rather than dropping the content of files in the local repository,
|
|
this option can specify a remote from which the files'
|
|
contents should be removed.
|
|
|
|
* `--auto`
|
|
|
|
Rather than trying to drop all specified files, drop only files that
|
|
are not preferred content of the repository.
|
|
See [[git-annex-preferred-content]](1)
|
|
|
|
* `--force`
|
|
|
|
Use this option with care! It bypasses safety checks, and forces
|
|
git-annex to delete the content of the specified files, even from
|
|
the last repository that is storing their content. Data loss can
|
|
result from using this option.
|
|
|
|
* `--all` `-A`
|
|
|
|
Rather than specifying a filename or path to drop, this option can be
|
|
used to drop all available versions of all files.
|
|
|
|
This is the default behavior when running git-annex drop in a bare repository.
|
|
|
|
Note that this bypasses checking the .gitattributes annex.numcopies
|
|
setting.
|
|
|
|
* `--branch=ref`
|
|
|
|
Drop files in the specified branch or treeish.
|
|
|
|
Note that this bypasses checking the .gitattributes annex.numcopies
|
|
setting.
|
|
|
|
* `--unused`
|
|
|
|
Drop files found by last run of git-annex unused.
|
|
|
|
Note that this bypasses checking the .gitattributes annex.numcopies
|
|
setting.
|
|
|
|
* `--key=keyname`
|
|
|
|
Use this option to drop a specified key.
|
|
|
|
Note that this bypasses checking the .gitattributes annex.numcopies
|
|
setting.
|
|
|
|
* file matching options
|
|
|
|
The [[git-annex-matching-options]](1)
|
|
can be used to specify files to drop.
|
|
|
|
* `--jobs=N` `-JN`
|
|
|
|
Runs multiple drop jobs in parallel. This is particularly useful
|
|
when git-annex has to contact remotes to check if it can drop files.
|
|
For example: `-J4`
|
|
|
|
* `--batch`
|
|
|
|
Enables batch mode, in which lines containing names of files to drop
|
|
are read from stdin.
|
|
|
|
As each specified file is processed, the usual output is
|
|
displayed. If a file's content is not present, or it does not
|
|
match specified matching options, or it is not an annexed file,
|
|
a blank line is output in response instead.
|
|
|
|
* `-z`
|
|
|
|
Makes the `--batch` input be delimited by nulls instead of the usual
|
|
newlines.
|
|
|
|
* `--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.
|
|
|
|
# SEE ALSO
|
|
|
|
[[git-annex]](1)
|
|
|
|
[[git-annex-get]](1)
|
|
|
|
[[git-annex-move]](1)
|
|
|
|
[[git-annex-copy]](1)
|
|
|
|
# AUTHOR
|
|
|
|
Joey Hess <id@joeyh.name>
|
|
|
|
Warning: Automatically converted into a man page by mdwn2man. Edit with care.
|