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.
38 .Nd display file status
42 .Op Fl f Ar format | Fl l | r | s | x
51 utility displays information about the file pointed to by
53 Read, write, or execute permissions of the named file are not required, but
54 all directories listed in the pathname leading to the file must be
56 If no argument is given,
58 displays information about the file descriptor for standard input.
62 only the target of the symbolic link is printed.
63 If the given argument is not a symbolic link and the
65 option is not specified,
67 will print nothing and exit with an error.
70 option is specified, the output is canonicalized by following every symlink
71 in every component of the given path recursively.
73 will resolve both absolute and relative paths, and return the absolute pathname
76 In this case, the argument does not need to be a symbolic link.
78 The information displayed is obtained by calling
80 with the given argument and evaluating the returned structure.
81 The default format displays the
98 fields, in that order.
100 The options are as follows:
101 .Bl -tag -width indent
107 immediately after each pathname that is a directory,
110 after each that is executable,
113 after each symbolic link,
122 after each that is a FIFO.
128 Treat each argument as the hexadecimal representation of an NFS file handle,
133 This requires root privileges.
139 The information reported by
141 will refer to the target of
143 if file is a symbolic link, and not to
146 If the link is broken or the target does not exist,
149 and report information about the link.
151 Do not force a newline to appear at the end of each piece of output.
153 Suppress failure messages if calls to
160 error messages are automatically suppressed.
162 Display information using the specified format.
165 section for a description of valid formats.
171 Display raw information.
172 That is, for all the fields in the
175 display the raw, numerical value (for example, times in seconds since the
178 Display information in
181 suitable for initializing variables.
183 Display timestamps using the specified format.
188 Display information in a more verbose way as known from some
193 Format strings are similar to
195 formats in that they start with
197 are then followed by a sequence of formatting characters, and end in
198 a character that selects the field of the
200 which is to be formatted.
203 is immediately followed by one of
207 then a newline character, a tab character, a percent character,
208 or the current file number is printed, otherwise the string is
209 examined for the following:
211 Any of the following optional flags:
212 .Bl -tag -width indent
214 Selects an alternate output form for octal and hexadecimal output.
215 Non-zero octal output will have a leading zero, and non-zero
216 hexadecimal output will have
220 Asserts that a sign indicating whether a number is positive or negative
221 should always be printed.
222 Non-negative numbers are not usually printed
225 Aligns string output to the left of the field, instead of to the right.
227 Sets the fill character for left padding to the
229 character, instead of a space.
231 Reserves a space at the front of non-negative signed output fields.
234 overrides a space if both are used.
237 Then the following fields:
238 .Bl -tag -width indent
240 An optional decimal digit string specifying the minimum field width.
242 An optional precision composed of a decimal point
244 and a decimal digit string that indicates the maximum string length,
245 the number of digits to appear after the decimal point in floating point
246 output, or the minimum number of digits to appear in numeric output.
248 An optional output format specifier which is one of
249 .Cm D , O , U , X , F ,
252 These represent signed decimal output, octal output, unsigned decimal
253 output, hexadecimal output, floating point output, and string output,
255 Some output formats do not apply to all fields.
256 Floating point output only applies to
264 The special output specifier
266 may be used to indicate that the output, if
267 applicable, should be in string format.
268 May be used in combination with:
269 .Bl -tag -width indent
275 Display actual device name.
282 Display group or user name.
298 Note that the default output format
301 is a string, but if specified explicitly, these four characters are
305 An optional sub field specifier (high, middle, low).
312 It can be one of the following:
313 .Bl -tag -width indent
317 specifies the major number for devices from
323 bits for permissions from the string form of
327 bits from the numeric forms of
329 and the long output form of
334 specifies the minor number for devices from
340 bits for permissions from the string form of
347 bits from the numeric forms of
351 style output character for file type when used with
355 for this is optional).
361 bits for permissions from the
362 string output form of
369 bits for the numeric forms of
373 A required field specifier, being one of the following:
374 .Bl -tag -width indent
385 File type and permissions
388 Number of hard links to
392 User ID and group ID of
395 .Pq Fa st_uid , st_gid .
397 Device number for character and block device special files
402 was last accessed or modified, or when the inode was last changed, or
403 the birth time of the inode
404 .Pq Fa st_atime , st_mtime , st_ctime , st_birthtime .
411 Number of blocks allocated for
415 Optimal file system I/O operation block size
418 User defined flags for
421 Inode generation number
425 The following five field specifiers are not drawn directly from the
429 .Bl -tag -width indent
431 The name of the file.
433 The absolute pathname corresponding to the file.
435 The file type, either as in
437 or in a more descriptive form if the
443 The target of a symbolic link.
449 field for character or block
450 special devices and gives size output for all others.
456 and the field specifier are required.
457 Most field specifiers default to
459 as an output form, with the
476 .Ex -std stat readlink
478 If no options are specified, the default format is
479 "%d %i %Sp %l %Su %Sg %r %z \e"%Sa\e" \e"%Sm\e" \e"%Sc\e" \e"%SB\e" %k %b %#Xf %N".
480 .Bd -literal -offset indent
482 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
485 Given a symbolic link
494 .Bd -literal -offset indent
495 \*[Gt] stat -F /tmp/foo
496 lrwxrwxrwx 1 jschauma cs 1 Apr 24 16:37:28 2002 /tmp/foo@ -\*[Gt] /
498 \*[Gt] stat -LF /tmp/foo
499 drwxr-xr-x 16 root wheel 512 Apr 19 10:57:54 2002 /tmp/foo/
502 To initialize some shell variables, you could use the
505 .Bd -literal -offset indent
507 % eval set `stat -s .cshrc`
508 % echo $st_size $st_mtimespec
512 $ eval $(stat -s .profile)
513 $ echo $st_size $st_mtimespec
517 In order to get a list of file types including files pointed to if the
518 file is a symbolic link, you could use the following format:
519 .Bd -literal -offset indent
520 $ stat -f "%N: %HT%SY" /tmp/*
521 /tmp/bar: Symbolic Link -\*[Gt] /tmp/foo
522 /tmp/output25568: Regular File
524 /tmp/foo: Symbolic Link -\*[Gt] /
527 In order to get a list of the devices, their types and the major and minor
528 device numbers, formatted with tabs and linebreaks, you could use the
530 .Bd -literal -offset indent
531 stat -f "Name: %N%n%tType: %HT%n%tMajor: %Hr%n%tMinor: %Lr%n%n" /dev/*
539 Type: Character Device
544 In order to determine the permissions set on a file separately, you could use
545 the following format:
546 .Bd -literal -offset indent
547 \*[Gt] stat -f "%Sp -\*[Gt] owner=%SHp group=%SMp other=%SLp" .
548 drwxr-xr-x -\*[Gt] owner=rwx group=r-x other=r-x
551 In order to determine the three files that have been modified most recently,
552 you could use the following format:
553 .Bd -literal -offset indent
554 \*[Gt] stat -f "%m%t%Sm %N" /tmp/* | sort -rn | head -3 | cut -f2-
555 Apr 25 11:47:00 2002 /tmp/blah
556 Apr 25 10:36:34 2002 /tmp/bar
557 Apr 24 16:47:35 2002 /tmp/foo
560 To display a file's modification time:
561 .Bd -literal -offset indent
562 \*[Gt] stat -f %m /tmp/foo
566 To display the same modification time in a readable format:
567 .Bd -literal -offset indent
568 \*[Gt] stat -f %Sm /tmp/foo
572 To display the same modification time in a readable and sortable format:
573 .Bd -literal -offset indent
574 \*[Gt] stat -f %Sm -t %Y%m%d%H%M%S /tmp/foo
578 To display the same in UTC:
579 .Bd -literal -offset indent
581 $ TZ= stat -f %Sm -t %Y%m%d%H%M%S /tmp/foo
603 utility was written by
604 .An Andrew Brown Aq Mt atatat@NetBSD.org .
605 This man page was written by
606 .An Jan Schaumann Aq Mt jschauma@NetBSD.org .