STAT(1) | General Commands Manual | STAT(1) |
stat
, readlink
— display file status
stat |
[-FLnq ] [-f
format | -l |
-r | -s |
-x ] [-t
timefmt] [file ...] |
readlink |
[-fn ] [file ...] |
The stat
utility displays information
about the file pointed to by file. Read, write, or
execute permissions of the named file are not required, but all directories
listed in the pathname leading to the file must be searchable. If no
argument is given, stat
displays information about
the file descriptor for standard input.
When invoked as readlink
, only the target
of the symbolic link is printed. If the given argument is not a symbolic
link and the -f
option is not specified,
readlink
will print nothing and exit with an error.
If the -f
option is specified, the output is
canonicalized by following every symlink in every component of the given
path recursively. readlink
will resolve both
absolute and relative paths, and return the absolute pathname corresponding
to file. In this case, the argument does not need to
be a symbolic link.
The information displayed is obtained by calling lstat(2) with the given argument and evaluating the returned structure. The default format displays the st_dev, st_ino, st_mode, st_nlink, st_uid, st_gid, st_rdev, st_size, st_atime, st_mtime, st_ctime, st_birthtime, st_blksize, st_blocks, and st_flags fields, in that order.
The options are as follows:
-F
/
’) immediately after each
pathname that is a directory, an asterisk
(‘*
’) after each that is executable,
an at sign (‘@
’) after each symbolic
link, a percent sign (‘%
’) after
each whiteout, an equal sign (‘=
’)
after each socket, and a vertical bar
(‘|
’) after each that is a FIFO. The
use of -F
implies -l
.-L
stat
will refer to the target of
file, if file is a symbolic link, and not to
file itself. If the link is broken or the target
does not exist, fall back on lstat(2)
and report information about the link.-f
format-l
ls
-lT
format.-n
-q
readlink
, error messages are automatically
suppressed.-r
-s
-t
timefmt-x
Format strings are similar to
printf(3) formats in that they start
with %
, are then followed by a sequence of
formatting characters, and end in a character that selects the field of the
struct stat which is to be formatted. If the
%
is immediately followed by one of
n
, t
,
%
, or @
, then a newline
character, a tab character, a percent character, or the current file number
is printed, otherwise the string is examined for the following:
Any of the following optional flags:
#
0x
” prepended to
it.+
-
0
0
’ character, instead of a
space.+
’ overrides a space if both are
used.Then the following fields:
.
’ and a decimal digit string that
indicates the maximum string length, the number of digits to appear after
the decimal point in floating point output, or the minimum number of
digits to appear in numeric output.D
, O
,
U
, X
,
F
, or S
. These represent
signed decimal output, octal output, unsigned decimal output, hexadecimal
output, floating point output, and string output, respectively. Some
output formats do not apply to all fields. Floating point output only
applies to timespec fields (the
a
, m
, and
c
fields).
The special output specifier S
may be
used to indicate that the output, if applicable, should be in string
format. May be used in combination with:
amc
dr
f
ls
-lTdo
.gu
p
ls
-lTd
.N
T
Y
->
” into the
output. Note that the default output format for
Y
is a string, but if specified explicitly,
these four characters are prepended.p
, d
,
r
, and T
output formats.
It can be one of the following:
H
r
or d
, the
“user” bits for permissions from the string form of
p
, the file “type” bits from the
numeric forms of p
, and the long output form
of T
.L
r
or d
, the
“other” bits for permissions from the string form of
p
, the “user”,
“group”, and “other” bits from the numeric
forms of p
, and the ls
-F
style output character for file type when
used with T
(the use of
L
for this is optional).M
p
, or the “suid”,
“sgid”, and “sticky” bits for the numeric
forms of p
.d
i
p
l
u
,
g
r
a
,
m
, c
,
B
z
b
k
f
v
The following five field specifiers are not drawn directly from the data in struct stat, but are:
N
R
T
ls
-F
or in a more descriptive form if the
sub field specifier H
is
given.Y
Z
Only the %
and the field specifier are
required. Most field specifiers default to U
as an
output form, with the exception of p
which defaults
to O
; a
,
m
, and c
which default to
D
; and Y
,
T
, and N
which default to
S
.
The stat
and
readlink
utilities exit 0 on success,
and >0 if an error occurs.
If no options are specified, the default format is "%d %i %Sp %l %Su %Sg %r %z \"%Sa\" \"%Sm\" \"%Sc\" \"%SB\" %k %b %#Xf %N".
> stat /tmp/bar 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
Given a symbolic link “foo” that points from
/tmp/foo to /, you would use
stat
as follows:
> stat -F /tmp/foo lrwxrwxrwx 1 jschauma cs 1 Apr 24 16:37:28 2002 /tmp/foo@ -> / > stat -LF /tmp/foo drwxr-xr-x 16 root wheel 512 Apr 19 10:57:54 2002 /tmp/foo/
To initialize some shell variables, you could use the
-s
flag as follows:
> csh % eval set `stat -s .cshrc` % echo $st_size $st_mtimespec 1148 1015432481 > sh $ eval $(stat -s .profile) $ echo $st_size $st_mtimespec 1148 1015432481
In order to get a list of file types including files pointed to if the file is a symbolic link, you could use the following format:
$ stat -f "%N: %HT%SY" /tmp/* /tmp/bar: Symbolic Link -> /tmp/foo /tmp/output25568: Regular File /tmp/blah: Directory /tmp/foo: Symbolic Link -> /
In order to get a list of the devices, their types and the major and minor device numbers, formatted with tabs and linebreaks, you could use the following format:
stat -f "Name: %N%n%tType: %HT%n%tMajor: %Hr%n%tMinor: %Lr%n%n" /dev/* [...] Name: /dev/wt8 Type: Block Device Major: 3 Minor: 8 Name: /dev/zero Type: Character Device Major: 2 Minor: 12
In order to determine the permissions set on a file separately, you could use the following format:
> stat -f "%Sp -> owner=%SHp group=%SMp other=%SLp" . drwxr-xr-x -> owner=rwx group=r-x other=r-x
In order to determine the three files that have been modified most recently, you could use the following format:
> stat -f "%m%t%Sm %N" /tmp/* | sort -rn | head -3 | cut -f2- Apr 25 11:47:00 2002 /tmp/blah Apr 25 10:36:34 2002 /tmp/bar Apr 24 16:47:35 2002 /tmp/foo
To display a file's modification time:
> stat -f %m /tmp/foo 1177697733
To display the same modification time in a readable format:
> stat -f %Sm /tmp/foo Apr 27 11:15:33 2007
To display the same modification time in a readable and sortable format:
> stat -f %Sm -t %Y%m%d%H%M%S /tmp/foo 20070427111533
To display the same in UTC:
> sh $ TZ= stat -f %Sm -t %Y%m%d%H%M%S /tmp/foo 20070427181533
file(1), ls(1), lstat(2), readlink(2), stat(2), printf(3), strftime(3)
The stat
utility appeared in
NetBSD 1.6 and FreeBSD
4.10.
The stat
utility was written by
Andrew Brown
<atatat@NetBSD.org>.
This man page was written by Jan Schaumann
<jschauma@NetBSD.org>.
June 22, 2017 | macOS 14.6 |