| blob | 4071c326e3b9c0ed98b8dbc43699924dece812b5 |
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: 05/20/2022
6 .\" Manual: Git Manual
7 .\" Source: Git 2.36.1.153.gf9b95943b6
8 .\" Language: English
9 .\"
10 .TH "GIT\-CHECK\-ATTR" "1" "05/20/2022" "Git 2\&.36\&.1\&.153\&.gf9b959" "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 [\-a | \-\-all | <attr>\&...] [\-\-] <pathname>\&...
36 \fIgit check\-attr\fR \-\-stdin [\-z] [\-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 \-\-
71 .RS 4
72 Interpret all preceding arguments as attributes and all following arguments as path names\&.
73 .RE
74 .sp
75 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\&.
76 .SH "OUTPUT"
77 .sp
78 The output is of the form: <path> COLON SP <attribute> COLON SP <info> LF
79 .sp
80 unless \fB\-z\fR is in effect, in which case NUL is used as delimiter: <path> NUL <attribute> NUL <info> NUL
81 .sp
82 <path> is the path of a file being queried, <attribute> is an attribute being queried and <info> can be either:
83 .PP
84 \fIunspecified\fR
85 .RS 4
86 when the attribute is not defined for the path\&.
87 .RE
88 .PP
89 \fIunset\fR
90 .RS 4
91 when the attribute is defined as false\&.
92 .RE
93 .PP
94 \fIset\fR
95 .RS 4
96 when the attribute is defined as true\&.
97 .RE
98 .PP
99 <value>
100 .RS 4
101 when a value has been assigned to the attribute\&.
102 .RE
103 .sp
104 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\&.
105 .SH "EXAMPLES"
106 .sp
107 In the examples, the following \fI\&.gitattributes\fR file is used:
108 .sp
109 .if n \{\
110 .RS 4
111 .\}
112 .nf
113 *\&.java diff=java \-crlf myAttr
114 NoMyAttr\&.java !myAttr
115 README caveat=unspecified
116 .fi
117 .if n \{\
118 .RE
119 .\}
120 .sp
122 .sp
123 .RS 4
124 .ie n \{\
125 \h'-04'\(bu\h'+03'\c
126 .\}
127 .el \{\
128 .sp -1
129 .IP \(bu 2.3
130 .\}
131 Listing a single attribute:
132 .RE
133 .sp
134 .if n \{\
135 .RS 4
136 .\}
137 .nf
138 $ git check\-attr diff org/example/MyClass\&.java
139 org/example/MyClass\&.java: diff: java
140 .fi
141 .if n \{\
142 .RE
143 .\}
144 .sp
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
172 .sp
173 .RS 4
174 .ie n \{\
175 \h'-04'\(bu\h'+03'\c
176 .\}
177 .el \{\
178 .sp -1
179 .IP \(bu 2.3
180 .\}
181 Listing all attributes for a file:
182 .RE
183 .sp
184 .if n \{\
185 .RS 4
186 .\}
187 .nf
188 $ git check\-attr \-\-all \-\- org/example/MyClass\&.java
189 org/example/MyClass\&.java: diff: java
190 org/example/MyClass\&.java: myAttr: set
191 .fi
192 .if n \{\
193 .RE
194 .\}
195 .sp
197 .sp
198 .RS 4
199 .ie n \{\
200 \h'-04'\(bu\h'+03'\c
201 .\}
202 .el \{\
203 .sp -1
204 .IP \(bu 2.3
205 .\}
206 Listing an attribute for multiple files:
207 .RE
208 .sp
209 .if n \{\
210 .RS 4
211 .\}
212 .nf
213 $ git check\-attr myAttr \-\- org/example/MyClass\&.java org/example/NoMyAttr\&.java
214 org/example/MyClass\&.java: myAttr: set
215 org/example/NoMyAttr\&.java: myAttr: unspecified
216 .fi
217 .if n \{\
218 .RE
219 .\}
220 .sp
222 .sp
223 .RS 4
224 .ie n \{\
225 \h'-04'\(bu\h'+03'\c
226 .\}
227 .el \{\
228 .sp -1
229 .IP \(bu 2.3
230 .\}
231 Not all values are equally unambiguous:
232 .RE
233 .sp
234 .if n \{\
235 .RS 4
236 .\}
237 .nf
238 $ git check\-attr caveat README
239 README: caveat: unspecified
240 .fi
241 .if n \{\
242 .RE
243 .\}
244 .sp
245 .SH "SEE ALSO"
246 .sp
247 \fBgitattributes\fR(5)\&.
248 .SH "GIT"
249 .sp
250 Part of the \fBgit\fR(1) suite