git-annex/doc/git-annex-status.mdwn
Joey Hess 84a74b80ee
better doc for --json-error-messages
Word so warnings can be included, not only errors.
2018-02-19 15:33:59 -04:00

46 lines
924 B
Markdown

# NAME
git-annex status - show the working tree status
# SYNOPSIS
git annex status `[path ...]`
# DESCRIPTION
Similar to `git status --short`, this command displays the status of the files
in the working tree.
Show files that are not checked into git (?), deleted (D),
modified (M), added but not committed (A), and type changed/unlocked (T).
Particularly useful in direct mode.
# OPTIONS
* `--ignore-submodules=when`
This option is passed on to git status, see its man page for
details.
* `--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-status(1)
# AUTHOR
Joey Hess <id@joeyh.name>
Warning: Automatically converted into a man page by mdwn2man. Edit with care.