i18n: grep: mark parseopt strings for translation
[git/jnareb-git.git] / Documentation / git-rev-parse.txt
1 git-rev-parse(1)
2 ================
5 ----
6 git-rev-parse - Pick out and massage parameters
10 --------
11 [verse]
12 'git rev-parse' [ --option ] <args>...
15 -----------
17 Many git porcelainish commands take mixture of flags
18 (i.e. parameters that begin with a dash '-') and parameters
19 meant for the underlying 'git rev-list' command they use internally
20 and flags and parameters for the other commands they use
21 downstream of 'git rev-list'.  This command is used to
22 distinguish between them.
26 -------
27 --parseopt::
28         Use 'git rev-parse' in option parsing mode (see PARSEOPT section below).
30 --keep-dashdash::
31         Only meaningful in `--parseopt` mode. Tells the option parser to echo
32         out the first `--` met instead of skipping it.
34 --stop-at-non-option::
35         Only meaningful in `--parseopt` mode.  Lets the option parser stop at
36         the first non-option argument.  This can be used to parse sub-commands
37         that take options themselves.
39 --sq-quote::
40         Use 'git rev-parse' in shell quoting mode (see SQ-QUOTE
41         section below). In contrast to the `--sq` option below, this
42         mode does only quoting. Nothing else is done to command input.
44 --revs-only::
45         Do not output flags and parameters not meant for
46         'git rev-list' command.
48 --no-revs::
49         Do not output flags and parameters meant for
50         'git rev-list' command.
52 --flags::
53         Do not output non-flag parameters.
55 --no-flags::
56         Do not output flag parameters.
58 --default <arg>::
59         If there is no parameter given by the user, use `<arg>`
60         instead.
62 --verify::
63         The parameter given must be usable as a single, valid
64         object name.  Otherwise barf and abort.
66 -q::
67 --quiet::
68         Only meaningful in `--verify` mode. Do not output an error
69         message if the first argument is not a valid object name;
70         instead exit with non-zero status silently.
72 --sq::
73         Usually the output is made one line per flag and
74         parameter.  This option makes output a single line,
75         properly quoted for consumption by shell.  Useful when
76         you expect your parameter to contain whitespaces and
77         newlines (e.g. when using pickaxe `-S` with
78         'git diff-{asterisk}'). In contrast to the `--sq-quote` option,
79         the command input is still interpreted as usual.
81 --not::
82         When showing object names, prefix them with '{caret}' and
83         strip '{caret}' prefix from the object names that already have
84         one.
86 --symbolic::
87         Usually the object names are output in SHA1 form (with
88         possible '{caret}' prefix); this option makes them output in a
89         form as close to the original input as possible.
91 --symbolic-full-name::
92         This is similar to \--symbolic, but it omits input that
93         are not refs (i.e. branch or tag names; or more
94         explicitly disambiguating "heads/master" form, when you
95         want to name the "master" branch when there is an
96         unfortunately named tag "master"), and show them as full
97         refnames (e.g. "refs/heads/master").
99 --abbrev-ref[=(strict|loose)]::
100         A non-ambiguous short name of the objects name.
101         The option core.warnAmbiguousRefs is used to select the strict
102         abbreviation mode.
104 --disambiguate=<prefix>::
105         Show every object whose name begins with the given prefix.
106         The <prefix> must be at least 4 hexadecimal digits long to
107         avoid listing each and every object in the repository by
108         mistake.
110 --all::
111         Show all refs found in `refs/`.
113 --branches[=pattern]::
114 --tags[=pattern]::
115 --remotes[=pattern]::
116         Show all branches, tags, or remote-tracking branches,
117         respectively (i.e., refs found in `refs/heads`,
118         `refs/tags`, or `refs/remotes`, respectively).
120 If a `pattern` is given, only refs matching the given shell glob are
121 shown.  If the pattern does not contain a globbing character (`?`,
122 `*`, or `[`), it is turned into a prefix match by appending `/*`.
124 --glob=pattern::
125         Show all refs matching the shell glob pattern `pattern`. If
126         the pattern does not start with `refs/`, this is automatically
127         prepended.  If the pattern does not contain a globbing
128         character (`?`, `*`, or `[`), it is turned into a prefix
129         match by appending `/*`.
131 --show-toplevel::
132         Show the absolute path of the top-level directory.
134 --show-prefix::
135         When the command is invoked from a subdirectory, show the
136         path of the current directory relative to the top-level
137         directory.
139 --show-cdup::
140         When the command is invoked from a subdirectory, show the
141         path of the top-level directory relative to the current
142         directory (typically a sequence of "../", or an empty string).
144 --git-dir::
145         Show `$GIT_DIR` if defined. Otherwise show the path to
146         the .git directory. The path shown, when relative, is
147         relative to the current working directory.
149 If `$GIT_DIR` is not defined and the current directory
150 is not detected to lie in a git repository or work tree
151 print a message to stderr and exit with nonzero status.
153 --is-inside-git-dir::
154         When the current working directory is below the repository
155         directory print "true", otherwise "false".
157 --is-inside-work-tree::
158         When the current working directory is inside the work tree of the
159         repository print "true", otherwise "false".
161 --is-bare-repository::
162         When the repository is bare print "true", otherwise "false".
164 --local-env-vars::
165         List the GIT_* environment variables that are local to the
166         repository (e.g. GIT_DIR or GIT_WORK_TREE, but not GIT_EDITOR).
167         Only the names of the variables are listed, not their value,
168         even if they are set.
170 --short::
171 --short=number::
172         Instead of outputting the full SHA1 values of object names try to
173         abbreviate them to a shorter unique name. When no length is specified
174         7 is used. The minimum length is 4.
176 --since=datestring::
177 --after=datestring::
178         Parse the date string, and output the corresponding
179         --max-age= parameter for 'git rev-list'.
181 --until=datestring::
182 --before=datestring::
183         Parse the date string, and output the corresponding
184         --min-age= parameter for 'git rev-list'.
186 <args>...::
187         Flags and parameters to be parsed.
189 --resolve-git-dir <path>::
190         Check if <path> is a valid git-dir or a git-file pointing to a valid
191         git-dir. If <path> is a valid git-dir the resolved path to git-dir will
192         be printed.
194 include::revisions.txt[]
197 --------
199 In `--parseopt` mode, 'git rev-parse' helps massaging options to bring to shell
200 scripts the same facilities C builtins have. It works as an option normalizer
201 (e.g. splits single switches aggregate values), a bit like `getopt(1)` does.
203 It takes on the standard input the specification of the options to parse and
204 understand, and echoes on the standard output a string suitable for `sh(1)` `eval`
205 to replace the arguments with normalized ones.  In case of error, it outputs
206 usage on the standard error stream, and exits with code 129.
208 Note: Make sure you quote the result when passing it to `eval`.  See
209 below for an example.
211 Input Format
212 ~~~~~~~~~~~~
214 'git rev-parse --parseopt' input format is fully text based. It has two parts,
215 separated by a line that contains only `--`. The lines before the separator
216 (should be more than one) are used for the usage.
217 The lines after the separator describe the options.
219 Each line of options has this format:
221 ------------
222 <opt_spec><flags>* SP+ help LF
223 ------------
225 `<opt_spec>`::
226         its format is the short option character, then the long option name
227         separated by a comma. Both parts are not required, though at least one
228         is necessary. `h,help`, `dry-run` and `f` are all three correct
229         `<opt_spec>`.
231 `<flags>`::
232         `<flags>` are of `*`, `=`, `?` or `!`.
233         * Use `=` if the option takes an argument.
235         * Use `?` to mean that the option is optional (though its use is discouraged).
237         * Use `*` to mean that this option should not be listed in the usage
238           generated for the `-h` argument. It's shown for `--help-all` as
239           documented in linkgit:gitcli[7].
241         * Use `!` to not make the corresponding negated long option available.
243 The remainder of the line, after stripping the spaces, is used
244 as the help associated to the option.
246 Blank lines are ignored, and lines that don't match this specification are used
247 as option group headers (start the line with a space to create such
248 lines on purpose).
250 Example
251 ~~~~~~~
253 ------------
254 OPTS_SPEC="\
255 some-command [options] <args>...
257 some-command does foo and bar!
259 h,help    show the help
261 foo       some nifty option --foo
262 bar=      some cool option --bar with an argument
264   An option group Header
265 C?        option C with an optional argument"
267 eval "$(echo "$OPTS_SPEC" | git rev-parse --parseopt -- "$@" || echo exit $?)"
268 ------------
271 --------
273 In `--sq-quote` mode, 'git rev-parse' echoes on the standard output a
274 single line suitable for `sh(1)` `eval`. This line is made by
275 normalizing the arguments following `--sq-quote`. Nothing other than
276 quoting the arguments is done.
278 If you want command input to still be interpreted as usual by
279 'git rev-parse' before the output is shell quoted, see the `--sq`
280 option.
282 Example
283 ~~~~~~~
285 ------------
286 $ cat >your-git-script.sh <<\EOF
287 #!/bin/sh
288 args=$(git rev-parse --sq-quote "$@")   # quote user-supplied arguments
289 command="git frotz -n24 $args"          # and use it inside a handcrafted
290                                         # command line
291 eval "$command"
294 $ sh your-git-script.sh "a b'c"
295 ------------
298 --------
300 * Print the object name of the current commit:
302 ------------
303 $ git rev-parse --verify HEAD
304 ------------
306 * Print the commit object name from the revision in the $REV shell variable:
308 ------------
309 $ git rev-parse --verify $REV
310 ------------
312 This will error out if $REV is empty or not a valid revision.
314 * Same as above:
316 ------------
317 $ git rev-parse --default master --verify $REV
318 ------------
320 but if $REV is empty, the commit object name from master will be printed.
324 Part of the linkgit:git[1] suite