1 .\" $NetBSD: stat.1,v 1.28 2010/04/05 21:25:01 joerg Exp $
3 .\" Copyright (c) 2002 The NetBSD Foundation, Inc.
4 .\" All rights reserved.
6 .\" This code is derived from software contributed to The NetBSD Foundation
7 .\" by Andrew Brown and Jan Schaumann.
9 .\" Redistribution and use in source and binary forms, with or without
10 .\" modification, are permitted provided that the following conditions
12 .\" 1. Redistributions of source code must retain the above copyright
13 .\" notice, this list of conditions and the following disclaimer.
14 .\" 2. Redistributions in binary form must reproduce the above copyright
15 .\" notice, this list of conditions and the following disclaimer in the
16 .\" documentation and/or other materials provided with the distribution.
18 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
19 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
20 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21 .\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
22 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28 .\" POSSIBILITY OF SUCH DAMAGE.
36 .Nd display file status
40 .Op Fl f Ar format | Fl l | r | s | x
49 utility displays information about the file pointed to by
51 Read, write, or execute permissions of the named file are not required, but
52 all directories listed in the pathname leading to the file must be
54 If no argument is given,
56 displays information about the file descriptor for standard input.
60 only the target of the symbolic link is printed.
61 If the given argument is not a symbolic link and the
63 option is not specified,
65 will print nothing and exit with an error.
68 option is specified, the output is canonicalized by following every symlink
69 in every component of the given path recursively.
71 will resolve both absolute and relative paths, and return the absolute pathname
74 In this case, the argument does not need to be a symbolic link.
76 The information displayed is obtained by calling
78 with the given argument and evaluating the returned structure.
79 The default format displays the
96 fields, in that order.
98 The options are as follows:
99 .Bl -tag -width indent
105 immediately after each pathname that is a directory,
108 after each that is executable,
111 after each symbolic link,
120 after each that is a FIFO.
126 Treat each argument as the hexadecimal representation of an NFS file handle,
131 This requires root privileges.
137 The information reported by
139 will refer to the target of
141 if file is a symbolic link, and not to
144 If the link is broken or the target does not exist,
147 and report information about the link.
149 Do not force a newline to appear at the end of each piece of output.
151 Suppress failure messages if calls to
158 error messages are automatically suppressed.
160 Display information using the specified format.
163 section for a description of valid formats.
169 Display raw information.
170 That is, for all the fields in the
173 display the raw, numerical value (for example, times in seconds since the
176 Display information in
179 suitable for initializing variables.
181 Display timestamps using the specified format.
186 Display information in a more verbose way as known from some
191 Format strings are similar to
193 formats in that they start with
195 are then followed by a sequence of formatting characters, and end in
196 a character that selects the field of the
198 which is to be formatted.
201 is immediately followed by one of
205 then a newline character, a tab character, a percent character,
206 or the current file number is printed, otherwise the string is
207 examined for the following:
209 Any of the following optional flags:
210 .Bl -tag -width indent
212 Selects an alternate output form for octal and hexadecimal output.
213 Non-zero octal output will have a leading zero, and non-zero
214 hexadecimal output will have
218 Asserts that a sign indicating whether a number is positive or negative
219 should always be printed.
220 Non-negative numbers are not usually printed
223 Aligns string output to the left of the field, instead of to the right.
225 Sets the fill character for left padding to the
227 character, instead of a space.
229 Reserves a space at the front of non-negative signed output fields.
232 overrides a space if both are used.
235 Then the following fields:
236 .Bl -tag -width indent
238 An optional decimal digit string specifying the minimum field width.
240 An optional precision composed of a decimal point
242 and a decimal digit string that indicates the maximum string length,
243 the number of digits to appear after the decimal point in floating point
244 output, or the minimum number of digits to appear in numeric output.
246 An optional output format specifier which is one of
247 .Cm D , O , U , X , F ,
250 These represent signed decimal output, octal output, unsigned decimal
251 output, hexadecimal output, floating point output, and string output,
253 Some output formats do not apply to all fields.
254 Floating point output only applies to
262 The special output specifier
264 may be used to indicate that the output, if
265 applicable, should be in string format.
266 May be used in combination with:
267 .Bl -tag -width indent
273 Display actual device name.
280 Display group or user name.
296 Note that the default output format
299 is a string, but if specified explicitly, these four characters are
303 An optional sub field specifier (high, middle, low).
310 It can be one of the following:
311 .Bl -tag -width indent
315 specifies the major number for devices from
321 bits for permissions from the string form of
325 bits from the numeric forms of
327 and the long output form of
332 specifies the minor number for devices from
338 bits for permissions from the string form of
345 bits from the numeric forms of
349 style output character for file type when used with
353 for this is optional).
359 bits for permissions from the
360 string output form of
367 bits for the numeric forms of
371 A required field specifier, being one of the following:
372 .Bl -tag -width indent
383 File type and permissions
386 Number of hard links to
390 User ID and group ID of
393 .Pq Fa st_uid , st_gid .
395 Device number for character and block device special files
400 was last accessed or modified, or when the inode was last changed, or
401 the birth time of the inode
402 .Pq Fa st_atime , st_mtime , st_ctime , st_birthtime .
409 Number of blocks allocated for
413 Optimal file system I/O operation block size
416 User defined flags for
419 Inode generation number
423 The following five field specifiers are not drawn directly from the
427 .Bl -tag -width indent
429 The name of the file.
431 The absolute pathname corresponding to the file.
433 The file type, either as in
435 or in a more descriptive form if the
441 The target of a symbolic link.
447 field for character or block
448 special devices and gives size output for all others.
454 and the field specifier are required.
455 Most field specifiers default to
457 as an output form, with the
474 .Ex -std stat readlink
476 If no options are specified, the default format is
477 "%d %i %Sp %l %Su %Sg %r %z \e"%Sa\e" \e"%Sm\e" \e"%Sc\e" \e"%SB\e" %k %b %#Xf %N".
478 .Bd -literal -offset indent
480 0 78852 -rw-r--r-- 1 root wheel 0 0 "Jul 8 10:26:03 2004" "Jul 8 10:26:03 2004" "Jul 8 10:28:13 2004" "Jan 1 09:00:00 1970" 16384 0 0 /tmp/bar
483 Given a symbolic link
492 .Bd -literal -offset indent
493 \*[Gt] stat -F /tmp/foo
494 lrwxrwxrwx 1 jschauma cs 1 Apr 24 16:37:28 2002 /tmp/foo@ -\*[Gt] /
496 \*[Gt] stat -LF /tmp/foo
497 drwxr-xr-x 16 root wheel 512 Apr 19 10:57:54 2002 /tmp/foo/
500 To initialize some shell variables, you could use the
503 .Bd -literal -offset indent
505 % eval set `stat -s .cshrc`
506 % echo $st_size $st_mtimespec
510 $ eval $(stat -s .profile)
511 $ echo $st_size $st_mtimespec
515 In order to get a list of file types including files pointed to if the
516 file is a symbolic link, you could use the following format:
517 .Bd -literal -offset indent
518 $ stat -f "%N: %HT%SY" /tmp/*
519 /tmp/bar: Symbolic Link -\*[Gt] /tmp/foo
520 /tmp/output25568: Regular File
522 /tmp/foo: Symbolic Link -\*[Gt] /
525 In order to get a list of the devices, their types and the major and minor
526 device numbers, formatted with tabs and linebreaks, you could use the
528 .Bd -literal -offset indent
529 stat -f "Name: %N%n%tType: %HT%n%tMajor: %Hr%n%tMinor: %Lr%n%n" /dev/*
537 Type: Character Device
542 In order to determine the permissions set on a file separately, you could use
543 the following format:
544 .Bd -literal -offset indent
545 \*[Gt] stat -f "%Sp -\*[Gt] owner=%SHp group=%SMp other=%SLp" .
546 drwxr-xr-x -\*[Gt] owner=rwx group=r-x other=r-x
549 In order to determine the three files that have been modified most recently,
550 you could use the following format:
551 .Bd -literal -offset indent
552 \*[Gt] stat -f "%m%t%Sm %N" /tmp/* | sort -rn | head -3 | cut -f2-
553 Apr 25 11:47:00 2002 /tmp/blah
554 Apr 25 10:36:34 2002 /tmp/bar
555 Apr 24 16:47:35 2002 /tmp/foo
558 To display a file's modification time:
559 .Bd -literal -offset indent
560 \*[Gt] stat -f %m /tmp/foo
564 To display the same modification time in a readable format:
565 .Bd -literal -offset indent
566 \*[Gt] stat -f %Sm /tmp/foo
570 To display the same modification time in a readable and sortable format:
571 .Bd -literal -offset indent
572 \*[Gt] stat -f %Sm -t %Y%m%d%H%M%S /tmp/foo
576 To display the same in UTC:
577 .Bd -literal -offset indent
579 $ TZ= stat -f %Sm -t %Y%m%d%H%M%S /tmp/foo
601 utility was written by
602 .An Andrew Brown Aq Mt atatat@NetBSD.org .
603 This man page was written by
604 .An Jan Schaumann Aq Mt jschauma@NetBSD.org .