Documentation/git-runstatus.txt

   1 git-runstatus(1)
   2 ================
   3
   4 NAME
   5 ----
   6 git-runstatus - A helper for git-status and git-commit
   7
   8
   9 SYNOPSIS
  10 --------
  11 'git-runstatus' [--color|--nocolor] [--amend] [--verbose] [--untracked]
  12
  13
  14 DESCRIPTION
  15 -----------
  16 Examines paths in the working tree that has changes unrecorded
  17 to the index file, and changes between the index file and the
  18 current HEAD commit.  The former paths are what you _could_
  19 commit by running 'git-update-index' before running 'git
  20 commit', and the latter paths are what you _would_ commit by
  21 running 'git commit'.
  22
  23 If there is no path that is different between the index file and
  24 the current HEAD commit, the command exits with non-zero status.
  25
  26 Note that this is _not_ the user level command you would want to
  27 run from the command line.  Use 'git-status' instead.
  28
  29
  30 OPTIONS
  31 -------
  32 --color::
  33         Show colored status, highlighting modified file names.
  34
  35 --nocolor::
  36         Turn off coloring.
  37
  38 --amend::
  39         Show status based on HEAD^1, not HEAD, i.e. show what
  40         'git-commit --amend' would do.
  41
  42 --verbose::
  43         Show unified diff of all file changes.
  44
  45 --untracked::
  46         Show files in untracked directories, too.  Without this
  47         option only its name and a trailing slash are displayed
  48         for each untracked directory.
  49
  50
  51 OUTPUT
  52 ------
  53 The output from this command is designed to be used as a commit
  54 template comments, and all the output lines are prefixed with '#'.
  55
  56
  57 Author
  58 ------
  59 Originally written by Linus Torvalds <torvalds@osdl.org> as part
  60 of git-commit, and later rewritten in C by Jeff King.
  61
  62 Documentation
  63 --------------
  64 Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.
  65
  66 GIT
  67 ---
  68 Part of the gitlink:git[7] suite
  69