man1/git-check-attr.1

   1 '\" t
   2 .\"     Title: git-check-attr
   3 .\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
   4 .\" Generator: DocBook XSL Stylesheets v1.79.2 <http://docbook.sf.net/>
   5 .\"      Date: 2024-08-21
   6 .\"    Manual: Git Manual
   7 .\"    Source: Git 2.46.0.288.g3a7362eb9f
   8 .\"  Language: English
   9 .\"
  10 .TH "GIT\-CHECK\-ATTR" "1" "2024-08-21" "Git 2\&.46\&.0\&.288\&.g3a7362" "Git Manual"
  11 .\" -----------------------------------------------------------------
  12 .\" * Define some portability stuff
  13 .\" -----------------------------------------------------------------
  14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15 .\" http://bugs.debian.org/507673
  16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18 .ie \n(.g .ds Aq \(aq
  19 .el       .ds Aq '
  20 .\" -----------------------------------------------------------------
  21 .\" * set default formatting
  22 .\" -----------------------------------------------------------------
  23 .\" disable hyphenation
  24 .nh
  25 .\" disable justification (adjust text to left margin only)
  26 .ad l
  27 .\" -----------------------------------------------------------------
  28 .\" * MAIN CONTENT STARTS HERE *
  29 .\" -----------------------------------------------------------------
  30 .SH "NAME"
  31 git-check-attr \- Display gitattributes information
  32 .SH "SYNOPSIS"
  33 .sp
  34 .nf
  35 \fIgit check\-attr\fR [\-\-source <tree\-ish>] [\-a | \-\-all | <attr>\&...\:] [\-\-] <pathname>\&...\:
  36 \fIgit check\-attr\fR \-\-stdin [\-z] [\-\-source <tree\-ish>] [\-a | \-\-all | <attr>\&...\:]
  37 .fi
  38 .SH "DESCRIPTION"
  39 .sp
  40 For every pathname, this command will list if each attribute is \fIunspecified\fR, \fIset\fR, or \fIunset\fR as a gitattribute on that pathname\&.
  41 .SH "OPTIONS"
  42 .PP
  43 \-a, \-\-all
  44 .RS 4
  45 List all attributes that are associated with the specified paths\&. If this option is used, then
  46 \fIunspecified\fR
  47 attributes will not be included in the output\&.
  48 .RE
  49 .PP
  50 \-\-cached
  51 .RS 4
  52 Consider
  53 \fB\&.gitattributes\fR
  54 in the index only, ignoring the working tree\&.
  55 .RE
  56 .PP
  57 \-\-stdin
  58 .RS 4
  59 Read pathnames from the standard input, one per line, instead of from the command line\&.
  60 .RE
  61 .PP
  62 \-z
  63 .RS 4
  64 The output format is modified to be machine\-parsable\&. If
  65 \fB\-\-stdin\fR
  66 is also given, input paths are separated with a NUL character instead of a linefeed character\&.
  67 .RE
  68 .PP
  69 \-\-source=<tree\-ish>
  70 .RS 4
  71 Check attributes against the specified tree\-ish\&. It is common to specify the source tree by naming a commit, branch, or tag associated with it\&.
  72 .RE
  73 .PP
  74 \-\-
  75 .RS 4
  76 Interpret all preceding arguments as attributes and all following arguments as path names\&.
  77 .RE
  78 .sp
  79 If none of \fB\-\-stdin\fR, \fB\-\-all\fR, or \fB\-\-\fR is used, the first argument will be treated as an attribute and the rest of the arguments as pathnames\&.
  80 .SH "OUTPUT"
  81 .sp
  82 The output is of the form: <path> COLON SP <attribute> COLON SP <info> LF
  83 .sp
  84 unless \fB\-z\fR is in effect, in which case NUL is used as delimiter: <path> NUL <attribute> NUL <info> NUL
  85 .sp
  86 <path> is the path of a file being queried, <attribute> is an attribute being queried, and <info> can be either:
  87 .PP
  88 \fIunspecified\fR
  89 .RS 4
  90 when the attribute is not defined for the path\&.
  91 .RE
  92 .PP
  93 \fIunset\fR
  94 .RS 4
  95 when the attribute is defined as false\&.
  96 .RE
  97 .PP
  98 \fIset\fR
  99 .RS 4
 100 when the attribute is defined as true\&.
 101 .RE
 102 .PP
 103 <value>
 104 .RS 4
 105 when a value has been assigned to the attribute\&.
 106 .RE
 107 .sp
 108 Buffering happens as documented under the \fBGIT_FLUSH\fR option in \fBgit\fR(1)\&. The caller is responsible for avoiding deadlocks caused by overfilling an input buffer or reading from an empty output buffer\&.
 109 .SH "EXAMPLES"
 110 .sp
 111 In the examples, the following \fI\&.gitattributes\fR file is used:
 112 .sp
 113 .if n \{\
 114 .RS 4
 115 .\}
 116 .nf
 117 *\&.java diff=java \-crlf myAttr
 118 NoMyAttr\&.java !myAttr
 119 README caveat=unspecified
 120 .fi
 121 .if n \{\
 122 .RE
 123 .\}
 124 .sp
 125 .RS 4
 126 .ie n \{\
 127 \h'-04'\(bu\h'+03'\c
 128 .\}
 129 .el \{\
 130 .sp -1
 131 .IP \(bu 2.3
 132 .\}
 133 Listing a single attribute:
 134 .RE
 135 .sp
 136 .if n \{\
 137 .RS 4
 138 .\}
 139 .nf
 140 $ git check\-attr diff org/example/MyClass\&.java
 141 org/example/MyClass\&.java: diff: java
 142 .fi
 143 .if n \{\
 144 .RE
 145 .\}
 146 .sp
 147 .RS 4
 148 .ie n \{\
 149 \h'-04'\(bu\h'+03'\c
 150 .\}
 151 .el \{\
 152 .sp -1
 153 .IP \(bu 2.3
 154 .\}
 155 Listing multiple attributes for a file:
 156 .RE
 157 .sp
 158 .if n \{\
 159 .RS 4
 160 .\}
 161 .nf
 162 $ git check\-attr crlf diff myAttr \-\- org/example/MyClass\&.java
 163 org/example/MyClass\&.java: crlf: unset
 164 org/example/MyClass\&.java: diff: java
 165 org/example/MyClass\&.java: myAttr: set
 166 .fi
 167 .if n \{\
 168 .RE
 169 .\}
 170 .sp
 171 .RS 4
 172 .ie n \{\
 173 \h'-04'\(bu\h'+03'\c
 174 .\}
 175 .el \{\
 176 .sp -1
 177 .IP \(bu 2.3
 178 .\}
 179 Listing all attributes for a file:
 180 .RE
 181 .sp
 182 .if n \{\
 183 .RS 4
 184 .\}
 185 .nf
 186 $ git check\-attr \-\-all \-\- org/example/MyClass\&.java
 187 org/example/MyClass\&.java: diff: java
 188 org/example/MyClass\&.java: myAttr: set
 189 .fi
 190 .if n \{\
 191 .RE
 192 .\}
 193 .sp
 194 .RS 4
 195 .ie n \{\
 196 \h'-04'\(bu\h'+03'\c
 197 .\}
 198 .el \{\
 199 .sp -1
 200 .IP \(bu 2.3
 201 .\}
 202 Listing an attribute for multiple files:
 203 .RE
 204 .sp
 205 .if n \{\
 206 .RS 4
 207 .\}
 208 .nf
 209 $ git check\-attr myAttr \-\- org/example/MyClass\&.java org/example/NoMyAttr\&.java
 210 org/example/MyClass\&.java: myAttr: set
 211 org/example/NoMyAttr\&.java: myAttr: unspecified
 212 .fi
 213 .if n \{\
 214 .RE
 215 .\}
 216 .sp
 217 .RS 4
 218 .ie n \{\
 219 \h'-04'\(bu\h'+03'\c
 220 .\}
 221 .el \{\
 222 .sp -1
 223 .IP \(bu 2.3
 224 .\}
 225 Not all values are equally unambiguous:
 226 .RE
 227 .sp
 228 .if n \{\
 229 .RS 4
 230 .\}
 231 .nf
 232 $ git check\-attr caveat README
 233 README: caveat: unspecified
 234 .fi
 235 .if n \{\
 236 .RE
 237 .\}
 238 .SH "SEE ALSO"
 239 .sp
 240 \fBgitattributes\fR(5)\&.
 241 .SH "GIT"
 242 .sp
 243 Part of the \fBgit\fR(1) suite