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.
132 The information reported by
134 will refer to the target of
136 if file is a symbolic link, and not to
139 If the link is broken or the target does not exist,
142 and report information about the link.
144 Do not force a newline to appear at the end of each piece of output.
146 Suppress failure messages if calls to
153 error messages are automatically suppressed.
155 Display information using the specified format.
158 section for a description of valid formats.
164 Display raw information.
165 That is, for all the fields in the
168 display the raw, numerical value (for example, times in seconds since the
171 Display information in
174 suitable for initializing variables.
176 Display information in a more verbose way as known from some
180 Display timestamps using the specified format.
186 Format strings are similar to
188 formats in that they start with
190 are then followed by a sequence of formatting characters, and end in
191 a character that selects the field of the
193 which is to be formatted.
196 is immediately followed by one of
200 then a newline character, a tab character, a percent character,
201 or the current file number is printed, otherwise the string is
202 examined for the following:
204 Any of the following optional flags:
205 .Bl -tag -width indent
207 Selects an alternate output form for octal and hexadecimal output.
208 Non-zero octal output will have a leading zero, and non-zero
209 hexadecimal output will have
213 Asserts that a sign indicating whether a number is positive or negative
214 should always be printed.
215 Non-negative numbers are not usually printed
218 Aligns string output to the left of the field, instead of to the right.
220 Sets the fill character for left padding to the
222 character, instead of a space.
224 Reserves a space at the front of non-negative signed output fields.
227 overrides a space if both are used.
230 Then the following fields:
231 .Bl -tag -width indent
233 An optional decimal digit string specifying the minimum field width.
235 An optional precision composed of a decimal point
237 and a decimal digit string that indicates the maximum string length,
238 the number of digits to appear after the decimal point in floating point
239 output, or the minimum number of digits to appear in numeric output.
241 An optional output format specifier which is one of
242 .Cm D , O , U , X , F ,
245 These represent signed decimal output, octal output, unsigned decimal
246 output, hexadecimal output, floating point output, and string output,
248 Some output formats do not apply to all fields.
249 Floating point output only applies to
257 The special output specifier
259 may be used to indicate that the output, if
260 applicable, should be in string format.
261 May be used in combination with:
262 .Bl -tag -width indent
268 Display actual device name.
275 Display group or user name.
291 Note that the default output format
294 is a string, but if specified explicitly, these four characters are
298 An optional sub field specifier (high, middle, low).
305 It can be one of the following:
306 .Bl -tag -width indent
310 specifies the major number for devices from
316 bits for permissions from the string form of
320 bits from the numeric forms of
322 and the long output form of
327 specifies the minor number for devices from
333 bits for permissions from the string form of
340 bits from the numeric forms of
344 style output character for file type when used with
348 for this is optional).
354 bits for permissions from the
355 string output form of
362 bits for the numeric forms of
366 A required field specifier, being one of the following:
367 .Bl -tag -width indent
378 File type and permissions
381 Number of hard links to
385 User ID and group ID of
388 .Pq Fa st_uid , st_gid .
390 Device number for character and block device special files
395 was last accessed or modified, or when the inode was last changed, or
396 the birth time of the inode
397 .Pq Fa st_atime , st_mtime , st_ctime , st_birthtime .
404 Number of blocks allocated for
408 Optimal file system I/O operation block size
411 User defined flags for
414 Inode generation number
418 The following five field specifiers are not drawn directly from the
422 .Bl -tag -width indent
424 The name of the file.
426 The absolute pathname corresponding to the file.
428 The file type, either as in
430 or in a more descriptive form if the
436 The target of a symbolic link.
442 field for character or block
443 special devices and gives size output for all others.
449 and the field specifier are required.
450 Most field specifiers default to
452 as an output form, with the
469 .Ex -std stat readlink
471 If no options are specified, the default format is
472 "%d %i %Sp %l %Su %Sg %r %z \e"%Sa\e" \e"%Sm\e" \e"%Sc\e" \e"%SB\e" %k %b %#Xf %N".
473 .Bd -literal -offset indent
475 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
478 Given a symbolic link
487 .Bd -literal -offset indent
488 \*[Gt] stat -F /tmp/foo
489 lrwxrwxrwx 1 jschauma cs 1 Apr 24 16:37:28 2002 /tmp/foo@ -\*[Gt] /
491 \*[Gt] stat -LF /tmp/foo
492 drwxr-xr-x 16 root wheel 512 Apr 19 10:57:54 2002 /tmp/foo/
495 To initialize some shell variables, you could use the
498 .Bd -literal -offset indent
500 % eval set `stat -s .cshrc`
501 % echo $st_size $st_mtimespec
505 $ eval $(stat -s .profile)
506 $ echo $st_size $st_mtimespec
510 In order to get a list of file types including files pointed to if the
511 file is a symbolic link, you could use the following format:
512 .Bd -literal -offset indent
513 $ stat -f "%N: %HT%SY" /tmp/*
514 /tmp/bar: Symbolic Link -\*[Gt] /tmp/foo
515 /tmp/output25568: Regular File
517 /tmp/foo: Symbolic Link -\*[Gt] /
520 In order to get a list of the devices, their types and the major and minor
521 device numbers, formatted with tabs and linebreaks, you could use the
523 .Bd -literal -offset indent
524 stat -f "Name: %N%n%tType: %HT%n%tMajor: %Hr%n%tMinor: %Lr%n%n" /dev/*
532 Type: Character Device
537 In order to determine the permissions set on a file separately, you could use
538 the following format:
539 .Bd -literal -offset indent
540 \*[Gt] stat -f "%Sp -\*[Gt] owner=%SHp group=%SMp other=%SLp" .
541 drwxr-xr-x -\*[Gt] owner=rwx group=r-x other=r-x
544 In order to determine the three files that have been modified most recently,
545 you could use the following format:
546 .Bd -literal -offset indent
547 \*[Gt] stat -f "%m%t%Sm %N" /tmp/* | sort -rn | head -3 | cut -f2-
548 Apr 25 11:47:00 2002 /tmp/blah
549 Apr 25 10:36:34 2002 /tmp/bar
550 Apr 24 16:47:35 2002 /tmp/foo
553 To display a file's modification time:
554 .Bd -literal -offset indent
555 \*[Gt] stat -f %m /tmp/foo
559 To display the same modification time in a readable format:
560 .Bd -literal -offset indent
561 \*[Gt] stat -f %Sm /tmp/foo
565 To display the same modification time in a readable and sortable format:
566 .Bd -literal -offset indent
567 \*[Gt] stat -f %Sm -t %Y%m%d%H%M%S /tmp/foo
571 To display the same in UTC:
572 .Bd -literal -offset indent
574 $ TZ= stat -f %Sm -t %Y%m%d%H%M%S /tmp/foo
596 utility was written by
598 .Aq atatat@NetBSD.org .
599 This man page was written by
601 .Aq jschauma@NetBSD.org .