1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
|
# NAME
git-annex - manage files with git, without checking their contents in
# SYNOPSIS
git annex subcommand [params ...]
# DESCRIPTION
git-annex allows managing files with git, without checking the file
contents into git. While that may seem paradoxical, it is useful when
dealing with files larger than git can currently easily handle, whether due
to limitations in memory, checksumming time, or disk space.
Even without file content tracking, being able to manage files with git,
move files around and delete files with versioned directory trees, and use
branches and distributed clones, are all very handy reasons to use git. And
annexed files can co-exist in the same git repository with regularly
versioned files, which is convenient for maintaining documents, Makefiles,
etc that are associated with annexed files but that benefit from full
revision control.
When a file is annexed, its content is moved into a key-value store, and
a symlink is made that points to the content. These symlinks are checked into
git and versioned like regular files. You can move them around, delete
them, and so on. Pushing to another git repository will make git-annex
there aware of the annexed file, and it can be used to retrieve its
content from the key-value store.
# EXAMPLES
# git annex get video/hackity_hack_and_kaxxt.mov
get video/_why_hackity_hack_and_kaxxt.mov (not available)
I was unable to access these remotes: server
Try making some of these repositories available:
5863d8c0-d9a9-11df-adb2-af51e6559a49 -- my home file server
58d84e8a-d9ae-11df-a1aa-ab9aa8c00826 -- portable USB drive
ca20064c-dbb5-11df-b2fe-002170d25c55 -- backup SATA drive
failed
# sudo mount /media/usb
# git remote add usbdrive /media/usb
# git annex get video/hackity_hack_and_kaxxt.mov
get video/hackity_hack_and_kaxxt.mov (copying from usbdrive...) ok
# git commit -a -m "got a video I want to rewatch on the plane"
# git annex add iso
add iso/Debian_5.0.iso ok
# git commit -a -m "saving Debian CD for later"
# git annex drop iso/Debian_4.0.iso
drop iso/Debian_4.0.iso ok
# git commit -a -m "freed up space"
# git annex move iso --to=usbdrive
move iso/Debian_5.0.iso (moving to usbdrive...) ok
# SUBCOMMANDS
Like many git commands, git-annex can be passed a path that
is either a file or a directory. In the latter case it acts on all relevant
files in the directory.
Many git-annex subcommands will stage changes for later `git commit` by you.
* add [path ...]
Adds files in the path to the annex. Files that are already checked into
git, or that git has been configured to ignore will be silently skipped.
* get [path ...]
Makes the content of annexed files available in this repository. Depending
on the backend used, this will involve copying them from another repository,
or downloading them, or transferring them from some kind of key-value store.
* drop [path ...]
Drops the content of annexed files from this repository.
git-annex may refuse to drop content if the backend does not think
it is safe to do so, typically because of the setting of annex.numcopies.
* move [path ...]
When used with the --to option, moves the content of annexed files from
the current repository to the specified one.
When used with the --from option, moves the content of annexed files
from the specified repository to the current one.
* init description
Initializes git-annex with a description of the git repository,
and sets up `.gitattributes` and the pre-commit hook.
This is an optional, but recommended step.
* unannex [path ...]
Use this to undo an accidental add command. This is not the command you
should use if you intentionally annexed a file and don't want its contents
any more. In that case you should use `git annex drop` instead, and you
can also `git rm` the file.
* fix [path ...]
Fixes up symlinks that have become broken to again point to annexed content.
This is useful to run if you have been moving the symlinks around.
* pre-commit [path ...]
Fixes up symlinks that are staged as part of a commit, to ensure they
point to annexed content.
This is meant to be called from git's pre-commit hook. `git annex init`
automatically creates a pre-commit hook using this.
* fromkey file
This can be used to maually set up a file to link to a specified key
in the key-value backend. How you determine an existing key in the backend
varies. For the URL backend, the key is just a URL to the content.
Example:
git annex fromkey --backend=URL --key=http://www.archive.org/somefile somefile
* dropkey [key ...]
Drops the annexed data for the specified keys from this repository.
This can be used to drop content for arbitrary keys, which do not need
to have a file in the git repository pointing at them.
* setkey file
Sets the annxed data for a key to the content of the specified file,
and then removes the file.
Example:
git annex setkey --key=1287765018:3 /tmp/file
# OPTIONS
* --force
Force unsafe actions, such as dropping a file's content when no other
source of it can be verified to still exist. Use with care.
* --quiet
Avoid the default verbose logging of what is done; only show errors
and progress displays.
* --verbose
Enable verbose logging.
* --backend=name
Specify the default key-value backend to use, adding it to the front
of the list normally configured by `annex.backends`.
* --key=name
Specifies a key to operate on, for use with the addkey subcommand.
* --from=repository
Specifies a repository that content will be retrieved from.
It should be specified using the name of a configured git remote.
* --to=repository
Specifies a git repository that content will be sent to.
It should be specified using the name of a configured git remote.
# CONFIGURATION
Like other git commands, git-annex is configured via `git-config`.
Here are all the supported configuration settings.
* `annex.uuid` -- a unique UUID for this repository (automatically set)
* `annex.numcopies` -- number of copies of files to keep across all
repositories (default: 1)
* `annex.backends` -- space-separated list of names of
the key-value backends to use. The first listed is used to store
new files. (default: "WORM SHA1 URL")
* `remote.<name>.annex-cost` -- When determining which repository to
transfer annexed files from or to, ones with lower costs are preferred.
The default cost is 100 for local repositories, and 200 for remote
repositories.
* `remote.<name>.annex-ignore` -- If set to `true`, prevents git-annex
from ever using this remote.
* `remote.<name>.annex-uuid` -- git-annex caches UUIDs of repositories
here.
* `remote.<name>.annex-scp-options` -- Options to use when using scp
to or from this repository. For example, to force ipv6, and limit
the bandwidth to 100Kbit/s, set it to "-6 -l 100"
* `remote.<name>.annex-ssh-options` -- Options to use when using ssh
to talk to this repository.
* `annex.scp-options` and `annex.ssh-options` -- Default scp and ssh
options to use if a remote does not have specific options.
# FILES
These files are used, in your git repository:
`.git/annex/` contains the annexed file contents that are currently
available. Annexed files in your git repository symlink to that content.
`.git-annex/uuid.log` is used to map between repository UUID and
decscriptions. You may edit it.
`.git-annex/*.log` is where git-annex records its content tracking
information. These files should be committed to git.
`.gitattributes` is configured to use git's union merge driver
to avoid conflicts when merging files in the `.git-annex` directory.
# SEE ALSO
Most of git-annex's documentation is available on its web site,
<http://git-annex.branchable.com/>
If git-annex is installed from a package, a copy of its documentation
should be included, in, for example, `/usr/share/doc/git-annex/`
# AUTHOR
Joey Hess <joey@ikiwiki.info>
<http://git-annex.branchable.com/>
Warning: this page is automatically made into a man page via [mdwn2man](http://git.ikiwiki.info/?p=ikiwiki;a=blob;f=mdwn2man;hb=HEAD). Edit with care
|
