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. When no  files  are
14       specified, all annexed files in the current directory are unlocked.
15
16       Unlocking a file changes how it is stored in the git repository (from a
17       symlink to a pointer file), so this command will make a change that you
18       can commit.
19
20       The  content of an unlocked file is still stored in git-annex, not git,
21       and when you commit modifications to the file, the  modifications  will
22       also be stored in git-annex, with only the pointer file stored in git.
23
24       If  you use git add to add a file to the annex, it will be added in un‐
25       locked form from the beginning. This  allows  workflows  where  a  file
26       starts  out  unlocked,  is modified as necessary, and is locked once it
27       reaches its final version.
28
29       Normally, unlocking a file requires a copy to be made of  its  content,
30       so  that its original content is preserved, while the copy can be modi‐
31       fied. To use less space, annex.thin can be set to true;  this  makes  a
32       hard  link  to  the  content be made instead of a copy. (Only when sup‐
33       ported by the file system.)  While  this  can  save  considerable  disk
34       space,  any  modification  made to a file will cause the old version of
35       the file to be lost from the local repository.  So,  enable  annex.thin
36       with care.
37

EXAMPLES

39        # git annex unlock disk-image
40        # git commit -m "unlocked to allow VM to make changes as it runs"
41
42        # git annex unlock photo.jpg
43        # gimp photo.jpg
44        # git annex add photo.jpg
45        # git annex lock photo.jpg
46        # git commit -m "redeye removal"
47

OPTIONS

49       file matching options
50
51              The  git-annex-matching-options(1)  can be used to specify files
52              to unlock.
53
54       --json Enable JSON output. This is intended to be  parsed  by  programs
55              that use git-annex. Each line of output is a JSON object.
56
57       --json-error-messages
58              Messages that would normally be output to standard error are in‐
59              cluded in the JSON instead.
60
61       Also the git-annex-common-options(1) can be used.
62

SEE ALSO

64       git-annex(1)
65
66       git-annex-edit(1)
67
68       git-annex-add(1)
69
70       git-annex-lock(1)
71

AUTHOR

73       Joey Hess <id@joeyh.name>
74
75                                                           git-annex-unlock(1)
Impressum