summaryrefslogtreecommitdiffstats
path: root/misc-utils/lslocks.8.adoc
blob: 21ad643e53a279a197fd056a318ddb8841f9824c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
//po4a: entry man manual
////
Man page for the lslocks command.
Copyright 2012 Davidlohr Bueso <dave@gnu.org>
May be distributed under the GNU General Public License
////
////
Copyright 1994 Salvatore Valente (svalente@mit.edu)
Copyright 1992 Rickard E. Faith (faith@cs.unc.edu)
May be distributed under the GNU General Public License
////
= lslocks(8)
:doctype: manpage
:man manual: System Administration
:man source: util-linux {release-version}
:page-layout: base
:command: lslocks
:plus: +

== NAME

lslocks - list local system locks

== SYNOPSIS

*lslocks* [options]

== DESCRIPTION

*lslocks* lists information about all the currently held file locks in a Linux system.

Note that lslocks also lists OFD (Open File Description) locks, these locks are not associated with any process (PID is -1). OFD locks are associated with the open file description on which they are acquired. This lock type is available since Linux 3.15, see *fcntl*(2) for more details.

== OPTIONS

*-b*, *--bytes*::
include::man-common/in-bytes.adoc[]

*-i*, *--noinaccessible*::
Ignore lock files which are inaccessible for the current user.

*-J*, *--json*::
Use JSON output format.

*-n*, *--noheadings*::
Do not print a header line.

*-o*, *--output* _list_::
Specify which output columns to print. Use *--help* to get a list of all supported columns.
+
The default list of columns may be extended if _list_ is specified in the format _{plus}list_ (e.g., *lslocks -o {plus}BLOCKER*).
//TRANSLATORS: Keep {plus} untranslated.

*--output-all*::
Output all available columns.

*-p*, *--pid* _pid_::
Display only the locks held by the process with this _pid_.

*-r*, *--raw*::
Use the raw output format.

*-u*, *--notruncate*::
Do not truncate text in columns.

include::man-common/help-version.adoc[]

== OUTPUT

COMMAND::
The command name of the process holding the lock.

PID::
The process ID of the process which holds the lock or -1 for OFDLCK.

TYPE::
The type of lock; can be FLOCK (created with *flock*(2)), POSIX (created with *fcntl*(2) and *lockf*(3)) or OFDLCK (created with *fcntl*(2)).

SIZE::
Size of the locked file.

MODE::
The lock's access permissions (read, write). If the process is blocked and waiting for the lock, then the mode is postfixed with an '*' (asterisk).

M::
Whether the lock is mandatory; 0 means no (meaning the lock is only advisory), 1 means yes. (See *fcntl*(2).)

START::
Relative byte offset of the lock.

END::
Ending offset of the lock.

PATH::
Full path of the lock. If none is found, or there are no permissions to read the path, it will fall back to the device's mountpoint and "..." is appended to the path. The path might be truncated; use *--notruncate* to get the full path.

BLOCKER::
The PID of the process which blocks the lock.

== NOTES

The *lslocks* command is meant to replace the *lslk*(8) command, originally written by mailto:abe@purdue.edu[Victor A. Abell] and unmaintained since 2001.

== AUTHORS

mailto:dave@gnu.org[Davidlohr Bueso]

== SEE ALSO

*flock*(1),
*fcntl*(2),
*lockf*(3)

include::man-common/bugreports.adoc[]

include::man-common/footer.adoc[]

ifdef::translation[]
include::man-common/translation.adoc[]
endif::[]