git-annex/doc/git-annex-lock.mdwn
Joey Hess 959ae7733a
man pages improvements
Added some examples. Tightened up some language and removed some
unncessary duplicate documentaton.
2020-05-12 09:07:45 -04:00

48 lines
998 B
Markdown

# 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.