aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/for-each-ref-options.adoc
blob: f13efb5f2556cf8c02b76e9580b7e4d4cf1a9855 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
`<pattern>...`::
	If one or more _<pattern>_ parameters are given, only refs are shown that
	match against at least one pattern, either using `fnmatch`(3) or
	literally, in the latter case matching completely or from the
	beginning up to a slash.

`--stdin`::
	The list of patterns is read from standard input instead of from
	the argument list.

`--count=<count>`::
	Stop after showing _<count>_ refs.

`--sort=<key>`::
	Sort on the field name _<key>_.  Prefix `-` to sort in
	descending order of the value.  When unspecified,
	`refname` is used.  You may use the `--sort=<key>` option
	multiple times, in which case the last key becomes the primary
	key.

`--format[=<format>]`::
	A string that interpolates `%(fieldname)` from a ref being shown and
	the object it points at. In addition, the string literal `%%`
	renders as `%` and `%xx` - where `xx` are hex digits - renders as
	the character with hex code `xx`. For example, `%00` interpolates to
	`\0` (_NUL_), `%09` to `\t` (_TAB_), and `%0a` to `\n` (_LF_).

When unspecified, _<format>_ defaults to `%(objectname) SPC %(objecttype)
TAB %(refname)`.

`--color[=<when>]`::
	Respect any colors specified in the `--format` option. The
	_<when__ field must be one of `always`, `never`, or `auto` (if
	`<when>` is absent, behave as if `always` was given).

`--shell`::
`--perl`::
`--python`::
`--tcl`::
	If given, strings that substitute `%(fieldname)`
	placeholders are quoted as string literals suitable for
	the specified host language.  This is meant to produce
	a scriptlet that can directly be "eval"ed.

`--points-at=<object>`::
	Only list refs which points at the given object.

`--merged[=<object>]`::
	Only list refs whose tips are reachable from the
	specified commit (`HEAD` if not specified).

`--no-merged[=<object>]`::
	Only list refs whose tips are not reachable from _<object>_(`HEAD` if not
	specified).

`--contains[=<object>]`::
	Only list refs which contain _<object>_(`HEAD` if not specified).

`--no-contains[=<object>]`::
	Only list refs which don't contain _<object>_ (`HEAD`
	if not specified).

`--ignore-case`::
	Sorting and filtering refs are case insensitive.

`--omit-empty`::
	Do not print a newline after formatted refs where the format expands
	to the empty string.

`--exclude=<excluded-pattern>`::
	If one or more `--exclude` options are given, only refs which do not
	match any _<excluded-pattern>_ parameters are shown. Matching is done
	using the same rules as _<pattern>_ above.

`--include-root-refs`::
	List root refs (`HEAD` and pseudorefs) apart from regular refs.

`--start-after=<marker>`::
    Allows paginating the output by skipping references up to and including the
    specified marker. When paging, it should be noted that references may be
    deleted, modified or added between invocations. Output will only yield those
    references which follow the marker lexicographically. Output begins from the
    first reference that would come after the marker alphabetically. Cannot be
    used with `--sort=<key>` or `--stdin` options, or the _<pattern>_ argument(s)
    to limit the refs.