1LSOF(8)                     System Manager's Manual                    LSOF(8)
2
3
4

NAME

6       lsof - list open files
7

SYNOPSIS

9       lsof  [  -?abChlnNOPRstUvVX  ]  [ -A A ] [ -c c ] [ +c c ] [ +|-d d ] [
10       +|-D D ] [ +|-f [cfgGn] ] [ -F [f] ] [ -g [s] ] [ -i [i] ] [ -k k  ]  [
11       +|-L  [l]  ]  [ +|-m m ] [ +|-M ] [ -o [o] ] [ -p s ] [ +|-r [t] ] [ -S
12       [t] ] [ -T [t] ] [ -u s ] [ +|-w ] [ -x [fl] ] [ -z [z] ] [ -Z [Z] ]  [
13       -- ] [names]
14

DESCRIPTION

16       Lsof  revision  4.78  lists information about files opened by processes
17       for the following UNIX dialects:
18
19            AIX 5.[123]
20            Apple Darwin 7.x and 8.x for Power Macintosh systems
21            FreeBSD 4.x, 4.1x, 5.x and [67].x for x86-based systems
22            FreeBSD 5.x and [67].x for Alpha, AMD64 and Sparc64-based
23                systems
24            HP-UX 11.00, 11.11 and 11.23
25            Linux 2.1.72 and above for x86-based systems
26            NetBSD 1.[456], 2.x and 3.x for Alpha, x86, and SPARC-based
27                systems
28            NEXTSTEP 3.[13] for NEXTSTEP architectures
29            OpenBSD 2.[89] and 3.[0-9] for x86-based systems
30            OPENSTEP 4.x
31            SCO OpenServer Release 5.0.6 for x86-based systems
32            SCO|Caldera UnixWare 7.1.4 for x86-based systems
33            Solaris 2.6, 8, 9 and 10
34            Tru64 UNIX 5.1
35
36       (See the DISTRIBUTION section of this manual page  for  information  on
37       how to obtain the latest lsof revision.)
38
39       An  open file may be a regular file, a directory, a block special file,
40       a character special file, an executing text  reference,  a  library,  a
41       stream  or  a  network  file  (Internet socket, NFS file or UNIX domain
42       socket.)  A specific file or all the files in  a  file  system  may  be
43       selected by path.
44
45       Instead  of  a  formatted display, lsof will produce output that can be
46       parsed by other programs.  See the -F, option description, and the OUT‐
47       PUT FOR OTHER PROGRAMS section for more information.
48
49       In  addition to producing a single output list, lsof will run in repeat
50       mode.  In repeat mode it will produce output, delay,  then  repeat  the
51       output  operation  until stopped with an interrupt or quit signal.  See
52       the +|-r [t] option description for more information.
53

OPTIONS

55       In the absence of any options, lsof lists all open files  belonging  to
56       all active processes.
57
58       If  any  list  request option is specified, other list requests must be
59       specifically requested - e.g., if -U is specified for  the  listing  of
60       UNIX  socket  files, NFS files won't be listed unless -N is also speci‐
61       fied; or if a user list is specified with the -u  option,  UNIX  domain
62       socket  files,  belonging  to  users  not  in the list, won't be listed
63       unless the -U option is also specified.
64
65       Normally list options that are specifically stated  are  ORed  -  i.e.,
66       specifying  the  -i option without an address and the -ufoo option pro‐
67       duces a listing of all network files OR files  belonging  to  processes
68       owned  by  user  ``foo''.   Three  exceptions are: 1) the `^' (negated)
69       login name or user ID (UID), specified with the -u option; 2)  the  `^'
70       (negated)  process  ID  (PID), specified with the -p option; and 3) the
71       `^' (negated) process group ID (PGID), specified with  the  -g  option.
72       Since they represent exclusions, they are applied without ORing or AND‐
73       ing and take effect before any other selection criteria are applied.
74
75       The -a option may be used to AND the selections.  For example, specify‐
76       ing -a, -U, and -ufoo produces a listing of only UNIX socket files that
77       belong to processes owned by user ``foo''.
78
79       Caution: the -a option causes all list selection options to  be  ANDed;
80       it can't be used to cause ANDing of selected pairs of selection options
81       by placing it between them, even though its placement there is  accept‐
82       able.   Wherever  -a  is  placed, it causes the ANDing of all selection
83       options.
84
85       Items of the same selection set - command names, file descriptors, net‐
86       work  addresses,  process  identifiers,  user  identifiers, zone names,
87       security contexts - are joined in a single ORed set and applied  before
88       the  result  participates  in  ANDing.   Thus,  for example, specifying
89       -i@aaa.bbb, -i@ccc.ddd, -a, and -ufff,ggg will select  the  listing  of
90       files  that  belong to either login ``fff'' OR ``ggg'' AND have network
91       connections to either host aaa.bbb OR ccc.ddd.
92
93       Options may be grouped together following a single prefix -- e.g.,  the
94       option  set  ``-a -b -C'' may be stated as -abC.  However, since values
95       are optional following +|-f, -F, -g, -i, +|-L, -o, +|-r, -S, -T, -x and
96       -z.   when  you  have  no values for them be careful that the following
97       character isn't ambiguous.  For example, -Fn might represent the -F and
98       -n options, or it might represent the n field identifier character fol‐
99       lowing the -F option.  When ambiguity is possible, start a  new  option
100       with  a  `-' character - e.g., ``-F -n''.  If the next option is a file
101       name, follow the possibly ambiguous option with ``--'' - e.g., ``-F  --
102       name''.
103
104       Either  the `+' or the `-' prefix may be applied to a group of options.
105       Options that don't take on separate meanings for each prefix - e.g., -i
106       - may be grouped under either prefix.  Thus, for example, ``+M -i'' may
107       be stated as ``+Mi'' and the group  means  the  same  as  the  separate
108       options.  Be careful of prefix grouping when one or more options in the
109       group does take on separate meanings under different prefixes  -  e.g.,
110       +|-M; ``-iM'' is not the same request as ``-i +M''.  When in doubt, use
111       separate options with appropriate prefixes.
112
113       -? -h    These two equivalent options  select  a  usage  (help)  output
114                list.   Lsof  displays a shortened form of this output when it
115                detects an error in the options supplied to it, after  it  has
116                displayed  messages  explaining  each  error.  (Escape the `?'
117                character as your shell requires.)
118
119       -a       This option causes list selection  options  to  be  ANDed,  as
120                described above.
121
122       -A A     This  option  is available on systems configured for AFS whose
123                AFS kernel code is implemented via dynamic modules.  It allows
124                the  lsof  user  to  specify  A as an alternate name list file
125                where the kernel addresses of the  dynamic  modules  might  be
126                found.  See the lsof FAQ (The FAQ section gives its location.)
127                for more information about dynamic modules, their symbols, and
128                how they affect lsof.
129
130       -b       This  option  causes lsof to avoid kernel functions that might
131                block - lstat(2), readlink(2), and stat(2).
132
133                See the BLOCKS AND TIMEOUTS and AVOIDING  KERNEL  BLOCKS  sec‐
134                tions for information on using this option.
135
136       -c c     This option selects the listing of files for processes execut‐
137                ing the command that begins with the characters of c.   Multi‐
138                ple  commands  may  be  specified,  using multiple -c options.
139                They are joined in a single ORed set before  participating  in
140                AND option selection.
141
142                If  c  begins  and  ends  with  a  slash ('/'), the characters
143                between the slashes are interpreted as a  regular  expression.
144                Shell meta-characters in the regular expression must be quoted
145                to prevent their interpretation by  the  shell.   The  closing
146                slash may be followed by these modifiers:
147
148                     b    the regular expression is a basic one.
149                     i    ignore the case of letters.
150                     x    the regular expression is an extended one
151                          (default).
152
153                See  the  lsof  FAQ (The FAQ section gives its location.)  for
154                more information on basic and extended regular expressions.
155
156                The simple command specification is  tested  first.   If  that
157                test fails, the command regular expression is applied.  If the
158                simple command test succeeds, the command  regular  expression
159                test  isn't  made.   This may result in ``no command found for
160                regex:'' messages when lsof's -V option is specified.
161
162       +c w     This option defines the maximum number of  initial  characters
163                of the name, supplied by the UNIX dialect, of the UNIX command
164                associated with a process to be printed in the COMMAND column.
165                (The lsof default is nine.)
166
167                Note  that  many  UNIX dialects do not supply all command name
168                characters to lsof in the files and structures from which lsof
169                obtains  command  name.   Often  dialects  limit the number of
170                characters supplied in  those  sources.   For  example,  Linux
171                2.4.27  and  Solaris  9  both  limit command name length to 16
172                characters.
173
174                If w is zero ('0'), all command characters supplied to lsof by
175                the UNIX dialect will be printed.
176
177                If w is less than the length of the column title, ``COMMAND'',
178                it will be raised to that length.
179
180       -C       This option disables the reporting of any path name components
181                from  the kernel's name cache.  See the KERNEL NAME CACHE sec‐
182                tion for more information.
183
184       +d s     This option causes lsof to search for all  open  instances  of
185                directory  s  and the files and directories it contains at its
186                top level.  This option does NOT descend the  directory  tree,
187                rooted  at  s.   The  +D  D  option  may  be used to request a
188                full-descent directory tree search, rooted at directory D.
189
190                Processing of the +d option does  not  follow  symbolic  links
191                within s unless the -x or -x  l option is also specified.  Nor
192                does it search for open files on file system mount  points  on
193                subdirectories  of  s  unless  the  -x or -x  f option is also
194                specified.
195
196                Note: the authority of the user of this option  limits  it  to
197                searching  for  files  that the user has permission to examine
198                with the system stat(2) function.
199
200       -d s     This option specifies a list  of  file  descriptors  (FDs)  to
201                exclude  from  or  include  in  the  output listing.  The file
202                descriptors are specified in the comma-separated set s - e.g.,
203                ``cwd,1,3'',  ``^6,^2''.   (There  should  be no spaces in the
204                set.)
205
206                The list is an exclusion list if all entries of the set  begin
207                with  '^'.   It  is  an inclusion list if no entry begins with
208                '^'.  Mixed lists are not permitted.
209
210                A file descriptor number range may be in the set  as  long  as
211                neither  member  is  empty,  both members are numbers, and the
212                ending member is larger than the starting one - e.g.,  ``0-7''
213                or  ``3-10''.   Ranges  may be specified for exclusion if they
214                have the  '^'  prefix  -  e.g.,  ``^0-7''  excludes  all  file
215                descriptors 0 through 7.
216
217                Multiple  file  descriptor numbers are joined in a single ORed
218                set before participating in AND option selection.
219
220                When there are exclusion and inclusion  members  in  the  set,
221                lsof  reports  them as errors and exits with a non-zero return
222                code.
223
224                See the description of File Descriptor (FD) output  values  in
225                the  OUTPUT  section  for  more information on file descriptor
226                names.
227
228       +D D     This option causes lsof to search for all  open  instances  of
229                directory  D  and all the files and directories it contains to
230                its complete depth.
231
232                Processing of the +D option does  not  follow  symbolic  links
233                within D unless the -x or -x  l option is also specified.  Nor
234                does it search for open files on file system mount  points  on
235                subdirectories  of  D  unless  the  -x or -x  f option is also
236                specified.
237
238                Note: the authority of the user of this option  limits  it  to
239                searching  for  files  that the user has permission to examine
240                with the system stat(2) function.
241
242                Further note: lsof may process this option slowly and  require
243                a large amount of dynamic memory to do it.  This is because it
244                must descend the entire directory tree, rooted at  D,  calling
245                stat(2)  for  each  file and directory, building a list of all
246                the files it finds, and searching that list for a  match  with
247                every  open  file.  When directory D is large, these steps can
248                take a long time, so use this option prudently.
249
250       -D D     This option directs lsof's use of the device cache file.   The
251                use  of  this  option is sometimes restricted.  See the DEVICE
252                CACHE FILE section and the sections that follow  it  for  more
253                information on this option.
254
255                -D  must be followed by a function letter; the function letter
256                may optionally be followed by a path  name.   Lsof  recognizes
257                these function letters:
258
259                     ? - report device cache file paths
260                     b - build the device cache file
261                     i - ignore the device cache file
262                     r - read the device cache file
263                     u - read and update the device cache file
264
265                The  b,  r,  and  u functions, accompanied by a path name, are
266                sometimes restricted.  When these  functions  are  restricted,
267                they  will not appear in the description of the -D option that
268                accompanies -h or -?  option output.   See  the  DEVICE  CACHE
269                FILE section and the sections that follow it for more informa‐
270                tion on these functions and when they're restricted.
271
272                The ?  function reports the read-only  and  write  paths  that
273                lsof can use for the device cache file, the names of any envi‐
274                ronment variables whose values lsof will examine when  forming
275                the  device  cache  file path, and the format for the personal
276                device cache file path.  (Escape the  `?'  character  as  your
277                shell requires.)
278
279                When  available,  the b, r, and u functions may be followed by
280                the  device  cache  file's  path.   The  standard  default  is
281                .lsof_hostname  in the home directory of the real user ID that
282                executes lsof, but this could have been changed when lsof  was
283                configured  and  compiled.   (The  output  of  the  -h  and -?
284                options show the current default prefix  -  e.g.,  ``.lsof''.)
285                The  suffix,  hostname,  is  the first component of the host's
286                name returned by gethostname(2).
287
288                When available, the b function directs lsof  to  build  a  new
289                device cache file at the default or specified path.
290
291                The i function directs lsof to ignore the default device cache
292                file and obtain its information about devices via direct calls
293                to the kernel.
294
295                The  r  function  directs lsof to read the device cache at the
296                default or specified path, but prevents it from creating a new
297                device  cache  file  when  none  exists or the existing one is
298                improperly structured.  The r function, when specified without
299                a  path name, prevents lsof from updating an incorrect or out‐
300                dated device cache file, or creating a new one in  its  place.
301                The  r function is always available when it is specified with‐
302                out a path name argument; it may be restricted by the  permis‐
303                sions of the lsof process.
304
305                When available, the u function directs lsof to read the device
306                cache file at the default or specified path, if possible,  and
307                to rebuild it, if necessary.  This is the default device cache
308                file function when no -D option has been specified.
309
310       +|-f [cfgGn]
311                f by itself clarifies how path name arguments are to be inter‐
312                preted.   When followed by c, f, g, G, or n in any combination
313                it specifies that the listing of kernel file structure  infor‐
314                mation is to be enabled (`+') or inhibited (`-').
315
316                Normally  a  path  name  argument is taken to be a file system
317                name if it matches a mounted-on  directory  name  reported  by
318                mount(8),  or  if  it  represents a block device, named in the
319                mount output and associated with  a  mounted  directory  name.
320                When +f is specified, all path name arguments will be taken to
321                be file system names, and lsof will complain if any  are  not.
322                This  can  be  useful,  for example, when the file system name
323                (mounted-on device) isn't a block device.   This  happens  for
324                some CD-ROM file systems.
325
326                When  -f  is specified by itself, all path name arguments will
327                be taken to be simple files.  Thus, for example,  the  ``-f --
328                /''  arguments direct lsof to search for open files with a `/'
329                path name, not all open files in the `/' (root) file system.
330
331                Be careful to make sure +f and -f are properly terminated  and
332                aren't followed by a character (e.g., of the file or file sys‐
333                tem name) that might be taken as a  parameter.   For  example,
334                use ``--'' after +f and -f as in these examples.
335
336                     $ lsof +f -- /file/system/name
337                     $ lsof -f -- /file/name
338
339                The  listing  of  information  from  kernel  file  structures,
340                requested with the +f [cfgGn] option form, is normally  inhib‐
341                ited,   and  is  not  available  for  some  dialects  -  e.g.,
342                /proc-based Linux.  When the prefix to f is a plus sign (`+'),
343                these characters request file structure information:
344
345                     c    file structure use count
346                     f    file structure address
347                     g    file flag abbreviations
348                     G    file flags in hexadecimal
349                     n    file structure node address
350
351                When the prefix is minus (`-') the same characters disable the
352                listing of the indicated values.
353
354                File  structure  addresses,  use  counts,  flags,   and   node
355                addresses  may  be used to detect more readily identical files
356                inherited by child processes and identical  files  in  use  by
357                different processes.  Lsof column output can be sorted by out‐
358                put columns holding the values and listed to identify  identi‐
359                cal  file use, or lsof field output can be parsed by an AWK or
360                Perl post-filter script, or by a C program.
361
362       -F f     This option specifies a character list, f,  that  selects  the
363                fields to be output for processing by another program, and the
364                character that terminates each output field.  Each field to be
365                output  is  specified with a single character in f.  The field
366                terminator defaults to NL, but may be changed  to  NUL  (000).
367                See the OUTPUT FOR OTHER PROGRAMS section for a description of
368                the field  identification  characters  and  the  field  output
369                process.
370
371                When the field selection character list is empty, all standard
372                fields are selected (except the  raw  device  field,  security
373                context  and  zone field for compatibility reasons) and the NL
374                field terminator is used.
375
376                When the field selection character list contains only  a  zero
377                (`0'),  all  fields  are selected (except the raw device field
378                for compatibility reasons) and the NUL terminator character is
379                used.
380
381                Other combinations of fields and their associated field termi‐
382                nator character must be set with explicit  entries  in  f,  as
383                described in the OUTPUT FOR OTHER PROGRAMS section.
384
385                When  a field selection character identifies an item lsof does
386                not normally list - e.g., PPID, selected with -R -  specifica‐
387                tion of the field character - e.g., ``-FR'' - also selects the
388                listing of the item.
389
390                When the field selection character list  contains  the  single
391                character  `?',  lsof  will  display  a help list of the field
392                identification characters.  (Escape the `?' character as  your
393                shell requires.)
394
395       -g [s]   This  option  excludes or selects the listing of files for the
396                processes whose optional process group  IDentification  (PGID)
397                numbers  are  in  the comma-separated set s - e.g., ``123'' or
398                ``123,^456''.  (There should be no spaces in the set.)
399
400                PGID numbers that begin with `^' (negation)  represent  exclu‐
401                sions.
402
403                Multiple  PGID  numbers are joined in a single ORed set before
404                participating in AND option selection.  However,  PGID  exclu‐
405                sions  are  applied  without  ORing  or ANDing and take effect
406                before other selection criteria are applied.
407
408                The -g option also enables the output display of PGID numbers.
409                When specified without a PGID set that's all it does.
410
411       -i [i]   This option selects the listing of files any of whose Internet
412                address matches the address specified in i.  If no address  is
413                specified, this option selects the listing of all Internet and
414                x.25 (HP-UX) network files.
415
416                If -i4 or -i6 is specified with  no  following  address,  only
417                files  of  the  indicated  IP  version, IPv4 or IPv6, are dis‐
418                played.  (An IPv6  specification  may  be  used  only  if  the
419                dialects   supports   IPv6,   as  indicated  by  ``[46]''  and
420                ``IPv[46]'' in lsof's -h or -?  output.)  Sequentially  speci‐
421                fying  -i4,  followed by -i6 is the same as specifying -i, and
422                vice-versa.  Specifying -i4, or -i6 after -i is  the  same  as
423                specifying -i4 or -i6 by itself.
424
425                Multiple  addresses  (up  to  a limit of 100) may be specified
426                with multiple -i options.  (A  port  number  or  service  name
427                range is counted as one address.)  They are joined in a single
428                ORed set before participating in AND option selection.
429
430                An Internet address is specified in the form (Items in  square
431                brackets are optional.):
432
433                [46][protocol][@hostname|hostaddr][:service|port]
434
435                where:
436                     46 specifies the IP version, IPv4 or IPv6
437                          that applies to the following address.
438                          '6' may be be specified only if the UNIX
439                          dialect supports IPv6.  If neither '4' nor
440                          '6' is specified, the following address
441                          applies to all IP versions.
442                     protocol is a protocol name - TCP or UDP.
443                     hostname is an Internet host name.  Unless a
444                          specific IP version is specified, open
445                          network files associated with host names
446                          of all versions will be selected.
447                     hostaddr is a numeric Internet IPv4 address in
448                          dot form; or an IPv6 numeric address in
449                          colon form, enclosed in brackets, if the
450                          UNIX dialect supports IPv6.  When an IP
451                          version is selected, only its numeric
452                          addresses may be specified.
453                     service is an /etc/services name - e.g., smtp -
454                          or a list of them.
455                     port is a port number, or a list of them.
456
457                IPv6  options  may  be  used only if the UNIX dialect supports
458                IPv6.  To see if the dialect supports IPv6, run lsof and spec‐
459                ify the -h or -?  (help) option.  If the displayed description
460                of the -i option contains ``[46]'' and  ``IPv[46]'',  IPv6  is
461                supported.
462
463                IPv4  host names and addresses may not be specified if network
464                file selection is limited to IPv6 with -i 6.  IPv6 host  names
465                and  addresses  may not be specified if network file selection
466                is limited to IPv4 with -i  4.   When  an  open  IPv4  network
467                file's  address  is mapped in an IPv6 address, the open file's
468                type will be IPv6, not IPv4, and its display will be  selected
469                by '6', not '4'.
470
471                At  least one address component - 4, 6, protocol, ,IR hostname
472                , hostaddr, or service - must be supplied.  The `@' character,
473                leading  the host specification, is always required; as is the
474                `:', leading the port specification.  Specify either  hostname
475                or  hostaddr.  Specify either service name list or port number
476                list.  If a service name list is specified, the  protocol  may
477                also  need to be specified if the TCP and UDP port numbers for
478                the service name are different.  Use any case - lower or upper
479                - for protocol.
480
481                Service names and port numbers may be combined in a list whose
482                entries are  separated  by  commas  and  whose  numeric  range
483                entries  are separated by minus signs.  There may be no embed‐
484                ded spaces, and all service names must belong to the specified
485                protocol.   Since  service  names  may  contain embedded minus
486                signs, the starting entry of a range can't be a service  name;
487                it can be a port number, however.
488
489                Here are some sample addresses:
490
491                     -i6 - IPv6 only
492                     TCP:25 - TCP and port 25
493                     @1.2.3.4 - Internet IPv4 host address 1.2.3.4
494                     @[3ffe:1ebc::1]:1234 - Internet IPv6 host address
495                          3ffe:1ebc::1, port 1234
496                     UDP:who - UDP who service port
497                     TCP@lsof.itap:513 - TCP, port 513 and host name lsof.itap
498                     tcp@foo:1-10,smtp,99 - TCP, ports 1 through 10,
499                          service name smtp, port 99, host name foo
500                     tcp@bar:1-smtp - TCP, ports 1 through smtp, host bar
501                     :time - either TCP or UDP time service port
502
503       -k k     This  option specifies a kernel name list file, k, in place of
504                /vmunix, /mach, etc.  This option is not available  under  AIX
505                on the IBM RISC/System 6000.
506
507       -l       This  option  inhibits  the  conversion  of user ID numbers to
508                login names.  It is also useful  when  login  name  lookup  is
509                working improperly or slowly.
510
511       +|-L [l] This  option  enables  (`+')  or disables (`-') the listing of
512                file link counts, where they are available - e.g., they aren't
513                available for sockets, or most FIFOs and pipes.
514
515                When  +L  is  specified  without  a following number, all link
516                counts will be listed.  When -L is specified (the default), no
517                link counts will be listed.
518
519                When  +L  is  followed  by  a number, only files having a link
520                count less than that number will be listed.   (No  number  may
521                follow  -L.)   A specification of the form ``+L1'' will select
522                open files that have been unlinked.  A  specification  of  the
523                form ``+aL1 <file_system>'' will select unlinked open files on
524                the specified file system.
525
526                For other link count comparisons, use field output (-F) and  a
527                post-processing script or program.
528
529       +|-m m   This option specifies an alternate kernel memory file or acti‐
530                vates mount table supplement processing.
531
532                The option form -m m specifies a kernel  memory  file,  m,  in
533                place of /dev/kmem or /dev/mem - e.g., a crash dump file.
534
535                The  option  form  +m requests that a mount supplement file be
536                written to the standard output file.  All  other  options  are
537                silently ignored.
538
539                There  will  be  a  line in the mount supplement file for each
540                mounted file system, containing the mounted file system direc‐
541                tory,  followed by a single space, followed by the device num‐
542                ber in hexadecimal "0x" format - e.g.,
543
544                     / 0x801
545
546                Lsof can use the mount supplement file to get  device  numbers
547                for  file  systems  when  it  can't  get  them  via stat(2) or
548                lstat(2).
549
550                The option form +m m identifies m as a mount supplement file.
551
552                Note: the +m and +m m options are not available for  all  sup‐
553                ported dialects.  Check the output of lsof's -h or -?  options
554                to see if the +m and +m m options are available.
555
556       +|-M     Enables (+) or disables (-) the reporting of portmapper regis‐
557                trations  for  local TCP and UDP ports.  The default reporting
558                mode is set  by  the  lsof  builder  with  the  HASPMAPENABLED
559                #define  in  the dialect's machine.h header file; lsof is dis‐
560                tributed  with  the  HASPMAPENABLED  #define  deactivated,  so
561                portmapper  reporting  is  disabled  by  default  and  must be
562                requested with +M.  Specifying lsof's -h or  -?   option  will
563                report  the  default  mode.  Disabling portmapper registration
564                when it is  already  disabled  or  enabling  it  when  already
565                enabled is acceptable.
566
567                When  portmapper  registration reporting is enabled, lsof dis‐
568                plays the portmapper registration (if any) for  local  TCP  or
569                UDP  ports  in  square brackets immediately following the port
570                numbers  or  service  names   -   e.g.,   ``:1234[name]''   or
571                ``:name[100083]''.  The registration information may be a name
572                or number, depending on what the registering program  supplied
573                to the portmapper when it registered the port.
574
575                When  portmapper  registration  reporting is enabled, lsof may
576                run a little more slowly or even become blocked when access to
577                the  portmapper  becomes  congested  or  stopped.  Reverse the
578                reporting mode to determine if portmapper registration report‐
579                ing is slowing or blocking lsof.
580
581                For purposes of portmapper registration reporting lsof consid‐
582                ers a TCP or UDP port local if: it is found in the local  part
583                of its containing kernel structure; or if it is located in the
584                foreign part of its containing kernel structure and the  local
585                and  foreign  Internet  addresses  are  the  same; or if it is
586                located in the foreign part of its containing kernel structure
587                and   the   foreign   Internet   address   is  INADDR_LOOPBACK
588                (127.0.0.1).  This rule may  make  lsof  ignore  some  foreign
589                ports  on  machines  with multiple interfaces when the foreign
590                Internet address is on a different interface  from  the  local
591                one.
592
593                See  the  lsof  FAQ (The FAQ section gives its location.)  for
594                further  discussion  of  portmapper   registration   reporting
595                issues.
596
597       -n       This option inhibits the conversion of network numbers to host
598                names for network files.  Inhibiting conversion may make  lsof
599                run  faster.   It  is also useful when host name lookup is not
600                working properly.
601
602       -N       This option selects the listing of NFS files.
603
604       -o       This option directs lsof to display file offset at all  times.
605                It  causes  the  SIZE/OFF output column title to be changed to
606                OFFSET.  Note: on some UNIX dialects lsof can't  obtain  accu‐
607                rate  or  consistent  file  offset information from its kernel
608                data sources, sometimes just for  particular  kinds  of  files
609                (e.g.,  socket  files.)  Consult the lsof FAQ (The FAQ section
610                gives its location.)  for more information.
611
612                The -o and -s options are mutually exclusive; they can't  both
613                be  specified.  When neither is specified, lsof displays what‐
614                ever value - size or offset - is appropriate and available for
615                the type of the file.
616
617       -o o     This  option  defines  the  number of decimal digits (o) to be
618                printed after the ``0t'' for a file offset before the form  is
619                switched to ``0x...''.  An o value of zero (unlimited) directs
620                lsof to use the ``0t'' form for all offset output.
621
622                This option does NOT direct lsof  to  display  offset  at  all
623                times;  specify  -o  (without  a  trailing number) to do that.
624                This option only specifies the number of digits  after  ``0t''
625                in  either mixed size and offset or offset-only output.  Thus,
626                for example, to direct lsof to display  offset  at  all  times
627                with a decimal digit count of 10, use:
628
629                     -o -o 10
630                or
631                     -oo10
632
633                The  default number of digits allowed after ``0t'' is normally
634                8, but may have been changed by the lsof builder.  Consult the
635                description  of  the -o o option in the output of the -h or -?
636                option to determine the default that is in effect.
637
638       -O       This option directs lsof to bypass the  strategy  it  uses  to
639                avoid  being  blocked  by some kernel operations - i.e., doing
640                them in forked child processes.  See the BLOCKS  AND  TIMEOUTS
641                and  AVOIDING  KERNEL  BLOCKS sections for more information on
642                kernel operations that may block lsof.
643
644                While use of this option will reduce lsof startup overhead, it
645                may also cause lsof to hang when the kernel doesn't respond to
646                a function.  Use this option cautiously.
647
648       -p s     This option excludes or selects the listing of files  for  the
649                processes  whose optional process IDentification (PID) numbers
650                are  in  the  comma-separated  set  s  -  e.g.,   ``123''   or
651                ``123,^456''.  (There should be no spaces in the set.)
652
653                PID  numbers  that  begin with `^' (negation) represent exclu‐
654                sions.
655
656                Multiple process ID numbers are joined in a  single  ORed  set
657                before  participating  in  AND option selection.  However, PID
658                exclusions are applied without ORing or ANDing and take effect
659                before other selection criteria are applied.
660
661       -P       This  option  inhibits  the conversion of port numbers to port
662                names for network files.  Inhibiting the conversion  may  make
663                lsof  run  a  little faster.  It is also useful when port name
664                lookup is not working properly.
665
666       +|-r [t] This option puts lsof in repeat mode.  There lsof  lists  open
667                files  as selected by other options, delays t seconds (default
668                fifteen), then  repeats  the  listing,  delaying  and  listing
669                repetitively  until stopped by a condition defined by the pre‐
670                fix to the option.
671
672                If the prefix is a `-', repeat mode is endless.  Lsof must  be
673                terminated with an interrupt or quit signal.
674
675                If  the prefix is `+', repeat mode will end the first cycle no
676                open files are listed - and of course  when  lsof  is  stopped
677                with  an  interrupt  or  quit  signal.   When repeat mode ends
678                because no files are listed, the process  exit  code  will  be
679                zero  if  any  open  files were ever listed; one, if none were
680                ever listed.
681
682                Lsof marks the end of each listing:  if  field  output  is  in
683                progress  (the  -F,  option has been specified), the marker is
684                `m'; otherwise the marker is ``========''.  The marker is fol‐
685                lowed by a NL character.
686
687                Repeat mode reduces lsof startup overhead, so it is more effi‐
688                cient to use this mode than to call lsof repetitively  from  a
689                shell script, for example.
690
691                To use repeat mode most efficiently, accompany +|-r with spec‐
692                ification of other lsof selection options, so  the  amount  of
693                kernel  memory  access  lsof  does  will be kept to a minimum.
694                Options that filter at the process level - e.g., -c,  -g,  -p,
695                -u - are the most efficient selectors.
696
697                Repeat  mode is useful when coupled with field output (see the
698                -F, option description) and a supervising awk or Perl  script,
699                or a C program.
700
701       -R       This  option directs lsof to list the Parent Process IDentifi‐
702                cation number in the PPID column.
703
704       -s       This option directs lsof to display file size  at  all  times.
705                It  causes  the  SIZE/OFF output column title to be changed to
706                SIZE.  If the file does not have a size, nothing is displayed.
707
708                The -o (without  a  following  decimal  digit  count)  and  -s
709                options  are mutually exclusive; they can't both be specified.
710                When neither is specified, lsof displays whatever value - size
711                or offset - is appropriate and available for the type of file.
712
713                Since  some  types  of  files don't have true sizes - sockets,
714                FIFOs, pipes, etc. - lsof displays for their sizes the content
715                amounts in their associated kernel buffers, if possible.
716
717       -S [t]   This  option  specifies an optional time-out seconds value for
718                kernel functions - lstat(2), readlink(2), and stat(2)  -  that
719                might  otherwise  deadlock.   The  minimum  for  t is two; the
720                default, fifteen; when no value is specified, the  default  is
721                used.
722
723                See the BLOCKS AND TIMEOUTS section for more information.
724
725       -T [t]   This  option  controls  the reporting of some TCP/TPI informa‐
726                tion, also  reported  by  netstat(1),  following  the  network
727                addresses.  In normal output the information appears in paren‐
728                theses, each item except state identified by a  keyword,  fol‐
729                lowed by `=', separated from others by a single space:
730
731                     <TCP or TPI state name>
732                     QR=<read queue length>
733                     QS=<send queue length>
734                     SO=<socket options and values>
735                     SS=<socket states>
736                     TF=<TCP flags and values>
737                     WR=<window read length>
738                     WW=<window write length>
739
740                Not all values are reported for all UNIX dialects.  Items val‐
741                ues (when available) are reported after the item name and '='.
742
743                When the field output mode is in effect (See OUTPUT FOR  OTHER
744                PROGRAMS.)   each  item  appears as a field with a `T' leading
745                character.
746
747                -T with no following key characters disables TCP/TPI  informa‐
748                tion reporting.
749
750                -T with following characters selects the reporting of specific
751                TCP/TPI information:
752
753                     f    selects reporting of socket options,
754                          states and values, and TCP flags and
755                          values.
756                     q    selects queue length reporting.
757                     s    selects connection state reporting.
758                     w    selects window size reporting.
759
760                Not all selections are enabled for some UNIX dialects.   State
761                may  be  selected for all dialects and is reported by default.
762                The -h or -?  help output for the -T  option  will  show  what
763                selections may be used with the UNIX dialect.
764
765                When  -T  is used to select information - i.e., it is followed
766                by one or more selection characters - the displaying of  state
767                is  disabled  by  default,  and it must be explicitly selected
768                again in the characters following -T.  (In effect,  then,  the
769                default  is equivalent to -Ts.)  For example, if queue lengths
770                and state are desired, use -Tqs.
771
772                Socket options, socket states, some socket values,  TCP  flags
773                and  one TCP value may be reported (when available in the UNIX
774                dialect) in the form of the names that commonly  appear  after
775                SO_,  so_,  SS_, TCP_  and TF_ in the dialect's header files -
776                most    often    <sys/socket.h>,     <sys/socketvar.h>     and
777                <netinet/tcp_var.h>.  Consult those header files for the mean‐
778                ing of the flags, options, states and values.
779
780                ``SO='' precedes socket options and  values;  ``SS='',  socket
781                states; and ``TF='', TCP flags and values.
782
783                If  a flag or option has a value, the value will follow an '='
784                and  the  name  --   e.g.,   ``SO=LINGER=5'',   ``SO=QLIM=5'',
785                ``TF=MSS=512''.  The following seven values may be reported:
786
787                     Name
788                     Reported  Description (Common Symbol)
789
790                     KEEPALIVE keep alive time (SO_KEEPALIVE)
791                     LINGER    linger time (SO_LINGER)
792                     MSS       maximum segment size (TCP_MAXSEG)
793                     PQLEN     partial listen queue connections
794                     QLEN      established listen queue connections
795                     QLIM      established listen queue limit
796                     RCVBUF    receive buffer length (SO_RCVBUF)
797                     SNDBUF    send buffer length (SO_SNDBUF)
798
799                Details  on what socket options and values, socket states, and
800                TCP flags and values may  be  displayed  for  particular  UNIX
801                dialects  may be found in the answer to the ``Why doesn't lsof
802                report socket options, socket states, and TCP flags and values
803                for  my  dialect?''  and ``Why doesn't lsof report the partial
804                listen queue connection count for my dialect?''  questions  in
805                the lsof FAQ (The FAQ section gives its location.)
806
807       -t       This  option  specifies  that lsof should produce terse output
808                with process identifiers only and no header -  e.g.,  so  that
809                the  output  may be piped to kill(1).  This option selects the
810                -w option.
811
812       -u s     This option selects the listing of files for  the  user  whose
813                login  names or user ID numbers are in the comma-separated set
814                s - e.g., ``abe'', or ``548,root''.  (There should be no  spa‐
815                ces in the set.)
816
817                Multiple login names or user ID numbers are joined in a single
818                ORed set before participating in AND option selection.
819
820                If a login name or user ID is preceded by a `^', it becomes  a
821                negation - i.e., files of processes owned by the login name or
822                user ID will never be listed.  A negated login name or user ID
823                selection  is neither ANDed nor ORed with other selections; it
824                is applied before all other selections and absolutely excludes
825                the  listing  of  the  files  of the process.  For example, to
826                direct lsof to exclude the listing of files belonging to  root
827                processes, specify ``-u^root'' or ``-u^0''.
828
829       -U       This option selects the listing of UNIX domain socket files.
830
831       -v       This  option  selects the listing of lsof version information,
832                including: revision number; when  the  lsof  binary  was  con‐
833                structed;  who  constructed  the binary and where; the name of
834                the compiler used to construct the lsof  binary;  the  version
835                number  of  the  compiler when readily available; the compiler
836                and loader flags used to construct the lsof binary; and system
837                information, typically the output of uname's -a option.
838
839       -V       This option directs lsof to indicate the items it was asked to
840                list and failed to find - command names, file names,  Internet
841                addresses  or  files, login names, NFS files, PIDs, PGIDs, and
842                UIDs.
843
844                When other options  are  ANDed  to  search  options,  or  com‐
845                pile-time options restrict the listing of some files, lsof may
846                not report that it failed to find a search item when an  ANDed
847                option or compile-time option prevents the listing of the open
848                file containing the located search item.
849
850                For example, ``lsof -V -iTCP@foobar -a -d 999'' may not report
851                a  failure  to locate open files at ``TCP@foobar'' and may not
852                list any, if none have a file descriptor  number  of  999.   A
853                similar  situation  arises when HASSECURITY and HASNOSOCKSECU‐
854                RITY are defined at compile time and they prevent the  listing
855                of open files.
856
857       +|-w     Enables  (+)  or  disables (-) the suppression of warning mes‐
858                sages.
859
860                The lsof builder may choose to have warning messages  disabled
861                or  enabled  by default.  The default warning message state is
862                indicated in the output of the -h or  -?   option.   Disabling
863                warning  messages  when  they are already disabled or enabling
864                them when already enabled is acceptable.
865
866                The -t option selects the -w option.
867
868       -x  [fl] This option may accompany the +d  and  +D  options  to  direct
869                their processing to cross over symbolic links and|or file sys‐
870                tem mount points encountered when scanning the directory  (+d)
871                or directory tree (+D).
872
873                If  -x  is  specified by itself without a following parameter,
874                cross-over processing of both symbolic links and  file  system
875                mount points is enabled.  Note that when -x is specified with‐
876                out a parameter, the next argument must begin with '-' or '+'.
877
878                The optional 'f' parameter enables  file  system  mount  point
879                cross-over  processing; 'l', symbolic link cross-over process‐
880                ing.
881
882                The -x option may not be supplied without also supplying a  +d
883                or +D option.
884
885       -X       This is a dialect-specific option.
886
887           AIX:
888                This IBM AIX RISC/System 6000 option requests the reporting of
889                executed text file and shared library references.
890
891                WARNING: because this option uses the kernel readx() function,
892                its  use  on  a  busy  AIX  system  might cause an application
893                process to hang so completely that it can  neither  be  killed
894                nor stopped.  I have never seen this happen or had a report of
895                its happening, but I think there is a  remote  possibility  it
896                could happen.
897
898                By  default  use  of readx() is disabled.  On AIX 5L and above
899                lsof may need setuid-root permission to  perform  the  actions
900                this option requests.
901
902                The  lsof builder may specify that the -X option be restricted
903                to processes whose real UID is root.  If that has  been  done,
904                the  -X  option  will  not appear in the -h or -?  help output
905                unless the real UID of the lsof process is root.  The  default
906                lsof  distribution allows any UID to specify -X, so by default
907                it will appear in the help output.
908
909                When AIX readx() use is disabled, lsof  may  not  be  able  to
910                report  information  for  all text and loader file references,
911                but it may also avoid exacerbating  an  AIX  kernel  directory
912                search kernel error, known as the Stale Segment ID bug.
913
914                The  readx()  function,  used  by lsof or any other program to
915                access some sections of kernel virtual memory, can trigger the
916                Stale  Segment ID bug.  It can cause the kernel's dir_search()
917                function to believe erroneously that part of an in-memory copy
918                of  a file system directory has been zeroed.  Another applica‐
919                tion process, distinct from lsof, asking the kernel to  search
920                the   directory   -   e.g.,  by  using  open(2)  -  can  cause
921                dir_search() to loop forever,  thus  hanging  the  application
922                process.
923
924                Consult  the  lsof  FAQ  (The FAQ section gives its location.)
925                and the 00README file of the lsof distribution for a more com‐
926                plete  description  of the Stale Segment ID bug, its APAR, and
927                methods for defining readx() use when compiling lsof.
928
929           Linux:
930                This Linux option requests that lsof  skip  the  reporting  of
931                information on all open TCP and UDP IPv4 and IPv6 files.
932
933                This  Linux  option  is  most  useful  when  the system has an
934                extremely large number of open TCP and UDP files, the process‐
935                ing   of   whose   information   in   the  /proc/net/tcp*  and
936                /proc/net/udp* files would take lsof a long  time,  and  whose
937                reporting is not of interest.
938
939                Use  this option with care and only when you are sure that the
940                information you want lsof to  display  isn't  associated  with
941                open TCP or UDP socket files.
942
943           Solaris 10 and above:
944                This  Solaris  10  and  above option requests the reporting of
945                cached paths for files that have been deleted - i.e.,  removed
946                with rm(1) or unlink(2).
947
948                The  cached  path  is followed by the string `` (deleted)'' to
949                indicate that the path by which the file was opened  has  been
950                deleted.
951
952                Because  intervening  changes made to the path - i.e., renames
953                with mv(1) or rename(2) - are not recorded in the cached path,
954                what  lsof  reports  is  only  the  path by which the file was
955                opened, not its possibly different final path.
956
957       -z [z]   specifies how Solaris 10 and higher zone information is to  be
958                handled.
959
960                Without  a following argument - e.g., NO z - the option speci‐
961                fies that zone names are to be listed in the ZONE output  col‐
962                umn.
963
964                The  -z option may be followed by a zone name, z.  That causes
965                lsof to list only open files for processes in that zone.  Mul‐
966                tiple  -z z option and argument pairs may be specified to form
967                a list of named zones.  Any open file of any process in any of
968                the  zones  will be listed, subject to other conditions speci‐
969                fied by other options and arguments.
970
971       -Z [Z]   specifies how SELinux security contexts are to be handled.
972
973                Without a following argument - e.g., NO Z - the option  speci‐
974                fies  that  security  contexts  are  to be listed in the SECU‐
975                RITY-CONTEXT output column.
976
977                The -Z option may be followed by a wildcard  security  context
978                name,  Z.   That  causes lsof to list only open files for pro‐
979                cesses in that security context.  Multiple  -Z  Z  option  and
980                argument  pairs  may  be  specified to form a list of security
981                contexts.  Any open file of any process in any of the security
982                contexts will be listed, subject to other conditions specified
983                by other options and arguments.  Note that Z can be  A:B:C  or
984                *:B:C or A:B:* or *:*:C to match against the A:B:C context.
985
986       --       The  double minus sign option is a marker that signals the end
987                of the keyed options.  It may be used, for example,  when  the
988                first file name begins with a minus sign.  It may also be used
989                when the absence of a value for the last keyed option must  be
990                signified  by  the  presence  of a minus sign in the following
991                option and before the start of the file names.
992
993       names    These are path names of  specific  files  to  list.   Symbolic
994                links  are  resolved  before use.  The first name may be sepa‐
995                rated from the preceding options with the ``--'' option.
996
997                If a name is the mounted-on directory of a file system or  the
998                device  of  the file system, lsof will list all the files open
999                on the file system.  To be considered a file system, the  name
1000                must  match a mounted-on directory name in mount(8) output, or
1001                match the name of a block device associated with a  mounted-on
1002                directory  name.  The +|-f option may be used to force lsof to
1003                consider a name a file system identifier (+f) or a simple file
1004                (-f).
1005
1006                If  name  is  a path to a directory that is not the mounted-on
1007                directory name of a file system, it is treated just as a regu‐
1008                lar  file is treated - i.e., its listing is restricted to pro‐
1009                cesses that have it open as a file or  as  a  process-specific
1010                directory,  such as the root or current working directory.  To
1011                request that lsof look for open files inside a directory name,
1012                use the +d s and +D D options.
1013
1014                If  a name is the base name of a family of multiplexed files -
1015                e. g, AIX's /dev/pt[cs] - lsof will list  all  the  associated
1016                multiplexed  files  on  the  device  that  are  open  -  e.g.,
1017                /dev/pt[cs]/1, /dev/pt[cs]/2, etc.
1018
1019                If a name is a UNIX domain  socket  name,  lsof  will  usually
1020                search for it by the characters of the name alone - exactly as
1021                it is specified and is recorded in the  kernel  socket  struc‐
1022                ture.   (See  the next paragraph for an exception to that rule
1023                for Linux.)  Specifying a relative path - e.g.,  ./file  -  in
1024                place  of  the  file's absolute path - e.g., /tmp/file - won't
1025                work because lsof must match the characters you  specify  with
1026                what it finds in the kernel UNIX domain socket structures.
1027
1028                If a name is a Linux UNIX domain socket name, in one case lsof
1029                is able to search for it  by  its  device  and  inode  number,
1030                allowing  name  to be a relative path.  The case requires that
1031                the absolute path -- i.e., one beginning with a slash ('/') be
1032                used  by  the  process  that  created the socket, and hence be
1033                stored in the /proc/net/unix file; and it requires  that  lsof
1034                be  able  to  obtain  the  device and node numbers of both the
1035                absolute  path  in  /proc/net/unix  and  name  via  successful
1036                stat(2)  system  calls.   When  those conditions are met, lsof
1037                will be able to search for the UNIX domain  socket  when  some
1038                path to it is is specified in name.  Thus, for example, if the
1039                path is /dev/log, and an lsof search  is  initiated  when  the
1040                working directory is /dev, then name could be ./log.
1041
1042                If  a name is none of the above, lsof will list any open files
1043                whose device and inode match that of the specified path name.
1044
1045                If you have also specified the -b option, the only  names  you
1046                may safely specify are file systems for which your mount table
1047                supplies alternate device numbers.  See  the  AVOIDING  KERNEL
1048                BLOCKS and ALTERNATE DEVICE NUMBERS sections for more informa‐
1049                tion.
1050
1051                Multiple file names are joined in a  single  ORed  set  before
1052                participating in AND option selection.
1053

AFS

1055       Lsof  supports the recognition of AFS files for these dialects (and AFS
1056       versions):
1057
1058            AIX 4.1.4 (AFS 3.4a)
1059            HP-UX 9.0.5 (AFS 3.4a)
1060            Linux 1.2.13 (AFS 3.3)
1061            Solaris 2.[56] (AFS 3.4a)
1062
1063       It may recognize AFS files on other versions of these dialects, but has
1064       not  been  tested there.  Depending on how AFS is implemented, lsof may
1065       recognize AFS files in other dialects, or may have difficulties  recog‐
1066       nizing AFS files in the supported dialects.
1067
1068       Lsof may have trouble identifying all aspects of AFS files in supported
1069       dialects when AFS kernel support is  implemented  via  dynamic  modules
1070       whose  addresses  do not appear in the kernel's variable name list.  In
1071       that case, lsof may have to guess at the identity  of  AFS  files,  and
1072       might  not be able to obtain volume information from the kernel that is
1073       needed for calculating AFS volume node numbers.  When lsof  can't  com‐
1074       pute volume node numbers, it reports blank in the NODE column.
1075
1076       The  -A  A  option is available in some dialect implementations of lsof
1077       for specifying the name list file where dynamic module kernel addresses
1078       may  be found.  When this option is available, it will be listed in the
1079       lsof help output, presented in response to the -h or -?
1080
1081       See the lsof FAQ (The FAQ section gives its location.)  for more infor‐
1082       mation  about  dynamic modules, their symbols, and how they affect lsof
1083       options.
1084
1085       Because AFS path lookups don't seem to participate in the kernel's name
1086       cache  operations,  lsof  can't  identify  path name components for AFS
1087       files.
1088

SECURITY

1090       Lsof has three features that may cause security concerns.   First,  its
1091       default  compilation mode allows anyone to list all open files with it.
1092       Second, by default it creates a user-readable and user-writable  device
1093       cache  file  in  the  home  directory of the real user ID that executes
1094       lsof.  (The list-all-open-files and device cache features may  be  dis‐
1095       abled when lsof is compiled.)  Third, its -k and -m options name alter‐
1096       nate kernel name list or memory files.
1097
1098       Restricting the listing of all open files is  controlled  by  the  com‐
1099       pile-time  HASSECURITY and HASNOSOCKSECURITY options.  When HASSECURITY
1100       is defined, lsof will allow only the root user to list all open  files.
1101       The  non-root  user may list only open files of processes with the same
1102       user IDentification number as the real  user  ID  number  of  the  lsof
1103       process (the one that its user logged on with).
1104
1105       However,  if HASSECURITY and HASNOSOCKSECURITY are both defined, anyone
1106       may list open socket files, provided they  are  selected  with  the  -i
1107       option.
1108
1109       When HASSECURITY is not defined, anyone may list all open files.
1110
1111       Help  output,  presented in response to the -h or -?  option, gives the
1112       status of the HASSECURITY and HASNOSOCKSECURITY definitions.
1113
1114       See the Security section of the 00README file of the lsof  distribution
1115       for  information on building lsof with the HASSECURITY and HASNOSOCKSE‐
1116       CURITY options enabled.
1117
1118       Creation and use of a user-readable and user-writable device cache file
1119       is  controlled  by  the  compile-time HASDCACHE option.  See the DEVICE
1120       CACHE FILE section and the sections that follow it for details  on  how
1121       its  path  is  formed.   For security considerations it is important to
1122       note that in the default lsof distribution, if the real user  ID  under
1123       which  lsof  is executed is root, the device cache file will be written
1124       in root's home directory - e.g., / or /root.   When  HASDCACHE  is  not
1125       defined, lsof does not write or attempt to read a device cache file.
1126
1127       When  HASDCACHE is defined, the lsof help output, presented in response
1128       to the -h, -D?, or -?  options, will provide device cache file handling
1129       information.   When HASDCACHE is not defined, the -h or -?  output will
1130       have no -D option description.
1131
1132       Before you decide to disable the device cache file feature  -  enabling
1133       it improves the performance of lsof by reducing the startup overhead of
1134       examining all the nodes in /dev (or /devices) - read the discussion  of
1135       it  in the 00DCACHE file of the lsof distribution and the lsof FAQ (The
1136       FAQ section gives its location.)
1137
1138       WHEN IN DOUBT, YOU CAN TEMPORARILY DISABLE THE USE OF THE DEVICE  CACHE
1139       FILE WITH THE -Di OPTION.
1140
1141       When lsof user declares alternate kernel name list or memory files with
1142       the -k and -m options, lsof checks the user's authority  to  read  them
1143       with  access(2).   This  is  intended to prevent whatever special power
1144       lsof's modes might confer on it from letting it read files not normally
1145       accessible via the authority of the real user ID.
1146

OUTPUT

1148       This  section  describes the information lsof lists for each open file.
1149       See the OUTPUT FOR OTHER PROGRAMS section for additional information on
1150       output that can be processed by another program.
1151
1152       Lsof  only  outputs printable (declared so by isprint(3)) 8 bit charac‐
1153       ters.  Non-printable characters are printed in one of three forms:  the
1154       C  ``\[bfrnt]'' form; the control character `^' form (e.g., ``^@''); or
1155       hexadecimal leading ``\x'' form (e.g., ``\xab'').  Space is  non-print‐
1156       able in the COMMAND column (``\x20'') and printable elsewhere.
1157
1158       For  some  dialects  -  if  HASSETLOCALE  is  defined  in the dialect's
1159       machine.h header file - lsof will print the extended 8  bit  characters
1160       of  a  language  locale.   The lsof process must be supplied a language
1161       locale environment variable (e.g., LANG) whose value represents a known
1162       language  locale in which the extended characters are considered print‐
1163       able by isprint(3).  Otherwise lsof considers the  extended  characters
1164       non-printable  and prints them according to its rules for non-printable
1165       characters, stated above.  Consult your dialect's setlocale(3) man page
1166       for  the names of other environment variables that may be used in place
1167       of LANG - e.g., LC_ALL, LC_CTYPE, etc.
1168
1169       Lsof's language locale support for a dialect also covers  wide  charac‐
1170       ters  -  e.g., UTF-8 - when HASSETLOCALE and HASWIDECHAR are defined in
1171       the dialect's machine.h header  file,  and  when  a  suitable  language
1172       locale has been defined in the appropriate environment variable for the
1173       lsof process.  Wide characters are printable under those conditions  if
1174       iswprint(3)  reports  them  to  be.  If HASSETLOCALE, HASWIDECHAR and a
1175       suitable language locale aren't defined, or if iswprint(3) reports wide
1176       characters  that  aren't  printable, lsof considers the wide characters
1177       non-printable and prints each of their 8 bits according  to  its  rules
1178       for non-printable characters, stated above.
1179
1180       Consult  the  answers to the "Language locale support" questions in the
1181       lsof FAQ (The FAQ section gives its location.) for more information.
1182
1183       Lsof dynamically sizes the output columns each time it runs, guarantee‐
1184       ing  that  each column is a minimum size.  It also guarantees that each
1185       column is separated from its predecessor by at least one space.
1186
1187       COMMAND    contains the first nine characters of the name of  the  UNIX
1188                  command  associated with the process.  If a non-zero w value
1189                  is specified to the +c w option,  the  column  contains  the
1190                  first  w  characters of the name of the UNIX command associ‐
1191                  ated with the process up to the limit of characters supplied
1192                  to lsof by the UNIX dialect.  (See the description of the +c
1193                  w command or the lsof FAQ for  more  information.   The  FAQ
1194                  section gives its location.)
1195
1196                  If  w  is  less  than the length of the column title, ``COM‐
1197                  MAND'', it will be raised to that length.
1198
1199                  If a zero w value is specified to the +c w option, the  col‐
1200                  umn contains all the characters of the name of the UNIX com‐
1201                  mand associated with the process.
1202
1203                  All command name characters maintained by the kernel in  its
1204                  structures  are  displayed  in field output when the command
1205                  name descriptor (`c') is  specified.   See  the  OUTPUT  FOR
1206                  OTHER  COMMANDS  section  for information on selecting field
1207                  output and the associated command name descriptor.
1208
1209       PID        is the Process IDentification number of the process.
1210
1211       ZONE       is the Solaris 10 and higher zone name.  This column must be
1212                  selected with the -z option.
1213
1214       SECURITY-CONTEXT
1215                  is  the  SELinux  security  context.   This  column  must be
1216                  selected with the -Z option.
1217
1218       PPID       is the Parent Process IDentification number of the  process.
1219                  It is only displayed when the -R option has been specified.
1220
1221       PGID       is  the  process group IDentification number associated with
1222                  the process.  It is only displayed when the  -g  option  has
1223                  been specified.
1224
1225       USER       is  the user ID number or login name of the user to whom the
1226                  process belongs, usually the  same  as  reported  by  ps(1).
1227                  However,  on  Linux USER is the user ID number or login that
1228                  owns the directory in /proc  where  lsof  finds  information
1229                  about  the process.  Usually that is the same value reported
1230                  by ps(1), but may differ when the process  has  changed  its
1231                  effective  user  ID.   (See  the  -l  option description for
1232                  information on when a user ID number or login name  is  dis‐
1233                  played.)
1234
1235       FD         is the File Descriptor number of the file or:
1236
1237                       cwd  current working directory;
1238                       Lnn  library references (AIX);
1239                       err  FD information error (see NAME column);
1240                       jld  jail directory (FreeBSD);
1241                       ltx  shared library text (code and data);
1242                       Mxx  hex memory-mapped type number xx.
1243                       m86  DOS Merge mapped file;
1244                       mem  memory-mapped file;
1245                       mmap memory-mapped device;
1246                       pd   parent directory;
1247                       rtd  root directory;
1248                       tr   kernel trace file (OpenBSD);
1249                       txt  program text (code and data);
1250                       v86  VP/ix mapped file;
1251
1252                  FD  is  followed  by one of these characters, describing the
1253                  mode under which the file is open:
1254
1255                       r for read access;
1256                       w for write access;
1257                       u for read and write access;
1258                       space if mode unknown and no lock
1259                            character follows;
1260                       `-' if mode unknown and lock
1261                            character follows.
1262
1263                  The mode character is followed by one of these lock  charac‐
1264                  ters, describing the type of lock applied to the file:
1265
1266                       N for a Solaris NFS lock of unknown type;
1267                       r for read lock on part of the file;
1268                       R for a read lock on the entire file;
1269                       w for a write lock on part of the file;
1270                       W for a write lock on the entire file;
1271                       u for a read and write lock of any length;
1272                       U for a lock of unknown type;
1273                       x  for an SCO OpenServer Xenix lock on part      of the
1274                  file;
1275                       X for an SCO OpenServer Xenix lock on  the       entire
1276                  file;
1277                       space if there is no lock.
1278
1279                  See  the  LOCKS  section  for  more  information on the lock
1280                  information character.
1281
1282                  The FD column contents constitutes a single field for  pars‐
1283                  ing in post-processing scripts.
1284
1285       TYPE       is  the  type  of  the node associated with the file - e.g.,
1286                  GDIR, GREG, VDIR, VREG, etc.
1287
1288                  or ``IPv4'' for an IPv4 socket;
1289
1290                  or ``IPv6'' for an open IPv6 network  file  -  even  if  its
1291                  address is IPv4, mapped in an IPv6 address;
1292
1293                  or ``ax25'' for a Linux AX.25 socket;
1294
1295                  or ``inet'' for an Internet domain socket;
1296
1297                  or ``lla'' for a HP-UX link level access file;
1298
1299                  or ``rte'' for an AF_ROUTE socket;
1300
1301                  or ``sock'' for a socket of unknown domain;
1302
1303                  or ``unix'' for a UNIX domain socket;
1304
1305                  or ``x.25'' for an HP-UX x.25 socket;
1306
1307                  or ``BLK'' for a block special file;
1308
1309                  or ``CHR'' for a character special file;
1310
1311                  or ``DEL'' for a Linux map file that has been deleted;
1312
1313                  or ``DIR'' for a directory;
1314
1315                  or ``DOOR'' for a VDOOR file;
1316
1317                  or ``FIFO'' for a FIFO special file;
1318
1319                  or ``KQUEUE'' for a BSD style kernel event queue file;
1320
1321                  or ``LINK'' for a symbolic link file;
1322
1323                  or ``MPB'' for a multiplexed block file;
1324
1325                  or ``MPC'' for a multiplexed character file;
1326
1327                  or  ``NOFD'' for a Linux /proc/<PID>/fd directory that can't
1328                  be opened -- the directory path appears in the NAME  column,
1329                  followed by an error message;
1330
1331                  or ``PAS'' for a /proc/as file;
1332
1333                  or ``PAXV'' for a /proc/auxv file;
1334
1335                  or ``PCRE'' for a /proc/cred file;
1336
1337                  or ``PCTL'' for a /proc control file;
1338
1339                  or ``PCUR'' for the current /proc process;
1340
1341                  or ``PCWD'' for a /proc current working directory;
1342
1343                  or ``PDIR'' for a /proc directory;
1344
1345                  or ``PETY'' for a /proc executable type (etype);
1346
1347                  or ``PFD'' for a /proc file descriptor;
1348
1349                  or ``PFDR'' for a /proc file descriptor directory;
1350
1351                  or ``PFIL'' for an executable /proc file;
1352
1353                  or ``PFPR'' for a /proc FP register set;
1354
1355                  or ``PGD'' for a /proc/pagedata file;
1356
1357                  or ``PGID'' for a /proc group notifier file;
1358
1359                  or ``PIPE'' for pipes;
1360
1361                  or ``PLC'' for a /proc/lwpctl file;
1362
1363                  or ``PLDR'' for a /proc/lpw directory;
1364
1365                  or ``PLDT'' for a /proc/ldt file;
1366
1367                  or ``PLPI'' for a /proc/lpsinfo file;
1368
1369                  or ``PLST'' for a /proc/lstatus file;
1370
1371                  or ``PLU'' for a /proc/lusage file;
1372
1373                  or ``PLWG'' for a /proc/gwindows file;
1374
1375                  or ``PLWI'' for a /proc/lwpsinfo file;
1376
1377                  or ``PLWS'' for a /proc/lwpstatus file;
1378
1379                  or ``PLWU'' for a /proc/lwpusage file;
1380
1381                  or ``PLWX'' for a /proc/xregs file'
1382
1383                  or ``PMAP'' for a /proc map file (map);
1384
1385                  or ``PMEM'' for a /proc memory image file;
1386
1387                  or ``PNTF'' for a /proc process notifier file;
1388
1389                  or ``POBJ'' for a /proc/object file;
1390
1391                  or ``PODR'' for a /proc/object directory;
1392
1393                  or  ``POLP''  for  an  old format /proc light weight process
1394                  file;
1395
1396                  or ``POPF'' for an old format /proc PID file;
1397
1398                  or ``POPG'' for an old format /proc page data file;
1399
1400                  or ``PORT'' for a SYSV named pipe;
1401
1402                  or ``PREG'' for a /proc register file;
1403
1404                  or ``PRMP'' for a /proc/rmap file;
1405
1406                  or ``PRTD'' for a /proc root directory;
1407
1408                  or ``PSGA'' for a /proc/sigact file;
1409
1410                  or ``PSIN'' for a /proc/psinfo file;
1411
1412                  or ``PSTA'' for a /proc status file;
1413
1414                  or ``PSXSEM'' for a POSIX semaphore file;
1415
1416                  or ``PSXSHM'' for a POSIX shared memory file;
1417
1418                  or ``PUSG'' for a /proc/usage file;
1419
1420                  or ``PW'' for a /proc/watch file;
1421
1422                  or ``PXMP'' for a /proc/xmap file;
1423
1424                  or ``REG'' for a regular file;
1425
1426                  or ``SMT'' for a shared memory transport file;
1427
1428                  or ``STSO'' for a stream socket;
1429
1430                  or ``UNNM'' for an unnamed type file;
1431
1432                  or ``XNAM'' for an OpenServer Xenix special file of  unknown
1433                  type;
1434
1435                  or ``XSEM'' for an OpenServer Xenix semaphore file;
1436
1437                  or ``XSD'' for an OpenServer Xenix shared data file;
1438
1439                  or  the  four  type  number octets if the corresponding name
1440                  isn't known.
1441
1442       FILE-ADDR  contains the kernel file structure address when f  has  been
1443                  specified to +f;
1444
1445       FCT        contains  the  file  reference  count  from  the kernel file
1446                  structure when c has been specified to +f;
1447
1448       FILE-FLAG  when g or G has been specified to +f,  this  field  contains
1449                  the  contents  of  the  f_flag[s]  member of the kernel file
1450                  structure and the kernel's per-process open file  flags  (if
1451                  available);  `G' causes them to be displayed in hexadecimal;
1452                  `g', as short-hand names; two lists may  be  displayed  with
1453                  entries  separated by commas, the lists separated by a semi‐
1454                  colon (`;'); the first list may contain short-hand names for
1455                  f_flag[s] values from the following table:
1456
1457                       AIO       asynchronous I/O (e.g., FAIO)
1458                       AP        append
1459                       ASYN      asynchronous I/O (e.g., FASYNC)
1460                       BAS       block, test, and set in use
1461                       BKIU      block if in use
1462                       BL        use block offsets
1463                       BSK       block seek
1464                       CA        copy avoid
1465                       CIO       concurrent I/O
1466                       CLON      clone
1467                       CLRD      CL read
1468                       CR        create
1469                       DF        defer
1470                       DFI       defer IND
1471                       DFLU      data flush
1472                       DIR       direct
1473                       DLY       delay
1474                       DOCL      do clone
1475                       DSYN      data-only integrity
1476                       EVO       event only
1477                       EX        open for exec
1478                       EXCL      exclusive open
1479                       FSYN      synchronous writes
1480                       GCDF      defer during unp_gc() (AIX)
1481                       GCMK      mark during unp_gc() (AIX)
1482                       GTTY      accessed via /dev/tty
1483                       HUP       HUP in progress
1484                       KERN      kernel
1485                       KIOC      kernel-issued ioctl
1486                       LCK       has lock
1487                       LG        large file
1488                       MBLK      stream message block
1489                       MK        mark
1490                       MNT       mount
1491                       MSYN      multiplex synchronization
1492                       NB        non-blocking I/O
1493                       NBDR      no BDRM check
1494                       NBIO      SYSV non-blocking I/O
1495                       NBF       n-buffering in effect
1496                       NC        no cache
1497                       ND        no delay
1498                       NDSY      no data synchronization
1499                       NET       network
1500                       NMFS      NM file system
1501                       NOTO      disable background stop
1502                       NSH       no share
1503                       NTTY      no controlling TTY
1504                       OLRM      OLR mirror
1505                       PAIO      POSIX asynchronous I/O
1506                       PP        POSIX pipe
1507                       R         read
1508                       RC        file and record locking cache
1509                       REV       revoked
1510                       RSH       shared read
1511                       RSYN      read synchronization
1512                       SL        shared lock
1513                       SNAP      cooked snapshot
1514                       SOCK      socket
1515                       SQSH      Sequent shared set on open
1516                       SQSV      Sequent SVM set on open
1517                       SQR       Sequent set repair on open
1518                       SQS1      Sequent full shared open
1519                       SQS2      Sequent partial shared open
1520                       STPI      stop I/O
1521                       SWR       synchronous read
1522                       SYN       file integrity while writing
1523                       TCPM      avoid TCP collision
1524                       TR        truncate
1525                       W         write
1526                       WKUP      parallel I/O synchronization
1527                       WTG       parallel I/O synchronization
1528                       VH        vhangup pending
1529                       VTXT      virtual text
1530                       XL        exclusive lock
1531
1532                  this  list of names was derived from F* #define's in dialect
1533                  header  files   <fcntl.h>,   <linux</fs.h>,   <sys/fcntl.c>,
1534                  <sys/fcntlcom.h>,  and  <sys/file.h>;  see the lsof.h header
1535                  file for a list showing the correspondence between the above
1536                  short-hand names and the header file definitions;
1537
1538                  the second list (after the semicolon) may contain short-hand
1539                  names for kernel per-process open file flags from  this  ta‐
1540                  ble:
1541
1542                       ALLC      allocated
1543                       BR        the file has been read
1544                       BHUP      activity stopped by SIGHUP
1545                       BW        the file has been written
1546                       CLSG      closing
1547                       CX        close-on-exec (see fcntl(F_SETFD))
1548                       LCK       lock was applied
1549                       MP        memory-mapped
1550                       OPIP      open pending - in progress
1551                       RSVW      reserved wait
1552                       SHMT      UF_FSHMAT set (AIX)
1553                       USE       in use (multi-threaded)
1554
1555       NODE-ID    (or  INODE-ADDR for some dialects) contains a unique identi‐
1556                  fier for the file node (usually the kernel  vnode  or  inode
1557                  address, but also occasionally a concatenation of device and
1558                  node number) when n has been specified to +f;
1559
1560       DEVICE     contains the device numbers,  separated  by  commas,  for  a
1561                  character  special, block special, regular, directory or NFS
1562                  file;
1563
1564                  or ``memory'' for a memory  file  system  node  under  Tru64
1565                  UNIX;
1566
1567                  or  the address of the private data area of a Solaris socket
1568                  stream;
1569
1570                  or a kernel reference address that identifies the file  (The
1571                  kernel  reference  address may be used for FIFO's, for exam‐
1572                  ple.);
1573
1574                  or the base address or device name of a Linux  AX.25  socket
1575                  device.
1576
1577                  Usually  only the lower thirty two bits of Tru64 UNIX kernel
1578                  addresses are displayed.
1579
1580       SIZE, SIZE/OFF, or OFFSET
1581                  is the size of the file or the  file  offset  in  bytes.   A
1582                  value  is  displayed in this column only if it is available.
1583                  Lsof displays whatever value - size or offset - is appropri‐
1584                  ate for the type of the file and the version of lsof.
1585
1586                  On  some UNIX dialects lsof can't obtain accurate or consis‐
1587                  tent file offset information from its kernel  data  sources,
1588                  sometimes  just  for particular kinds of files (e.g., socket
1589                  files.)  In other cases, files don't have true sizes - e.g.,
1590                  sockets, FIFOs, pipes - so lsof displays for their sizes the
1591                  content amounts it finds in their kernel buffer  descriptors
1592                  (e.g.,  socket  buffer  size counts or TCP/IP window sizes.)
1593                  Consult the lsof FAQ (The FAQ section gives  its  location.)
1594                  for more information.
1595
1596                  The  file  size  is displayed in decimal; the offset is nor‐
1597                  mally displayed in decimal with a leading ``0t'' if it  con‐
1598                  tains 8 digits or less; in hexadecimal with a leading ``0x''
1599                  if it is longer than 8 digits.  (Consult  the  -o  o  option
1600                  description  for information on when 8 might default to some
1601                  other value.)
1602
1603                  Thus the leading ``0t'' and ``0x'' identify an  offset  when
1604                  the  column may contain both a size and an offset (i.e., its
1605                  title is SIZE/OFF).
1606
1607                  If the -o option is specified, lsof always displays the file
1608                  offset (or nothing if no offset is available) and labels the
1609                  column OFFSET.  The offset  always  begins  with  ``0t''  or
1610                  ``0x'' as described above.
1611
1612                  The  lsof  user can control the switch from ``0t'' to ``0x''
1613                  with the -o o option.   Consult  its  description  for  more
1614                  information.
1615
1616                  If the -s option is specified, lsof always displays the file
1617                  size (or nothing if no size is  available)  and  labels  the
1618                  column  SIZE.  The -o and -s options are mutually exclusive;
1619                  they can't both be specified.
1620
1621                  For files that don't have a fixed size - e.g., don't  reside
1622                  on a disk device - lsof will display appropriate information
1623                  about the current size or position of  the  file  if  it  is
1624                  available in the kernel structures that define the file.
1625
1626       NLINK      contains the file link count when +L has been specified;
1627
1628       NODE       is the node number of a local file;
1629
1630                  or the inode number of an NFS file in the server host;
1631
1632                  or the Internet protocol type - e. g, ``TCP'';
1633
1634                  or ``STR'' for a stream;
1635
1636                  or ``CCITT'' for an HP-UX x.25 socket;
1637
1638                  or the IRQ or inode number of a Linux AX.25 socket device.
1639
1640       NAME       is  the name of the mount point and file system on which the
1641                  file resides;
1642
1643                  or the name of a file specified in the names  option  (after
1644                  any symbolic links have been resolved);
1645
1646                  or the name of a character special or block special device;
1647
1648                  or  the  local  and  remote  Internet addresses of a network
1649                  file; the local host name or IP  number  is  followed  by  a
1650                  colon  (':'),  the  port,  ``->'',  and  the two-part remote
1651                  address; IP addresses may be reported as numbers  or  names,
1652                  depending  on  the +|-M, -n, and -P options; colon-separated
1653                  IPv6  numbers  are  enclosed  in   square   brackets;   IPv4
1654                  INADDR_ANY  and  IPv6 IN6_IS_ADDR_UNSPECIFIED addresses, and
1655                  zero port numbers are represented by an  asterisk  ('*');  a
1656                  UDP  destination  address  may  be followed by the amount of
1657                  time elapsed since the last packet was sent to the  destina‐
1658                  tion;  TCP  and  UDP  remote  addresses  may  be followed by
1659                  TCP/TPI information in parentheses - state (e.g.,  ``(ESTAB‐
1660                  LISHED)'',  ``(Unbound)''),  queue  sizes,  and window sizes
1661                  (not all dialects) - in a fashion similar to what netstat(1)
1662                  reports; see the -T option description or the description of
1663                  the TCP/TPI field in OUTPUT  FOR  OTHER  PROGRAMS  for  more
1664                  information on state, queue size, and window size;
1665
1666                  or  the  address  or  name of a UNIX domain socket, possibly
1667                  including a stream clone device name, a file system object's
1668                  path  name,  local and foreign kernel addresses, socket pair
1669                  information, and a bound vnode address;
1670
1671                  or the local and remote mount point names of an NFS file;
1672
1673                  or ``STR'', followed by the stream name;
1674
1675                  or a stream character device name, followed  by  ``->''  and
1676                  the  stream name or a list of stream module names, separated
1677                  by ``->'';
1678
1679                  or ``STR:'' followed by the SCO OpenServer stream device and
1680                  module names, separated by ``->'';
1681
1682                  or  system  directory name, `` -- '', and as many components
1683                  of the path name as lsof can find in the kernel's name cache
1684                  for selected dialects (See the KERNEL NAME CACHE section for
1685                  more information.);
1686
1687                  or ``PIPE->'', followed by a Solaris kernel pipe destination
1688                  address;
1689
1690                  or  ``COMMON:'',  followed  by  the vnode device information
1691                  structure's device name, for a Solaris common vnode;
1692
1693                  or the address family, followed by a slash  (`/'),  followed
1694                  by  fourteen  comma-separated  bytes  of  a non-Internet raw
1695                  socket address;
1696
1697                  or the HP-UX x.25 local address,  followed  by  the  virtual
1698                  connection  number  (if any), followed by the remote address
1699                  (if any);
1700
1701                  or ``(dead)'' for disassociated Tru64 UNIX files - typically
1702                  terminal  files  that  have  been flagged with the TIOCNOTTY
1703                  ioctl and closed by daemons;
1704
1705                  or ``rd=<offset>'' and ``wr=<offset>'' for the values of the
1706                  read and write offsets of a FIFO;
1707
1708                  or  ``clone n:/dev/event'' for SCO OpenServer file clones of
1709                  the /dev/event device, where n is the minor device number of
1710                  the file;
1711
1712                  or  ``(socketpair:  n)'' for a Solaris 2.6, 8, 9  or 10 UNIX
1713                  domain socket, created by the socketpair(3N)  network  func‐
1714                  tion;
1715
1716                  or  ``no  PCB'' for socket files that do not have a protocol
1717                  block associated  with  them,  optionally  followed  by  ``,
1718                  CANTSENDMORE''  if  sending on the socket has been disabled,
1719                  or ``, CANTRCVMORE'' if receiving on  the  socket  has  been
1720                  disabled (e.g., by the shutdown(2) function);
1721
1722                  or the local and remote addresses of a Linux IPX socket file
1723                  in the form <net>:[<node>:]<port>, followed  in  parentheses
1724                  by  the transmit and receive queue sizes, and the connection
1725                  state;
1726
1727                  or ``dgram'' or ``stream'' for the type UnixWare  7.1.1  and
1728                  above  in-kernel  UNIX  domain  sockets, followed by a colon
1729                  (':') and the local path name when  available,  followed  by
1730                  ``->''  and the remote path name or kernel socket address in
1731                  hexadecimal when available.
1732
1733       For dialects that support a ``namefs'' file system, allowing  one  file
1734       to   be   attached   to   another   with  fattach(3C),  lsof  will  add
1735       ``(FA:<address1><direction><address2>)''   to    the    NAME    column.
1736       <address1> and <address2> are hexadecimal vnode addresses.  <direction>
1737       will be ``<-'' if <address2> has been fattach'ed to  this  vnode  whose
1738       address  is  <address1>; and ``->'' if <address1>, the vnode address of
1739       this vnode, has been fattach'ed to <address2>.  <address1> may be omit‐
1740       ted if it already appears in the DEVICE column.
1741
1742       Lsof  may  add  two  parenthetical  notes  to  the NAME column for open
1743       Solaris 10 files: ``(?)'' if lsof considers the path name of  question‐
1744       able  accuracy;  and  ``(deleted)'' if the -X option has been specified
1745       and lsof detects the open file's path name has been  deleted.   Consult
1746       the  lsof  FAQ (The FAQ section gives its location.)  for more informa‐
1747       tion on these NAME column additions.
1748

LOCKS

1750       Lsof can't adequately report the wide  variety  of  UNIX  dialect  file
1751       locks  in a single character.  What it reports in a single character is
1752       a compromise between the information it finds in  the  kernel  and  the
1753       limitations of the reporting format.
1754
1755       Moreover, when a process holds several byte level locks on a file, lsof
1756       only reports the status of the first lock it encounters.  If  it  is  a
1757       byte level lock, then the lock character will be reported in lower case
1758       - i.e., `r', `w', or `x'  -  rather  than  the  upper  case  equivalent
1759       reported for a full file lock.
1760
1761       Generally  lsof  can  only  report  on locks held by local processes on
1762       local files.  When a local process sets a lock on  a  remotely  mounted
1763       (e.g.,  NFS)  file,  the  remote  server  host usually records the lock
1764       state.  One exception is Solaris - at some patch levels of 2.3, and  in
1765       all  versions  above  2.4,  the  Solaris  kernel records information on
1766       remote locks in local structures.
1767
1768       Lsof has trouble reporting locks for some UNIX dialects.   Consult  the
1769       BUGS section of this manual page or the lsof FAQ (The FAQ section gives
1770       its location.)  for more information.
1771

OUTPUT FOR OTHER PROGRAMS

1773       When the -F option is specified, lsof produces output that is  suitable
1774       for  processing by another program - e.g, an awk or Perl script, or a C
1775       program.
1776
1777       Each unit of information is output in a field that is identified with a
1778       leading character and terminated by a NL (012) (or a NUL (000) if the 0
1779       (zero) field identifier character is specified.)  The data of the field
1780       follows  immediately  after  the  field  identification  character  and
1781       extends to the field terminator.
1782
1783       It is possible to think of field output as process and  file  sets.   A
1784       process  set  begins  with a field whose identifier is `p' (for process
1785       IDentifier (PID)).  It extends to the beginning of the next  PID  field
1786       or  the beginning of the first file set of the process, whichever comes
1787       first.  Included in the process set are fields that identify  the  com‐
1788       mand,  the  process group IDentification (PGID) number, and the user ID
1789       (UID) number or login name.
1790
1791       A file set begins with a  field  whose  identifier  is  `f'  (for  file
1792       descriptor).   It  is followed by lines that describe the file's access
1793       mode, lock state, type, device, size, offset, inode, protocol, name and
1794       stream  module  names.  It extends to the beginning of the next file or
1795       process set, whichever comes first.
1796
1797       When the NUL (000) field terminator has been selected with the 0 (zero)
1798       field  identifier character, lsof ends each process and file set with a
1799       NL (012) character.
1800
1801       Lsof always produces one field, the PID (`p') field.  All other  fields
1802       may  be declared optionally in the field identifier character list that
1803       follows the -F option.  When a field selection character identifies  an
1804       item lsof does not normally list - e.g., PPID, selected with -R - spec‐
1805       ification of the field character - e.g., ``-FR''  -  also  selects  the
1806       listing of the item.
1807
1808       It is entirely possible to select a set of fields that cannot easily be
1809       parsed - e.g., if the field descriptor field is not selected, it may be
1810       difficult  to  identify  file sets.  To help you avoid this difficulty,
1811       lsof supports the -F option; it selects the output of all  fields  with
1812       NL  terminators  (the  -F0 option pair selects the output of all fields
1813       with NUL terminators).  For compatibility reasons neither  -F  nor  -F0
1814       select the raw device field.
1815
1816       These  are  the  fields  that  lsof will produce.  The single character
1817       listed first is the field identifier.
1818
1819            a    file access mode
1820            c    process command name (all characters from proc or
1821                 user structure)
1822            C    file structure share count
1823            d    file's device character code
1824            D    file's major/minor device number (0x<hexadecimal>)
1825            f    file descriptor
1826            F    file structure address (0x<hexadecimal>)
1827            G    file flaGs (0x<hexadecimal>; names if +fg follows)
1828            i    file's inode number
1829            k    link count
1830            l    file's lock status
1831            L    process login name
1832            m    marker between repeated output
1833            n    file name, comment, Internet address
1834            N    node identifier (ox<hexadecimal>
1835            o    file's offset (decimal)
1836            p    process ID (always selected)
1837            g    process group ID
1838            P    protocol name
1839            r    raw device number (0x<hexadecimal>)
1840            R    parent process ID
1841            s    file's size (decimal)
1842            S    file's stream identification
1843            t    file's type
1844            T    TCP/TPI information, identified by prefixes (the
1845                 `=' is part of the prefix):
1846                     QR=<read queue size>
1847                     QS=<send queue size>
1848                     SO=<socket options and values> (not all dialects)
1849                     SS=<socket states> (not all dialects)
1850                     ST=<connection state>
1851                     TF=<TCP flags and values> (not all dialects)
1852                     WR=<window read size>  (not all dialects)
1853                     WW=<window write size>  (not all dialects)
1854                 (TCP/TPI information isn't reported for all supported
1855                   UNIX dialects. The -h or -? help output for the
1856                   -T option will show what TCP/TPI reporting can be
1857                   requested.)
1858            u    process user ID
1859            z    Solaris 10 and higher zone name
1860            0    use NUL field terminator character in place of NL
1861            1-9  dialect-specific field identifiers (The output
1862                 of -F? identifies the information to be found
1863                 in dialect-specific fields.)
1864
1865       You can get on-line help information  on  these  characters  and  their
1866       descriptions by specifying the -F?  option pair.  (Escape the `?' char‐
1867       acter as your shell requires.)  Additional information on field content
1868       can be found in the OUTPUT section.
1869
1870       As  an  example,  ``-F pcfn'' will select the process ID (`p'), command
1871       name (`c'), file descriptor (`f') and file name (`n') fields with an NL
1872       field terminator character; ``-F pcfn0'' selects the same output with a
1873       NUL (000) field terminator character.
1874
1875       Lsof doesn't produce all fields for every process  or  file  set,  only
1876       those  that  are  available.   Some fields are mutually exclusive: file
1877       device characters and file major/minor device numbers; file inode  num‐
1878       ber  and  protocol name; file name and stream identification; file size
1879       and offset.  One or the other member of these mutually  exclusive  sets
1880       will appear in field output, but not both.
1881
1882       Normally  lsof ends each field with a NL (012) character.  The 0 (zero)
1883       field identifier character may be specified to change the field  termi‐
1884       nator  character  to  a  NUL  (000).  A NUL terminator may be easier to
1885       process with xargs (1), for example, or  with  programs  whose  quoting
1886       mechanisms  may  not  easily  cope  with the range of characters in the
1887       field output.  When the NUL field terminator is in use, lsof ends  each
1888       process and file set with a NL (012).
1889
1890       Three aids to producing programs that can process lsof field output are
1891       included in the lsof distribution.  The  first  is  a  C  header  file,
1892       lsof_fields.h, that contains symbols for the field identification char‐
1893       acters, indexes for storing them in a table,  and  explanation  strings
1894       that may be compiled into programs.  Lsof uses this header file.
1895
1896       The  second  aid  is a set of sample scripts that process field output,
1897       written in awk, Perl 4, and Perl 5.  They're  located  in  the  scripts
1898       subdirectory of the lsof distribution.
1899
1900       The  third aid is the C library used for the lsof test suite.  The test
1901       suite is written in C and uses field output  to  validate  the  correct
1902       operation  of lsof.  The library can be found in the tests/LTlib.c file
1903       of the  lsof  distribution.   The  library  uses  the  first  aid,  the
1904       lsof_fields.h header file.
1905

BLOCKS AND TIMEOUTS

1907       Lsof  can  be blocked by some kernel functions that it uses - lstat(2),
1908       readlink(2), and stat(2).  These functions are stalled in  the  kernel,
1909       for  example,  when  the  hosts  where  mounted NFS file systems reside
1910       become inaccessible.
1911
1912       Lsof attempts to break these blocks with timers  and  child  processes,
1913       but  the  techniques are not wholly reliable.  When lsof does manage to
1914       break a block, it will report the break with  an  error  message.   The
1915       messages may be suppressed with the -t and -w options.
1916
1917       The  default  timeout value may be displayed with the -h or -?  option,
1918       and it may be changed with the -S [t] option.  The minimum for t is two
1919       seconds,  but  you should avoid small values, since slow system respon‐
1920       siveness can cause short timeouts to expire  unexpectedly  and  perhaps
1921       stop lsof before it can produce any output.
1922
1923       When lsof has to break a block during its access of mounted file system
1924       information, it normally  continues,  although  with  less  information
1925       available to display about open files.
1926
1927       Lsof  can  also be directed to avoid the protection of timers and child
1928       processes when using the kernel functions that might block by  specify‐
1929       ing  the  -O  option.  While this will allow lsof to start up with less
1930       overhead, it exposes lsof completely  to  the  kernel  situations  that
1931       might block it.  Use this option cautiously.
1932

AVOIDING KERNEL BLOCKS

1934       You  can use the -b option to tell lsof to avoid using kernel functions
1935       that would block.  Some cautions apply.
1936
1937       First, using this option  usually  requires  that  your  system  supply
1938       alternate device numbers in place of the device numbers that lsof would
1939       normally obtain with the lstat(2) and stat(2)  kernel  functions.   See
1940       the  ALTERNATE DEVICE NUMBERS section for more information on alternate
1941       device numbers.
1942
1943       Second, you can't specify names for lsof to locate unless they're  file
1944       system  names.  This is because lsof needs to know the device and inode
1945       numbers of files listed with names in the  lsof  options,  and  the  -b
1946       option  prevents  lsof  from obtaining them.  Moreover, since lsof only
1947       has device numbers for the file systems that have alternates, its abil‐
1948       ity  to  locate  files on file systems depends completely on the avail‐
1949       ability and accuracy of the alternates.  If no  alternates  are  avail‐
1950       able,  or  if  they're incorrect, lsof won't be able to locate files on
1951       the named file systems.
1952
1953       Third, if the names of your file system directories that  lsof  obtains
1954       from  your  system's mount table are symbolic links, lsof won't be able
1955       to resolve the links.  This is because the -b  option  causes  lsof  to
1956       avoid  the  kernel  readlink(2)  function  it  uses to resolve symbolic
1957       links.
1958
1959       Finally, using the -b option causes lsof to issue warning messages when
1960       it  needs  to use the kernel functions that the -b option directs it to
1961       avoid.  You can suppress these messages by specifying  the  -w  option,
1962       but  if  you do, you won't see the alternate device numbers reported in
1963       the warning messages.
1964

ALTERNATE DEVICE NUMBERS

1966       On some dialects, when lsof has to break a block because it  can't  get
1967       information  about  a  mounted file system via the lstat(2) and stat(2)
1968       kernel functions, or because you specified  the  -b  option,  lsof  can
1969       obtain  some of the information it needs - the device number and possi‐
1970       bly the file system type - from the system mount table.  When  that  is
1971       possible,  lsof  will  report  the device number it obtained.  (You can
1972       suppress the report by specifying the -w option.)
1973
1974       You can assist this process if your mount table is  supported  with  an
1975       /etc/mtab  or /etc/mnttab file that contains an options field by adding
1976       a ``dev=xxxx'' field for mount points that do not  have  one  in  their
1977       options  strings.  Note: you must be able to edit the file - i.e., some
1978       mount tables like recent Solaris /etc/mnttab or Linux /proc/mounts  are
1979       read-only and can't be modified.
1980
1981       You  may  also  be  able to supply device numbers using the +m and +m m
1982       options, provided they are supported by your dialect.  Check the output
1983       of  lsof's  -h  or  -?   options  to see if the +m and +m m options are
1984       available.
1985
1986       The ``xxxx'' portion of the field is the hexadecimal value of the  file
1987       system's device number.  (Consult the st_dev field of the output of the
1988       lstat(2) and stat(2) functions for the appropriate values for your file
1989       systems.)   Here's  an example from a Sun Solaris 2.6 /etc/mnttab for a
1990       file system remotely mounted via NFS:
1991
1992            nfs  ignore,noquota,dev=2a40001
1993
1994       There's an advantage to having ``dev=xxxx'' entries in your mount table
1995       file,  especially  for  file  systems  that are mounted from remote NFS
1996       servers.  When a remote server crashes and you  want  to  identify  its
1997       users  by  running  lsof  on one of its clients, lsof probably won't be
1998       able to get output from the lstat(2) and stat(2) functions for the file
1999       system.   If  it  can  obtain  the file system's device number from the
2000       mount table, it will be able to display the files open on  the  crashed
2001       NFS server.
2002
2003       Some  dialects  that  do not use an ASCII /etc/mtab or /etc/mnttab file
2004       for the mount table may still provide an alternative device  number  in
2005       their internal mount tables.  This includes AIX, Apple Darwin, FreeBSD,
2006       NetBSD, OpenBSD, and Tru64 UNIX.  Lsof knows how to obtain the alterna‐
2007       tive  device  number for these dialects and uses it when its attempt to
2008       lstat(2) or stat(2) the file system is blocked.
2009
2010       If you're not sure your dialect supplies alternate device  numbers  for
2011       file  systems from its mount table, use this lsof incantation to see if
2012       it reports any alternate device numbers:
2013
2014              lsof -b
2015
2016       Look for standard error file warning  messages  that  begin  ``assuming
2017       "dev=xxxx" from ...''.
2018

KERNEL NAME CACHE

2020       Lsof  is  able  to  examine the kernel's name cache or use other kernel
2021       facilities (e.g., the ADVFS  4.x  tag_to_path()  function  under  Tru64
2022       UNIX)  on  some dialects for most file system types, excluding AFS, and
2023       extract recently used path name components from it.  (AFS  file  system
2024       path  lookups don't use the kernel's name cache; some Solaris VxFS file
2025       system operations apparently don't use it, either.)
2026
2027       Lsof reports the complete paths it finds in the NAME column.   If  lsof
2028       can't  report  all  components in a path, it reports in the NAME column
2029       the file system name, followed by a space, two `-' characters,  another
2030       space,  and  the  name  components it has located, separated by the `/'
2031       character.
2032
2033       When lsof is run in repeat mode - i.e., with the -r option specified  -
2034       the  extent  to  which  it can report path name components for the same
2035       file may vary from cycle to cycle.  That's because other  running  pro‐
2036       cesses  can  cause the kernel to remove entries from its name cache and
2037       replace them with others.
2038
2039       Lsof's use of the kernel name cache to identify the paths of files  can
2040       lead  it to report incorrect components under some circumstances.  This
2041       can happen when the kernel name cache uses device and node number as  a
2042       key  (e.g., SCO OpenServer) and a key on a rapidly changing file system
2043       is reused.  If the UNIX dialect's kernel doesn't purge the  name  cache
2044       entry  for a file when it is unlinked, lsof may find a reference to the
2045       wrong entry in the cache.  The lsof FAQ  (The  FAQ  section  gives  its
2046       location.)  has more information on this situation.
2047
2048       Lsof can report path name components for these dialects:
2049
2050            FreeBSD
2051            HP-UX
2052            Linux
2053            NetBSD
2054            NEXTSTEP
2055            OpenBSD
2056            OPENSTEP
2057            SCO OpenServer
2058            SCO|Caldera UnixWare
2059            Solaris
2060            Tru64 UNIX
2061
2062       Lsof can't report path name components for these dialects:
2063
2064            AIX
2065
2066       If you want to know why lsof can't report path name components for some
2067       dialects, see the lsof FAQ (The FAQ section gives its location.)
2068

DEVICE CACHE FILE

2070       Examining all members of the /dev (or /devices) node tree with  stat(2)
2071       functions  can  be  time  consuming.  What's more, the information that
2072       lsof needs - device number, inode number, and path - rarely changes.
2073
2074       Consequently, lsof normally maintains an ASCII text file of cached /dev
2075       (or  /devices) information (exception: the /proc-based Linux lsof where
2076       it's not needed.)  The local system administrator who builds  lsof  can
2077       control  the  way  the device cache file path is formed, selecting from
2078       these options:
2079
2080            Path from the -D option;
2081            Path from an environment variable;
2082            System-wide path;
2083            Personal path (the default);
2084            Personal path, modified by an environment variable.
2085
2086       Consult the output of the -h, -D? , or -?  help options for the current
2087       state  of  device  cache  support.   The  help output lists the default
2088       read-mode device cache file path that is  in  effect  for  the  current
2089       invocation  of  lsof.   The  -D?  option output lists the read-only and
2090       write device cache file paths, the names of any applicable  environment
2091       variables, and the personal device cache path format.
2092
2093       Lsof  can  detect  that the current device cache file has been acciden‐
2094       tally or maliciously modified by integrity checks, including the compu‐
2095       tation  and verification of a sixteen bit Cyclic Redundancy Check (CRC)
2096       sum on the file's contents.  When lsof senses something wrong with  the
2097       file, it issues a warning and attempts to remove the current cache file
2098       and create a new copy, but only to a path that the process can  legiti‐
2099       mately write.
2100
2101       The  path  from which a lsof process may attempt to read a device cache
2102       file may not be the same as the  path  to  which  it  can  legitimately
2103       write.   Thus when lsof senses that it needs to update the device cache
2104       file, it may choose a different path for writing it from the path  from
2105       which it read an incorrect or outdated version.
2106
2107       If  available,  the -Dr option will inhibit the writing of a new device
2108       cache file.  (It's always available when specified without a path  name
2109       argument.)
2110
2111       When  a  new  device  is added to the system, the device cache file may
2112       need to be recreated.  Since lsof compares  the  mtime  of  the  device
2113       cache  file  with  the mtime and ctime of the /dev (or /devices) direc‐
2114       tory, it usually detects that a new device has been added; in that case
2115       lsof  issues a warning message and attempts to rebuild the device cache
2116       file.
2117
2118       Whenever lsof writes a device cache file, it sets its ownership to  the
2119       real  UID  of  the executing process, and its permission modes to 0600,
2120       this restricting its reading and writing to the file's owner.
2121

LSOF PERMISSIONS THAT AFFECT DEVICE CACHE FILE ACCESS

2123       Two permissions of the lsof executable affect  its  ability  to  access
2124       device cache files.  The permissions are set by the local system admin‐
2125       istrator when lsof is installed.
2126
2127       The first and rarer permission is setuid-root.  It  comes  into  effect
2128       when  lsof  is executed; its effective UID is then root, while its real
2129       (i.e., that of the logged-on user) UID is not.  The  lsof  distribution
2130       recommends that versions for these dialects run setuid-root.
2131
2132            HP-UX 11.11 and 11.23
2133            Linux
2134
2135       The  second and more common permission is setgid.  It comes into effect
2136       when the effective  group  IDentification  number  (GID)  of  the  lsof
2137       process  is  set  to  one that can access kernel memory devices - e.g.,
2138       ``kmem'', ``sys'', or ``system''.
2139
2140       An lsof process that has setgid permission usually surrenders the  per‐
2141       mission  after it has accessed the kernel memory devices.  When it does
2142       that, lsof can allow more liberal device cache  path  formations.   The
2143       lsof  distribution recommends that versions for these dialects run set‐
2144       gid and be allowed to surrender setgid permission.
2145
2146            AIX 5.[123]
2147            Apple Darwin 7.x Power Macintosh systems
2148            FreeBSD 4.x, 4.1x, 5.x and [67].x for x86-based systems
2149            FreeBSD 5.x and [67].x for Alpha, AMD64 and Sparc64-based
2150                systems
2151            HP-UX 11.00
2152            NetBSD 1.[456], 2.x and 3.x for Alpha, x86, and SPARC-based
2153                systems
2154            NEXTSTEP 3.[13] for NEXTSTEP architectures
2155            OpenBSD 2.[89] and 3.[0-9] for x86-based systems
2156            OPENSTEP 4.x
2157            SCO OpenServer Release 5.0.6 for x86-based systems
2158            SCO|Caldera UnixWare 7.1.4 for x86-based systems
2159            Solaris 2.6, 8, 9 and 10
2160            Tru64 UNIX 5.1
2161
2162       (Note: lsof for AIX 5L and above needs setuid-root permission if its -X
2163       option is used.)
2164
2165       Lsof for these dialects does not support a device cache, so the permis‐
2166       sions given to the executable don't apply to the device cache file.
2167
2168            Linux
2169

DEVICE CACHE FILE PATH FROM THE -D OPTION

2171       The -D option provides limited means for specifying  the  device  cache
2172       file  path.  Its ?  function will report the read-only and write device
2173       cache file paths that lsof will use.
2174
2175       When the -D b, r, and u functions are available, you can  use  them  to
2176       request  that the cache file be built in a specific location (b[path]);
2177       read but not rebuilt (r[path]); or read and rebuilt (u[path]).  The  b,
2178       r,  and  u  functions  are  restricted under some conditions.  They are
2179       restricted when the lsof process is setuid-root.   The  path  specified
2180       with the r function is always read-only, even when it is available.
2181
2182       The  b,  r,  and  u functions are also restricted when the lsof process
2183       runs setgid and lsof doesn't surrender the setgid permission.  (See the
2184       LSOF  PERMISSIONS  THAT  AFFECT  DEVICE CACHE FILE ACCESS section for a
2185       list of implementations that normally don't surrender their setgid per‐
2186       mission.)
2187
2188       A further -D function, i (for ignore), is always available.
2189
2190       When  available,  the  b function tells lsof to read device information
2191       from the kernel with the stat(2) function and build a device cache file
2192       at the indicated path.
2193
2194       When  available,  the  r  function  tells lsof to read the device cache
2195       file, but not update it.  When a  path  argument  accompanies  -Dr,  it
2196       names  the  device cache file path.  The r function is always available
2197       when it is specified without a path name argument.  If lsof is not run‐
2198       ning  setuid-root  and  surrenders  its  setgid permission, a path name
2199       argument may accompany the r function.
2200
2201       When available, the u function tells lsof to attempt to  read  and  use
2202       the  device  cache file.  If it can't read the file, or if it finds the
2203       contents of the file incorrect or outdated, it  will  read  information
2204       from  the kernel, and attempt to write an updated version of the device
2205       cache file, but only to a path it considers  legitimate  for  the  lsof
2206       process effective and real UIDs.
2207

DEVICE CACHE PATH FROM AN ENVIRONMENT VARIABLE

2209       Lsof's  second  choice for the device cache file is the contents of the
2210       LSOFDEVCACHE environment variable.  It avoids this choice if  the  lsof
2211       process is setuid-root, or the real UID of the process is root.
2212
2213       A  further  restriction  applies to a device cache file path taken from
2214       the LSOFDEVCACHE environment variable: lsof will  not  write  a  device
2215       cache file to the path if the lsof process doesn't surrender its setgid
2216       permission.  (See the LSOF PERMISSIONS THAT AFFECT  DEVICE  CACHE  FILE
2217       ACCESS  section for information on implementations that don't surrender
2218       their setgid permission.)
2219
2220       The local system administrator can disable the use of the  LSOFDEVCACHE
2221       environment  variable  or  change its name when building lsof.  Consult
2222       the output of -D?  for the environment variable's name.
2223

SYSTEM-WIDE DEVICE CACHE PATH

2225       The local system administrator may choose to have a system-wide  device
2226       cache file when building lsof.  That file will generally be constructed
2227       by a special system administration procedure when the system is  booted
2228       or  when  the contents of /dev or /devices) changes.  If defined, it is
2229       lsof's third device cache file path choice.
2230
2231       You can tell that a system-wide device cache file is in effect for your
2232       local installation by examining the lsof help option output - i.e., the
2233       output from the -h or -?  option.
2234
2235       Lsof will never write to the system-wide  device  cache  file  path  by
2236       default.   It  must  be  explicitly  named  with  a  -D  function  in a
2237       root-owned procedure.  Once the file has been  written,  the  procedure
2238       must  change  its permission modes to 0644 (owner-read and owner-write,
2239       group-read, and other-read).
2240

PERSONAL DEVICE CACHE PATH (DEFAULT)

2242       The default device cache file path of  the  lsof  distribution  is  one
2243       recorded  in  the  home  directory  of the real UID that executes lsof.
2244       Added to the home directory is a second  path  component  of  the  form
2245       .lsof_hostname.
2246
2247       This is lsof's fourth device cache file path choice, and is usually the
2248       default.  If a system-wide device cache file path was defined when lsof
2249       was  built, this fourth choice will be applied when lsof can't find the
2250       system-wide device cache file.  This is the only  time  lsof  uses  two
2251       paths when reading the device cache file.
2252
2253       The  hostname part of the second component is the base name of the exe‐
2254       cuting host, as returned by gethostname(2).  The base name  is  defined
2255       to  be  the  characters  preceding the first `.'  in the gethostname(2)
2256       output, or all the gethostname(2) output if it contains no `.'.
2257
2258       The device cache file belongs to  the  user  ID  and  is  readable  and
2259       writable  by  the  user ID alone - i.e., its modes are 0600.  Each dis‐
2260       tinct real user ID on a given host that executes lsof  has  a  distinct
2261       device  cache file.  The hostname part of the path distinguishes device
2262       cache files in an NFS-mounted home directory into  which  device  cache
2263       files are written from several different hosts.
2264
2265       The  personal device cache file path formed by this method represents a
2266       device cache file that lsof will attempt to read, and will  attempt  to
2267       write  should  it not exist or should its contents be incorrect or out‐
2268       dated.
2269
2270       The -Dr option without a path name argument will inhibit the writing of
2271       a new device cache file.
2272
2273       The -D?  option will list the format specification for constructing the
2274       personal device cache file.  The conversions used in the format  speci‐
2275       fication are described in the 00DCACHE file of the lsof distribution.
2276

MODIFIED PERSONAL DEVICE CACHE PATH

2278       If  this  option is defined by the local system administrator when lsof
2279       is built, the LSOFPERSDCPATH environment variable contents may be  used
2280       to add a component of the personal device cache file path.
2281
2282       The  LSOFPERSDCPATH  variable  contents are inserted in the path at the
2283       place marked by the local system administrator with the ``%p''  conver‐
2284       sion  in  the HASPERSDC format specification of the dialect's machine.h
2285       header file.  (It's placed  right  after  the  home  directory  in  the
2286       default lsof distribution.)
2287
2288       Thus, for example, if LSOFPERSDCPATH contains ``LSOF'', the home direc‐
2289       tory is ``/Homes/abe'', the host name is ``lsof.itap.purdue.edu'',  and
2290       the  HASPERSDC  format is the default (``%h/%p.lsof_%L''), the modified
2291       personal device cache file path is:
2292
2293            /Homes/abe/LSOF/.lsof_vic
2294
2295       The LSOFPERSDCPATH  environment  variable  is  ignored  when  the  lsof
2296       process is setuid-root or when the real UID of the process is root.
2297
2298       Lsof  will  not  write to a modified personal device cache file path if
2299       the lsof process doesn't surrender setgid permission.   (See  the  LSOF
2300       PERMISSIONS  THAT AFFECT DEVICE CACHE FILE ACCESS section for a list of
2301       implementations that normally don't surrender their setgid permission.)
2302
2303       If, for example, you want to create a sub-directory of personal  device
2304       cache  file  paths  by using the LSOFPERSDCPATH environment variable to
2305       name it, and lsof doesn't surrender its  setgid  permission,  you  will
2306       have  to  allow  lsof to create device cache files at the standard per‐
2307       sonal path and move them to your subdirectory with shell commands.
2308
2309       The local system administrator may: disable this option  when  lsof  is
2310       built;  change the name of the environment variable from LSOFPERSDCPATH
2311       to something else; change the HASPERSDC format to include the  personal
2312       path component in another place; or exclude the personal path component
2313       entirely.  Consult the output of the -D?  option  for  the  environment
2314       variable's name and the HASPERSDC format specification.
2315

DIAGNOSTICS

2317       Errors are identified with messages on the standard error file.
2318
2319       Lsof returns a one (1) if any error was detected, including the failure
2320       to locate command names, file names, Internet addresses or files, login
2321       names, NFS files, PIDs, PGIDs, or UIDs it was asked to list.  If the -V
2322       option is specified, lsof will indicate the search items it  failed  to
2323       list.
2324
2325       It  returns a zero (0) if no errors were detected and if it was able to
2326       list some information about all the specified search arguments.
2327
2328       When lsof cannot open access to /dev (or /devices) or one of its subdi‐
2329       rectories, or get information on a file in them with stat(2), it issues
2330       a warning message and continues.  That lsof will issue warning messages
2331       about inaccessible files in /dev (or /devices) is indicated in its help
2332       output - requested with the -h or >B -?  options -  with the message:
2333
2334            Inaccessible /dev warnings are enabled.
2335
2336       The warning message may be suppressed with the -w option.  It may  also
2337       have been suppressed by the system administrator when lsof was compiled
2338       by the setting of the WARNDEVACCESS definition.  In this case, the out‐
2339       put from the help options will include the message:
2340
2341            Inaccessible /dev warnings are disabled.
2342
2343       Inaccessible  device  warning messages usually disappear after lsof has
2344       created a working device cache file.
2345

EXAMPLES

2347       For a more extensive set of examples, documented more  fully,  see  the
2348       00QUICKSTART file of the lsof distribution.
2349
2350       To list all open files, use:
2351
2352              lsof
2353
2354       To list all open Internet, x.25 (HP-UX), and UNIX domain files, use:
2355
2356              lsof -i -U
2357
2358       To  list all open IPv4 network files in use by the process whose PID is
2359       1234, use:
2360
2361              lsof -i 4 -a -p 1234
2362
2363       Presuming the UNIX dialect supports IPv6, to list only open  IPv6  net‐
2364       work files, use:
2365
2366              lsof -i 6
2367
2368       To  list all files using any protocol on ports 513, 514, or 515 of host
2369       wonderland.cc.purdue.edu, use:
2370
2371              lsof -i @wonderland.cc.purdue.edu:513-515
2372
2373       To list all files using any protocol on any port of  mace.cc.purdue.edu
2374       (cc.purdue.edu is the default domain), use:
2375
2376              lsof -i @mace
2377
2378       To  list  all  open  files  for login name ``abe'', or user ID 1234, or
2379       process 456, or process 123, or process 789, use:
2380
2381              lsof -p 456,123,789 -u 1234,abe
2382
2383       To list all open files on device /dev/hd4, use:
2384
2385              lsof /dev/hd4
2386
2387       To find the process that has /u/abe/foo open, use:
2388
2389              lsof /u/abe/foo
2390
2391       To send a SIGHUP to the processes that have /u/abe/bar open, use:
2392
2393              kill -HUP `lsof -t /u/abe/bar`
2394
2395       To find any open file, including an open UNIX domain socket file,  with
2396       the name /dev/log, use:
2397
2398              lsof /dev/log
2399
2400       To  find  processes  with  open  files  on  the  NFS  file system named
2401       /nfs/mount/point whose server is inaccessible, and presuming your mount
2402       table supplies the device number for /nfs/mount/point, use:
2403
2404              lsof -b /nfs/mount/point
2405
2406       To do the preceding search with warning messages suppressed, use:
2407
2408              lsof -bw /nfs/mount/point
2409
2410       To ignore the device cache file, use:
2411
2412              lsof -Di
2413
2414       To  obtain  PID  and  command  name field output for each process, file
2415       descriptor, file device number, and file inode number for each file  of
2416       each process, use:
2417
2418              lsof -FpcfDi
2419
2420       To  list  the files at descriptors 1 and 3 of every process running the
2421       lsof command for login ID ``abe'' every 10 seconds, use:
2422
2423              lsof -c lsof -a -d 1 -d 3 -u abe -r10
2424
2425       To list the current working directory of processes  running  a  command
2426       that is exactly four characters long and has an 'o' or 'O' in character
2427       three, use this regular expression form of the -c c option:
2428
2429              lsof -c /^..o.$/i -a -d cwd
2430
2431       To find an IP version 4 socket file by its associated numeric  dot-form
2432       address, use:
2433
2434              lsof -i@128.210.15.17
2435
2436       To  find  an  IP  version 6 socket file (when the UNIX dialect supports
2437       IPv6) by its associated numeric colon-form address, use:
2438
2439              lsof -i@[0:1:2:3:4:5:6:7]
2440
2441       To find an IP version 6 socket file (when  the  UNIX  dialect  supports
2442       IPv6)  by  an  associated  numeric colon-form address that has a run of
2443       zeroes in it - e.g., the loop-back address - use:
2444
2445              lsof -i@[::1]
2446

BUGS

2448       Since lsof reads kernel memory in its  search  for  open  files,  rapid
2449       changes in kernel memory may produce unpredictable results.
2450
2451       When  a file has multiple record locks, the lock status character (fol‐
2452       lowing the file descriptor) is derived from a test of  the  first  lock
2453       structure, not from any combination of the individual record locks that
2454       might be described by multiple lock structures.
2455
2456       Lsof can't search for files with restrictive access permissions by name
2457       unless  it  is installed with root set-UID permission.  Otherwise it is
2458       limited to searching for files to which its user or its  set-GID  group
2459       (if any) has access permission.
2460
2461       The display of the destination address of a raw socket (e.g., for ping)
2462       depends on the UNIX operating system.  Some dialects store the destina‐
2463       tion address in the raw socket's protocol control block, some do not.
2464
2465       Lsof can't always represent Solaris device numbers in the same way that
2466       ls(1) does.  For example, the major and minor device numbers  that  the
2467       lstat(2) and stat(2) functions report for the directory on which CD-ROM
2468       files are mounted (typically /cdrom) are not the same as the ones  that
2469       it  reports for the device on which CD-ROM files are mounted (typically
2470       /dev/sr0).  (Lsof reports the directory numbers.)
2471
2472       The support for /proc file systems is available only for BSD and  Tru64
2473       UNIX  dialects,  Linux, and dialects derived from SYSV R4 - e.g., Free‐
2474       BSD, NetBSD, OpenBSD, Solaris, UnixWare.
2475
2476       Some /proc file items - device number, inode number, and  file  size  -
2477       are  unavailable in some dialects.  Searching for files in a /proc file
2478       system may require that the full path name be specified.
2479
2480       No text (txt) file descriptors are displayed for Linux processes.   All
2481       entries  for  files  other than the current working directory, the root
2482       directory, and numerical file descriptors are labeled mem descriptors.
2483
2484       Lsof can't search for Tru64 UNIX named pipes  by  name,  because  their
2485       kernel implementation of lstat(2) returns an improper device number for
2486       a named pipe.
2487
2488       Lsof can't report fully or correctly on HP-UX 9.01,  10.20,  and  11.00
2489       locks  because  of  insufficient access to kernel data or errors in the
2490       kernel data.  See the lsof FAQ (The FAQ section  gives  its  location.)
2491       for details.
2492
2493       The  AIX  SMT file type is a fabrication.  It's made up for file struc‐
2494       tures whose type (15) isn't defined in the AIX  /usr/include/sys/file.h
2495       header  file.   One  way  to  create  such  file structures is to run X
2496       clients with the DISPLAY variable set to ``:0.0''.
2497
2498       The +|-f[cfgGn] option is not supported under /proc-based  Linux  lsof,
2499       because it doesn't read kernel structures from kernel memory.
2500

ENVIRONMENT

2502       Lsof may access these environment variables.
2503
2504       LANG              defines  a language locale.  See setlocale(3) for the
2505                         names of other variables that can be used in place of
2506                         LANG - e.g., LC_ALL, LC_TYPE, etc.
2507
2508       LSOFDEVCACHE      defines  the  path  to  a device cache file.  See the
2509                         DEVICE CACHE PATH FROM AN ENVIRONMENT  VARIABLE  sec‐
2510                         tion for more information.
2511
2512       LSOFPERSDCPATH    defines  the  middle component of a modified personal
2513                         device cache file path.  See  the  MODIFIED  PERSONAL
2514                         DEVICE CACHE PATH section for more information.
2515

FAQ

2517       Frequently-asked  questions and their answers (an FAQ) are available in
2518       the 00FAQ file of the lsof distribution.
2519
2520       That file is also available via anonymous ftp from lsof.itap.purdue.edu
2521       at pub/tools/unix/lsofFAQ.  The URL is:
2522
2523              ftp://lsof.itap.purdue.edu/pub/tools/unix/lsof/FAQ
2524

FILES

2526       /dev/kmem         kernel virtual memory device
2527
2528       /dev/mem          physical memory device
2529
2530       /dev/swap         system paging device
2531
2532       .lsof_hostname    lsof's  device  cache  file (The suffix, hostname, is
2533                         the first component of the host's  name  returned  by
2534                         gethostname(2).)
2535

AUTHORS

2537       Lsof  was written by Victor A. Abell <abe@purdue.edu> of Purdue Univer‐
2538       sity.  Many others have contributed to lsof.   They're  listed  in  the
2539       00CREDITS file of the lsof distribution.
2540

DISTRIBUTION

2542       The latest distribution of lsof is available via anonymous ftp from the
2543       host lsof.itap.purdue.edu.  You'll find the lsof  distribution  in  the
2544       pub/tools/unix/lsof directory.
2545
2546       You can also use this URL:
2547
2548              ftp://lsof.itap.purdue.edu/pub/tools/unix/lsof
2549
2550       Lsof  is also mirrored elsewhere.  When you access lsof.itap.purdue.edu
2551       and change to its pub/tools/unix/lsof directory, you'll be given a list
2552       of  some mirror sites.  The pub/tools/unix/lsof directory also contains
2553       a more complete list in its mirrors file.  Use mirrors with  caution  -
2554       not all mirrors always have the latest lsof revision.
2555
2556       Some  pre-compiled  Lsof  executables  are  available on lsof.itap.pur‐
2557       due.edu, but their use is discouraged - it's better that you build your
2558       own  from  the  sources.   If you feel you must use a pre-compiled exe‐
2559       cutable, please read the cautions that appear in the  README  files  of
2560       the pub/tools/unix/lsof/binaries subdirectories and in the 00* files of
2561       the distribution.
2562
2563       More  information  on  the  lsof  distribution  can  be  found  in  its
2564       README.lsof_<version> file.  If you intend to get the lsof distribution
2565       and build it, please read README.lsof_<version> and the other 00* files
2566       of the distribution before sending questions to the author.
2567

SEE ALSO

2569       Not  all  the following manual pages may exist in every UNIX dialect to
2570       which lsof has been ported.
2571
2572       access(2), awk(1), crash(1), fattach(3C),  ff(1),  fstat(8),  fuser(1),
2573       gethostname(2),  isprint(3),  kill(1),  lstat(2), modload(8), mount(8),
2574       netstat(1),  ofiles(8L),  perl(1),  ps(1),  readlink(2),  setlocale(3),
2575       stat(2), uname(1).
2576
2577
2578
2579                                 Revision-4.78                         LSOF(8)
Impressum