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 vsnapshot <http://docbook.sf.net/>
   5 .\"      Date: 2024-04-10
   6 .\"    Manual: Git Manual
   7 .\"    Source: Git 2.44.0.568.g436d4e5b14
   8 .\"  Language: English
   9 .\"
  10 .TH "GIT\-CHECK\-ATTR" "1" "2024\-04\-10" "Git 2\&.44\&.0\&.568\&.g436d4e" "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 .sp
  39 .SH "DESCRIPTION"
  40 .sp
  41 For every pathname, this command will list if each attribute is \fIunspecified\fR, \fIset\fR, or \fIunset\fR as a gitattribute on that pathname\&.
  42 .SH "OPTIONS"
  43 .PP
  44 \-a, \-\-all
  45 .RS 4
  46 List all attributes that are associated with the specified paths\&. If this option is used, then
  47 \fIunspecified\fR
  48 attributes will not be included in the output\&.
  49 .RE
  50 .PP
  51 \-\-cached
  52 .RS 4
  53 Consider
  54 \fB\&.gitattributes\fR
  55 in the index only, ignoring the working tree\&.
  56 .RE
  57 .PP
  58 \-\-stdin
  59 .RS 4
  60 Read pathnames from the standard input, one per line, instead of from the command line\&.
  61 .RE
  62 .PP
  63 \-z
  64 .RS 4
  65 The output format is modified to be machine\-parsable\&. If
  66 \fB\-\-stdin\fR
  67 is also given, input paths are separated with a NUL character instead of a linefeed character\&.
  68 .RE
  69 .PP
  70 \-\-source=<tree\-ish>
  71 .RS 4
  72 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\&.
  73 .RE
  74 .PP
  75 \-\-
  76 .RS 4
  77 Interpret all preceding arguments as attributes and all following arguments as path names\&.
  78 .RE
  79 .sp
  80 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\&.
  81 .SH "OUTPUT"
  82 .sp
  83 The output is of the form: <path> COLON SP <attribute> COLON SP <info> LF
  84 .sp
  85 unless \fB\-z\fR is in effect, in which case NUL is used as delimiter: <path> NUL <attribute> NUL <info> NUL
  86 .sp
  87 <path> is the path of a file being queried, <attribute> is an attribute being queried, and <info> can be either:
  88 .PP
  89 \fIunspecified\fR
  90 .RS 4
  91 when the attribute is not defined for the path\&.
  92 .RE
  93 .PP
  94 \fIunset\fR
  95 .RS 4
  96 when the attribute is defined as false\&.
  97 .RE
  98 .PP
  99 \fIset\fR
 100 .RS 4
 101 when the attribute is defined as true\&.
 102 .RE
 103 .PP
 104 <value>
 105 .RS 4
 106 when a value has been assigned to the attribute\&.
 107 .RE
 108 .sp
 109 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\&.
 110 .SH "EXAMPLES"
 111 .sp
 112 In the examples, the following \fI\&.gitattributes\fR file is used:
 113 .sp
 114 .if n \{\
 115 .RS 4
 116 .\}
 117 .nf
 118 *\&.java diff=java \-crlf myAttr
 119 NoMyAttr\&.java !myAttr
 120 README caveat=unspecified
 121 .fi
 122 .if n \{\
 123 .RE
 124 .\}
 125 .sp
 126
 127 .sp
 128 .RS 4
 129 .ie n \{\
 130 \h'-04'\(bu\h'+03'\c
 131 .\}
 132 .el \{\
 133 .sp -1
 134 .IP \(bu 2.3
 135 .\}
 136 Listing a single attribute:
 137 .RE
 138 .sp
 139 .if n \{\
 140 .RS 4
 141 .\}
 142 .nf
 143 $ git check\-attr diff org/example/MyClass\&.java
 144 org/example/MyClass\&.java: diff: java
 145 .fi
 146 .if n \{\
 147 .RE
 148 .\}
 149 .sp
 150
 151 .sp
 152 .RS 4
 153 .ie n \{\
 154 \h'-04'\(bu\h'+03'\c
 155 .\}
 156 .el \{\
 157 .sp -1
 158 .IP \(bu 2.3
 159 .\}
 160 Listing multiple attributes for a file:
 161 .RE
 162 .sp
 163 .if n \{\
 164 .RS 4
 165 .\}
 166 .nf
 167 $ git check\-attr crlf diff myAttr \-\- org/example/MyClass\&.java
 168 org/example/MyClass\&.java: crlf: unset
 169 org/example/MyClass\&.java: diff: java
 170 org/example/MyClass\&.java: myAttr: set
 171 .fi
 172 .if n \{\
 173 .RE
 174 .\}
 175 .sp
 176
 177 .sp
 178 .RS 4
 179 .ie n \{\
 180 \h'-04'\(bu\h'+03'\c
 181 .\}
 182 .el \{\
 183 .sp -1
 184 .IP \(bu 2.3
 185 .\}
 186 Listing all attributes for a file:
 187 .RE
 188 .sp
 189 .if n \{\
 190 .RS 4
 191 .\}
 192 .nf
 193 $ git check\-attr \-\-all \-\- org/example/MyClass\&.java
 194 org/example/MyClass\&.java: diff: java
 195 org/example/MyClass\&.java: myAttr: set
 196 .fi
 197 .if n \{\
 198 .RE
 199 .\}
 200 .sp
 201
 202 .sp
 203 .RS 4
 204 .ie n \{\
 205 \h'-04'\(bu\h'+03'\c
 206 .\}
 207 .el \{\
 208 .sp -1
 209 .IP \(bu 2.3
 210 .\}
 211 Listing an attribute for multiple files:
 212 .RE
 213 .sp
 214 .if n \{\
 215 .RS 4
 216 .\}
 217 .nf
 218 $ git check\-attr myAttr \-\- org/example/MyClass\&.java org/example/NoMyAttr\&.java
 219 org/example/MyClass\&.java: myAttr: set
 220 org/example/NoMyAttr\&.java: myAttr: unspecified
 221 .fi
 222 .if n \{\
 223 .RE
 224 .\}
 225 .sp
 226
 227 .sp
 228 .RS 4
 229 .ie n \{\
 230 \h'-04'\(bu\h'+03'\c
 231 .\}
 232 .el \{\
 233 .sp -1
 234 .IP \(bu 2.3
 235 .\}
 236 Not all values are equally unambiguous:
 237 .RE
 238 .sp
 239 .if n \{\
 240 .RS 4
 241 .\}
 242 .nf
 243 $ git check\-attr caveat README
 244 README: caveat: unspecified
 245 .fi
 246 .if n \{\
 247 .RE
 248 .\}
 249 .sp
 250 .SH "SEE ALSO"
 251 .sp
 252 \fBgitattributes\fR(5)\&.
 253 .SH "GIT"
 254 .sp
 255 Part of the \fBgit\fR(1) suite