git-annex/doc/git-annex-lock.mdwn

# NAME

git-annex lock - lock files to prevent modification

# SYNOPSIS

git annex lock `[path ...]`

# DESCRIPTION

Lock the specified annexed files, to prevent them from being modified.
When no files are specified, all annexed files in the current directory are
locked.

Locking a file changes how it is stored in the git repository (from a
pointer file to a symlink), so this command will make a change that you
can commit.

# OPTIONS

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

* `--json`

  Enable JSON output. This is intended to be parsed by programs that use
  git-annex. Each line of output is a JSON object.

* `--json-error-messages`

  Messages that would normally be output to standard error are included in
  the json instead.

# SEE ALSO

[[git-annex]](1)

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

[[git-annex-unlock]](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`

man pages improvements Added some examples. Tightened up some language and removed some unncessary duplicate documentaton. 2020-05-12 13:07:45 +00:00			`git-annex lock - lock files to prevent modification`
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
			`# SYNOPSIS`

			git annex lock `[path ...]`

			`# DESCRIPTION`

man pages improvements Added some examples. Tightened up some language and removed some unncessary duplicate documentaton. 2020-05-12 13:07:45 +00:00			`Lock the specified annexed files, to prevent them from being modified.`
			`When no files are specified, all annexed files in the current directory are`
			`locked.`

			`Locking a file changes how it is stored in the git repository (from a`
			`pointer file to a symlink), so this command will make a change that you`
			`can commit.`
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 lock.`

unlock, lock: Support --json. 2017-10-30 18:44:11 +00:00			* `--json`

			`Enable JSON output. This is intended to be parsed by programs that use`
			`git-annex. Each line of output is a JSON object.`

add --json-error-messages (not yet implemented) Added --json-error-messages option, which includes error messages in the json output, rather than outputting them to stderr. The actual rediretion of errors is not implemented yet, this is only the docs and option plumbing. This commit was supported by the NSF-funded DataLad project. 2018-02-19 18:28:17 +00:00			* `--json-error-messages`

better doc for --json-error-messages Word so warnings can be included, not only errors. 2018-02-19 19:33:59 +00:00			`Messages that would normally be output to standard error are included in`
			`the json instead.`
add --json-error-messages (not yet implemented) Added --json-error-messages option, which includes error messages in the json output, rather than outputting them to stderr. The actual rediretion of errors is not implemented yet, this is only the docs and option plumbing. This commit was supported by the NSF-funded DataLad project. 2018-02-19 18:28:17 +00:00
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			`# 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-add]](1)`

			`[[git-annex-unlock]](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.`