git-annex/doc/git-annex-lock.mdwn
Joey Hess b184fc490a
split out common options to its own page and mention it on each subcommand page
Sometimes users would get confused because an option they were looking
for was not mentioned on a subcommand's man page, and they had not
noticed that the main git-annex man page had a list of common options.
This change lets each subcommand mention the common options, similarly
to how the matching options are handled.

This commit was sponsored by Svenne Krap on Patreon.
2021-05-10 15:00:13 -04:00

50 lines
1 KiB
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.
* Also the [[git-annex-common-options]](1) can be used.
# 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.