1git-annex-drop(1) General Commands Manual git-annex-drop(1)
2#a NAME
6 git-annex drop - remove content of files from repository
8
10 git annex drop [path ...]
11
13 Drops the content of annexed files from this repository, when possible.
14 git-annex will refuse to drop content if it cannot verify it is safe to
16 do so. Usually this involves verifying that the content is stored in
17 some other repository.
18 Content that is required to be stored in the repository will not be
20 dropped even if enough copies exist elsewhere. See git-annex-re‐
21 quired(1).
22 With no parameters, tries to drop all annexed files in the current di‐
24 rectory. Paths of files or directories to drop can be specified.
25
27 # git annex drop *.jpeg
28 drop photo1.jpg (checking origin...) ok
29 drop photo2.jpg (unsafe)
30 Could only verify the existence of 0 out of 1 necessary copies
31 Rather than dropping this file, try using: git annex move
33 (Use --force to override this check, or adjust numcopies.)
35 failed
36 drop photo3.jpg (checking origin...) ok
37
39 --from=remote
40 Rather than dropping the content of files in the local reposi‐
42 tory, this option can specify a remote from which the files'
43 contents should be removed.
44 --auto Rather than trying to drop all specified files, drop only those
46 that are not preferred content of the repository. See git-an‐
47 nex-preferred-content(1)
48 --force
50 Use this option with care! It bypasses safety checks, and forces
51 git-annex to delete the content of the specified files, even
52 from the last repository that is storing their content. Data
53 loss can result from using this option.
54 --all -A
56 Rather than specifying a filename or path to drop, this option
57 can be used to drop all available versions of all files.
58 This is the default behavior when running git-annex drop in a
60 bare repository.
61 Note that this bypasses checking the .gitattributes annex.num‐
63 copies setting and required content settings.
64 --branch=ref
66 Drop files in the specified branch or treeish.
67 Note that this bypasses checking the .gitattributes annex.num‐
69 copies setting and required content settings.
70 --unused
72 Drop files found by last run of git-annex unused.
73 Note that this bypasses checking the .gitattributes annex.num‐
75 copies setting and required content settings.
76 --key=keyname
78 Use this option to drop a specified key.
79 Note that this bypasses checking the .gitattributes annex.num‐
81 copies setting and required content settings.
82 matching options
84 The git-annex-matching-options(1) can be used to specify what to
85 drop.
86 --jobs=N -JN
88 Runs multiple drop jobs in parallel. This is particularly useful
89 when git-annex has to contact remotes to check if it can drop
90 files. For example: -J4
91 Setting this to "cpus" will run one job per CPU core.
93 --batch
95 Enables batch mode, in which lines containing names of files to
96 drop are read from stdin.
97 As each specified file is processed, the usual output is dis‐
99 played. If a file's content is not present, or it does not match
100 specified matching options, or it is not an annexed file, a
101 blank line is output in response instead.
102 --batch-keys
104 This is like --batch but the lines read from stdin are parsed as
105 keys.
106 Note that this bypasses checking the .gitattributes annex.num‐
108 copies setting and required content settings.
109 -z Makes the batch input be delimited by nulls instead of the usual
111 newlines.
112 --json Enable JSON output. This is intended to be parsed by programs
114 that use git-annex. Each line of output is a JSON object.
115 --json-error-messages
117 Messages that would normally be output to standard error are in‐
118 cluded in the json instead.
119 Also the git-annex-common-options(1) can be used.
121
123 git-annex(1)
124 git-annex-get(1)
126 git-annex-move(1)
128 git-annex-copy(1)
130
132 Joey Hess <id@joeyh.name>
133 git-annex-drop(1)