1git-annex-unlock(1)         General Commands Manual        git-annex-unlock(1)
2
3
4

NAME

6       git-annex-unlock - unlock files for modification
7

SYNOPSIS

9       git annex unlock [path ...]
10

DESCRIPTION

12       Normally, the content of annexed files is protected from being changed.
13       Unlocking an annexed file allows it to be modified. This  replaces  the
14       symlink  for each specified file with the file's content.  You can then
15       modify it and git annex add (or git commit) to save your changes.
16
17       In repositories with annex.version 5 or earlier, unlocking  a  file  is
18       local  to the repository, and is temporary. With version 6, unlocking a
19       file changes how it is stored in the git repository (from a symlink  to
20       a  pointer  file),  so you can commit it like any other change. Also in
21       version 6, you can use git add to add a file to the annex  in  unlocked
22       form.  This allows workflows where a file starts out unlocked, is modi‐
23       fied as necessary, and is locked once it reaches its final version.
24
25       Normally, unlocking a file requires a copy to be made of  its  content,
26       so  that its original content is preserved, while the copy can be modi‐
27       fied.  To use less space, annex.thin can be set to true; this  makes  a
28       hard  link  to  the  content be made instead of a copy. (Only when sup‐
29       ported by the file system, and only in  repository  version  6.)  While
30       this  can save considerable disk space, any modification made to a file
31       will cause the old version of the file to be lost from the local repos‐
32       itory. So, enable annex.thin with care.
33

OPTIONS

35       file matching options
36
37              The  git-annex-matching-options(1)  can be used to specify files
38              to unlock.
39
40       --json Enable JSON output. This is intended to be  parsed  by  programs
41              that use git-annex. Each line of output is a JSON object.
42
43       --json-error-messages
44              Messages  that  would  normally  be output to standard error are
45              included in the json instead.
46

SEE ALSO

48       git-annex(1)
49
50       git-annex-edit(1)
51
52       git-annex-add(1)
53
54       git-annex-lock(1)
55

AUTHOR

57       Joey Hess <id@joeyh.name>
58
59                                                           git-annex-unlock(1)
Impressum