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
|
.\" Copyright (c) 2018, Red Hat, Inc. All rights reserved.
.\"
.\" SPDX-License-Identifier: GPL-2.0-or-later
.TH ioctl_fslabel 2 2024-05-02 "Linux man-pages (unreleased)"
.SH NAME
ioctl_fslabel \- get or set a filesystem label
.SH LIBRARY
Standard C library
.RI ( libc ", " \-lc )
.SH SYNOPSIS
.nf
.BR "#include <linux/fs.h>" " /* Definition of " *FSLABEL* " constants */"
.B #include <sys/ioctl.h>
.P
.BI "int ioctl(int " fd ", FS_IOC_GETFSLABEL, char " label [FSLABEL_MAX]);
.BI "int ioctl(int " fd ", FS_IOC_SETFSLABEL, char " label [FSLABEL_MAX]);
.fi
.SH DESCRIPTION
If a filesystem supports online label manipulation, these
.BR ioctl (2)
operations can be used to get or set the filesystem label for the filesystem
on which
.I fd
resides.
The
.B FS_IOC_SETFSLABEL
operation requires privilege
.RB ( CAP_SYS_ADMIN ).
.SH RETURN VALUE
On success zero is returned.
On error, \-1 is returned, and
.I errno
is set to indicate the error.
.SH ERRORS
Possible errors include (but are not limited to) the following:
.TP
.B EFAULT
.I label
references an inaccessible memory area.
.TP
.B EINVAL
The specified label exceeds the maximum label length for the filesystem.
.TP
.B ENOTTY
This can appear if the filesystem does not support online label manipulation.
.TP
.B EPERM
The calling process does not have sufficient permissions to set the label.
.SH STANDARDS
Linux.
.SH HISTORY
Linux 4.18.
.P
They were previously known as
.B BTRFS_IOC_GET_FSLABEL
and
.B BTRFS_IOC_SET_FSLABEL
and were private to Btrfs.
.SH NOTES
The maximum string length for this interface is
.BR FSLABEL_MAX ,
including the terminating null byte (\[aq]\\0\[aq]).
Filesystems have differing maximum label lengths, which may or
may not include the terminating null.
The string provided to
.B FS_IOC_SETFSLABEL
must always be null-terminated, and the string returned by
.B FS_IOC_GETFSLABEL
will always be null-terminated.
.SH SEE ALSO
.BR ioctl (2),
.BR blkid (8)
|
