]> git.ipfire.org Git - thirdparty/util-linux.git/blobdiff - misc-utils/lsblk.8
Merge branch 'hardlink' of https://github.com/rudimeier/util-linux into hardlink
[thirdparty/util-linux.git] / misc-utils / lsblk.8
index 5e2c1242f5191a2651eda6ca8a3e03e7e7a532f5..2787569fed5108b207dd47862e712fd8b6784829 100644 (file)
@@ -13,7 +13,9 @@ command reads the
 .B sysfs
 filesystem and
 .B udev db
-to gather information.
+to gather information. If the udev db is not available or lsblk is compiled without udev support than it
+tries to read LABELs, UUIDs and filesystem types from the block device. In this case root permissions
+are necessary.
 .PP
 The command prints all block devices (except RAM disks) in a tree-like format
 by default.  Use
@@ -21,7 +23,7 @@ by default.  Use
 to get a list of all available columns.
 .PP
 The default output, as well as the default output from options like
-.BR \-\-fs
+.B \-\-fs
 and
 .BR \-\-topology ,
 is subject to change.  So whenever possible, you should avoid using default
@@ -41,7 +43,7 @@ before lsblk to synchronize with udev.
 .SH OPTIONS
 .TP
 .BR \-a , " \-\-all"
-Also list empty devices.  (By default they are skipped.)
+Also list empty devices and RAM disk devices.
 .TP
 .BR \-b , " \-\-bytes"
 Print the SIZE column in bytes rather than in a human-readable format.
@@ -53,10 +55,19 @@ Print information about the discarding capabilities (TRIM, UNMAP) for each devic
 Do not print holder devices or slaves.  For example, \fBlsblk --nodeps /dev/sda\fR prints
 information about the sda device only.
 .TP
+.BR \-E , " \-\-dedup " \fIcolumn\fP
+Use \fIcolumn\fP as a de-duplication key to de-duplicate output tree. If the
+key is not available for the device, or the device is a partition and parental
+whole-disk device provides the same key than the device is always printed.
+
+The usual use case is to de-duplicate output on system multi-path devices, for
+example by \fB\-E WWN\fR.
+.TP
 .BR \-e , " \-\-exclude " \fIlist\fP
 Exclude the devices specified by the comma-separated \fIlist\fR of major device numbers.
-Note that RAM disks (major=1) are excluded by default.  The filter is applied to the
-top-level devices only.
+Note that RAM disks (major=1) are excluded by default if \fB\-\-all\fR is no specified.
+The filter is applied to the top-level devices only. This maybe be confusing for
+\fB\-\-list\fR output format where hierarchy of the devices is not obvious.
 .TP
 .BR \-f , " \-\-fs"
 Output info about filesystems.  This option is equivalent to
@@ -70,7 +81,8 @@ Display help text and exit.
 .TP
 .BR \-I , " \-\-include " \fIlist\fP
 Include devices specified by the comma-separated \fIlist\fR of major device numbers.
-The filter is applied to the top-level devices only.
+The filter is applied to the top-level devices only. This maybe be confusing for
+\fB\-\-list\fR output format where hierarchy of the devices is not obvious.
 .TP
 .BR \-i , " \-\-ascii"
 Use ASCII characters for tree formatting.
@@ -79,7 +91,13 @@ Use ASCII characters for tree formatting.
 Use JSON output format.
 .TP
 .BR \-l , " \-\-list"
-Produce output in the form of a list.
+Produce output in the form of a list. The output does not provide information
+about relationships between devices and since version 2.34 every device is
+printed only once.
+.TP
+.BR \-M , " \-\-merge"
+Group parents of sub-trees to provide more readable output for RAIDs and
+Multi-path devices. The tree-like output is required.
 .TP
 .BR \-m , " \-\-perms"
 Output info about device owner, group and mode.  This option is equivalent to
@@ -114,7 +132,8 @@ Produce output in raw format.  All potentially unsafe characters are hex-escaped
 Output info about SCSI devices only.  All partitions, slaves and holder devices are ignored.
 .TP
 .BR \-s , " \-\-inverse"
-Print dependencies in inverse order.
+Print dependencies in inverse order. If the \fB\-\-list\fR output is requested then
+the lines are still ordered by dependencies.
 .TP
 .BR \-t , " \-\-topology"
 Output info about block-device topology.
@@ -125,7 +144,18 @@ This option is equivalent to
 Display version information and exit.
 .TP
 .BR \-x , " \-\-sort " \fIcolumn\fP
-Sort output lines by \fIcolumn\fP. This option enables \fB\-\-list\fR output.
+Sort output lines by \fIcolumn\fP. This option enables \fB\-\-list\fR output format by default.
+It is possible to use the option \fI\-\-tree\fP to force tree-like output and
+than the tree branches are sorted by the \fIcolumn\fP.
+.TP
+.BR \-z , " \-\-zoned"
+Print the zone model for each device.
+.TP
+.BR " \-\-sysroot " \fIdirectory\fP
+Gather data for a Linux instance other than the instance from which the lsblk
+command is issued.  The specified directory is the system root of the Linux
+instance to be inspected.  This option is designed for the testing purpose.
+
 .SH NOTES
 For partitions, some information (e.g. queue attributes) is inherited from the
 parent device.
@@ -134,7 +164,7 @@ The
 .B lsblk
 command needs to be able to look up each block device by major:minor numbers,
 which is done by using
-.BR /sys/dev/block .
+.IR /sys/dev/block .
 This sysfs block directory appeared in kernel 2.6.27 (October 2008).
 In case of problems with a new enough kernel, check that CONFIG_SYSFS
 was enabled at the time of the kernel build.
@@ -145,7 +175,7 @@ success
 .IP 1
 failure
 .IP 32
-not found all specified devices
+none of specified devices found
 .IP 64
 some specified devices found, some not found
 
@@ -155,6 +185,8 @@ Milan Broz <mbroz@redhat.com>
 Karel Zak <kzak@redhat.com>
 .fi
 .SH ENVIRONMENT
+.IP LSBLK_DEBUG=all
+enables lsblk debug output.
 .IP LIBBLKID_DEBUG=all
 enables libblkid debug output.
 .IP LIBMOUNT_DEBUG=all
@@ -164,9 +196,9 @@ enables libsmartcols debug output.
 .IP LIBSMARTCOLS_DEBUG_PADDING=on
 use visible padding characters. Requires enabled LIBSMARTCOLS_DEBUG.
 .SH SEE ALSO
-.BR findmnt (8),
+.BR ls (1),
 .BR blkid (8),
-.BR ls (1)
+.BR findmnt (8)
 .SH AVAILABILITY
 The lsblk command is part of the util-linux package and is available from
-ftp://ftp.kernel.org/pub/linux/utils/util-linux/.
+https://www.kernel.org/pub/linux/utils/util-linux/.