git-annex/doc/git-annex-unlock.mdwn

# NAME

git-annex unlock - unlock files for modification

# SYNOPSIS

git annex unlock `[path ...]`

# DESCRIPTION

Normally, the content of annexed files is protected from being changed.
Unlocking an annexed file allows it to be modified. This replaces the
symlink for each specified file with a copy of the file's content.
You can then modify it and `git annex add` (or `git commit`) to save your
changes.

In repositories with annex.version 5 or earlier, unlocking a file is local
to the repository, and is temporary. With version 6, unlocking a file
changes how it is stored in the git repository (from a symlink to a pointer
file), so you can commit it like any other change. Also in version 6, you
can use `git add` to add a fie to the annex in unlocked form. This allows
workflows where a file starts out unlocked, is modified as necessary, and
is locked once it reaches its final version.

# OPTIONS

* file matching options
 
  The [[git-annex-matching-options]](1)
  can be used to specify files to unlock.

# SEE ALSO

[[git-annex]](1)

[[git-annex-edit]](1)

[[git-annex-add]](1)

[[git-annex-lock]](1)

# AUTHOR

Joey Hess <id@joeyh.name>

Warning: Automatically converted into a man page by mdwn2man. Edit with care.
splitting up the man page Common command man pages all split out and often expanded. A few sections split out into their own pages. Still need to do all the other commands.. 2015-03-23 19:36:10 +00:00			`# NAME`

			`git-annex unlock - unlock files for modification`

			`# SYNOPSIS`

			git annex unlock `[path ...]`

			`# DESCRIPTION`

			`Normally, the content of annexed files is protected from being changed.`
			`Unlocking an annexed file allows it to be modified. This replaces the`
			`symlink for each specified file with a copy of the file's content.`
v6 git-annex unlock Note that the implementation uses replaceFile, so that the actual replacement of the work tree file is atomic. This seems a good property to have! It would be possible for unlock in v6 mode to be run on files that do not have their content present. However, that would be a behavior change from before, and I don't see any immediate need to support it, so I didn't implement it. 2015-12-10 20:12:05 +00:00			You can then modify it and `git annex add` (or `git commit`) to save your
			`changes.`

			`In repositories with annex.version 5 or earlier, unlocking a file is local`
			`to the repository, and is temporary. With version 6, unlocking a file`
			`changes how it is stored in the git repository (from a symlink to a pointer`
			`file), so you can commit it like any other change. Also in version 6, you`
			can use `git add` to add a fie to the annex in unlocked form. This allows
			`workflows where a file starts out unlocked, is modified as necessary, and`
			`is locked once it reaches its final version.`
splitting up the man page Common command man pages all split out and often expanded. A few sections split out into their own pages. Still need to do all the other commands.. 2015-03-23 19:36:10 +00:00
			`# OPTIONS`

			`* file matching options`

			`The [[git-annex-matching-options]](1)`
			`can be used to specify files to unlock.`

			`# SEE ALSO`

			`[[git-annex]](1)`

expand manpages cross-references significantly i found that most man pages only had references to the main git-annex manpage, which i stillfind pretty huge and hard to navigate through. i tried to sift through all the man pages and add cross-references between relevant pages. my general rule of thumb is that links should be both ways unless one of the pages is a more general page that would become ridiculously huge if all backlinks would be added (git-annex-preferred-content comes to mind). i have also make the links one per line as this is how it was done in the metadata pages so far. i did everything but the plumbing, utility and test commands, although some of those are linked from the other commands so cross-links were added there as well. 2015-05-29 16:12:55 +00:00			`[[git-annex-edit]](1)`

			`[[git-annex-add]](1)`

			`[[git-annex-lock]](1)`

splitting up the man page Common command man pages all split out and often expanded. A few sections split out into their own pages. Still need to do all the other commands.. 2015-03-23 19:36:10 +00:00			`# AUTHOR`

			`Joey Hess <id@joeyh.name>`

			`Warning: Automatically converted into a man page by mdwn2man. Edit with care.`