1 9ddaf4ab 2023-04-08 benni .\" Copyright (c) 2023 Benjamin Stürz <benni@stuerz.xyz>
3 9ddaf4ab 2023-04-08 benni .\" Permission to use, copy, modify, and distribute this software for any
4 9ddaf4ab 2023-04-08 benni .\" purpose with or without fee is hereby granted, provided that the above
5 9ddaf4ab 2023-04-08 benni .\" copyright notice and this permission notice appear in all copies.
7 9ddaf4ab 2023-04-08 benni .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
8 9ddaf4ab 2023-04-08 benni .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
9 9ddaf4ab 2023-04-08 benni .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
10 9ddaf4ab 2023-04-08 benni .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
11 9ddaf4ab 2023-04-08 benni .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
12 9ddaf4ab 2023-04-08 benni .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
13 9ddaf4ab 2023-04-08 benni .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
14 5691dc7b 2023-05-05 benni .TH LSBLK 8 lsblk-@VERSION@ 2023-05-05
16 33bf1ca4 2023-04-08 benni lsblk \- list block devices
17 33bf1ca4 2023-04-08 benni .SH SYNOPSIS
19 1678d261 2023-05-15 benni [\fB-abinUuV\fR]
20 5691dc7b 2023-05-05 benni [\fIdisk ...\fR]
21 33bf1ca4 2023-04-08 benni .SH DESCRIPTION
24 b78f9b30 2023-04-08 benni utility can be used to examine block devices attached to the system.
27 5691dc7b 2023-05-05 benni operands it lists the specified devices.
28 5691dc7b 2023-05-05 benni Otherwise it lists all attached block devices.
29 fc7d38e3 2023-04-08 benni .SH OPTIONS
32 9c5d8ecc 2023-05-02 benni prints version information to stdout, then exit.
35 bf0e6461 2023-05-02 benni print all fields.
38 1678d261 2023-05-15 benni don't scan for RAID volumes using
39 1678d261 2023-05-15 benni .BR bio (4) .
42 0c961f7d 2023-05-04 benni don't print fancy unicode characters, only print ASCII.
45 8380cc51 2023-05-01 benni don't print the header.
48 1115ad3a 2023-05-05 benni also print the disklabel UID.
51 9c5d8ecc 2023-05-02 benni also print the filesystem usage of each partition
52 9c5d8ecc 2023-05-02 benni and the disklabel usage of each disk.
54 5691dc7b 2023-05-05 benni Note: The disklabel usage is calculated by
55 5691dc7b 2023-05-05 benni summing the size of all (except "c") partitions.
57 1115ad3a 2023-05-05 benni Note 2: lsblk shows the total amount of free space,
58 1115ad3a 2023-05-05 benni including space reserved for /root.
59 5691dc7b 2023-05-05 benni .SH EXIT STATUS
62 5691dc7b 2023-05-05 benni utility exits 0 on success, and >0 if an error occurs.
63 5691dc7b 2023-05-05 benni .SH EXAMPLES
64 5691dc7b 2023-05-05 benni The following line lists all block devices:
70 5691dc7b 2023-05-05 benni The following line lists all fields of sd0:
73 5691dc7b 2023-05-05 benni lsblk -a sd0
78 f14e5929 2023-05-17 benni The name of the disk/partition.
84 f14e5929 2023-05-17 benni The disklabel UID of the disk.
90 f14e5929 2023-05-17 benni The size of the partition, not the filesystem.
96 f14e5929 2023-05-17 benni For disks: The amount of allocated disk space for partitions.
99 f14e5929 2023-05-17 benni For mounted partitions: The amount of used space.
105 f14e5929 2023-05-17 benni For disks: SIZE - FREE
108 f14e5929 2023-05-17 benni For partitions: FS_SIZE - FREE
114 f14e5929 2023-05-17 benni For disks: The type of the disk.
117 f14e5929 2023-05-17 benni For partitions: The type of data on the partition.
120 f14e5929 2023-05-17 benni .B COMMENT
123 f14e5929 2023-05-17 benni For all disks: The label of the disk.
126 f14e5929 2023-05-17 benni For RAID disks: Additionally the status of the volume.
129 f14e5929 2023-05-17 benni For mounted partitions: The first found current mount point.
130 33bf1ca4 2023-04-08 benni .SH SEE ALSO
131 9c5d8ecc 2023-05-02 benni .BR disklabel (8) ,
132 1678d261 2023-05-15 benni .BR bio (4) ,
133 9c5d8ecc 2023-05-02 benni .BR df (1)
134 5691dc7b 2023-05-05 benni .SH HISTORY
136 5691dc7b 2023-05-05 benni .B lsblk(8)
137 5691dc7b 2023-05-05 benni utility was originally written by the
138 5691dc7b 2023-05-05 benni .B util-linux
140 5691dc7b 2023-05-05 benni This is an
141 5691dc7b 2023-05-05 benni .I incompatible
142 5691dc7b 2023-05-05 benni clone of the original \fBlsblk\fR.
143 5691dc7b 2023-05-05 benni It is incompatible because it doesn't support
144 5691dc7b 2023-05-05 benni the same set of options as the original
145 5691dc7b 2023-05-05 benni and because of differences in the output.
146 5691dc7b 2023-05-05 benni More incompatibilities are caused by specific features only being available
147 5691dc7b 2023-05-05 benni on either Linux or OpenBSD.
148 f65cdacb 2023-05-15 benni .SH AUTHORS
151 f65cdacb 2023-05-15 benni program was written by Benjamin Stürz <benni@stuerz.xyz>.