|
1 | | -<pattern>...:: |
2 | | - If one or more patterns are given, only refs are shown that |
3 | | - match against at least one pattern, either using fnmatch(3) or |
| 1 | +`<pattern>...`:: |
| 2 | + If one or more _<pattern>_ parameters are given, only refs are shown that |
| 3 | + match against at least one pattern, either using `fnmatch`(3) or |
4 | 4 | literally, in the latter case matching completely or from the |
5 | 5 | beginning up to a slash. |
6 | 6 |
|
7 | | ---stdin:: |
8 | | - If `--stdin` is supplied, then the list of patterns is read from |
9 | | - standard input instead of from the argument list. |
| 7 | +`--stdin`:: |
| 8 | + The list of patterns is read from standard input instead of from |
| 9 | + the argument list. |
10 | 10 |
|
11 | | ---count=<count>:: |
12 | | - By default the command shows all refs that match |
13 | | - `<pattern>`. This option makes it stop after showing |
14 | | - that many refs. |
| 11 | +`--count=<count>`:: |
| 12 | + Stop after showing _<count>_ refs. |
15 | 13 |
|
16 | | ---sort=<key>:: |
17 | | - A field name to sort on. Prefix `-` to sort in |
| 14 | +`--sort=<key>`:: |
| 15 | + Sort on the field name _<key>_. Prefix `-` to sort in |
18 | 16 | descending order of the value. When unspecified, |
19 | | - `refname` is used. You may use the --sort=<key> option |
| 17 | + `refname` is used. You may use the `--sort=<key>` option |
20 | 18 | multiple times, in which case the last key becomes the primary |
21 | 19 | key. |
22 | 20 |
|
23 | | ---format=<format>:: |
| 21 | +`--format[=<format>]`:: |
24 | 22 | A string that interpolates `%(fieldname)` from a ref being shown and |
25 | 23 | the object it points at. In addition, the string literal `%%` |
26 | 24 | renders as `%` and `%xx` - where `xx` are hex digits - renders as |
27 | 25 | the character with hex code `xx`. For example, `%00` interpolates to |
28 | | - `\0` (NUL), `%09` to `\t` (TAB), and `%0a` to `\n` (LF). |
29 | | -+ |
30 | | -When unspecified, `<format>` defaults to `%(objectname) SPC %(objecttype) |
| 26 | + `\0` (_NUL_), `%09` to `\t` (_TAB_), and `%0a` to `\n` (_LF_). |
| 27 | + |
| 28 | +When unspecified, _<format>_ defaults to `%(objectname) SPC %(objecttype) |
31 | 29 | TAB %(refname)`. |
32 | 30 |
|
33 | | ---color[=<when>]:: |
| 31 | +`--color[=<when>]`:: |
34 | 32 | Respect any colors specified in the `--format` option. The |
35 | | - `<when>` field must be one of `always`, `never`, or `auto` (if |
| 33 | + _<when__ field must be one of `always`, `never`, or `auto` (if |
36 | 34 | `<when>` is absent, behave as if `always` was given). |
37 | 35 |
|
38 | | ---shell:: |
39 | | ---perl:: |
40 | | ---python:: |
41 | | ---tcl:: |
| 36 | +`--shell`:: |
| 37 | +`--perl`:: |
| 38 | +`--python`:: |
| 39 | +`--tcl`:: |
42 | 40 | If given, strings that substitute `%(fieldname)` |
43 | 41 | placeholders are quoted as string literals suitable for |
44 | 42 | the specified host language. This is meant to produce |
45 | | - a scriptlet that can directly be `eval`ed. |
| 43 | + a scriptlet that can directly be "eval"ed. |
46 | 44 |
|
47 | | ---points-at=<object>:: |
| 45 | +`--points-at=<object>`:: |
48 | 46 | Only list refs which points at the given object. |
49 | 47 |
|
50 | | ---merged[=<object>]:: |
| 48 | +`--merged[=<object>]`:: |
51 | 49 | Only list refs whose tips are reachable from the |
52 | | - specified commit (HEAD if not specified). |
53 | | - |
54 | | ---no-merged[=<object>]:: |
55 | | - Only list refs whose tips are not reachable from the |
56 | | - specified commit (HEAD if not specified). |
| 50 | + specified commit (`HEAD` if not specified). |
57 | 51 |
|
58 | | ---contains[=<object>]:: |
59 | | - Only list refs which contain the specified commit (HEAD if not |
| 52 | +`--no-merged[=<object>]`:: |
| 53 | + Only list refs whose tips are not reachable from _<object>_(`HEAD` if not |
60 | 54 | specified). |
61 | 55 |
|
62 | | ---no-contains[=<object>]:: |
63 | | - Only list refs which don't contain the specified commit (HEAD |
| 56 | +`--contains[=<object>]`:: |
| 57 | + Only list refs which contain _<object>_(`HEAD` if not specified). |
| 58 | + |
| 59 | +`--no-contains[=<object>]`:: |
| 60 | + Only list refs which don't contain _<object>_ (`HEAD` |
64 | 61 | if not specified). |
65 | 62 |
|
66 | | ---ignore-case:: |
| 63 | +`--ignore-case`:: |
67 | 64 | Sorting and filtering refs are case insensitive. |
68 | 65 |
|
69 | | ---omit-empty:: |
| 66 | +`--omit-empty`:: |
70 | 67 | Do not print a newline after formatted refs where the format expands |
71 | 68 | to the empty string. |
72 | 69 |
|
73 | | ---exclude=<pattern>:: |
74 | | - If one or more patterns are given, only refs which do not match |
75 | | - any excluded pattern(s) are shown. Matching is done using the |
76 | | - same rules as `<pattern>` above. |
| 70 | +`--exclude=<excluded-pattern>`:: |
| 71 | + If one or more `--exclude` options are given, only refs which do not |
| 72 | + match any _<excluded-pattern>_ parameters are shown. Matching is done |
| 73 | + using the same rules as _<pattern>_ above. |
77 | 74 |
|
78 | | ---include-root-refs:: |
79 | | - List root refs (HEAD and pseudorefs) apart from regular refs. |
| 75 | +`--include-root-refs`:: |
| 76 | + List root refs (`HEAD` and pseudorefs) apart from regular refs. |
80 | 77 |
|
81 | | ---start-after=<marker>:: |
| 78 | +`--start-after=<marker>`:: |
82 | 79 | Allows paginating the output by skipping references up to and including the |
83 | 80 | specified marker. When paging, it should be noted that references may be |
84 | 81 | deleted, modified or added between invocations. Output will only yield those |
|
0 commit comments