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