diff options
| author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-06-17 10:51:52 +0000 |
|---|---|---|
| committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-06-17 10:51:52 +0000 |
| commit | 4ad94864781f48b1a4b77f9cfb934622bf756ba1 (patch) | |
| tree | 3900955c1886e6d2570fea7125ee1f01bafe876d /upstream/opensuse-tumbleweed/man5 | |
| parent | Adding upstream version 4.22.0. (diff) | |
| download | manpages-l10n-4ad94864781f48b1a4b77f9cfb934622bf756ba1.tar.xz manpages-l10n-4ad94864781f48b1a4b77f9cfb934622bf756ba1.zip | |
Adding upstream version 4.23.0.upstream/4.23.0
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'upstream/opensuse-tumbleweed/man5')
259 files changed, 13889 insertions, 9066 deletions
diff --git a/upstream/opensuse-tumbleweed/man5/acct.5 b/upstream/opensuse-tumbleweed/man5/acct.5 index e1d88d4a..7a4cb521 100644 --- a/upstream/opensuse-tumbleweed/man5/acct.5 +++ b/upstream/opensuse-tumbleweed/man5/acct.5 @@ -2,7 +2,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH acct 5 2023-05-03 "Linux man-pages 6.05.01" +.TH acct 5 2024-05-02 "Linux man-pages (unreleased)" .SH NAME acct \- process accounting file .SH SYNOPSIS @@ -15,18 +15,18 @@ If the kernel is built with the process accounting option enabled then calling .BR acct (2) starts process accounting, for example: -.PP +.P .in +4n acct("/var/log/pacct"); .in -.PP +.P When process accounting is enabled, the kernel writes a record to the accounting file as each process on the system terminates. This record contains information about the terminated process, and is defined in .I <sys/acct.h> as follows: -.PP +.P .in +4n .EX #define ACCT_COMM 16 @@ -65,7 +65,7 @@ enum { /* Bits that may be set in ac_flag field */ }; .EE .in -.PP +.P The .I comp_t data type is a floating-point value consisting of a 3-bit, base-8 exponent, @@ -73,11 +73,11 @@ and a 13-bit mantissa. A value, .IR c , of this type can be converted to a (long) integer as follows: -.PP +.P .nf v = (c & 0x1fff) << (((c >> 13) & 0x7) * 3); .fi -.PP +.P The .IR ac_utime , .IR ac_stime , @@ -101,7 +101,7 @@ and fields is widened from 16 to 32 bits (in line with the increased size of UID and GIDs in Linux 2.4 and later). The records are defined as follows: -.PP +.P .in +4n .EX struct acct_v3 { @@ -135,19 +135,19 @@ and the details vary somewhat between systems. None. .SH HISTORY glibc 2.6. -.PP +.P Process accounting originated on BSD. .SH NOTES Records in the accounting file are ordered by termination time of the process. -.PP +.P Up to and including Linux 2.6.9, a separate accounting record is written for each thread created using the NPTL threading library; since Linux 2.6.10, a single accounting record is written for the entire process on termination of the last thread in the process. -.PP +.P The .I /proc/sys/kernel/acct file, described in diff --git a/upstream/opensuse-tumbleweed/man5/binfmt.d.5 b/upstream/opensuse-tumbleweed/man5/binfmt.d.5 index 27e746ec..01d08860 100644 --- a/upstream/opensuse-tumbleweed/man5/binfmt.d.5 +++ b/upstream/opensuse-tumbleweed/man5/binfmt.d.5 @@ -1,5 +1,5 @@ '\" t -.TH "BINFMT\&.D" "5" "" "systemd 254" "binfmt.d" +.TH "BINFMT\&.D" "5" "" "systemd 255" "binfmt.d" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/upstream/opensuse-tumbleweed/man5/btrfs.5 b/upstream/opensuse-tumbleweed/man5/btrfs.5 index 208aa24b..a952ad8d 100644 --- a/upstream/opensuse-tumbleweed/man5/btrfs.5 +++ b/upstream/opensuse-tumbleweed/man5/btrfs.5 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BTRFS" "5" "Feb 14, 2024" "6.7.1" "BTRFS" +.TH "BTRFS" "5" "May 02, 2024" "6.8.1" "BTRFS" .SH NAME btrfs \- topics about the BTRFS filesystem (mount options, supported file attributes and other) .SH DESCRIPTION @@ -70,7 +70,7 @@ storage model, hardware considerations .SS BTRFS SPECIFIC MOUNT OPTIONS .sp This section describes mount options specific to BTRFS. For the generic mount -options please refer to \fBmount(8)\fP manual page. The options are sorted alphabetically +options please refer to \fI\%mount(8)\fP manual page. The options are sorted alphabetically (discarding the \fIno\fP prefix). .sp \fBNOTE:\fP @@ -95,7 +95,7 @@ have been applied. (default: on) .sp Enable/disable support for POSIX Access Control Lists (ACLs). See the -\fBacl(5)\fP manual page for more information about ACLs. +\fI\%acl(5)\fP manual page for more information about ACLs. .sp The support for ACL is build\-time configurable (BTRFS_FS_POSIX_ACL) and mount fails if \fIacl\fP is requested but the feature is not compiled in. @@ -228,7 +228,7 @@ If compression is enabled, \fInodatacow\fP and \fInodatasum\fP are disabled. .sp Enable data copy\-on\-write for newly created files. \fINodatacow\fP implies \fInodatasum\fP, and disables \fIcompression\fP\&. All files created -under \fInodatacow\fP are also set the NOCOW file attribute (see \fBchattr(1)\fP). +under \fInodatacow\fP are also set the NOCOW file attribute (see \fI\%chattr(1)\fP). .sp \fBNOTE:\fP .INDENT 7.0 @@ -247,7 +247,7 @@ at the cost of potential partial writes, in case the write is interrupted Enable data checksumming for newly created files. \fIDatasum\fP implies \fIdatacow\fP, i.e. the normal mode of operation. All files created under \fInodatasum\fP inherit the \(dqno checksums\(dq property, however there\(aqs no -corresponding file attribute (see \fBchattr(1)\fP). +corresponding file attribute (see \fI\%chattr(1)\fP). .sp \fBNOTE:\fP .INDENT 7.0 @@ -599,7 +599,7 @@ Historically, any user could create a snapshot even if he was not owner of the source subvolume, the subvolume deletion has been restricted for that reason. The subvolume creation has been restricted but this mount option is still required. This is a usability issue. -Since 4.18, the \fBrmdir(2)\fP syscall can delete an empty subvolume just like an +Since 4.18, the \fI\%rmdir(2)\fP syscall can delete an empty subvolume just like an ordinary directory. Whether this is possible can be detected at runtime, see \fIrmdir_subvol\fP feature in \fIFILESYSTEM FEATURES\fP\&. .UNINDENT @@ -635,7 +635,7 @@ previous use of the \fIinode_cache\fP option can be removed by .UNINDENT .SS NOTES ON GENERIC MOUNT OPTIONS .sp -Some of the general mount options from \fBmount(8)\fP that affect BTRFS and are +Some of the general mount options from \fI\%mount(8)\fP that affect BTRFS and are worth mentioning. .INDENT 0.0 .TP @@ -763,6 +763,11 @@ stored as an extent, saves a few percent of metadata if sparse files are used .sp extended RAID1 mode with copies on 3 or 4 devices respectively .TP +.B raid_stripe_tree +(since: 6.7) +.sp +a separate tree for tracking file extents on RAID profiles +.TP .B RAID56 (since: 3.9) .sp @@ -771,7 +776,7 @@ the filesystem contains or contained a RAID56 profile of block groups .B rmdir_subvol (since: 4.18) .sp -indicate that \fBrmdir(2)\fP syscall can delete an empty subvolume just like an +indicate that \fI\%rmdir(2)\fP syscall can delete an empty subvolume just like an ordinary directory. Note that this feature only depends on the kernel version. .TP .B skinny_metadata @@ -784,6 +789,11 @@ reduced\-size metadata for extent references, saves a few percent of metadata .sp number of the highest supported send stream version .TP +.B simple_quota +(since: 6.7) +.sp +simplified quota accounting +.TP .B supported_checksums (since: 5.5) .sp @@ -813,8 +823,8 @@ sequentially, see section \fI\%ZONED MODE\fP .SH SWAPFILE SUPPORT .sp A swapfile, when active, is a file\-backed swap area. It is supported since kernel 5.0. -Use \fBswapon(8)\fP to activate it, until then (respectively again after deactivating it -with \fBswapoff(8)\fP) it\(aqs just a normal file (with NODATACOW set), for which the special +Use \fI\%swapon(8)\fP to activate it, until then (respectively again after deactivating it +with \fI\%swapoff(8)\fP) it\(aqs just a normal file (with NODATACOW set), for which the special restrictions for active swapfiles don\(aqt apply. .sp There are some limitations of the implementation in BTRFS and Linux swap @@ -1447,9 +1457,9 @@ pattern detection, byte frequency, Shannon entropy. .SH COMPATIBILITY .sp Compression is done using the COW mechanism so it\(aqs incompatible with -\fInodatacow\fP\&. Direct IO works on compressed files but will fall back to buffered -writes and leads to recompression. Currently \fInodatasum\fP and compression don\(aqt -work together. +\fInodatacow\fP\&. Direct IO read works on compressed files but will fall back to +buffered writes and leads to no compression even if force compression is set. +Currently \fInodatasum\fP and compression don\(aqt work together. .sp The compression algorithms have been added over time so the version compatibility should be also considered, together with other tools that may @@ -1886,7 +1896,7 @@ depends on the \fInodesize\fP value, for 4KiB it\(aqs 3949 bytes, for larger nod it\(aqs 4095 due to the system limit PATH_MAX .sp The symlink target may not be a valid path, i.e. the path name components -can exceed the limits (NAME_MAX), there\(aqs no content validation at \fBsymlink(3)\fP +can exceed the limits (NAME_MAX), there\(aqs no content validation at \fI\%symlink(3)\fP creation. .TP .B maximum number of inodes @@ -1944,7 +1954,7 @@ old and new interfaces, with confusing names. The following list should clarify that: .INDENT 0.0 .IP \(bu 2 -\fIattributes\fP: \fBchattr(1)\fP or \fBlsattr(1)\fP utilities (the ioctls are +\fIattributes\fP: \fI\%chattr(1)\fP or \fI\%lsattr(1)\fP utilities (the ioctls are FS_IOC_GETFLAGS and FS_IOC_SETFLAGS), due to the ioctl names the attributes are also called flags .IP \(bu 2 @@ -1952,7 +1962,7 @@ are also called flags bits similar to the attributes but extensible and new bits will be added in the future (the ioctls are FS_IOC_FSGETXATTR and FS_IOC_FSSETXATTR but they are not related to extended attributes that are also called xattrs), there\(aqs -no standard tool to change the bits, there\(aqs support in \fBxfs_io(8)\fP as +no standard tool to change the bits, there\(aqs support in \fI\%xfs_io(8)\fP as command \fBxfs_io \-c chattr\fP .UNINDENT .SS Attributes @@ -1986,11 +1996,11 @@ empty files. .UNINDENT .TP .B d -\fIno dump\fP, makes sense with 3rd party tools like \fBdump(8)\fP, on BTRFS the +\fIno dump\fP, makes sense with 3rd party tools like \fI\%dump(8)\fP, on BTRFS the attribute can be set/unset but no other special handling is done .TP .B D -\fIsynchronous directory updates\fP, for more details search \fBopen(2)\fP for \fIO_SYNC\fP +\fIsynchronous directory updates\fP, for more details search \fI\%open(2)\fP for \fIO_SYNC\fP and \fIO_DSYNC\fP .TP .B i @@ -1999,23 +2009,23 @@ long as this attribute is set (obviously the exception is unsetting the attribut .TP .B m \fIno compression\fP, permanently turn off compression on the given file. Any -compression mount options will not affect this file. (\fBchattr\fP support added in +compression mount options will not affect this file. (\fI\%chattr(1)\fP support added in 1.46.2) .sp When set on a directory, all newly created files will inherit this attribute. This attribute cannot be set with \fIc\fP at the same time. .TP .B S -\fIsynchronous updates\fP, for more details search \fBopen(2)\fP for \fIO_SYNC\fP and +\fIsynchronous updates\fP, for more details search \fI\%open(2)\fP for \fIO_SYNC\fP and \fIO_DSYNC\fP .UNINDENT .sp No other attributes are supported. For the complete list please refer to the -\fBchattr(1)\fP manual page. +\fI\%chattr(1)\fP manual page. .SS XFLAGS .sp There\(aqs an overlap of letters assigned to the bits with the attributes, this list -refers to what \fBxfs_io(8)\fP provides: +refers to what \fI\%xfs_io(8)\fP provides: .INDENT 0.0 .TP .B i @@ -2757,10 +2767,23 @@ have been demonstrated (\fIrowhammer\fP) achieving specific bits to be flipped. While these were targeted, this shows that a series of reads or writes can affect unrelated parts of memory. .sp +Block group profiles with redundancy (like RAID1) will not protect against +memory errors as the blocks are first stored in memory before they are written +to the devices from the same source. +.sp +A filesystem mounted read\-only will not affect the underlying block device in +almost 100% (with highly unlikely exceptions). The exception is a tree\-log that +needs to be replayed during mount (and before the read\-only mount takes place), +working memory is needed for that and that can be affected by bit flips. +There\(aqs a theoretical case where bit flip changes the filesystem status from +read\-only to read\-write. +.sp Further reading: .INDENT 0.0 .IP \(bu 2 \fI\%https://en.wikipedia.org/wiki/Row_hammer\fP +.IP \(bu 2 +memory overclocking, XMP, potential risks .UNINDENT .sp What to do: @@ -2772,6 +2795,10 @@ is under heavy load that the default memtest cannot trigger memory errors may appear as filesystem going read\-only due to \(dqpre write\(dq check, that verify meta data before they get written but fail some basic consistency checks +.IP \(bu 2 +newly built systems should be tested before being put to production use, +ideally start a IO/CPU load that will be run on such system later; namely +systems that will utilize overclocking or special performance features .UNINDENT .SS Direct memory access (DMA) .sp @@ -2827,7 +2854,7 @@ to avoid unnecessary resets and performs optimizations to maximize the storage media lifetime. The known techniques are deduplication (blocks with same fingerprint/hash are mapped to same physical block), compression or internal remapping and garbage collection of used memory cells. Due to the additional -processing there are measures to verity the data e.g. by ECC codes. +processing there are measures to verify the data e.g. by ECC codes. .sp The observations of failing SSDs show that the whole electronic fails at once or affects a lot of data (e.g. stored on one chip). Recovering such data @@ -2960,13 +2987,13 @@ and replacing the card could be required as well. filesystem when it tells you.\fP .SH SEE ALSO .sp -\fBacl(5)\fP, +\fI\%acl(5)\fP, \fI\%btrfs(8)\fP, -\fBchattr(1)\fP, -\fBfstrim(8)\fP, -\fBioctl(2)\fP, +\fI\%chattr(1)\fP, +\fI\%fstrim(8)\fP, +\fI\%ioctl(2)\fP, \fI\%mkfs.btrfs(8)\fP, -\fBmount(8)\fP, -\fBswapon(8)\fP +\fI\%mount(8)\fP, +\fI\%swapon(8)\fP .\" Generated by docutils manpage writer. . diff --git a/upstream/opensuse-tumbleweed/man5/charmap.5 b/upstream/opensuse-tumbleweed/man5/charmap.5 index 280ba4e5..47d038dc 100644 --- a/upstream/opensuse-tumbleweed/man5/charmap.5 +++ b/upstream/opensuse-tumbleweed/man5/charmap.5 @@ -2,7 +2,7 @@ .\" .\" SPDX-License-Identifier: GPL-2.0-or-later .\" -.TH charmap 5 2022-10-30 "Linux man-pages 6.05.01" +.TH charmap 5 2024-05-02 "Linux man-pages (unreleased)" .SH NAME charmap \- character set description file .SH DESCRIPTION @@ -38,11 +38,11 @@ This value must be less than or equal than .RI < mb_cur_max >. If not specified, it defaults to .RI < mb_cur_max >. -.PP +.P The character set definition section starts with the keyword .I CHARMAP in the first column. -.PP +.P The following lines may have one of the two following forms to define the character set: .TP @@ -55,23 +55,23 @@ being optional. This form defines a character range and its byte sequence, .I comment being optional. -.PP +.P The character set definition section ends with the string .IR "END CHARMAP" . -.PP +.P The character set definition section may optionally be followed by a section to define widths of characters. -.PP +.P The .I WIDTH_DEFAULT keyword can be used to define the default width for all characters not explicitly listed. The default character width is 1. -.PP +.P The width section for individual characters starts with the keyword .I WIDTH in the first column. -.PP +.P The following lines may have one of the two following forms to define the widths of the characters: .TP @@ -80,7 +80,7 @@ This form defines the width of exactly one character. .TP .RI < character >...< character >\ width This form defines the width for all the characters in the range. -.PP +.P The width definition section ends with the string .IR "END WIDTH" . .SH FILES @@ -93,7 +93,7 @@ POSIX.2. The Euro sign is defined as follows in the .I UTF\-8 charmap: -.PP +.P .nf <U20AC> /xe2/x82/xac EURO SIGN .fi diff --git a/upstream/opensuse-tumbleweed/man5/core.5 b/upstream/opensuse-tumbleweed/man5/core.5 index c19846ee..c24f6f97 100644 --- a/upstream/opensuse-tumbleweed/man5/core.5 +++ b/upstream/opensuse-tumbleweed/man5/core.5 @@ -2,7 +2,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH core 5 2023-05-03 "Linux man-pages 6.05.01" +.TH core 5 2024-05-02 "Linux man-pages (unreleased)" .SH NAME core \- core dump file .SH DESCRIPTION @@ -16,14 +16,14 @@ This image can be used in a debugger (e.g., to inspect the state of the program at the time that it terminated. A list of the signals which cause a process to dump core can be found in .BR signal (7). -.PP +.P A process can set its soft .B RLIMIT_CORE resource limit to place an upper limit on the size of the core dump file that will be produced if it receives a "core dump" signal; see .BR getrlimit (2) for details. -.PP +.P There are various circumstances in which a core dump file is not produced: .IP \[bu] 3 @@ -115,13 +115,13 @@ option. The kernel was configured without the .B CONFIG_COREDUMP option. -.PP +.P In addition, a core dump may exclude part of the address space of the process if the .BR madvise (2) .B MADV_DONTDUMP flag was employed. -.PP +.P On systems that employ .BR systemd (1) as the @@ -139,7 +139,7 @@ file (since Linux 2.6 and 2.4.21) can be set to define a template that is used to name core dump files. The template can contain % specifiers which are substituted by the following values when a core file is created: -.PP +.P .RS 4 .PD 0 .TP 4 @@ -211,7 +211,7 @@ Epoch, 1970-01-01 00:00:00 +0000 (UTC). Numeric real UID of dumped process. .PD .RE -.PP +.P A single % at the end of the template is dropped from the core filename, as is the combination of a % followed by any character other than those listed above. @@ -230,7 +230,7 @@ and .I /proc/sys/kernel/core_uses_pid (see below) is nonzero, then .PID will be appended to the core filename. -.PP +.P Paths are interpreted according to the settings that are active for the crashing process. That means the crashing process's mount namespace (see @@ -239,7 +239,7 @@ its current working directory (found via .BR getcwd (2)), and its root directory (see .BR chroot (2)). -.PP +.P Since Linux 2.4, Linux has also provided a more primitive method of controlling the name of the core dump file. @@ -250,7 +250,7 @@ file contains the value 0, then a core dump file is simply named If this file contains a nonzero value, then the core dump file includes the process ID in a name of the form .IR core.PID . -.PP +.P Since Linux 3.6, .\" 9520628e8ceb69fa9a4aee6b57f22675d9e1b709 if @@ -264,7 +264,7 @@ file. If the first character of this file is a pipe symbol (\fB|\fP), then the remainder of the line is interpreted as the command-line for a user-space program (or script) that is to be executed. -.PP +.P Since Linux 5.3.0, .\" commit 315c69261dd3fa12dbc830d4fa00d1fad98d3b03 the pipe template is split on spaces into an argument list @@ -283,7 +283,7 @@ Executable names with multiple spaces in them are not correctly represented in earlier kernels, meaning that the core dump handler needs to use mechanisms to find the executable name. -.PP +.P Instead of being written to a file, the core dump is given as standard input to the program. Note the following points: @@ -354,7 +354,7 @@ files prematurely. This in turn creates the possibility that a misbehaving collecting program can block the reaping of a crashed process by simply never exiting. -.PP +.P Since Linux 2.6.32, .\" commit a293980c2e261bd5b0d2a77340dd04f684caff58 the @@ -364,7 +364,7 @@ The value in this file defines how many concurrent crashing processes may be piped to user-space programs in parallel. If this value is exceeded, then those crashing processes above this value are noted in the kernel log and their core dumps are skipped. -.PP +.P A value of 0 in this file is special. It indicates that unlimited processes may be captured in parallel, but that no waiting will take place (i.e., the collecting @@ -378,13 +378,13 @@ Since Linux 2.6.23, the Linux-specific file can be used to control which memory segments are written to the core dump file in the event that a core dump is performed for the process with the corresponding process ID. -.PP +.P The value in the file is a bit mask of memory mapping types (see .BR mmap (2)). If a bit is set in the mask, then memory mappings of the corresponding type are dumped; otherwise they are not dumped. The bits in this file have the following meanings: -.PP +.P .PD 0 .RS 4 .TP @@ -420,24 +420,24 @@ bit 8 (since Linux 4.4) Dump shared DAX pages. .RE .PD -.PP +.P By default, the following bits are set: 0, 1, 4 (if the .B CONFIG_CORE_DUMP_DEFAULT_ELF_HEADERS kernel configuration option is enabled), and 5. This default can be modified at boot time using the .I coredump_filter boot option. -.PP +.P The value of this file is displayed in hexadecimal. (The default value is thus displayed as 33.) -.PP +.P Memory-mapped I/O pages such as frame buffer are never dumped, and virtual DSO .RB ( vdso (7)) pages are always dumped, regardless of the .I coredump_filter value. -.PP +.P A child process created via .BR fork (2) inherits its parent's @@ -447,18 +447,18 @@ the .I coredump_filter value is preserved across an .BR execve (2). -.PP +.P It can be useful to set .I coredump_filter in the parent shell before running a program, for example: -.PP +.P .in +4n .EX .RB "$" " echo 0x7 > /proc/self/coredump_filter" .RB "$" " ./some_program" .EE .in -.PP +.P This file is provided only if the kernel was built with the .B CONFIG_ELF_CORE configuration option. @@ -477,14 +477,14 @@ feature that allows piping core dumps to a program. One can verify this by checking whether core dumps are being piped to the .BR systemd\-coredump (8) program: -.PP +.P .in +4n .EX $ \fBcat /proc/sys/kernel/core_pattern\fP |/usr/lib/systemd/systemd\-coredump %P %u %g %s %t %c %e .EE .in -.PP +.P In this case, core dumps will be placed in the location configured for .BR systemd\-coredump (8), typically as @@ -495,7 +495,7 @@ One can list the core dumps that have been recorded by .BR systemd\-coredump (8) using .BR coredumpctl (1): -.PP +.P .EX $ \fBcoredumpctl list | tail \-5\fP Wed 2017\-10\-11 22:25:30 CEST 2748 1000 1000 3 present /usr/bin/sleep @@ -504,7 +504,7 @@ Thu 2017\-10\-12 06:30:50 CEST 2767 1000 1000 3 present /usr/bin/sleep Thu 2017\-10\-12 06:37:40 CEST 2918 1000 1000 3 present /usr/bin/cat Thu 2017\-10\-12 08:13:07 CEST 2955 1000 1000 3 present /usr/bin/cat .EE -.PP +.P The information shown for each core dump includes the date and time of the dump, the PID, UID, and GID of the dumping process, the signal number that caused the core dump, @@ -517,24 +517,24 @@ location into a specified file. For example, to extract the core dump for PID 2955 shown above to a file named .I core in the current directory, one could use: -.PP +.P .in +4n .EX $ \fBcoredumpctl dump 2955 \-o core\fP .EE .in -.PP +.P For more extensive details, see the .BR coredumpctl (1) manual page. -.PP +.P To (persistently) disable the .BR systemd (1) mechanism that archives core dumps, restoring to something more like traditional Linux behavior, one can set an override for the .BR systemd (1) mechanism, using something like: -.PP +.P .in +4n .EX # \fBecho "kernel.core_pattern=core.%p" > \e\fP @@ -542,13 +542,13 @@ mechanism, using something like: # \fB/lib/systemd/systemd\-sysctl\fP .EE .in -.PP +.P It is also possible to temporarily (i.e., until the next reboot) change the .I core_pattern setting using a command such as the following (which causes the names of core dump files to include the executable name as well as the number of the signal which triggered the core dump): -.PP +.P .in +4n .EX # \fBsysctl \-w kernel.core_pattern="%e\-%s.core"\fP @@ -560,7 +560,7 @@ The .BR gdb (1) .I gcore command can be used to obtain a core dump of a running process. -.PP +.P In Linux versions up to and including 2.6.27, .\" Changed with commit 6409324b385f3f63a03645b4422e3be67348d922 if a multithreaded process (or, more precisely, a process that @@ -593,7 +593,7 @@ file. The following shell session demonstrates the use of this program (compiled to create an executable named .IR core_pattern_pipe_test ): -.PP +.P .in +4n .EX .RB "$" " cc \-o core_pattern_pipe_test core_pattern_pipe_test.c" diff --git a/upstream/opensuse-tumbleweed/man5/coredump.conf.5 b/upstream/opensuse-tumbleweed/man5/coredump.conf.5 index 0b07e69e..abf6940d 100644 --- a/upstream/opensuse-tumbleweed/man5/coredump.conf.5 +++ b/upstream/opensuse-tumbleweed/man5/coredump.conf.5 @@ -1,5 +1,5 @@ '\" t -.TH "COREDUMP\&.CONF" "5" "" "systemd 254" "coredump.conf" +.TH "COREDUMP\&.CONF" "5" "" "systemd 255" "coredump.conf" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -101,12 +101,16 @@ is set to 0 (see below), the core will be written to either way (under a temporary filename, or even in an unlinked file), \fIStorage=\fR thus only controls whether to leave it there even after it was processed\&. +.sp +Added in version 215\&. .RE .PP \fICompress=\fR .RS 4 Controls compression for external storage\&. Takes a boolean argument, which defaults to "yes"\&. +.sp +Added in version 215\&. .RE .PP \fIProcessSizeMax=\fR @@ -118,6 +122,8 @@ Setting and \fIProcessSizeMax=0\fR disables all coredump handling except for a log entry\&. +.sp +Added in version 215\&. .RE .PP \fIExternalSizeMax=\fR, \fIJournalSizeMax=\fR @@ -129,6 +135,8 @@ may be lowered relative to the default, but not increased\&. Unit suffixes are a .sp \fIExternalSizeMax=infinity\fR sets the core size to unlimited\&. +.sp +Added in version 215\&. .RE .PP \fIMaxUse=\fR, \fIKeepFree=\fR @@ -140,6 +148,8 @@ makes sure that old core dumps are removed as soon as the total disk space taken \fBKeepFree=\fR controls how much disk space to keep free at least (defaults to 15% of the total disk size)\&. Note that the disk space used by core dumps might temporarily exceed these limits while core dumps are processed\&. Note that old core dumps are also removed based on time via \fBsystemd-tmpfiles\fR(8)\&. Set either value to 0 to turn off size\-based cleanup\&. +.sp +Added in version 215\&. .RE .PP The defaults for all values are listed as comments in the template diff --git a/upstream/opensuse-tumbleweed/man5/crontab.5 b/upstream/opensuse-tumbleweed/man5/crontab.5 index 0c6a300a..341c119b 100644 --- a/upstream/opensuse-tumbleweed/man5/crontab.5 +++ b/upstream/opensuse-tumbleweed/man5/crontab.5 @@ -98,7 +98,8 @@ This option is useful if you decide to use /bin/mail instead of aliasing and UUCP usually does not read its mail. If .I MAILFROM is defined (and non-empty), it is used as the envelope sender address, -otherwise, ``root'' is used. +otherwise, the username of the executing user is used. This variable is +also inherited from the crond process environment. .PP (Note: Both .I MAILFROM @@ -297,8 +298,8 @@ crontab entry won\'t cause that entry to be executed every 35 minutes; instead, it will be executed twice every hour, at 0 and 35 minutes past. For more fine-grained control you can do something like this: .nf -* * * * * if [ $(expr \( $(date +\%s) / 60 \) \% 58) = 0 ]; then echo this runs every 58 minutes; fi -0 * * * * if [ $(expr \( $(date +\%s) / 3600 \) \% 23) = 0 ]; then echo this runs every 23 hours on the hour; fi +* * * * * if [ $(expr \\( $(date +%s) / 60 \\) % 58) = 0 ]; then echo this runs every 58 minutes; fi +0 * * * * if [ $(expr \\( $(date +%s) / 3600 \\) % 23) = 0 ]; then echo this runs every 23 hours on the hour; fi .fi Adjust as needed if your .BR date (1) diff --git a/upstream/opensuse-tumbleweed/man5/depmod.d.5 b/upstream/opensuse-tumbleweed/man5/depmod.d.5 index b7907dba..ac6fa8fc 100644 --- a/upstream/opensuse-tumbleweed/man5/depmod.d.5 +++ b/upstream/opensuse-tumbleweed/man5/depmod.d.5 @@ -2,12 +2,12 @@ .\" Title: depmod.d .\" Author: Jon Masters <jcm@jonmasters.org> .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> -.\" Date: 12/06/2023 +.\" Date: 03/05/2024 .\" Manual: depmod.d .\" Source: kmod .\" Language: English .\" -.TH "DEPMOD\&.D" "5" "12/06/2023" "kmod" "depmod.d" +.TH "DEPMOD\&.D" "5" "03/05/2024" "kmod" "depmod.d" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -53,7 +53,7 @@ is simple: one command per line, with blank lines and lines starting with \*(Aq# .PP search \fIsubdirectory\&.\&.\&.\fR .RS 4 -This allows you to specify the order in which /usr/lib/modules (or other configured module location) subdirectories will be processed by +This allows you to specify the order in which /lib/modules (or other configured module location) subdirectories will be processed by \fBdepmod\fR\&. Directories are listed in order, with the highest priority given to the first listed directory and the lowest priority given to the last directory listed\&. The special keyword \fBbuilt\-in\fR refers to the standard module directories installed by the kernel\&. Another special keyword @@ -73,13 +73,13 @@ This command allows you to override which version of a specific module will be u \fBdepmod\fR command\&. It is possible to specify one kernel or all kernels using the * wildcard\&. \fImodulesubdirectory\fR -is the name of the subdirectory under /usr/lib/modules (or other module location) where the target module is installed\&. +is the name of the subdirectory under /lib/modules (or other module location) where the target module is installed\&. .sp For example, it is possible to override the priority of an updated test module called \fBkmod\fR by specifying the following command: "override kmod * extra"\&. This will ensure that any matching module name installed under the \fBextra\fR -subdirectory within /usr/lib/modules (or other module location) will take priority over any likenamed module already provided by the kernel\&. +subdirectory within /lib/modules (or other module location) will take priority over any likenamed module already provided by the kernel\&. .RE .PP external \fIkernelversion\fR \fIabsolutemodulesdirectory\&.\&.\&.\fR diff --git a/upstream/opensuse-tumbleweed/man5/dir_colors.5 b/upstream/opensuse-tumbleweed/man5/dir_colors.5 index ccee2524..4719690c 100644 --- a/upstream/opensuse-tumbleweed/man5/dir_colors.5 +++ b/upstream/opensuse-tumbleweed/man5/dir_colors.5 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: GPL-2.0-or-later .\" -.TH dir_colors 5 2023-07-15 "Linux man-pages 6.05.01" +.TH dir_colors 5 2024-05-02 "Linux man-pages (unreleased)" .SH NAME dir_colors \- configuration file for dircolors(1) .SH DESCRIPTION @@ -13,11 +13,11 @@ uses the environment variable .B LS_COLORS to determine the colors in which the filenames are to be displayed. This environment variable is usually set by a command like -.PP +.P .RS eval \`dircolors some_path/dir_colors\` .RE -.PP +.P found in a system default shell initialization file, like .I /etc/profile or @@ -29,13 +29,13 @@ Usually, the file used here is and can be overridden by a .I .dir_colors file in one's home directory. -.PP +.P This configuration file consists of several statements, one per line. Anything right of a hash mark (#) is treated as a comment, if the hash mark is at the beginning of a line or is preceded by at least one whitespace. Blank lines are ignored. -.PP +.P The .I global section of the file consists of any statement before the first @@ -53,7 +53,7 @@ statements which specify the terminal types (as given by the environment variable) the following declarations apply to. It is always possible to override a global declaration by a subsequent terminal-specific one. -.PP +.P The following statements are recognized; case is insignificant: .TP .B TERM \fIterminal-type\fR @@ -75,7 +75,7 @@ The default is \fIno\fR. .B EIGHTBIT yes|no (Slackware only; ignored by GNU .BR dircolors (1).) -Specifies that eight-bit ISO 8859 characters should be enabled by +Specifies that eight-bit ISO/IEC\~8859 characters should be enabled by default. For compatibility reasons, this can also be specified as 1 for \fIyes\fR or 0 for \fIno\fR. @@ -191,7 +191,7 @@ Synonym: .B LEFTCODE \fIcolor-sequence\fR Specifies the .I "left code" -for non-ISO\ 6429 terminals (see below). +for non-ISO/IEC\~6429 terminals (see below). .IP Synonym: .BR LEFT . @@ -199,7 +199,7 @@ Synonym: .B RIGHTCODE \fIcolor-sequence\fR Specifies the .I "right code" -for non-ISO\ 6429 terminals (see below). +for non-ISO/IEC\~6429 terminals (see below). .IP Synonym: .BR RIGHT . @@ -207,7 +207,7 @@ Synonym: .B ENDCODE \fIcolor-sequence\fR Specifies the .I "end code" -for non-ISO\ 6429 terminals (see below). +for non-ISO/IEC\~6429 terminals (see below). .IP Synonym: .BR END . @@ -227,16 +227,16 @@ for .B emacs backup files. This form should be considered obsolete. -.SS ISO 6429 (ANSI) color sequences -Most color-capable ASCII terminals today use ISO 6429 (ANSI) color sequences, +.SS ISO/IEC\~6429 (ANSI) color sequences +Most color-capable ASCII terminals today use ISO/IEC\~6429 (ANSI) color sequences, and many common terminals without color capability, including .B xterm -and the widely used and cloned DEC VT100, will recognize ISO 6429 color +and the widely used and cloned DEC VT100, will recognize ISO/IEC\~6429 color codes and harmlessly eliminate them from the output or emulate them. .B ls -uses ISO 6429 codes by default, assuming colorization is enabled. -.PP -ISO 6429 color sequences are composed of sequences of numbers +uses ISO/IEC\~6429 codes by default, assuming colorization is enabled. +.P +ISO/IEC\~6429 color sequences are composed of sequences of numbers separated by semicolons. The most common codes are: .RS @@ -264,9 +264,9 @@ l l. 47 for white (or gray) background .TE .RE -.PP +.P Not all commands will work on all systems or display devices. -.PP +.P .B ls uses the following defaults: .TS @@ -283,7 +283,7 @@ BLK 44;37 Block device CHR 44;37 Character device EXEC 35 Executable file .TE -.PP +.P A few terminal programs do not recognize the default properly. If all text gets colorized after you do a directory @@ -303,7 +303,7 @@ To do so, you will have to use the and .B ENDCODE definitions. -.PP +.P When writing out a filename, .B ls generates the following output sequence: @@ -326,7 +326,7 @@ escape codes away from the user). If they are not appropriate for your terminal, you can eliminate them by specifying the respective keyword on a line by itself. -.PP +.P .B NOTE: If the .B ENDCODE @@ -366,7 +366,7 @@ lb l. \e# Hash mark (#) .TE .RE -.PP +.P Note that escapes are necessary to enter a space, backslash, caret, or any control character anywhere in the string, as well as a hash mark as the first character. @@ -377,7 +377,7 @@ System-wide configuration file. .TP .I \[ti]/.dir_colors Per-user configuration file. -.PP +.P This page describes the .B dir_colors file format as used in the fileutils-4.1 package; @@ -387,7 +387,7 @@ The default .B LEFTCODE and .B RIGHTCODE -definitions, which are used by ISO 6429 terminals are: +definitions, which are used by ISO/IEC\~6429 terminals are: .RS .TS lb l. @@ -395,7 +395,7 @@ LEFTCODE \ee[ RIGHTCODE m .TE .RE -.PP +.P The default .B ENDCODE is undefined. diff --git a/upstream/opensuse-tumbleweed/man5/dnssec-trust-anchors.d.5 b/upstream/opensuse-tumbleweed/man5/dnssec-trust-anchors.d.5 index 21829f1b..4671d2f5 100644 --- a/upstream/opensuse-tumbleweed/man5/dnssec-trust-anchors.d.5 +++ b/upstream/opensuse-tumbleweed/man5/dnssec-trust-anchors.d.5 @@ -1,5 +1,5 @@ '\" t -.TH "DNSSEC\-TRUST\-ANCHORS\&.D" "5" "" "systemd 254" "dnssec-trust-anchors.d" +.TH "DNSSEC\-TRUST\-ANCHORS\&.D" "5" "" "systemd 255" "dnssec-trust-anchors.d" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/upstream/opensuse-tumbleweed/man5/elf.5 b/upstream/opensuse-tumbleweed/man5/elf.5 index 6fa4ddf7..f520b1ad 100644 --- a/upstream/opensuse-tumbleweed/man5/elf.5 +++ b/upstream/opensuse-tumbleweed/man5/elf.5 @@ -32,7 +32,7 @@ .\" 2007-10-11, Mike Frysinger <vapier@gentoo.org>, various fixes .\" 2007-12-08, mtk, Converted from mdoc to man macros .\" -.TH ELF 5 2023-05-03 "Linux man-pages 6.05.01" +.TH ELF 5 2024-05-08 "Linux man-pages (unreleased)" .SH NAME elf \- format of Executable and Linking Format (ELF) files .SH SYNOPSIS @@ -47,7 +47,7 @@ defines the format of ELF executable binary files. Amongst these files are normal executable files, relocatable object files, core files, and shared objects. -.PP +.P An executable file using the ELF file format consists of an ELF header, followed by a program header table or a section header table, or both. The ELF header is always at offset zero of the file. @@ -56,7 +56,7 @@ table and the section header table's offset in the file are defined in the ELF header. The two tables describe the rest of the particularities of the file. -.PP +.P .\" Applications which wish to process ELF binary files for their native .\" architecture only should include .\" .I <elf_abi.h> @@ -68,7 +68,7 @@ the file. .\" ELF_xxx". .\" Applications written this way can be compiled on any architecture, .\" regardless of whether the host is 32-bit or 64-bit. -.\" .PP +.\" .P .\" Should an application need to process ELF files of an unknown .\" architecture, then the application needs to explicitly use either .\" "Elf32_xxx" @@ -79,7 +79,7 @@ the file. .\" "ELF32_xxx" .\" or .\" "ELF64_xxx". -.\" .PP +.\" .P This header file describes the above mentioned headers as C structures and also includes structures for dynamic sections, relocation sections and symbol tables. @@ -96,7 +96,7 @@ stands for .I uint32_t or .IR uint64_t ): -.PP +.P .in +4n .EX ElfN_Addr Unsigned program address, uintN_t @@ -112,7 +112,7 @@ ElfN_Xword uint64_t .\" Elf32_Size Unsigned object size .EE .in -.PP +.P (Note: the *BSD terminology is a bit different. There, .I Elf64_Half @@ -125,7 +125,7 @@ is used for .IR uint16_t . In order to avoid confusion these types are replaced by explicit ones in the below.) -.PP +.P All data structures that the file format defines follow the "natural" size and alignment guidelines for the relevant class. @@ -138,7 +138,7 @@ The ELF header is described by the type .I Elf32_Ehdr or .IR Elf64_Ehdr : -.PP +.P .in +4n .EX #define EI_NIDENT 16 @@ -161,7 +161,7 @@ typedef struct { } ElfN_Ehdr; .EE .in -.PP +.P The fields have the following meanings: .\" .\" @@ -632,7 +632,7 @@ The ELF program header is described by the type or .I Elf64_Phdr depending on the architecture: -.PP +.P .in +4n .EX typedef struct { @@ -647,7 +647,7 @@ typedef struct { } Elf32_Phdr; .EE .in -.PP +.P .in +4n .EX typedef struct { @@ -662,7 +662,7 @@ typedef struct { } Elf64_Phdr; .EE .in -.PP +.P The main difference between the 32-bit and the 64-bit program header lies in the location of the .I p_flags @@ -727,7 +727,9 @@ occur only if the program header table is part of the memory image of the program. If it is present, it must precede any loadable segment entry. .TP -.BR PT_LOPROC ", " PT_HIPROC +.B PT_LOPROC +.TQ +.B PT_HIPROC Values in the inclusive range .RB [ PT_LOPROC , .BR PT_HIPROC ] @@ -783,7 +785,7 @@ A readable segment. A text segment commonly has the flags .B PF_X and -.B PF_R . +.BR PF_R . A data segment commonly has .B PF_W and @@ -824,7 +826,7 @@ header table. holds the number of entries the section header table contains. .I e_shentsize holds the size in bytes of each entry. -.PP +.P A section header table index is a subscript into this array. Some section header table indices are reserved: @@ -848,7 +850,9 @@ or otherwise meaningless section reference. .B SHN_LORESERVE This value specifies the lower bound of the range of reserved indices. .TP -.BR SHN_LOPROC ", " SHN_HIPROC +.B SHN_LOPROC +.TQ +.B SHN_HIPROC Values greater in the inclusive range .RB [ SHN_LOPROC , .BR SHN_HIPROC ] @@ -875,9 +879,9 @@ and inclusive. The section header table does not contain entries for the reserved indices. -.PP +.P The section header has the following structure: -.PP +.P .in +4n .EX typedef struct { @@ -894,7 +898,7 @@ typedef struct { } Elf32_Shdr; .EE .in -.PP +.P .in +4n .EX typedef struct { @@ -911,7 +915,7 @@ typedef struct { } Elf64_Shdr; .EE .in -.PP +.P No real differences exist between the 32-bit and 64-bit section headers. .TP .I sh_name @@ -1002,7 +1006,9 @@ object file can also contain a .B SHT_SYMTAB section. .TP -.BR SHT_LOPROC ", " SHT_HIPROC +.B SHT_LOPROC +.TQ +.B SHT_HIPROC Values in the inclusive range .RB [ SHT_LOPROC , .BR SHT_HIPROC ] @@ -1106,7 +1112,7 @@ Some sections hold a table of fixed-sized entries, such as a symbol table. For such a section, this member gives the size in bytes for each entry. This member contains zero if the section does not hold a table of fixed-size entries. -.PP +.P Various sections hold program and control information: .TP .I .bss @@ -1438,12 +1444,12 @@ The first byte, which is index zero, is defined to hold a null byte (\[aq]\e0\[aq]). Similarly, a string table's last byte is defined to hold a null byte, ensuring null termination for all strings. -.PP +.P An object file's symbol table holds information needed to locate and relocate a program's symbolic definitions and references. A symbol table index is a subscript into this array. -.PP +.P .in +4n .EX typedef struct { @@ -1456,7 +1462,7 @@ typedef struct { } Elf32_Sym; .EE .in -.PP +.P .in +4n .EX typedef struct { @@ -1469,7 +1475,7 @@ typedef struct { } Elf64_Sym; .EE .in -.PP +.P The 32-bit and 64-bit versions have the same members, just in a different order. .TP @@ -1520,7 +1526,9 @@ and it precedes the other .B STB_LOCAL symbols of the file, if it is present. .TP -.BR STT_LOPROC ", " STT_HIPROC +.B STT_LOPROC +.TQ +.B STT_HIPROC Values in the inclusive range .RB [ STT_LOPROC , .BR STT_HIPROC ] @@ -1542,7 +1550,9 @@ reference to the same symbol. Weak symbols resemble global symbols, but their definitions have lower precedence. .TP -.BR STB_LOPROC ", " STB_HIPROC +.B STB_LOPROC +.TQ +.B STB_HIPROC Values in the inclusive range .RB [ STB_LOPROC , .BR STB_HIPROC ] @@ -1552,18 +1562,23 @@ are reserved for processor-specific semantics. There are macros for packing and unpacking the binding and type fields: .RS .TP -.BR ELF32_ST_BIND( \fIinfo\fP ) ", " ELF64_ST_BIND( \fIinfo\fP ) +.BI ELF32_ST_BIND( info ) +.TQ +.BI ELF64_ST_BIND( info ) Extract a binding from an .I st_info value. .TP -.BR ELF32_ST_TYPE( \fIinfo ) ", " ELF64_ST_TYPE( \fIinfo\fP ) +.BI ELF32_ST_TYPE( info ) +.TQ +.BI ELF64_ST_TYPE( info ) Extract a type from an .I st_info value. .TP -.BR ELF32_ST_INFO( \fIbind\fP ", " \fItype\fP ) ", " \ -ELF64_ST_INFO( \fIbind\fP ", " \fItype\fP ) +.BI ELF32_ST_INFO( bind ", " type ) +.TQ +.BI ELF64_ST_INFO( bind ", " type ) Convert a binding and a type into an .I st_info value. @@ -1592,9 +1607,9 @@ references in the local module always resolve to the local symbol Symbol is available to other modules, but references in the local module always resolve to the local symbol. .PD -.PP +.P There are macros for extracting the visibility type: -.PP +.P .BR ELF32_ST_VISIBILITY (other) or .BR ELF64_ST_VISIBILITY (other) @@ -1615,9 +1630,9 @@ describes how to modify their section contents, thus allowing executable and shared object files to hold the right information for a process's program image. Relocation entries are these data. -.PP +.P Relocation structures that do not need an addend: -.PP +.P .in +4n .EX typedef struct { @@ -1626,7 +1641,7 @@ typedef struct { } Elf32_Rel; .EE .in -.PP +.P .in +4n .EX typedef struct { @@ -1635,9 +1650,9 @@ typedef struct { } Elf64_Rel; .EE .in -.PP +.P Relocation structures that need an addend: -.PP +.P .in +4n .EX typedef struct { @@ -1647,7 +1662,7 @@ typedef struct { } Elf32_Rela; .EE .in -.PP +.P .in +4n .EX typedef struct { @@ -1695,7 +1710,7 @@ The member controls the interpretation of .IR d_un . -.PP +.P .in +4n .EX typedef struct { @@ -1708,7 +1723,7 @@ typedef struct { extern Elf32_Dyn _DYNAMIC[]; .EE .in -.PP +.P .in +4n .EX typedef struct { @@ -1772,7 +1787,7 @@ Address of the termination function String table offset to name of shared object .TP .B DT_RPATH -String table offset to library search path (deprecated) +String table offset to search path for direct and indirect library dependencies .TP .B DT_SYMBOLIC Alert linker to search this shared object before the executable for symbols @@ -1804,9 +1819,11 @@ Instruct dynamic linker to process all relocations before transferring control to the executable .TP .B DT_RUNPATH -String table offset to library search path +String table offset to search path for direct library dependencies .TP -.BR DT_LOPROC ", " DT_HIPROC +.B DT_LOPROC +.TQ +.B DT_HIPROC Values in the inclusive range .RB [ DT_LOPROC , .BR DT_HIPROC ] @@ -1855,7 +1872,7 @@ but many projects define their own set of extensions. For example, the GNU tool chain uses ELF notes to pass information from the linker to the C library. -.PP +.P Note sections contain a series of notes (see the .I struct definitions below). @@ -1863,10 +1880,10 @@ Each note is followed by the name field (whose length is defined in \fIn_namesz\fR) and then by the descriptor field (whose length is defined in \fIn_descsz\fR) and whose starting address has a 4 byte alignment. Neither field is defined in the note struct due to their arbitrary lengths. -.PP +.P An example for parsing out two consecutive notes should clarify their layout in memory: -.PP +.P .in +4n .EX void *memory, *name, *desc; @@ -1890,7 +1907,7 @@ next_note = memory + sizeof(*note) + ALIGN_UP(note\->n_descsz, 4); .EE .in -.PP +.P Keep in mind that the interpretation of .I n_type depends on the namespace defined by the @@ -1902,7 +1919,7 @@ field is not set (e.g., is 0), then there are two sets of notes: one for core files and one for all other ELF types. If the namespace is unknown, then tools will usually fallback to these sets of notes as well. -.PP +.P .in +4n .EX typedef struct { @@ -1912,7 +1929,7 @@ typedef struct { } Elf32_Nhdr; .EE .in -.PP +.P .in +4n .EX typedef struct { @@ -2143,7 +2160,7 @@ Architecture information. ELF first appeared in System V. The ELF format is an adopted standard. -.PP +.P The extensions for .IR e_phnum , .IR e_shnum , @@ -2178,19 +2195,19 @@ look under SEE ALSO. .BR dl_iterate_phdr (3), .BR core (5), .BR ld.so (8) -.PP +.P Hewlett-Packard, .IR "Elf-64 Object File Format" . -.PP +.P Santa Cruz Operation, .IR "System V Application Binary Interface" . -.PP +.P UNIX System Laboratories, "Object Files", .IR "Executable and Linking Format (ELF)" . -.PP +.P Sun Microsystems, .IR "Linker and Libraries Guide" . -.PP +.P AMD64 ABI Draft, .IR "System V Application Binary Interface AMD64 Architecture Processor Supplement" . diff --git a/upstream/opensuse-tumbleweed/man5/environment.d.5 b/upstream/opensuse-tumbleweed/man5/environment.d.5 index 92c2ecc7..596f42d2 100644 --- a/upstream/opensuse-tumbleweed/man5/environment.d.5 +++ b/upstream/opensuse-tumbleweed/man5/environment.d.5 @@ -1,5 +1,5 @@ '\" t -.TH "ENVIRONMENT\&.D" "5" "" "systemd 254" "environment.d" +.TH "ENVIRONMENT\&.D" "5" "" "systemd 255" "environment.d" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/upstream/opensuse-tumbleweed/man5/erofs.5 b/upstream/opensuse-tumbleweed/man5/erofs.5 index 97edfdcd..12113332 100644 --- a/upstream/opensuse-tumbleweed/man5/erofs.5 +++ b/upstream/opensuse-tumbleweed/man5/erofs.5 @@ -2,14 +2,14 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH erofs 5 2023-04-29 "Linux man-pages 6.05.01" +.TH erofs 5 2024-05-02 "Linux man-pages (unreleased)" .SH NAME erofs \- the Enhanced Read-Only File System .SH DESCRIPTION .B erofs is a create-once read-only filesystem, with support for compression and a multi-device backing store. -.PP +.P There are two inode formats: .IP \[bu] 3 32-byte compact with 16-bit UID/GID, @@ -92,6 +92,6 @@ of some of the parameters above. .BR mkfs.erofs (1), .BR fsck.erofs (1), .BR dump.erofs (1) -.PP +.P .I Documentation/filesystems/erofs.txt in the Linux source. diff --git a/upstream/opensuse-tumbleweed/man5/filesystems.5 b/upstream/opensuse-tumbleweed/man5/filesystems.5 index cc766992..42b17aee 100644 --- a/upstream/opensuse-tumbleweed/man5/filesystems.5 +++ b/upstream/opensuse-tumbleweed/man5/filesystems.5 @@ -4,7 +4,7 @@ .\" .\" 2007-12-14 mtk Added Reiserfs, XFS, JFS. .\" -.TH filesystems 5 2023-04-10 "Linux man-pages 6.05.01" +.TH filesystems 5 2024-05-02 "Linux man-pages (unreleased)" .nh .SH NAME filesystems \- Linux filesystem types: ext, ext2, ext3, ext4, hpfs, iso9660, @@ -31,17 +31,17 @@ that enables enumeration of the currently available filesystem types regardless of .I /proc availability and/or sanity. -.PP +.P If you need a currently unsupported filesystem, insert the corresponding kernel module or recompile the kernel. -.PP +.P In order to use a filesystem, you have to .I mount it; see .BR mount (2) and .BR mount (8). -.PP +.P The following list provides a short description of the available or historically available filesystems in the Linux kernel. @@ -99,11 +99,11 @@ This filesystem is read-only under Linux due to the lack of available documentation. .TP .B iso9660 -is a CD-ROM filesystem type conforming to the ISO 9660 standard. +is a CD-ROM filesystem type conforming to the ISO/IEC\~9660 standard. .RS .TP .B "High Sierra" -Linux supports High Sierra, the precursor to the ISO 9660 standard for +Linux supports High Sierra, the precursor to the ISO/IEC\~9660 standard for CD-ROM filesystems. It is automatically recognized within the .B iso9660 diff --git a/upstream/opensuse-tumbleweed/man5/ftpusers.5 b/upstream/opensuse-tumbleweed/man5/ftpusers.5 index 9af5c521..38d57b0d 100644 --- a/upstream/opensuse-tumbleweed/man5/ftpusers.5 +++ b/upstream/opensuse-tumbleweed/man5/ftpusers.5 @@ -2,7 +2,7 @@ .\" .\" SPDX-License-Identifier: GPL-2.0-or-later .\" -.TH ftpusers 5 2022-10-30 "Linux man-pages 6.05.01" +.TH ftpusers 5 2024-05-02 "Linux man-pages (unreleased)" .SH NAME ftpusers \- list of users that may not log in via the FTP daemon .SH DESCRIPTION @@ -13,14 +13,14 @@ File Transfer Protocol (FTP) server daemon. This file is used not merely for system administration purposes but also for improving security within a TCP/IP networked environment. -.PP +.P The .B ftpusers file will typically contain a list of the users that either have no business using ftp or have too many privileges to be allowed to log in through the FTP server daemon. Such users usually include root, daemon, bin, uucp, and news. -.PP +.P If your FTP server daemon doesn't use .BR ftpusers , then it is suggested that you read its documentation to find out how to diff --git a/upstream/opensuse-tumbleweed/man5/gai.conf.5 b/upstream/opensuse-tumbleweed/man5/gai.conf.5 index bba44807..a69e845e 100644 --- a/upstream/opensuse-tumbleweed/man5/gai.conf.5 +++ b/upstream/opensuse-tumbleweed/man5/gai.conf.5 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: GPL-2.0-only .\" -.TH gai.conf 5 2023-02-05 "Linux man-pages 6.05.01" +.TH gai.conf 5 2024-05-02 "Linux man-pages (unreleased)" .SH NAME gai.conf \- getaddrinfo(3) configuration file .SH DESCRIPTION @@ -20,11 +20,11 @@ to dynamically change the sorting. For the glibc implementation, this can be achieved with the .I /etc/gai.conf file. -.PP +.P Each line in the configuration file consists of a keyword and its parameters. White spaces in any place are ignored. Lines starting with \[aq]#\[aq] are comments and are ignored. -.PP +.P The keywords currently recognized are: .TP \fBlabel\fR \fInetmask\fR \fIprecedence\fR @@ -66,7 +66,7 @@ file is supported since glibc 2.5. .SH EXAMPLES The default table according to RFC\ 3484 would be specified with the following configuration file: -.PP +.P .in +4n .EX label ::1/128 0 diff --git a/upstream/opensuse-tumbleweed/man5/gdbinit.5 b/upstream/opensuse-tumbleweed/man5/gdbinit.5 index 493425d0..a3dbdbd5 100644 --- a/upstream/opensuse-tumbleweed/man5/gdbinit.5 +++ b/upstream/opensuse-tumbleweed/man5/gdbinit.5 @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "GDBINIT 5" -.TH GDBINIT 5 2024-02-27 gdb- "GNU Development Tools" +.TH GDBINIT 5 2024-04-24 gdb- "GNU Development Tools" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/opensuse-tumbleweed/man5/group.5 b/upstream/opensuse-tumbleweed/man5/group.5 index d39f8434..fdf79e03 100644 --- a/upstream/opensuse-tumbleweed/man5/group.5 +++ b/upstream/opensuse-tumbleweed/man5/group.5 @@ -4,7 +4,7 @@ .\" SPDX-License-Identifier: GPL-2.0-or-later .\" .\" Modified Sat Jul 24 17:06:03 1993 by Rik Faith (faith@cs.unc.edu) -.TH group 5 2022-10-30 "Linux man-pages 6.05.01" +.TH group 5 2024-05-02 "Linux man-pages (unreleased)" .SH NAME group \- user group file .SH DESCRIPTION @@ -12,13 +12,13 @@ The .I /etc/group file is a text file that defines the groups on the system. There is one entry per line, with the following format: -.PP +.P .in +4n .EX group_name:password:GID:user_list .EE .in -.PP +.P The fields are as follows: .TP .I group_name diff --git a/upstream/opensuse-tumbleweed/man5/homed.conf.5 b/upstream/opensuse-tumbleweed/man5/homed.conf.5 index 8a52f0b0..5e8f02e8 100644 --- a/upstream/opensuse-tumbleweed/man5/homed.conf.5 +++ b/upstream/opensuse-tumbleweed/man5/homed.conf.5 @@ -1,5 +1,5 @@ '\" t -.TH "HOMED\&.CONF" "5" "" "systemd 254" "homed.conf" +.TH "HOMED\&.CONF" "5" "" "systemd 255" "homed.conf" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -90,6 +90,8 @@ is on a btrfs file system, and otherwise\&. Note that the storage selected on the \fBhomectl\fR command line always takes precedence\&. +.sp +Added in version 246\&. .RE .PP \fIDefaultFileSystemType=\fR @@ -104,6 +106,8 @@ or "btrfs"\&. This setting has no effect if a different storage mechanism is used\&. The file system type selected on the \fBhomectl\fR command line always takes precedence\&. +.sp +Added in version 246\&. .RE .SH "SEE ALSO" .PP diff --git a/upstream/opensuse-tumbleweed/man5/host.conf.5 b/upstream/opensuse-tumbleweed/man5/host.conf.5 index 8f645512..822ad491 100644 --- a/upstream/opensuse-tumbleweed/man5/host.conf.5 +++ b/upstream/opensuse-tumbleweed/man5/host.conf.5 @@ -4,7 +4,7 @@ .\" SPDX-License-Identifier: GPL-2.0-or-later .\" .\" 2003-08-23 Martin Schulze <joey@infodrom.org> Updated according to glibc 2.3.2 -.TH host.conf 5 2023-03-08 "Linux man-pages 6.05.01" +.TH host.conf 5 2024-05-02 "Linux man-pages (unreleased)" .SH NAME host.conf \- resolver configuration file .SH DESCRIPTION @@ -121,7 +121,7 @@ Line comments can appear anywhere and not only at the beginning of a line. The .BR nsswitch.conf (5) file is the modern way of controlling the order of host lookups. -.PP +.P In glibc 2.4 and earlier, the following keyword is recognized: .TP .I order @@ -134,7 +134,7 @@ Valid methods are Overrides the .I order command. -.PP +.P .\" commit 7d68cdaa4f748e87ee921f587ee2d483db624b3d Since glibc 2.0.7, and up through glibc 2.24, the following keywords and environment variable diff --git a/upstream/opensuse-tumbleweed/man5/hostname.5 b/upstream/opensuse-tumbleweed/man5/hostname.5 index 732b3ecc..ff5139a9 100644 --- a/upstream/opensuse-tumbleweed/man5/hostname.5 +++ b/upstream/opensuse-tumbleweed/man5/hostname.5 @@ -1,5 +1,5 @@ '\" t -.TH "HOSTNAME" "5" "" "systemd 254" "hostname" +.TH "HOSTNAME" "5" "" "systemd 255" "hostname" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -55,7 +55,7 @@ and the associated tools will obtain the hostname in the following ways: .sp -1 .IP \(bu 2.3 .\} -If the kernel commandline parameter +If the kernel command line parameter \fIsystemd\&.hostname=\fR specifies a valid hostname, \fBsystemd\fR(1) diff --git a/upstream/opensuse-tumbleweed/man5/hosts.5 b/upstream/opensuse-tumbleweed/man5/hosts.5 index 7e178149..bab44554 100644 --- a/upstream/opensuse-tumbleweed/man5/hosts.5 +++ b/upstream/opensuse-tumbleweed/man5/hosts.5 @@ -5,7 +5,7 @@ .\" Minor polishing, aeb .\" Modified, 2002-06-16, Mike Coleman .\" -.TH hosts 5 2023-05-03 "Linux man-pages 6.05.01" +.TH hosts 5 2024-05-02 "Linux man-pages (unreleased)" .SH NAME hosts \- static table lookup for hostnames .SH SYNOPSIS @@ -21,10 +21,10 @@ with hostnames, one line per IP address. For each host a single line should be present with the following information: .RS -.PP +.P IP_address canonical_hostname [aliases...] .RE -.PP +.P The IP address can conform to either IPv4 or IPv6. Fields of the entry are separated by any number of blanks and/or tab characters. @@ -39,7 +39,7 @@ shorter hostnames, or generic hostnames (for example, .IR localhost ). If required, a host may have two separate entries in this file; one for each version of the Internet Protocol (IPv4 and IPv6). -.PP +.P The Berkeley Internet Name Domain (BIND) Server implements the Internet name server for UNIX systems. It augments or replaces the @@ -47,7 +47,7 @@ It augments or replaces the file or hostname lookup, and frees a host from relying on .I /etc/hosts being up to date and complete. -.PP +.P In modern systems, even though the host table has been superseded by DNS, it is still widely used for: .TP @@ -77,7 +77,7 @@ except in cases where the file is cached by applications. .SS Historical notes RFC\ 952 gave the original format for the host table, though it has since changed. -.PP +.P Before the advent of DNS, the host table was the only way of resolving hostnames on the fledgling Internet. Indeed, this file could be @@ -115,7 +115,7 @@ ff02::2 ip6\-allrouters .BR resolver (5), .BR hostname (7), .BR named (8) -.PP +.P Internet RFC\ 952 .\" .SH AUTHOR .\" This manual page was written by Manoj Srivastava <srivasta@debian.org>, diff --git a/upstream/opensuse-tumbleweed/man5/hosts.equiv.5 b/upstream/opensuse-tumbleweed/man5/hosts.equiv.5 index a9521da3..718ec15b 100644 --- a/upstream/opensuse-tumbleweed/man5/hosts.equiv.5 +++ b/upstream/opensuse-tumbleweed/man5/hosts.equiv.5 @@ -1,7 +1,7 @@ .\" Copyright (c) 1995 Peter Tobias <tobias@et-inf.fho-emden.de> .\" .\" SPDX-License-Identifier: GPL-1.0-or-later -.TH hosts.equiv 5 2023-02-05 "Linux man-pages 6.05.01" +.TH hosts.equiv 5 2024-05-02 "Linux man-pages (unreleased)" .SH NAME hosts.equiv \- list of hosts and users that are granted "trusted" .B r @@ -17,11 +17,11 @@ or .BR rcp ) without supplying a password. -.PP +.P The file uses the following format: .TP \fI+|[\-]hostname|+@netgroup|\-@netgroup\fP \fI[+|[\-]username|+@netgroup|\-@netgroup]\fP -.PP +.P The .I hostname is the name of a host which is logically equivalent @@ -39,7 +39,7 @@ Users from that host must always supply additional credentials, including possibly a password. For security reasons you should always use the FQDN of the hostname and not the short hostname. -.PP +.P The .I username entry grants a specific user access to all user @@ -57,9 +57,9 @@ with a minus (\-) sign. This says that the user is not trusted no matter what other entries for that host exist. -.PP +.P Netgroups can be specified by preceding the netgroup by an @ sign. -.PP +.P Be extremely careful when using the plus (+) sign. A simple typographical error could result in a standalone plus sign. @@ -72,7 +72,7 @@ Some systems will honor the contents of this file only when it has owner root and no write permission for anybody else. Some exceptionally paranoid systems even require that there be no other hard links to the file. -.PP +.P Modern systems use the Pluggable Authentication Modules library (PAM). With PAM a standalone plus sign is considered a wildcard character which means "any host" only when the word @@ -86,124 +86,124 @@ Below are some example or .I \[ti]/.rhosts files. -.PP +.P Allow any user to log in from any host: -.PP +.P .in +4n .EX + .EE .in -.PP +.P Allow any user from .I host with a matching local account to log in: -.PP +.P .in +4n .EX host .EE .in -.PP +.P Note: the use of .I +host is never a valid syntax, including attempting to specify that any user from the host is allowed. -.PP +.P Allow any user from .I host to log in: -.PP +.P .in +4n .EX host + .EE .in -.PP +.P Note: this is distinct from the previous example since it does not require a matching local account. -.PP +.P Allow .I user from .I host to log in as any non-root user: -.PP +.P .in +4n .EX host user .EE .in -.PP +.P Allow all users with matching local accounts from .I host to log in except for .IR baduser : -.PP +.P .in +4n .EX host \-baduser host .EE .in -.PP +.P Deny all users from .IR host : -.PP +.P .in +4n .EX \-host .EE .in -.PP +.P Note: the use of .I "\-host\ \-user" is never a valid syntax, including attempting to specify that a particular user from the host is not trusted. -.PP +.P Allow all users with matching local accounts on all hosts in a .IR netgroup : -.PP +.P .in +4n .EX +@netgroup .EE .in -.PP +.P Disallow all users on all hosts in a .IR netgroup : -.PP +.P .in +4n .EX \-@netgroup .EE .in -.PP +.P Allow all users in a .I netgroup to log in from .I host as any non-root user: -.PP +.P .in +4n .EX host +@netgroup .EE .in -.PP +.P Allow all users with matching local accounts on all hosts in a .I netgroup except .IR baduser : -.PP +.P .in +4n .EX +@netgroup \-baduser +@netgroup .EE .in -.PP +.P Note: the deny statements must always precede the allow statements because the file is processed sequentially until the first matching rule is found. .SH SEE ALSO diff --git a/upstream/opensuse-tumbleweed/man5/icewm-env.5 b/upstream/opensuse-tumbleweed/man5/icewm-env.5 index d9aeb44a..d2e27cd0 100644 --- a/upstream/opensuse-tumbleweed/man5/icewm-env.5 +++ b/upstream/opensuse-tumbleweed/man5/icewm-env.5 @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "ICEWM-ENV 5" -.TH ICEWM-ENV 5 2023-12-28 "icewm 3.4.5" "Standards, Environments and Macros" +.TH ICEWM-ENV 5 2024-05-20 "icewm 3.5.0" "Standards, Environments and Macros" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/opensuse-tumbleweed/man5/icewm-focus_mode.5 b/upstream/opensuse-tumbleweed/man5/icewm-focus_mode.5 index 08551870..5848997b 100644 --- a/upstream/opensuse-tumbleweed/man5/icewm-focus_mode.5 +++ b/upstream/opensuse-tumbleweed/man5/icewm-focus_mode.5 @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "ICEWM-FOCUS_MODE 5" -.TH ICEWM-FOCUS_MODE 5 2023-12-28 "icewm 3.4.5" "Standards, Environments and Macros" +.TH ICEWM-FOCUS_MODE 5 2024-05-20 "icewm 3.5.0" "Standards, Environments and Macros" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/opensuse-tumbleweed/man5/icewm-keys.5 b/upstream/opensuse-tumbleweed/man5/icewm-keys.5 index d6e959b7..a60b59c2 100644 --- a/upstream/opensuse-tumbleweed/man5/icewm-keys.5 +++ b/upstream/opensuse-tumbleweed/man5/icewm-keys.5 @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "ICEWM-KEYS 5" -.TH ICEWM-KEYS 5 2023-12-28 "icewm 3.4.5" "Standards, Environments and Macros" +.TH ICEWM-KEYS 5 2024-05-20 "icewm 3.5.0" "Standards, Environments and Macros" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -102,7 +102,10 @@ following four ways, which are identical: \& key "Ctrl++" xterm .Ve .PP -To bind the mouse use \f(CW\*(C`Pointer_Button1\*(C'\fR for button 1, and so on. +To bind the mouse, use \f(CW\*(C`Pointer_Button1\*(C'\fR for button 1, and so on. +This only works when the mouse is over the root window. +See below for examples. +.PP The command \f(CW\*(C`icesh keys\*(C'\fR instructs icewm to reload this file. .SS FORMAT .IX Subsection "FORMAT" diff --git a/upstream/opensuse-tumbleweed/man5/icewm-menu.5 b/upstream/opensuse-tumbleweed/man5/icewm-menu.5 index c523891c..eb0c925c 100644 --- a/upstream/opensuse-tumbleweed/man5/icewm-menu.5 +++ b/upstream/opensuse-tumbleweed/man5/icewm-menu.5 @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "ICEWM-MENU 5" -.TH ICEWM-MENU 5 2023-12-28 "icewm 3.4.5" "Standards, Environments and Macros" +.TH ICEWM-MENU 5 2024-05-20 "icewm 3.5.0" "Standards, Environments and Macros" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/opensuse-tumbleweed/man5/icewm-preferences.5 b/upstream/opensuse-tumbleweed/man5/icewm-preferences.5 index 94bdd49e..0f55d182 100644 --- a/upstream/opensuse-tumbleweed/man5/icewm-preferences.5 +++ b/upstream/opensuse-tumbleweed/man5/icewm-preferences.5 @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "ICEWM-PREFERENCES 5" -.TH ICEWM-PREFERENCES 5 2023-12-28 "icewm 3.4.5" "Standards, Environments and Macros" +.TH ICEWM-PREFERENCES 5 2024-05-20 "icewm 3.5.0" "Standards, Environments and Macros" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/opensuse-tumbleweed/man5/icewm-prefoverride.5 b/upstream/opensuse-tumbleweed/man5/icewm-prefoverride.5 index ff68c344..eb1fbe00 100644 --- a/upstream/opensuse-tumbleweed/man5/icewm-prefoverride.5 +++ b/upstream/opensuse-tumbleweed/man5/icewm-prefoverride.5 @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "ICEWM-PREFOVERRIDE 5" -.TH ICEWM-PREFOVERRIDE 5 2023-12-28 "icewm 3.4.5" "Standards, Environments and Macros" +.TH ICEWM-PREFOVERRIDE 5 2024-05-20 "icewm 3.5.0" "Standards, Environments and Macros" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/opensuse-tumbleweed/man5/icewm-programs.5 b/upstream/opensuse-tumbleweed/man5/icewm-programs.5 index fa8733fa..f76c1910 100644 --- a/upstream/opensuse-tumbleweed/man5/icewm-programs.5 +++ b/upstream/opensuse-tumbleweed/man5/icewm-programs.5 @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "ICEWM-PROGRAMS 5" -.TH ICEWM-PROGRAMS 5 2023-12-28 "icewm 3.4.5" "Standards, Environments and Macros" +.TH ICEWM-PROGRAMS 5 2024-05-20 "icewm 3.5.0" "Standards, Environments and Macros" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/opensuse-tumbleweed/man5/icewm-shutdown.5 b/upstream/opensuse-tumbleweed/man5/icewm-shutdown.5 index d8029628..534772b8 100644 --- a/upstream/opensuse-tumbleweed/man5/icewm-shutdown.5 +++ b/upstream/opensuse-tumbleweed/man5/icewm-shutdown.5 @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "ICEWM-SHUTDOWN 5" -.TH ICEWM-SHUTDOWN 5 2023-12-28 "icewm 3.4.5" "Standards, Environments and Macros" +.TH ICEWM-SHUTDOWN 5 2024-05-20 "icewm 3.5.0" "Standards, Environments and Macros" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/opensuse-tumbleweed/man5/icewm-startup.5 b/upstream/opensuse-tumbleweed/man5/icewm-startup.5 index 2c797cfe..22044517 100644 --- a/upstream/opensuse-tumbleweed/man5/icewm-startup.5 +++ b/upstream/opensuse-tumbleweed/man5/icewm-startup.5 @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "ICEWM-STARTUP 5" -.TH ICEWM-STARTUP 5 2023-12-28 "icewm 3.4.5" "Standards, Environments and Macros" +.TH ICEWM-STARTUP 5 2024-05-20 "icewm 3.5.0" "Standards, Environments and Macros" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/opensuse-tumbleweed/man5/icewm-theme.5 b/upstream/opensuse-tumbleweed/man5/icewm-theme.5 index 138a6d6a..6775255c 100644 --- a/upstream/opensuse-tumbleweed/man5/icewm-theme.5 +++ b/upstream/opensuse-tumbleweed/man5/icewm-theme.5 @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "ICEWM-THEME 5" -.TH ICEWM-THEME 5 2023-12-28 "icewm 3.4.5" "Standards, Environments and Macros" +.TH ICEWM-THEME 5 2024-05-20 "icewm 3.5.0" "Standards, Environments and Macros" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/opensuse-tumbleweed/man5/icewm-toolbar.5 b/upstream/opensuse-tumbleweed/man5/icewm-toolbar.5 index afea02bd..7ea7e4e9 100644 --- a/upstream/opensuse-tumbleweed/man5/icewm-toolbar.5 +++ b/upstream/opensuse-tumbleweed/man5/icewm-toolbar.5 @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "ICEWM-TOOLBAR 5" -.TH ICEWM-TOOLBAR 5 2023-12-28 "icewm 3.4.5" "Standards, Environments and Macros" +.TH ICEWM-TOOLBAR 5 2024-05-20 "icewm 3.5.0" "Standards, Environments and Macros" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/opensuse-tumbleweed/man5/icewm-winoptions.5 b/upstream/opensuse-tumbleweed/man5/icewm-winoptions.5 index ba04a452..7a257ecb 100644 --- a/upstream/opensuse-tumbleweed/man5/icewm-winoptions.5 +++ b/upstream/opensuse-tumbleweed/man5/icewm-winoptions.5 @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "ICEWM-WINOPTIONS 5" -.TH ICEWM-WINOPTIONS 5 2023-12-28 "icewm 3.4.5" "Standards, Environments and Macros" +.TH ICEWM-WINOPTIONS 5 2024-05-20 "icewm 3.5.0" "Standards, Environments and Macros" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/opensuse-tumbleweed/man5/intro.5 b/upstream/opensuse-tumbleweed/man5/intro.5 index d30e194c..71ec35e2 100644 --- a/upstream/opensuse-tumbleweed/man5/intro.5 +++ b/upstream/opensuse-tumbleweed/man5/intro.5 @@ -5,13 +5,13 @@ .\" .\" Modified Sat Jul 24 17:06:52 1993 by Rik Faith (faith@cs.unc.edu) .\" Modified Sun Jan 14 00:34:09 1996 by Andries Brouwer (aeb@cwi.nl) -.TH intro 5 2022-10-30 "Linux man-pages 6.05.01" +.TH intro 5 2024-05-02 "Linux man-pages (unreleased)" .SH NAME intro \- introduction to file formats and filesystems .SH DESCRIPTION Section 5 of the manual describes various file formats, as well as the corresponding C structures, if any. -.PP +.P In addition, this section contains a number of pages that document various filesystems. .SH NOTES diff --git a/upstream/opensuse-tumbleweed/man5/issue.5 b/upstream/opensuse-tumbleweed/man5/issue.5 index 98dfe68e..019e5f72 100644 --- a/upstream/opensuse-tumbleweed/man5/issue.5 +++ b/upstream/opensuse-tumbleweed/man5/issue.5 @@ -5,7 +5,7 @@ .\" .\" Modified Sun Jul 25 11:06:22 1993 by Rik Faith <faith@cs.unc.edu> .\" Modified Mon Oct 21 17:47:19 EDT 1996 by Eric S. Raymond <esr@thyrsus.com> -.TH issue 5 2022-10-30 "Linux man-pages 6.05.01" +.TH issue 5 2024-05-02 "Linux man-pages (unreleased)" .SH NAME issue \- prelogin message and identification file .SH DESCRIPTION diff --git a/upstream/opensuse-tumbleweed/man5/journal-remote.conf.5 b/upstream/opensuse-tumbleweed/man5/journal-remote.conf.5 index 5708a49c..39b2ab34 100644 --- a/upstream/opensuse-tumbleweed/man5/journal-remote.conf.5 +++ b/upstream/opensuse-tumbleweed/man5/journal-remote.conf.5 @@ -1,5 +1,5 @@ '\" t -.TH "JOURNAL\-REMOTE\&.CONF" "5" "" "systemd 254" "journal-remote.conf" +.TH "JOURNAL\-REMOTE\&.CONF" "5" "" "systemd 255" "journal-remote.conf" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -75,6 +75,8 @@ All options are configured in the [Remote] section: \fISeal=\fR .RS 4 Periodically sign the data in the journal using Forward Secure Sealing\&. +.sp +Added in version 229\&. .RE .PP \fISplitMode=\fR @@ -83,21 +85,29 @@ One of "host" or "none"\&. +.sp +Added in version 220\&. .RE .PP \fIServerKeyFile=\fR .RS 4 SSL key in PEM format\&. +.sp +Added in version 220\&. .RE .PP \fIServerCertificateFile=\fR .RS 4 SSL certificate in PEM format\&. +.sp +Added in version 220\&. .RE .PP \fITrustedCertificateFile=\fR .RS 4 SSL CA certificate\&. +.sp +Added in version 220\&. .RE .PP \fIMaxUse=\fR, \fIKeepFree=\fR, \fIMaxFileSize=\fR, \fIMaxFiles=\fR @@ -124,6 +134,8 @@ will respect both limits and use the smaller of the two values\&. .sp \fIMaxFiles=\fR controls how many individual journal files to keep at most\&. Note that only archived files are deleted to reduce the number of files until this limit is reached; active files will stay around\&. This means that, in effect, there might still be more journal files around in total than this limit after a vacuuming operation is complete\&. +.sp +Added in version 253\&. .RE .SH "SEE ALSO" .PP diff --git a/upstream/opensuse-tumbleweed/man5/journal-upload.conf.5 b/upstream/opensuse-tumbleweed/man5/journal-upload.conf.5 index 46d33e65..09f47e5f 100644 --- a/upstream/opensuse-tumbleweed/man5/journal-upload.conf.5 +++ b/upstream/opensuse-tumbleweed/man5/journal-upload.conf.5 @@ -1,5 +1,5 @@ '\" t -.TH "JOURNAL\-UPLOAD\&.CONF" "5" "" "systemd 254" "journal-upload.conf" +.TH "JOURNAL\-UPLOAD\&.CONF" "5" "" "systemd 255" "journal-upload.conf" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -79,21 +79,29 @@ The URL to upload the journal entries to\&. See the description of option in \fBsystemd-journal-upload\fR(8) for the description of possible values\&. There is no default value, so either this option or the command\-line option must be always present to make an upload\&. +.sp +Added in version 232\&. .RE .PP \fIServerKeyFile=\fR .RS 4 SSL key in PEM format\&. +.sp +Added in version 232\&. .RE .PP \fIServerCertificateFile=\fR .RS 4 SSL CA certificate in PEM format\&. +.sp +Added in version 232\&. .RE .PP \fITrustedCertificateFile=\fR .RS 4 SSL CA certificate\&. +.sp +Added in version 232\&. .RE .PP \fINetworkTimeoutSec=\fR @@ -102,6 +110,8 @@ When network connectivity to the server is lost, this option configures the time \fBsystemd\-journal\-upload\fR exits\&. Takes a value in seconds (or in other time units if suffixed with "ms", "min", "h", etc)\&. For details, see \fBsystemd.time\fR(5)\&. +.sp +Added in version 249\&. .RE .SH "SEE ALSO" .PP diff --git a/upstream/opensuse-tumbleweed/man5/journald.conf.5 b/upstream/opensuse-tumbleweed/man5/journald.conf.5 index dc754063..0e01b600 100644 --- a/upstream/opensuse-tumbleweed/man5/journald.conf.5 +++ b/upstream/opensuse-tumbleweed/man5/journald.conf.5 @@ -1,5 +1,5 @@ '\" t -.TH "JOURNALD\&.CONF" "5" "" "systemd 254" "journald.conf" +.TH "JOURNALD\&.CONF" "5" "" "systemd 255" "journald.conf" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -155,6 +155,8 @@ to an empty string\&. Note that per\-user journal files are not supported unless persistent storage is enabled, thus making \fBjournalctl \-\-user\fR unavailable\&. +.sp +Added in version 186\&. .RE .PP \fICompress=\fR @@ -170,6 +172,8 @@ Takes a boolean value\&. If enabled (the default), and a sealing key is availabl command), Forward Secure Sealing (FSS) for all persistent journal files is enabled\&. FSS is based on \m[blue]\fBSeekable Sequential Key Generators\fR\m[]\&\s-2\u[1]\d\s+2 by G\&. A\&. Marson and B\&. Poettering (doi:10\&.1007/978\-3\-642\-40203\-6_7) and may be used to protect journal files from unnoticed alteration\&. +.sp +Added in version 189\&. .RE .PP \fISplitMode=\fR @@ -185,6 +189,8 @@ for more details about UID ranges\&. If \fIStorage=\fR above), only a single journal file is used\&. Defaults to "uid"\&. +.sp +Added in version 190\&. .RE .PP \fIRateLimitIntervalSec=\fR, \fIRateLimitBurst=\fR @@ -335,6 +341,8 @@ should be sufficient to ensure that journal files do not grow without bounds\&. or "m" to override the default time unit of seconds\&. +.sp +Added in version 195\&. .RE .PP \fIMaxRetentionSec=\fR @@ -350,11 +358,15 @@ should be sufficient to ensure that journal files do not grow without bounds\&. or " m" to override the default time unit of seconds\&. +.sp +Added in version 195\&. .RE .PP \fISyncIntervalSec=\fR .RS 4 The timeout before synchronizing journal files to disk\&. After syncing, journal files are placed in the OFFLINE state\&. Note that syncing is unconditionally done immediately after a log message of priority CRIT, ALERT or EMERG has been logged\&. This setting hence applies only to messages of the levels ERR, WARNING, NOTICE, INFO, DEBUG\&. The default timeout is 5 minutes\&. +.sp +Added in version 199\&. .RE .PP \fIForwardToSyslog=\fR, \fIForwardToKMsg=\fR, \fIForwardToConsole=\fR, \fIForwardToWall=\fR @@ -412,6 +424,8 @@ for "systemd\&.journald\&.max_level_kmsg=", "systemd\&.journald\&.max_level_console=", "systemd\&.journald\&.max_level_wall="\&. +.sp +Added in version 185\&. .RE .PP \fIReadKMsg=\fR @@ -421,6 +435,8 @@ Takes a boolean value\&. If enabled processes /dev/kmsg messages generated by the kernel\&. In the default journal namespace this option is enabled by default, it is disabled in all others\&. +.sp +Added in version 235\&. .RE .PP \fIAudit=\fR @@ -438,6 +454,8 @@ collects generated audit records, it just controls whether it tells the kernel t from collecting the generated messages, the socket unit "systemd\-journald\-audit\&.socket" can be disabled and in this case this setting is without effect\&. +.sp +Added in version 246\&. .RE .PP \fITTYPath=\fR @@ -446,6 +464,8 @@ Change the console TTY to use if \fIForwardToConsole=yes\fR is used\&. Defaults to /dev/console\&. +.sp +Added in version 185\&. .RE .PP \fILineMax=\fR @@ -457,6 +477,8 @@ characters\&. If no such delimiter is read for the specified number of bytes a h or \fBAF_INET\fR datagram\&. Takes a size in bytes\&. If the value is suffixed with K, M, G or T, the specified size is parsed as Kilobytes, Megabytes, Gigabytes, or Terabytes (with the base 1024), respectively\&. Defaults to 48K, which is relatively large but still small enough so that log records likely fit into network datagrams along with extra room for metadata\&. Note that values below 79 are not accepted and will be bumped to 79\&. +.sp +Added in version 235\&. .RE .SH "FORWARDING TO TRADITIONAL SYSLOG DAEMONS" .PP diff --git a/upstream/opensuse-tumbleweed/man5/locale.5 b/upstream/opensuse-tumbleweed/man5/locale.5 index 051e5edf..f3da0c50 100644 --- a/upstream/opensuse-tumbleweed/man5/locale.5 +++ b/upstream/opensuse-tumbleweed/man5/locale.5 @@ -7,7 +7,7 @@ .\" 2008-06-17 Petr Baudis <pasky@suse.cz> .\" LC_TIME: Describe first_weekday and first_workday .\" -.TH locale 5 2023-02-05 "Linux man-pages 6.05.01" +.TH locale 5 2024-05-02 "Linux man-pages (unreleased)" .SH NAME locale \- describes a locale definition file .SH DESCRIPTION @@ -16,7 +16,7 @@ The definition file contains all the information that the .BR localedef (1) command needs to convert it into the binary locale database. -.PP +.P The definition files consist of sections which each describe a locale category in detail. See @@ -36,7 +36,7 @@ It defaults to the backslash (\e). is followed by a character that will be used as the comment-character for the rest of the file. It defaults to the number sign (#). -.PP +.P The locale definition has one part for each locale category. Each part can be copied from another existing locale or can be defined from scratch. @@ -52,7 +52,7 @@ and where a .I copy statement can be followed by locale-specific rules and selected overrides. -.PP +.P When defining a locale or a category from scratch, an existing system- provided locale definition file should be used as a reference to follow common glibc conventions. @@ -70,7 +70,7 @@ The following category sections are defined by POSIX: .B LC_NUMERIC .IP \[bu] .B LC_TIME -.PP +.P In addition, since glibc 2.2, the GNU C library supports the following nonstandard categories: .IP \[bu] 3 @@ -85,7 +85,7 @@ the GNU C library supports the following nonstandard categories: .B LC_PAPER .IP \[bu] .B LC_TELEPHONE -.PP +.P See .BR locale (7) for a more detailed description of each category. @@ -93,7 +93,7 @@ for a more detailed description of each category. The definition starts with the string .I LC_ADDRESS in the first column. -.PP +.P The following keywords are allowed: .TP .I postal_fmt @@ -159,7 +159,7 @@ State, province, or prefecture. .TP %c Country, as taken from data record. -.PP +.P Each field descriptor may have an \[aq]R\[aq] after the \[aq]%\[aq] to specify that the information is taken from a Romanized version string of the @@ -176,13 +176,13 @@ locale). followed by the abbreviation of the country (see CERT_MAILCODES). .TP .I country_ab2 -followed by the two-letter abbreviation of the country (ISO 3166). +followed by the two-letter abbreviation of the country (ISO\~3166). .TP .I country_ab3 -followed by the three-letter abbreviation of the country (ISO 3166). +followed by the three-letter abbreviation of the country (ISO\~3166). .TP .I country_num -followed by the numeric country code (ISO 3166). +followed by the numeric country code (ISO\~3166). .TP .I country_car followed by the international license plate country code. @@ -194,19 +194,19 @@ followed by the ISBN code (for books). followed by the language name in the language of the current document. .TP .I lang_ab -followed by the two-letter abbreviation of the language (ISO 639). +followed by the two-letter abbreviation of the language (ISO\~639). .TP .I lang_term -followed by the three-letter abbreviation of the language (ISO 639-2/T). +followed by the three-letter abbreviation of the language (ISO\~639-2/T). .TP .I lang_lib followed by the three-letter abbreviation of the language for library -use (ISO 639-2/B). +use (ISO\~639-2/B). Applications should in general prefer .I lang_term over .IR lang_lib . -.PP +.P The .B LC_ADDRESS definition ends with the string @@ -215,7 +215,7 @@ definition ends with the string The definition starts with the string .I LC_CTYPE in the first column. -.PP +.P The following keywords are allowed: .TP .I upper @@ -461,7 +461,7 @@ in the target character set. .TP .I translit_end marks the end of the transliteration rules. -.PP +.P The .B LC_CTYPE definition ends with the string @@ -469,11 +469,11 @@ definition ends with the string .SS LC_COLLATE Note that glibc does not support all POSIX-defined options, only the options described below are supported (as of glibc 2.23). -.PP +.P The definition starts with the string .I LC_COLLATE in the first column. -.PP +.P The following keywords are allowed: .TP .I coll_weight_max @@ -506,7 +506,7 @@ followed by a redefinition of a collation rule. .I reorder\-end marks the end of the redefinition of a collation rule. .TP -.I reorde\r-sections\-after +.I reorder\-sections\-after followed by a script name to reorder listed scripts after. .TP .I reorder\-sections\-end @@ -518,7 +518,7 @@ followed by a declaration of a script. .I symbol\-equivalence followed by a collating-symbol to be equivalent to another defined collating-symbol. -.PP +.P The collation rule definition starts with a line: .TP .I order_start @@ -530,7 +530,7 @@ or The order definition consists of lines that describe the collation order and is terminated with the keyword .IR order_end . -.PP +.P The .B LC_COLLATE definition ends with the string @@ -539,7 +539,7 @@ definition ends with the string The definition starts with the string .I LC_IDENTIFICATION in the first column. -.PP +.P The following keywords are allowed: .TP .I title @@ -595,7 +595,7 @@ followed by the revision number of this document. .TP .I date followed by the revision date of this document. -.PP +.P In addition, for each of the categories defined by the document, there should be a line starting with the keyword .IR category , @@ -608,7 +608,7 @@ a semicolon, and one of the .B LC_* identifiers. -.PP +.P The .B LC_IDENTIFICATION definition ends with the string @@ -617,7 +617,7 @@ definition ends with the string The definition starts with the string .I LC_MESSAGES in the first column. -.PP +.P The following keywords are allowed: .TP .I yesexpr @@ -633,7 +633,7 @@ followed by the output string corresponding to "yes". .TP .I nostr followed by the output string corresponding to "no". -.PP +.P The .B LC_MESSAGES definition ends with the string @@ -642,7 +642,7 @@ definition ends with the string The definition starts with the string .I LC_MEASUREMENT in the first column. -.PP +.P The following keywords are allowed: .TP .I measurement @@ -656,7 +656,7 @@ Metric. .B 2 US customary measurements. .RE -.PP +.P The .B LC_MEASUREMENT definition ends with the string @@ -665,14 +665,14 @@ definition ends with the string The definition starts with the string .I LC_MONETARY in the first column. -.PP +.P The following keywords are allowed: .TP .I int_curr_symbol followed by the international currency symbol. This must be a 4-character string containing the international currency symbol as -defined by the ISO 4217 standard (three characters) followed by a +defined by the ISO\~4217 standard (three characters) followed by a separator. .TP .I currency_symbol @@ -848,7 +848,7 @@ should be placed for a negative internationally formatted monetary quantity. The same values are recognized as for .IR p_sign_posn . -.PP +.P The .B LC_MONETARY definition ends with the string @@ -857,7 +857,7 @@ definition ends with the string The definition starts with the string .I LC_NAME in the first column. -.PP +.P Various keywords are allowed, but only .I name_fmt is mandatory. @@ -935,7 +935,7 @@ followed by the salutation for unmarried women. .TP .I name_ms followed by the salutation valid for all women. -.PP +.P The .B LC_NAME definition ends with the string @@ -944,7 +944,7 @@ definition ends with the string The definition starts with the string .I LC_NUMERIC in the first column. -.PP +.P The following keywords are allowed: .TP .I decimal_point @@ -967,7 +967,7 @@ left of the previous group. If the last integer is not \-1, then the size of the previous group (if any) is repeatedly used for the remainder of the digits. If the last integer is \-1, then no further grouping is performed. -.PP +.P The .B LC_NUMERIC definition ends with the string @@ -976,7 +976,7 @@ definition ends with the string The definition starts with the string .I LC_PAPER in the first column. -.PP +.P The following keywords are allowed: .TP .I height @@ -984,7 +984,7 @@ followed by the height, in millimeters, of the standard paper format. .TP .I width followed by the width, in millimeters, of the standard paper format. -.PP +.P The .B LC_PAPER definition ends with the string @@ -993,7 +993,7 @@ definition ends with the string The definition starts with the string .I LC_TELEPHONE in the first column. -.PP +.P The following keywords are allowed: .TP .I tel_int_fmt @@ -1036,7 +1036,7 @@ followed by the prefix used to call international phone numbers. .TP .I int_prefix followed by the prefix used from other countries to dial this country. -.PP +.P The .B LC_TELEPHONE definition ends with the string @@ -1045,7 +1045,7 @@ definition ends with the string The definition starts with the string .I LC_TIME in the first column. -.PP +.P The following keywords are allowed: .TP .I abday @@ -1105,9 +1105,9 @@ followed by semicolon-separated strings that define how years are counted and displayed for each era in the locale. Each string has the following format: .RS -.PP +.P .IR direction ":" offset ":" start_date ":" end_date ":" era_name ":" era_format -.PP +.P The fields are to be defined as follows: .TP 4 .I direction @@ -1237,7 +1237,7 @@ followed by the appropriate date representation for .BR date (1) (for syntax, see .BR strftime (3)). -.PP +.P The .B LC_TIME definition ends with the string diff --git a/upstream/opensuse-tumbleweed/man5/locale.conf.5 b/upstream/opensuse-tumbleweed/man5/locale.conf.5 index 608cb17f..531a8d8f 100644 --- a/upstream/opensuse-tumbleweed/man5/locale.conf.5 +++ b/upstream/opensuse-tumbleweed/man5/locale.conf.5 @@ -1,5 +1,5 @@ '\" t -.TH "LOCALE\&.CONF" "5" "" "systemd 254" "locale.conf" +.TH "LOCALE\&.CONF" "5" "" "systemd 255" "locale.conf" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/upstream/opensuse-tumbleweed/man5/localtime.5 b/upstream/opensuse-tumbleweed/man5/localtime.5 index ca417410..091dfcc0 100644 --- a/upstream/opensuse-tumbleweed/man5/localtime.5 +++ b/upstream/opensuse-tumbleweed/man5/localtime.5 @@ -1,5 +1,5 @@ '\" t -.TH "LOCALTIME" "5" "" "systemd 254" "localtime" +.TH "LOCALTIME" "5" "" "systemd 255" "localtime" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/upstream/opensuse-tumbleweed/man5/logind.conf.5 b/upstream/opensuse-tumbleweed/man5/logind.conf.5 index 97eef777..b8bc5bb6 100644 --- a/upstream/opensuse-tumbleweed/man5/logind.conf.5 +++ b/upstream/opensuse-tumbleweed/man5/logind.conf.5 @@ -1,5 +1,5 @@ '\" t -.TH "LOGIND\&.CONF" "5" "" "systemd 254" "logind.conf" +.TH "LOGIND\&.CONF" "5" "" "systemd 255" "logind.conf" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -102,6 +102,8 @@ activation (see above)\&. The VT selected with this option will be marked busy u is always available\&. Defaults to 6 (in other words, there will always be a "getty" available on Alt\-F6\&.)\&. When set to 0, VT reservation is disabled\&. +.sp +Added in version 190\&. .RE .PP \fIKillUserProcesses=\fR @@ -168,6 +170,8 @@ Configures the action to take when the system is idle\&. Takes one of Note that this requires that user sessions correctly report the idle status to the system\&. The system will execute the action after all sessions report that they are idle, no idle inhibitor lock is active, and subsequently, the time configured with \fIIdleActionSec=\fR (see below) has expired\&. +.sp +Added in version 198\&. .RE .PP \fIIdleActionSec=\fR @@ -175,6 +179,8 @@ Note that this requires that user sessions correctly report the idle status to t Configures the delay after which the action configured in \fIIdleAction=\fR (see above) is taken after the system is idle\&. +.sp +Added in version 198\&. .RE .PP \fIInhibitDelayMaxSec=\fR @@ -191,6 +197,8 @@ user@\&.service around for a user after they logged out fully\&. If set to zero, the per\-user service is terminated immediately when the last session of the user has ended\&. If this option is configured to non\-zero rapid logout/login cycles are sped up, as the user\*(Aqs service manager is not constantly restarted\&. If set to "infinity" the per\-user service for a user is never terminated again after first login, and continues to run until system shutdown\&. Defaults to 10s\&. +.sp +Added in version 240\&. .RE .PP \fIHandlePowerKey=\fR, \fIHandlePowerKeyLongPress=\fR, \fIHandleRebootKey=\fR, \fIHandleRebootKeyLongPress=\fR, \fIHandleSuspendKey=\fR, \fIHandleSuspendKeyLongPress=\fR, \fIHandleHibernateKey=\fR, \fIHandleHibernateKeyLongPress=\fR, \fIHandleLidSwitch=\fR, \fIHandleLidSwitchExternalPower=\fR, \fIHandleLidSwitchDocked=\fR @@ -260,6 +268,8 @@ A different application may disable logind\*(Aqs handling of system power and sl "handle\-reboot\-key")\&. This is most commonly used by graphical desktop environments to take over suspend and hibernation handling, and to use their own configuration mechanisms\&. If a low\-level inhibitor lock is taken, logind will not take any action when that key or switch is triggered and the \fIHandle*=\fR settings are irrelevant\&. +.sp +Added in version 184\&. .RE .PP \fIPowerKeyIgnoreInhibited=\fR, \fISuspendKeyIgnoreInhibited=\fR, \fIHibernateKeyIgnoreInhibited=\fR, \fILidSwitchIgnoreInhibited=\fR, \fIRebootKeyIgnoreInhibited=\fR @@ -287,11 +297,15 @@ defaults to "yes"\&. This means that when \fBsystemd\-logind\fR is handling events by itself (no low level inhibitor locks are taken by another application), the lid switch does not respect suspend blockers by default, but the power and sleep keys do\&. +.sp +Added in version 190\&. .RE .PP \fIHoldoffTimeoutSec=\fR .RS 4 Specifies a period of time after system startup or system resume in which systemd will hold off on reacting to lid events\&. This is required for the system to properly detect any hotplugged devices so systemd can ignore lid events if external monitors, or docks, are connected\&. If set to 0, systemd will always react immediately, possibly before the kernel fully probed all hotplugged devices\&. This is safe, as long as you do not care for systemd to account for devices that have been plugged or unplugged while the system was off\&. Defaults to 30s\&. +.sp +Added in version 220\&. .RE .PP \fIRuntimeDirectorySize=\fR @@ -301,6 +315,8 @@ Sets the size limit on the runtime directory for each user who logs in\&. Takes a size in bytes, optionally suffixed with the usual K, G, M, and T suffixes, to the base 1024 (IEC)\&. Alternatively, a numerical percentage suffixed by "%" may be specified, which sets the size limit relative to the amount of physical RAM\&. Defaults to 10%\&. Note that this size is a safety limit only\&. As each runtime directory is a tmpfs file system, it will only consume as much memory as is needed\&. +.sp +Added in version 211\&. .RE .PP \fIRuntimeDirectoryInodesMax=\fR @@ -310,11 +326,15 @@ Sets the limit on number of inodes for the runtime directory for each user who logs in\&. Takes a number, optionally suffixed with the usual K, G, M, and T suffixes, to the base 1024 (IEC)\&. Defaults to \fIRuntimeDirectorySize=\fR divided by 4096\&. Note that this size is a safety limit only\&. As each runtime directory is a tmpfs file system, it will only consume as much memory as is needed\&. +.sp +Added in version 246\&. .RE .PP \fIInhibitorsMax=\fR .RS 4 Controls the maximum number of concurrent inhibitors to permit\&. Defaults to 8192 (8K)\&. +.sp +Added in version 230\&. .RE .PP \fISessionsMax=\fR @@ -323,12 +343,16 @@ Controls the maximum number of concurrent user sessions to manage\&. Defaults to pam_systemd\&.so module is included in the PAM stack configuration, further login sessions will either be refused, or permitted but not tracked by systemd\-logind\&. +.sp +Added in version 230\&. .RE .PP \fIRemoveIPC=\fR .RS 4 Controls whether System V and POSIX IPC objects belonging to the user shall be removed when the user fully logs out\&. Takes a boolean argument\&. If enabled, the user may not consume IPC resources after the last of the user\*(Aqs sessions terminated\&. This covers System V semaphores, shared memory and message queues, as well as POSIX shared memory and message queues\&. Note that IPC objects of the root user and other system users are excluded from the effect of this setting\&. Defaults to "yes"\&. +.sp +Added in version 212\&. .RE .PP \fIStopIdleSessionSec=\fR @@ -340,6 +364,8 @@ checks the idle state of all sessions\&. Every session that is idle for longer t (systemd\-logind is not checking the idle state of sessions)\&. For details about the syntax of time spans, see \fBsystemd.time\fR(7)\&. +.sp +Added in version 252\&. .RE .SH "SEE ALSO" .PP diff --git a/upstream/opensuse-tumbleweed/man5/machine-id.5 b/upstream/opensuse-tumbleweed/man5/machine-id.5 index 5e55cdfe..5fabdd19 100644 --- a/upstream/opensuse-tumbleweed/man5/machine-id.5 +++ b/upstream/opensuse-tumbleweed/man5/machine-id.5 @@ -1,5 +1,5 @@ '\" t -.TH "MACHINE\-ID" "5" "" "systemd 254" "machine-id" +.TH "MACHINE\-ID" "5" "" "systemd 255" "machine-id" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -89,7 +89,8 @@ will attempt to use the D\-Bus machine ID from product_uuid or the devicetree vm,uuid -(on KVM systems), and finally a randomly generated UUID\&. +(on KVM systems), the Xen hypervisor +uuid, and finally a randomly generated UUID\&. .PP After the machine ID is established, \fBsystemd\fR(1) diff --git a/upstream/opensuse-tumbleweed/man5/machine-info.5 b/upstream/opensuse-tumbleweed/man5/machine-info.5 index 04b4dc15..f77dc12b 100644 --- a/upstream/opensuse-tumbleweed/man5/machine-info.5 +++ b/upstream/opensuse-tumbleweed/man5/machine-info.5 @@ -1,5 +1,5 @@ '\" t -.TH "MACHINE\-INFO" "5" "" "systemd 254" "machine-info" +.TH "MACHINE\-INFO" "5" "" "systemd 255" "machine-info" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -85,6 +85,8 @@ and for virtualized systems that lack an immediate physical chassis\&. .sp Note that most systems allow detection of the chassis type automatically (based on firmware information or suchlike)\&. This setting should only be used to override a misdetection or to manually configure the chassis type where automatic detection is not available\&. +.sp +Added in version 197\&. .RE .PP \fIDEPLOYMENT=\fR @@ -94,6 +96,8 @@ Describes the system deployment environment\&. One of the following is suggested "integration", "staging", "production"\&. +.sp +Added in version 216\&. .RE .PP \fILOCATION=\fR @@ -102,6 +106,8 @@ Describes the system location if applicable and known\&. Takes a human\-friendly "Berlin, Germany" or as specific as "Left Rack, 2nd Shelf"\&. +.sp +Added in version 216\&. .RE .PP \fIHARDWARE_VENDOR=\fR @@ -109,6 +115,8 @@ or as specific as Specifies the hardware vendor\&. If unspecified, the hardware vendor set in DMI or \fBhwdb\fR(7) will be used\&. +.sp +Added in version 251\&. .RE .PP \fIHARDWARE_MODEL=\fR @@ -116,6 +124,8 @@ will be used\&. Specifies the hardware model\&. If unspecified, the hardware model set in DMI or \fBhwdb\fR(7) will be used\&. +.sp +Added in version 251\&. .RE .SH "EXAMPLE" .sp diff --git a/upstream/opensuse-tumbleweed/man5/modprobe.d.5 b/upstream/opensuse-tumbleweed/man5/modprobe.d.5 index 9fd3354c..8b54f18b 100644 --- a/upstream/opensuse-tumbleweed/man5/modprobe.d.5 +++ b/upstream/opensuse-tumbleweed/man5/modprobe.d.5 @@ -2,12 +2,12 @@ .\" Title: modprobe.d .\" Author: Jon Masters <jcm@jonmasters.org> .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> -.\" Date: 12/06/2023 +.\" Date: 03/05/2024 .\" Manual: modprobe.d .\" Source: kmod .\" Language: English .\" -.TH "MODPROBE\&.D" "5" "12/06/2023" "kmod" "modprobe.d" +.TH "MODPROBE\&.D" "5" "03/05/2024" "kmod" "modprobe.d" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/upstream/opensuse-tumbleweed/man5/modules.dep.5 b/upstream/opensuse-tumbleweed/man5/modules.dep.5 index 9f0c60f1..cdd0bfff 100644 --- a/upstream/opensuse-tumbleweed/man5/modules.dep.5 +++ b/upstream/opensuse-tumbleweed/man5/modules.dep.5 @@ -2,12 +2,12 @@ .\" Title: modules.dep .\" Author: Jon Masters <jcm@jonmasters.org> .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> -.\" Date: 12/06/2023 +.\" Date: 03/05/2024 .\" Manual: modules.dep .\" Source: kmod .\" Language: English .\" -.TH "MODULES\&.DEP" "5" "12/06/2023" "kmod" "modules.dep" +.TH "MODULES\&.DEP" "5" "03/05/2024" "kmod" "modules.dep" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -31,16 +31,16 @@ modules.dep, modules.dep.bin \- Module dependency information .SH "SYNOPSIS" .PP -/usr/lib/modules/modules\&.dep +/lib/modules/modules\&.dep .PP -/usr/lib/modules/modules\&.dep\&.bin +/lib/modules/modules\&.dep\&.bin .SH "DESCRIPTION" .PP modules\&.dep\&.bin is a binary file generated by \fBdepmod\fR listing the dependencies for every module in the directories under -/usr/lib/modules/\fIversion\fR\&. It is used by kmod tools such as +/lib/modules/\fIversion\fR\&. It is used by kmod tools such as \fBmodprobe\fR and libkmod\&. .PP diff --git a/upstream/opensuse-tumbleweed/man5/nanorc.5 b/upstream/opensuse-tumbleweed/man5/nanorc.5 index 4416b7dd..672f6e16 100644 --- a/upstream/opensuse-tumbleweed/man5/nanorc.5 +++ b/upstream/opensuse-tumbleweed/man5/nanorc.5 @@ -1,4 +1,4 @@ -.\" Copyright (C) 2003-2011, 2013-2023 Free Software Foundation, Inc. +.\" Copyright (C) 2003-2011, 2013-2024 Free Software Foundation, Inc. .\" .\" This document is dual-licensed. You may distribute and/or modify it .\" under the terms of either of the following licenses: @@ -16,14 +16,14 @@ .\" Documentation License along with this program. If not, see .\" <https://www.gnu.org/licenses/>. .\" -.TH NANORC 5 "version 7.2" "January 2023" +.TH NANORC 5 "version 8.0" "May 2024" .SH NAME nanorc \- GNU nano's configuration file .SH DESCRIPTION The \fInanorc\fP files contain the default settings for \fBnano\fP, -a small and friendly editor. During startup, if \fB\-\-rcfile\fR +a small and friendly text editor. During startup, if \fB\-\-rcfile\fR is not given, \fBnano\fR will read two files: first the system-wide settings, from \fI/etc/nanorc\fP (the exact path might be different on your system), and then the user-specific settings, either @@ -32,6 +32,24 @@ or from \fI~/.config/nano/nanorc\fR, whichever is encountered first. If \fB\-\-rcfile\fR is given, \fBnano\fR will read just the specified settings file. +.SH NOTICE +Since version 8.0, to be newcomer friendly, \fB^F\fR starts a forward search, +\fB^B\fR starts a backward search, \fBM\-F\fR searches the next occurrence +forward, and \fBM\-B\fR searches the next occurrence backward. If you want +those keystrokes to do what they did before version 8.0, add the following +lines at the end of your \fInanorc\fR file: +.sp +.RS 4 +.B bind ^F forward main +.br +.B bind ^B back main +.br +.B bind M\-F formatter main +.br +.B bind M\-B linter main +.RE +.sp + .SH OPTIONS The configuration file accepts a series of \fBset\fP and \fBunset\fP commands, which can be used to configure nano on startup without using @@ -80,10 +98,12 @@ with \fBset backup\fR or \fB\-\-backup\fR or \fB\-B\fR. The uniquely numbered files are stored in the specified \fIdirectory\fR. .TP .B set boldtext -Use bold instead of reverse video for the title bar, status bar, key combos, -function tags, line numbers, and selected text. This can be overridden by -setting the options \fBtitlecolor\fP, \fBstatuscolor\fP, \fBkeycolor\fP, -\fBfunctioncolor\fP, \fBnumbercolor\fP, and \fBselectedcolor\fP. +Use bold instead of reverse video for the title bar, status bar, +prompt bar, mini bar, key combos, function tags, line numbers, +and selected text. This can be overridden by setting the options +\fBtitlecolor\fP, \fBstatuscolor\fP, +\fBpromptcolor\fP, \fBminicolor\fP, \fBkeycolor\fP, \fBfunctioncolor\fP, +\fBnumbercolor\fP, and/or \fBselectedcolor\fP. .TP .B set bookstyle When justifying, treat any line that starts with whitespace as the @@ -171,7 +191,7 @@ The default value is "\fB(<[{)>]}\fP". .B set minibar Suppress the title bar and instead show information about the current buffer at the bottom of the screen, in the space -for the status bar. In this "minibar" the filename is shown +for the status bar. In this "mini bar" the filename is shown on the left, followed by an asterisk if the buffer has been modified. On the right are displayed the current line and column number, the code of the character under the cursor (in Unicode format: U+xxxx), @@ -186,7 +206,7 @@ The line plus column numbers and the character code are displayed only when The state flags are displayed only when \fBset stateflags\fR is used. .TP .B set minicolor \fR[\fBbold,\fR][\fBitalic,\fR]\fIfgcolor\fB,\fIbgcolor\fR -Use this color combination for the minibar. +Use this color combination for the mini bar. (When this option is not specified, the colors of the title bar are used.) See \fBset titlecolor\fR for more details. .TP @@ -239,7 +259,7 @@ See \fBset titlecolor\fR for more details. .BI "set punct """ characters """ Set the characters treated as closing punctuation when justifying paragraphs. This may not include blank characters. Only the -specfified closing punctuation, optionally followed by closing brackets +specified closing punctuation, optionally followed by closing brackets (see \fBbrackets\fP), can end sentences. The default value is "\fB!.?\fP". .TP .B set quickblank @@ -278,8 +298,6 @@ Save a changed buffer automatically on exit (\fB^X\fR); don't prompt. .TP .B set scrollercolor \fIfgcolor\fB,\fIbgcolor\fR Use this color combination for the indicator alias "scrollbar". -(On terminal emulators that link to a libvte older than version 0.55, -using a background color here does not work correctly.) See \fBset titlecolor\fR for more details. .TP .B set selectedcolor \fR[\fBbold,\fR][\fBitalic,\fR]\fIfgcolor\fB,\fIbgcolor\fR @@ -335,6 +353,7 @@ greater than 0. The default value is \fB8\fR. .B set tabstospaces Convert each typed tab to spaces -- to the number of spaces that a tab at that position would take up. +(Note: pasted tabs are not converted.) .TP .B set titlecolor \fR[\fBbold,\fR][\fBitalic,\fR]\fIfgcolor\fB,\fIbgcolor\fR Use this color combination for the title bar. @@ -345,6 +364,8 @@ Each of these eight names may be prefixed with the word \fBlight\fR to get a brighter version of that color. The word \fBgrey\fR or \fBgray\fR may be used as a synonym for \fBlightblack\fR. +On a Linux console, \fBlight\fR does not have +any effect for a background color. On terminal emulators that can do at least 256 colors, other valid (but unprefixable) color names are: .BR pink ", " purple ", " mauve ", " lagoon ", " mint ", " @@ -398,12 +419,6 @@ and disappears after 1.5 seconds or upon the next keystroke. With \fBM\-Z\fR the title bar plus status bar can be toggled. With \fBM\-X\fR the help lines. -.SH NOTES -Option \fBset suspendable\fR has been removed. -Suspension is enabled by default, reachable via \fB^T^Z\fR. -(If you want a plain \fB^Z\fR to suspend nano, -add \fBbind ^Z suspend main\fR to your nanorc.) - .SH SYNTAX HIGHLIGHTING Coloring the different syntactic elements of a file is done via regular expressions (see the \fBcolor\fR command below). @@ -444,9 +459,10 @@ will be added to this syntax, until a new \fBsyntax\fR command is encountered. .sp When \fBnano\fR is run, this syntax will be automatically -activated if the current filename matches the extended regular -expression \fIfileregex\fR. Or the syntax can be explicitly -activated by using the \fB\-Y\fR or \fB\-\-syntax\fR +activated (for the relevant buffer) if the absolute filename +matches the extended regular expression \fIfileregex\fR. +Or the syntax can be explicitly activated (for all buffers) +by using the \fB\-Y\fR or \fB\-\-syntax\fR command-line option followed by the \fIname\fR. .sp The syntax \fBdefault\fP is special: it takes no \fIfileregex\fR, @@ -499,6 +515,8 @@ Each of these eight names may be prefixed with the word \fBlight\fR to get a brighter version of that color. The word \fBgrey\fR or \fBgray\fR may be used as a synonym for \fBlightblack\fR. +On a Linux console, \fBlight\fR does not have +any effect for a background color. On terminal emulators that can do at least 256 colors, other valid (but unprefixable) color names are: .BR pink ", " purple ", " mauve ", " lagoon ", " mint ", " @@ -570,7 +588,7 @@ menus where the key exists when \fBall\fP is used). .sp Note that \fBbind \fIkey\fR \fB"{\fIfunction\fB}"\fR \fImenu\fR is equivalent to \fBbind \fIkey\fR \fIfunction\fR \fImenu\fR, except that for the latter form -\fBnano\fR will check the availabilty of the \fIfunction\fR in the given \fImenu\fR +\fBnano\fR will check the availability of the \fIfunction\fR in the given \fImenu\fR at startup time (and report an error if it does not exist there), whereas for the first form \fBnano\fR will check at execution time that the \fIfunction\fR exists but not whether it makes any sense in the current menu. The user has to take care @@ -791,6 +809,12 @@ Moves the cursor to the beginning of the current or preceding block of text. .B nextblock Moves the cursor to the beginning of the next block of text. .TP +.B toprow +Moves the cursor to the first row in the viewport. +.TP +.B bottomrow +Moves the cursor to the last row in the viewport. +.TP .B pageup Goes up one screenful. .TP @@ -886,7 +910,7 @@ Toggles between searching for something and replacing something. Toggles between searching for text and targeting a line number. .TP .B flipexecute -Toggles between inserting a file and executing a command. +Switches from inserting a file to executing a command. .TP .B flippipe When executing a command, toggles whether the current buffer (or marked @@ -1038,6 +1062,20 @@ For \fBbind\fR it means all menus where the specified \fIfunction\fR exists; for \fBunbind\fR it means all menus where the specified \fIkey\fR exists. .RE +.SH EXAMPLES +To make \fBCtrl+Z\fR suspend nano: +.sp +.RS +.B bind ^Z suspend main +.RE +.sp +To make \fBShift+Alt+C\fR copy the marked region to the system's clipboard: +.sp +.RS +.B bind Sh-M-C """{execute}| xsel -ib {enter}{undo}""" main +.RE +.sp + .SH FILES .TP .I /etc/nanorc diff --git a/upstream/opensuse-tumbleweed/man5/networkd.conf.5 b/upstream/opensuse-tumbleweed/man5/networkd.conf.5 index f52b8c25..c878709f 100644 --- a/upstream/opensuse-tumbleweed/man5/networkd.conf.5 +++ b/upstream/opensuse-tumbleweed/man5/networkd.conf.5 @@ -1,5 +1,5 @@ '\" t -.TH "NETWORKD\&.CONF" "5" "" "systemd 254" "networkd.conf" +.TH "NETWORKD\&.CONF" "5" "" "systemd 255" "networkd.conf" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -74,12 +74,16 @@ Takes a boolean\&. If set to yes, then measures the traffic of each interface, and \fBnetworkctl status \fR\fB\fIINTERFACE\fR\fR shows the measured speed\&. Defaults to no\&. +.sp +Added in version 244\&. .RE .PP \fISpeedMeterIntervalSec=\fR .RS 4 Specifies the time interval to calculate the traffic speed of each interface\&. If \fISpeedMeter=no\fR, the value is ignored\&. Defaults to 10sec\&. +.sp +Added in version 244\&. .RE .PP \fIManageForeignRoutingPolicyRules=\fR @@ -88,6 +92,8 @@ A boolean\&. When true, \fBsystemd\-networkd\fR will remove rules that are not configured in \&.network files (except for rules with protocol "kernel")\&. When false, it will not remove any foreign rules, keeping them even if they are not configured in a \&.network file\&. Defaults to yes\&. +.sp +Added in version 249\&. .RE .PP \fIManageForeignRoutes=\fR @@ -106,6 +112,8 @@ when \fIKeepConfiguration=\fR is true or "static")\&. When false, it will not remove any foreign routes, keeping them even if they are not configured in a \&.network file\&. Defaults to yes\&. +.sp +Added in version 246\&. .RE .PP \fIRouteTable=\fR @@ -115,6 +123,8 @@ Defines the route table name\&. Takes a whitespace\-separated list of the pairs "default", "main", or "local", as these route table names are predefined with route table number 253, 254, and 255, respectively\&. The route table number must be an integer in the range 1\&...4294967295, except for predefined numbers 253, 254, and 255\&. This setting can be specified multiple times\&. If an empty string is specified, then the list specified earlier are cleared\&. Defaults to unset\&. +.sp +Added in version 248\&. .RE .PP \fIIPv6PrivacyExtensions=\fR @@ -126,6 +136,8 @@ and "kernel"\&. See for details in \fBsystemd.network\fR(5)\&. Defaults to "no"\&. +.sp +Added in version 254\&. .RE .SH "[DHCPV4] SECTION OPTIONS" .PP @@ -141,7 +153,7 @@ Specifies how the DUID should be generated\&. See \m[blue]\fBRFC 3315\fR\m[]\&\s-2\u[1]\d\s+2 for a description of all the options\&. .sp -The following values are understood: +This takes an integer in the range 0\&...65535, or one of the following string values: .PP \fBvendor\fR .RS 4 @@ -152,6 +164,8 @@ as the vendor identifier (systemd) and hashed contents of \fBmachine-id\fR(5)\&. This is the default if \fIDUIDType=\fR is not specified\&. +.sp +Added in version 230\&. .RE .PP \fBuuid\fR @@ -163,6 +177,8 @@ is not set, then the product UUID is used as a DUID value\&. If a system does no \fBmachine-id\fR(5) is used as a DUID value\&. About the application\-specific machine ID, see \fBsd_id128_get_machine_app_specific\fR(3)\&. +.sp +Added in version 230\&. .RE .PP \fBlink\-layer\-time[:\fR\fB\fITIME\fR\fR\fB]\fR, \fBlink\-layer\fR @@ -176,11 +192,15 @@ is specified, then the MAC address of the interface is used as a DUID value\&. T can take additional time value after a colon, e\&.g\&. "link\-layer\-time:2018\-01\-23 12:34:56 UTC"\&. The default time value is "2000\-01\-01 00:00:00 UTC"\&. +.sp +Added in version 240\&. .RE .sp In all cases, \fIDUIDRawData=\fR can be used to override the actual DUID value that is used\&. +.sp +Added in version 230\&. .RE .PP \fIDUIDRawData=\fR @@ -213,6 +233,8 @@ DUIDRawData=00:00:ab:11:f9:2a:c2:77:29:f9:5c:00 .sp This specifies a 14 byte DUID, with the type DUID\-EN ("00:02"), enterprise number 43793 ("00:00:ab:11"), and identifier value "f9:2a:c2:77:29:f9:5c:00"\&. + +Added in version 230\&. .RE .SH "[DHCPV6] SECTION OPTIONS" .PP @@ -224,6 +246,8 @@ The following options are understood: \fIDUIDType=\fR, \fIDUIDRawData=\fR .RS 4 As in the [DHCPv4] section\&. +.sp +Added in version 249\&. .RE .SH "SEE ALSO" .PP diff --git a/upstream/opensuse-tumbleweed/man5/networks.5 b/upstream/opensuse-tumbleweed/man5/networks.5 index cf660e34..0aa28935 100644 --- a/upstream/opensuse-tumbleweed/man5/networks.5 +++ b/upstream/opensuse-tumbleweed/man5/networks.5 @@ -4,7 +4,7 @@ .\" .\" 2008-09-04, mtk, taken from Debian downstream, with a few light edits .\" -.TH networks 5 2022-10-30 "Linux man-pages 6.05.01" +.TH networks 5 2024-05-02 "Linux man-pages (unreleased)" .SH NAME networks \- network name information .SH DESCRIPTION @@ -13,18 +13,18 @@ The file is a plain ASCII file that describes known DARPA networks and symbolic names for these networks. Each line represents a network and has the following structure: -.PP +.P .RS -.I name number aliases ... +.I name number aliases .\|.\|. .RE -.PP +.P where the fields are delimited by spaces or tabs. Empty lines are ignored. The hash character (\fB#\fP) indicates the start of a comment: this character, and the remaining characters up to the end of the current line, are ignored by library functions that process the file. -.PP +.P The field descriptions are: .TP .I name @@ -40,7 +40,7 @@ may be omitted. .TP .I aliases Optional aliases for the network. -.PP +.P This file is read by the .BR route (8) and diff --git a/upstream/opensuse-tumbleweed/man5/nologin.5 b/upstream/opensuse-tumbleweed/man5/nologin.5 index af006f52..6e83b761 100644 --- a/upstream/opensuse-tumbleweed/man5/nologin.5 +++ b/upstream/opensuse-tumbleweed/man5/nologin.5 @@ -5,7 +5,7 @@ .\" .\" Modified Sun Jul 25 11:06:34 1993 by Rik Faith (faith@cs.unc.edu) .\" Corrected Mon Oct 21 17:47:19 EDT 1996 by Eric S. Raymond (esr@thyrsus.com) -.TH nologin 5 2022-10-30 "Linux man-pages 6.05.01" +.TH nologin 5 2024-05-02 "Linux man-pages (unreleased)" .SH NAME nologin \- prevent unprivileged users from logging into the system .SH DESCRIPTION diff --git a/upstream/opensuse-tumbleweed/man5/nscd.conf.5 b/upstream/opensuse-tumbleweed/man5/nscd.conf.5 index 041793ea..0121e845 100644 --- a/upstream/opensuse-tumbleweed/man5/nscd.conf.5 +++ b/upstream/opensuse-tumbleweed/man5/nscd.conf.5 @@ -4,7 +4,7 @@ .\" .\" SPDX-License-Identifier: GPL-2.0-or-later .\" -.TH nscd.conf 5 2023-02-05 "Linux man-pages 6.05.01" +.TH nscd.conf 5 2024-05-02 "Linux man-pages (unreleased)" .SH NAME nscd.conf \- name service cache daemon configuration file .SH DESCRIPTION @@ -20,16 +20,16 @@ or TAB characters. A \[aq]#\[aq] (number sign) indicates the beginning of a comment; following characters, up to the end of the line, are not interpreted by nscd. -.PP +.P Valid services are \fIpasswd\fP, \fIgroup\fP, \fIhosts\fP, \fIservices\fP, or \fInetgroup\fP. -.PP +.P .B logfile .I debug-file-name .RS Specifies name of the file to which debug info should be written. .RE -.PP +.P .B debug\-level .I value .RS @@ -40,7 +40,7 @@ Sets the desired debug level. 3 (and above) shows all debug info. The default is 0. .RE -.PP +.P .B threads .I number .RS @@ -52,14 +52,14 @@ The number of threads may increase dynamically up to in response to demand from clients, but never decreases. .RE -.PP +.P .B max\-threads .I number .RS Specifies the maximum number of threads. The default is 32. .RE -.PP +.P .B server\-user .I user .RS @@ -67,13 +67,13 @@ If this option is set, nscd will run as this user and not as root. If a separate cache for every user is used (\-S parameter), this option is ignored. .RE -.PP +.P .B stat\-user .I user .RS Specifies the user who is allowed to request statistics. .RE -.PP +.P .B reload\-count unlimited | .I number @@ -93,14 +93,14 @@ The default limit is 5. A limit of 0 turns off the reloading feature. See NOTES below for further discussion of reloading. .RE -.PP +.P .B paranoia .I <yes|no> .RS Enabling paranoia mode causes nscd to restart itself periodically. The default is no. .RE -.PP +.P .B restart\-interval .I time .RS @@ -112,7 +112,7 @@ if periodic restart is enabled by enabling mode. The default is 3600. .RE -.PP +.P .B enable\-cache .I service .I <yes|no> @@ -122,7 +122,7 @@ Enables or disables the specified cache. The default is no. .RE -.PP +.P .B positive\-time\-to\-live .I service .I value @@ -138,7 +138,7 @@ Note that for some name services (including specifically DNS) the TTL returned from the name service is used and this attribute is ignored. .RE -.PP +.P .B negative\-time\-to\-live .I service .I value @@ -153,7 +153,7 @@ are several files owned by UIDs (user IDs) not in system databases (for example untarring the Linux kernel sources as root); should be kept small to reduce cache coherency problems. .RE -.PP +.P .B suggested\-size .I service .I value @@ -163,7 +163,7 @@ This is the internal hash table size, should remain a prime number for optimum efficiency. The default is 211. .RE -.PP +.P .B check\-files .I service .I <yes|no> @@ -181,7 +181,7 @@ and .IR /etc/netgroup . The default is yes. .RE -.PP +.P .B persistent .I service .I <yes|no> @@ -193,7 +193,7 @@ over server restarts; useful when mode is set. The default is no. .RE -.PP +.P .B shared .I service .I <yes|no> @@ -207,7 +207,7 @@ The default is no. Note that a cache miss will still result in asking the daemon over the socket. .RE -.PP +.P .B max\-db\-size .I service .I bytes @@ -216,7 +216,7 @@ The maximum allowable size, in bytes, of the database files for the .IR service . The default is 33554432. .RE -.PP +.P .B auto\-propagate .I service .I <yes|no> @@ -252,13 +252,13 @@ your distribution might differ. .BR nscd (8) has a feature called reloading, whose behavior can be surprising. -.PP +.P Reloading is enabled when the .B reload-count attribute has a non-zero value. The default value in the source code enables reloading, although your distribution may differ. -.PP +.P When reloading is enabled, positive cached entries (the results of successful queries) do not simply expire when their TTL is up. @@ -282,7 +282,7 @@ reset the reload counter on the entry. Purging the cache using .I nscd\~-i overrides the reload logic and removes the entry. -.PP +.P Reloading has the effect of extending cache entry TTLs without compromising on cache coherency, at the cost of additional load on the backing name service. @@ -297,7 +297,7 @@ the effective TTL is the value returned from the name service and the value of the .B positive\-time\-to\-live attribute. -.PP +.P Please consider the following advice carefully: .IP \[bu] 3 If your application will make a second request for the same name, @@ -325,7 +325,7 @@ to is almost never a good idea, as it will result in a cache that never expires entries and puts never-ending additional load on the backing name service. -.PP +.P Some distributions have an init script for .BR nscd (8) with a diff --git a/upstream/opensuse-tumbleweed/man5/nss.5 b/upstream/opensuse-tumbleweed/man5/nss.5 index d53e1cd5..258cc113 100644 --- a/upstream/opensuse-tumbleweed/man5/nss.5 +++ b/upstream/opensuse-tumbleweed/man5/nss.5 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: GPL-2.0-only .\" -.TH nss 5 2023-02-05 "Linux man-pages 6.05.01" +.TH nss 5 2024-05-02 "Linux man-pages (unreleased)" .SH NAME nss \- Name Service Switch configuration file .SH DESCRIPTION @@ -13,7 +13,7 @@ Switch implementation in the GNU C library. The various services provided are implemented by independent modules, each of which naturally varies widely from the other. -.PP +.P The default implementations coming with the GNU C library are by default conservative and do not use unsafe data. This might be very costly in some situations, especially when the databases @@ -22,11 +22,11 @@ Some modules allow the system administrator to request taking shortcuts if these are known to be safe. It is then the system administrator's responsibility to ensure the assumption is correct. -.PP +.P There are other modules where the implementation changed over time. If an implementation used to sacrifice speed for memory consumption, it might create problems if the preference is switched. -.PP +.P The .I /etc/default/nss file contains a number of variable assignments. @@ -35,7 +35,7 @@ NSS modules. White spaces are ignored. Lines beginning with \[aq]#\[aq] are treated as comments. -.PP +.P The variables currently recognized are: .TP \fBNETID_AUTHORITATIVE =\fR \fITRUE\fR|\fIFALSE\fR @@ -86,7 +86,7 @@ the next entry. \fI/etc/default/nss\fR .SH EXAMPLES The default configuration corresponds to the following configuration file: -.PP +.P .in +4n .EX NETID_AUTHORITATIVE=FALSE diff --git a/upstream/opensuse-tumbleweed/man5/nsswitch.conf.5 b/upstream/opensuse-tumbleweed/man5/nsswitch.conf.5 index 49b288ef..b394cf42 100644 --- a/upstream/opensuse-tumbleweed/man5/nsswitch.conf.5 +++ b/upstream/opensuse-tumbleweed/man5/nsswitch.conf.5 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: GPL-2.0-or-later .\" -.TH nsswitch.conf 5 2023-05-03 "Linux man-pages 6.05.01" +.TH nsswitch.conf 5 2024-05-02 "Linux man-pages (unreleased)" .SH NAME nsswitch.conf \- Name Service Switch configuration file .SH DESCRIPTION @@ -14,13 +14,13 @@ the sources from which to obtain name-service information in a range of categories, and in what order. Each category of information is identified by a database name. -.PP +.P The file is plain ASCII text, with columns separated by spaces or tab characters. The first column specifies the database name. The remaining columns describe the order of sources to query and a limited set of actions that can be performed by lookup result. -.PP +.P The following databases are understood by the GNU C Library: .TP 12 .B aliases @@ -82,7 +82,7 @@ and related functions. Shadow user passwords, used by .BR getspnam (3) and related functions. -.PP +.P The GNU C Library ignores databases with unknown names. Some applications use this to implement special handling for their own databases. @@ -100,11 +100,11 @@ Refer to and .BR subgid (5) for more details. -.PP +.P Here is an example .I /etc/nsswitch.conf file: -.PP +.P .in +4n .EX passwd: compat @@ -119,7 +119,7 @@ rpc: nis [NOTFOUND=return] files services: nis [NOTFOUND=return] files .EE .in -.PP +.P The first column is the database name. The remaining columns specify: .IP \[bu] 3 @@ -129,7 +129,7 @@ those services will be queried, in turn, until a result is found. .IP \[bu] Optional actions to perform if a particular result is obtained from the preceding service, for example, "[NOTFOUND=return]". -.PP +.P The service specifications supported on your system depend on the presence of shared libraries, and are therefore extensible. Libraries called @@ -155,20 +155,20 @@ The version number may be 1 for glibc 2.0, or 2 for glibc 2.1 and later. On systems with additional libraries installed, you may have access to further services such as "hesiod", "ldap", "winbind", and "wins". -.PP +.P An action may also be specified following a service specification. The action modifies the behavior following a result obtained from the preceding data source. Action items take the general form: -.PP +.P .RS 4 .RI [ STATUS = ACTION ] .br .RI [! STATUS = ACTION ] .RE -.PP +.P where -.PP +.P .RS 4 .I STATUS => @@ -188,11 +188,11 @@ where | .B merge .RE -.PP +.P The ! negates the test, matching all possible results except the one specified. The case of the keywords is not significant. -.PP +.P The .I STATUS value is matched against the result of the lookup function called by @@ -220,7 +220,7 @@ This could mean a file is locked or a server currently cannot accept more connections. The default action for this condition is "continue". .RE -.PP +.P The .I ACTION value can be one of: @@ -261,7 +261,7 @@ additionally permits special entries in corresponding files for granting users or members of netgroups access to the system. The following entries are valid in this mode: .RS 4 -.PP +.P For .B passwd and @@ -291,7 +291,7 @@ Exclude all users in the given Include every user, except previously excluded ones, from the NIS passwd/shadow map. .RE -.PP +.P For .B group database: @@ -312,7 +312,7 @@ Include every group, except previously excluded ones, from the NIS group map. .RE .RE -.PP +.P By default, the source is "nis", but this may be overridden by specifying any NSS service except "compat" itself as the source for the pseudo-databases @@ -355,7 +355,7 @@ implements "nis" source. implements "nisplus" source. .PD .RE -.PP +.P The following files are read when "files" source is specified for respective databases: .RS 4 @@ -409,7 +409,7 @@ is automatically reloaded if the file is changed. In earlier versions, the entire file was read only once within each process. If the file was later changed, the process would continue using the old configuration. -.PP +.P Traditionally, there was only a single source for service information, often in the form of a single configuration file (e.g., \fI/etc/passwd\fP). diff --git a/upstream/opensuse-tumbleweed/man5/oomd.conf.5 b/upstream/opensuse-tumbleweed/man5/oomd.conf.5 index 50dcd263..35023c5b 100644 --- a/upstream/opensuse-tumbleweed/man5/oomd.conf.5 +++ b/upstream/opensuse-tumbleweed/man5/oomd.conf.5 @@ -1,5 +1,5 @@ '\" t -.TH "OOMD\&.CONF" "5" "" "systemd 254" "oomd.conf" +.TH "OOMD\&.CONF" "5" "" "systemd 255" "oomd.conf" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -80,6 +80,8 @@ will take action\&. If the fraction of memory used and the fraction of swap used \fBsystemd\-oomd\fR will act on eligible descendant control groups with swap usage greater than 5% of total swap, starting from the ones with the highest swap usage\&. Which control groups are monitored and what action gets taken depends on what the unit has configured for \fIManagedOOMSwap=\fR\&. Takes a value specified in percent (when suffixed with "%"), permille ("‰") or permyriad ("‱"), between 0% and 100%, inclusive\&. Defaults to 90%\&. +.sp +Added in version 247\&. .RE .PP \fIDefaultMemoryPressureLimit=\fR @@ -94,6 +96,8 @@ will act on eligible descendant control groups, starting from the ones with the \fIManagedOOMMemoryPressure=\fR\&. Takes a fraction specified in the same way as \fISwapUsedLimit=\fR above\&. Defaults to 60%\&. +.sp +Added in version 247\&. .RE .PP \fIDefaultMemoryPressureDurationSec=\fR @@ -104,6 +108,8 @@ will take action\&. Memory pressure limits are defined by \fIDefaultMemoryPressureLimit=\fR and \fIManagedOOMMemoryPressureLimit=\fR\&. Must be set to 0, or at least 1 second\&. Defaults to 30 seconds when unset or 0\&. +.sp +Added in version 248\&. .RE .SH "SEE ALSO" .PP diff --git a/upstream/opensuse-tumbleweed/man5/org.freedesktop.LogControl1.5 b/upstream/opensuse-tumbleweed/man5/org.freedesktop.LogControl1.5 index f2d4efd4..70733a8e 100644 --- a/upstream/opensuse-tumbleweed/man5/org.freedesktop.LogControl1.5 +++ b/upstream/opensuse-tumbleweed/man5/org.freedesktop.LogControl1.5 @@ -1,5 +1,5 @@ '\" t -.TH "ORG\&.FREEDESKTOP\&.LOGCONTROL1" "5" "" "systemd 254" "org.freedesktop.LogControl1" +.TH "ORG\&.FREEDESKTOP\&.LOGCONTROL1" "5" "" "systemd 255" "org.freedesktop.LogControl1" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/upstream/opensuse-tumbleweed/man5/org.freedesktop.home1.5 b/upstream/opensuse-tumbleweed/man5/org.freedesktop.home1.5 index af8c0744..b91e1d7e 100644 --- a/upstream/opensuse-tumbleweed/man5/org.freedesktop.home1.5 +++ b/upstream/opensuse-tumbleweed/man5/org.freedesktop.home1.5 @@ -1,5 +1,5 @@ '\" t -.TH "ORG\&.FREEDESKTOP\&.HOME1" "5" "" "systemd 254" "org.freedesktop.home1" +.TH "ORG\&.FREEDESKTOP\&.HOME1" "5" "" "systemd 255" "org.freedesktop.home1" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/upstream/opensuse-tumbleweed/man5/org.freedesktop.hostname1.5 b/upstream/opensuse-tumbleweed/man5/org.freedesktop.hostname1.5 index 48121d0c..b0d8da1f 100644 --- a/upstream/opensuse-tumbleweed/man5/org.freedesktop.hostname1.5 +++ b/upstream/opensuse-tumbleweed/man5/org.freedesktop.hostname1.5 @@ -1,5 +1,5 @@ '\" t -.TH "ORG\&.FREEDESKTOP\&.HOSTNAME1" "5" "" "systemd 254" "org.freedesktop.hostname1" +.TH "ORG\&.FREEDESKTOP\&.HOSTNAME1" "5" "" "systemd 255" "org.freedesktop.hostname1" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -89,6 +89,10 @@ node /org/freedesktop/hostname1 { readonly s FirmwareVendor = \*(Aq\&.\&.\&.\*(Aq; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const") readonly t FirmwareDate = \&.\&.\&.; + @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const") + readonly ay MachineID = [\&.\&.\&.]; + @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const") + readonly ay BootID = [\&.\&.\&.]; }; interface org\&.freedesktop\&.DBus\&.Peer { \&.\&.\&. }; interface org\&.freedesktop\&.DBus\&.Introspectable { \&.\&.\&. }; @@ -132,6 +136,8 @@ node /org/freedesktop/hostname1 { + + .PP Whenever the hostname or other metadata is changed via the daemon, \fBPropertyChanged\fR @@ -578,6 +584,22 @@ $ gdbus introspect \-\-system \e .PP David Zeuthen\*(Aqs original Fedora \m[blue]\fBFeature page about xdg\-hostname\fR\m[]\&\s-2\u[3]\d\s+2 +.SH "HISTORY" +.SS "The D\-Bus API" +.PP +\fIFirmwareVersion\fR +and +\fBGetHardwareSerial()\fR +were added in version 251\&. +.PP +\fIOperatingSystemSupportEnd\fR, +\fIFirmwareVendor\fR, and +\fIFirmwareDate\fR +were added in version 253\&. +.PP +\fIMachineID\fR, and +\fIBootID\fR +were added in version 256\&. .SH "NOTES" .IP " 1." 4 polkit diff --git a/upstream/opensuse-tumbleweed/man5/org.freedesktop.import1.5 b/upstream/opensuse-tumbleweed/man5/org.freedesktop.import1.5 index ec7b2da9..cbea124e 100644 --- a/upstream/opensuse-tumbleweed/man5/org.freedesktop.import1.5 +++ b/upstream/opensuse-tumbleweed/man5/org.freedesktop.import1.5 @@ -1,5 +1,5 @@ '\" t -.TH "ORG\&.FREEDESKTOP\&.IMPORT1" "5" "" "systemd 254" "org.freedesktop.import1" +.TH "ORG\&.FREEDESKTOP\&.IMPORT1" "5" "" "systemd 255" "org.freedesktop.import1" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/upstream/opensuse-tumbleweed/man5/org.freedesktop.locale1.5 b/upstream/opensuse-tumbleweed/man5/org.freedesktop.locale1.5 index 26731543..4644366b 100644 --- a/upstream/opensuse-tumbleweed/man5/org.freedesktop.locale1.5 +++ b/upstream/opensuse-tumbleweed/man5/org.freedesktop.locale1.5 @@ -1,5 +1,5 @@ '\" t -.TH "ORG\&.FREEDESKTOP\&.LOCALE1" "5" "" "systemd 254" "org.freedesktop.locale1" +.TH "ORG\&.FREEDESKTOP\&.LOCALE1" "5" "" "systemd 255" "org.freedesktop.locale1" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/upstream/opensuse-tumbleweed/man5/org.freedesktop.login1.5 b/upstream/opensuse-tumbleweed/man5/org.freedesktop.login1.5 index 7ab6ee14..135cb69b 100644 --- a/upstream/opensuse-tumbleweed/man5/org.freedesktop.login1.5 +++ b/upstream/opensuse-tumbleweed/man5/org.freedesktop.login1.5 @@ -1,5 +1,5 @@ '\" t -.TH "ORG\&.FREEDESKTOP\&.LOGIN1" "5" "" "systemd 254" "org.freedesktop.login1" +.TH "ORG\&.FREEDESKTOP\&.LOGIN1" "5" "" "systemd 255" "org.freedesktop.login1" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -77,6 +77,30 @@ node /org/freedesktop/login1 { out u vtnr, out b existing); @org\&.freedesktop\&.systemd1\&.Privileged("true") + CreateSessionWithPIDFD(in u uid, + in h pidfd, + in s service, + in s type, + in s class, + in s desktop, + in s seat_id, + in u vtnr, + in s tty, + in s display, + in b remote, + in s remote_user, + in s remote_host, + in t flags, + in a(sv) properties, + out s session_id, + out o object_path, + out s runtime_path, + out h fifo_fd, + out u uid, + out s seat_id, + out u vtnr, + out b existing); + @org\&.freedesktop\&.systemd1\&.Privileged("true") ReleaseSession(in s session_id); ActivateSession(in s session_id); ActivateSessionOnSeat(in s session_id, @@ -153,6 +177,8 @@ node /org/freedesktop/login1 { SeatRemoved(s seat_id, o object_path); PrepareForShutdown(b start); + PrepareForShutdownWithMetadata(b start, + a{sv} metadata); PrepareForSleep(b start); properties: @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") @@ -224,7 +250,6 @@ node /org/freedesktop/login1 { readonly (st) ScheduledShutdown = \&.\&.\&.; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") readonly b Docked = \&.\&.\&.; - @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") readonly b LidClosed = \&.\&.\&.; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") readonly b OnExternalPower = \&.\&.\&.; @@ -367,6 +392,8 @@ node /org/freedesktop/login1 { + + .SS "Methods" .PP \fBGetSession()\fR @@ -400,8 +427,8 @@ lists all currently active inhibitors\&. It returns an array of structures consi \fIpid\fR (process ID)\&. .PP -\fBCreateSession()\fR -and +\fBCreateSession()\fR, +\fBCreateSessionWithPIDFD()\fR, and \fBReleaseSession()\fR may be used to open or close login sessions\&. These calls should \fInever\fR @@ -491,9 +518,10 @@ to allow for extendability, defined as follows: .RS 4 .\} .nf -#define SD_LOGIND_ROOT_CHECK_INHIBITORS (UINT64_C(1) << 0) -#define SD_LOGIND_KEXEC_REBOOT (UINT64_C(1) << 1) -#define SD_LOGIND_SOFT_REBOOT (UINT64_C(1) << 2) +#define SD_LOGIND_ROOT_CHECK_INHIBITORS (UINT64_C(1) << 0) +#define SD_LOGIND_KEXEC_REBOOT (UINT64_C(1) << 1) +#define SD_LOGIND_SOFT_REBOOT (UINT64_C(1) << 2) +#define SD_LOGIND_SOFT_REBOOT_IF_NEXTROOT_SET_UP (UINT64_C(1) << 3) .fi .if n \{\ @@ -510,9 +538,16 @@ is 0 then these methods behave just like the versions without flags\&. When \fBRebootWithFlags()\fR performs a kexec reboot if kexec kernel is loaded\&. When \fBSD_LOGIND_SOFT_REBOOT\fR -(0x04) is set, then +(0x04) is set, or +\fBSD_LOGIND_SOFT_REBOOT_IF_NEXTROOT_SET_UP\fR +(0x08) is set and a new root file system has been set up on +"/run/nextroot/", then \fBRebootWithFlags()\fR performs a userspace reboot only\&. +\fBSD_LOGIND_SOFT_REBOOT_IF_NEXTROOT_SET_UP\fR +and +\fBSD_LOGIND_KEXEC_REBOOT\fR +can be combined, with soft\-reboot having precedence\&. .PP \fBSetRebootParameter()\fR sets a parameter for a subsequent reboot operation\&. See the description of @@ -627,13 +662,25 @@ The signals are sent each time a session is created or removed, a user logs in or out, or a seat is added or removed\&. They each contain the ID of the object plus the object path\&. .PP The -\fBPrepareForShutdown()\fR -and -\fBPrepareForSleep()\fR +\fBPrepareForShutdown\fR, +\fBPrepareForShutdownWithMetadata\fR, and +\fBPrepareForSleep\fR signals are sent right before (with the argument "true") or after (with the argument "false") the system goes down for reboot/poweroff and suspend/hibernate, respectively\&. This may be used by applications to save data on disk, release memory, or do other jobs that should be done shortly before shutdown/sleep, in conjunction with delay inhibitor locks\&. After completion of this work they should release their inhibition locks in order to not delay the operation any further\&. For more information see -\m[blue]\fBInhibitor Locks\fR\m[]\&\s-2\u[2]\d\s+2\&. +\m[blue]\fBInhibitor Locks\fR\m[]\&\s-2\u[2]\d\s+2\&. The +\fBPrepareForShutdownWithMetadata()\fR +signal additionally sends a list of key/value pair metadata fields\&. Currently it sends a +\fItype\fR +string which defines the type of shutdown\&. The type can be one of +"power\-off", +"reboot", +"halt", +"kexec" +or +"soft\-reboot"\&. This signal is sent first, followed by +\fBPrepareForShutdown\fR +(for backward compatibility)\&. .SS "Properties" .PP Most properties simply reflect the configuration, see @@ -1555,6 +1602,30 @@ $ busctl introspect org\&.freedesktop\&.login1 /org/freedesktop/login1/session/4 .PP These D\-Bus interfaces follow \m[blue]\fBthe usual interface versioning guidelines\fR\m[]\&\s-2\u[4]\d\s+2\&. +.SH "HISTORY" +.SS "The Manager Object" +.PP +\fIHandlePowerKeyLongPress\fR, +\fIHandleRebootKey\fR, +\fIHandleRebootKeyLongPress\fR, +\fIHandleSuspendKeyLongPress\fR, and +\fIHandleHibernateKeyLongPress\fR +were added in version 251\&. +.PP +\fIStopIdleSessionUSec\fR +was added in version 252\&. +.PP +\fBPrepareForShutdownWithMetadata\fR +and +\fBCreateSessionWithPIDFD()\fR +were added in version 255\&. +.SS "Session Objects" +.PP +\fBSetDisplay()\fR +was added in version 252\&. +.PP +\fBSetTTY()\fR +was added in version 254\&. .SH "NOTES" .IP " 1." 4 polkit diff --git a/upstream/opensuse-tumbleweed/man5/org.freedesktop.machine1.5 b/upstream/opensuse-tumbleweed/man5/org.freedesktop.machine1.5 index 5af9868e..a63a4960 100644 --- a/upstream/opensuse-tumbleweed/man5/org.freedesktop.machine1.5 +++ b/upstream/opensuse-tumbleweed/man5/org.freedesktop.machine1.5 @@ -1,5 +1,5 @@ '\" t -.TH "ORG\&.FREEDESKTOP\&.MACHINE1" "5" "" "systemd 254" "org.freedesktop.machine1" +.TH "ORG\&.FREEDESKTOP\&.MACHINE1" "5" "" "systemd 255" "org.freedesktop.machine1" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -561,6 +561,19 @@ $ gdbus introspect \-\-system \e .PP These D\-Bus interfaces follow \m[blue]\fBthe usual interface versioning guidelines\fR\m[]\&\s-2\u[2]\d\s+2\&. +.SH "HISTORY" +.SS "The Manager Object" +.PP +\fBCopyFromMachineWithFlags()\fR +and +\fBCopyToMachineWithFlags()\fR +were added in version 252\&. +.SS "Machine Objects" +.PP +\fBCopyFromWithFlags()\fR +and +\fBCopyToWithFlags()\fR +were added in version 252\&. .SH "NOTES" .IP " 1." 4 New Control Group Interfaces diff --git a/upstream/opensuse-tumbleweed/man5/org.freedesktop.network1.5 b/upstream/opensuse-tumbleweed/man5/org.freedesktop.network1.5 index a914388e..46092e21 100644 --- a/upstream/opensuse-tumbleweed/man5/org.freedesktop.network1.5 +++ b/upstream/opensuse-tumbleweed/man5/org.freedesktop.network1.5 @@ -1,5 +1,5 @@ '\" t -.TH "ORG\&.FREEDESKTOP\&.NETWORK1" "5" "" "systemd 254" "org.freedesktop.network1" +.TH "ORG\&.FREEDESKTOP\&.NETWORK1" "5" "" "systemd 255" "org.freedesktop.network1" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -162,7 +162,6 @@ node /org/freedesktop/network1/link/_1 { interface org\&.freedesktop\&.DBus\&.Peer { \&.\&.\&. }; interface org\&.freedesktop\&.DBus\&.Introspectable { \&.\&.\&. }; interface org\&.freedesktop\&.DBus\&.Properties { \&.\&.\&. }; - interface org\&.freedesktop\&.network1\&.DHCPServer { \&.\&.\&. }; }; .fi @@ -195,8 +194,6 @@ node /org/freedesktop/network1/link/_1 { - - .PP Provides information about interfaces\&. .SH "NETWORK OBJECT" @@ -257,6 +254,7 @@ node /org/freedesktop/network1/link/_1 { interface org\&.freedesktop\&.DBus\&.Peer { \&.\&.\&. }; interface org\&.freedesktop\&.DBus\&.Introspectable { \&.\&.\&. }; interface org\&.freedesktop\&.DBus\&.Properties { \&.\&.\&. }; + interface org\&.freedesktop\&.network1\&.Link { \&.\&.\&. }; }; .fi @@ -266,8 +264,66 @@ node /org/freedesktop/network1/link/_1 { .sp + + .PP Provides information about leases\&. +.SH "DHCPV4 CLIENT OBJECT" +.sp +.if n \{\ +.RS 4 +.\} +.nf +node /org/freedesktop/network1/link/_1 { + interface org\&.freedesktop\&.network1\&.DHCPv4Client { + properties: + readonly s State = \*(Aq\&.\&.\&.\*(Aq; + }; + interface org\&.freedesktop\&.DBus\&.Peer { \&.\&.\&. }; + interface org\&.freedesktop\&.DBus\&.Introspectable { \&.\&.\&. }; + interface org\&.freedesktop\&.DBus\&.Properties { \&.\&.\&. }; + interface org\&.freedesktop\&.network1\&.Link { \&.\&.\&. }; +}; + +.fi +.if n \{\ +.RE +.\} +.sp + + + + +.PP +Provides information about DHCPv4 client status\&. +.SH "DHCPV6 CLIENT OBJECT" +.sp +.if n \{\ +.RS 4 +.\} +.nf +node /org/freedesktop/network1/link/_1 { + interface org\&.freedesktop\&.network1\&.DHCPv6Client { + properties: + readonly s State = \*(Aq\&.\&.\&.\*(Aq; + }; + interface org\&.freedesktop\&.DBus\&.Peer { \&.\&.\&. }; + interface org\&.freedesktop\&.DBus\&.Introspectable { \&.\&.\&. }; + interface org\&.freedesktop\&.DBus\&.Properties { \&.\&.\&. }; + interface org\&.freedesktop\&.network1\&.Link { \&.\&.\&. }; +}; + +.fi +.if n \{\ +.RE +.\} +.sp + + + + +.PP +Provides information about DHCPv6 client status\&. .SH "EXAMPLES" .PP \fBExample\ \&1.\ \&Introspect org\&.freedesktop\&.network1\&.Manager on the bus\fR @@ -303,6 +359,15 @@ $ gdbus introspect \-\-system \e .PP These D\-Bus interfaces follow \m[blue]\fBthe usual interface versioning guidelines\fR\m[]\&\s-2\u[1]\d\s+2\&. +.SH "HISTORY" +.SS "DHCPv4 Client Object" +.PP +\fIState\fR +was added in version 255\&. +.SS "DHCPv6 Client Object" +.PP +\fIState\fR +was added in version 255\&. .SH "NOTES" .IP " 1." 4 the usual interface versioning guidelines diff --git a/upstream/opensuse-tumbleweed/man5/org.freedesktop.oom1.5 b/upstream/opensuse-tumbleweed/man5/org.freedesktop.oom1.5 index 2116c5a5..85840abb 100644 --- a/upstream/opensuse-tumbleweed/man5/org.freedesktop.oom1.5 +++ b/upstream/opensuse-tumbleweed/man5/org.freedesktop.oom1.5 @@ -1,5 +1,5 @@ '\" t -.TH "ORG\&.FREEDESKTOP\&.OOM1" "5" "" "systemd 254" "org.freedesktop.oom1" +.TH "ORG\&.FREEDESKTOP\&.OOM1" "5" "" "systemd 255" "org.freedesktop.oom1" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -92,6 +92,11 @@ T} .PP These D\-Bus interfaces follow \m[blue]\fBthe usual interface versioning guidelines\fR\m[]\&\s-2\u[1]\d\s+2\&. +.SH "HISTORY" +.SS "The Manager Object" +.PP +\fBKilled\fR +was added in version 252\&. .SH "NOTES" .IP " 1." 4 the usual interface versioning guidelines diff --git a/upstream/opensuse-tumbleweed/man5/org.freedesktop.portable1.5 b/upstream/opensuse-tumbleweed/man5/org.freedesktop.portable1.5 index a7d9566a..3ecf21a7 100644 --- a/upstream/opensuse-tumbleweed/man5/org.freedesktop.portable1.5 +++ b/upstream/opensuse-tumbleweed/man5/org.freedesktop.portable1.5 @@ -1,5 +1,5 @@ '\" t -.TH "ORG\&.FREEDESKTOP\&.PORTABLE1" "5" "" "systemd 254" "org.freedesktop.portable1" +.TH "ORG\&.FREEDESKTOP\&.PORTABLE1" "5" "" "systemd 255" "org.freedesktop.portable1" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -336,7 +336,7 @@ write mkdir .RE .sp -Note that an image cannot be attached if a unit that it contains is already present on the system\&. +Note that an image cannot be attached if a unit that it contains is already present on the system\&. Note that this method returns only after all the listed operations are completed, and due to the I/O involved it might take some time\&. .PP \fBAttachImageWithExtensions()\fR attaches a portable image to the system\&. This method is a superset of @@ -364,7 +364,7 @@ detaches a portable image from the system\&. This method takes an image path or unlink .RE .sp -Note that an image cannot be detached if a unit that it contains is running\&. +Note that an image cannot be detached if a unit that it contains is running\&. Note that this method returns only after all the listed operations are completed, and due to the I/O involved it might take some time\&. .PP \fBDetachImageWithExtensions()\fR detaches a portable image from the system\&. This method is a superset of @@ -418,19 +418,19 @@ and \fBReattachImageWithExtensions()\fR methods take in options as flags instead of booleans to allow for extendability\&. \fISD_SYSTEMD_PORTABLE_FORCE_ATTACH\fR -will cause safety checks that ensure the units are not running while the new image is attached or detached to be skipped\&. -\fISD_SYSTEMD_PORTABLE_FORCE_SYSEXT\fR -will cause the check that the +will bypass the safety checks that ensure the units are not running while the image is attached or detached\&. +\fISD_SYSTEMD_PORTABLE_FORCE_EXTENSION\fR +will bypass the check that ensures the extension\-release\&.\fINAME\fR -file in the extension image matches the image name to be skipped\&. They are defined as follows: +file in the extension image matches the image name\&. They are defined as follows: .sp .if n \{\ .RS 4 .\} .nf -#define SD_SYSTEMD_PORTABLE_RUNTIME (UINT64_C(1) << 0) -#define SD_SYSTEMD_PORTABLE_FORCE_ATTACH (UINT64_C(1) << 1) -#define SD_SYSTEMD_PORTABLE_FORCE_SYSEXT (UINT64_C(1) << 2) +#define SD_SYSTEMD_PORTABLE_RUNTIME (UINT64_C(1) << 0) +#define SD_SYSTEMD_PORTABLE_FORCE_ATTACH (UINT64_C(1) << 1) +#define SD_SYSTEMD_PORTABLE_FORCE_EXTENSION (UINT64_C(1) << 2) .fi .if n \{\ @@ -749,6 +749,18 @@ specifies the image disk usage limit (exclusive)\&. .PP These D\-Bus interfaces follow \m[blue]\fBthe usual interface versioning guidelines\fR\m[]\&\s-2\u[1]\d\s+2\&. +.SH "HISTORY" +.SS "The Manager Object" +.PP +\fBGetImageStateWithExtensions()\fR +was added in version 251\&. +.SS "The Image Object" +.PP +\fBGetStateWithExtensions()\fR +was added in version 251\&. +.PP +\fBReattachWithExtensions()\fR +was added in version 254\&. .SH "NOTES" .IP " 1." 4 the usual interface versioning guidelines diff --git a/upstream/opensuse-tumbleweed/man5/org.freedesktop.resolve1.5 b/upstream/opensuse-tumbleweed/man5/org.freedesktop.resolve1.5 index 7810193a..2046567f 100644 --- a/upstream/opensuse-tumbleweed/man5/org.freedesktop.resolve1.5 +++ b/upstream/opensuse-tumbleweed/man5/org.freedesktop.resolve1.5 @@ -1,5 +1,5 @@ '\" t -.TH "ORG\&.FREEDESKTOP\&.RESOLVE1" "5" "" "systemd 254" "org.freedesktop.resolve1" +.TH "ORG\&.FREEDESKTOP\&.RESOLVE1" "5" "" "systemd 255" "org.freedesktop.resolve1" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -420,6 +420,32 @@ set) so that all settings take effect during the full time the network interface The \fBRevertLink()\fR method may be used to revert all per\-link settings described above to the defaults\&. +.PP +The +\fBFlushCaches()\fR +flushes all resource record caches maintained by the resolver, and ensures that any subsequent lookups re\-request their responses from their sources\&. +.PP +The +\fBResetServerFeatures()\fR +flushes any feature information learned about remote DNS servers\&. This ensures that subsequent lookups will be initially attempted at the highest DNS protocol feature level again, possibly requiring a (potentially slow) downgrade cycle to recognize the supported feature level again\&. +.PP +The +\fBRegisterService()\fR +method may be used to register a DNS\-SD service on the host\&. This functionality is closely related to the functionality provided by +\fBsystemd.dnssd\fR(5) +files\&. It takes a server identifier string as first parameter (this is jus a local identifier, and should be chosen so that it neither collides with the basename of +*\&.dnssd +files nor with names chosen by other IPC clients)\&. It also takes a name template string for the DNS\-SD service name visible on the network\&. This string is subject to specifier expansation, as documented for the +\fIName=\fR +setting in +*\&.dnssd +files\&. It also takes a service type string containing the DNS\-SD service type, as well as an IP port, a priority/weight pair for the DNS\-SD SRV record\&. Finally, it takes an array of TXT record data\&. It returns an object path which may be used as handle to the registered service\&. +.PP +The +\fBUnregisterService()\fR +method undoes the effect of +\fBRegisterService()\fR +and deletes a DNS\-SD service previously created via IPC again\&. .sp .it 1 an-trap .nr an-no-space-flag 1 @@ -646,6 +672,10 @@ property reports whether the stub listener on port 53 is enabled\&. Possible val (only the UDP listener is enabled), and "tcp" (only the TCP listener is enabled)\&. +.PP +The +\fIDNSSECNegativeTrustAnchors\fR +property contains a list of recognized DNSSEC negative trust anchors and contains a list of domains\&. .SH "LINK OBJECT" .sp .if n \{\ @@ -781,26 +811,36 @@ interface) may return some of the following errors: \fBorg\&.freedesktop\&.resolve1\&.NoNameServers\fR .RS 4 No suitable DNS servers were found to resolve a request\&. +.sp +Added in version 246\&. .RE .PP \fBorg\&.freedesktop\&.resolve1\&.InvalidReply\fR .RS 4 A response from the selected DNS server was not understood\&. +.sp +Added in version 246\&. .RE .PP \fBorg\&.freedesktop\&.resolve1\&.NoSuchRR\fR .RS 4 The requested name exists, but there is no resource record of the requested type for it\&. (This is the DNS NODATA case)\&. +.sp +Added in version 246\&. .RE .PP \fBorg\&.freedesktop\&.resolve1\&.CNameLoop\fR .RS 4 The look\-up failed because a CNAME or DNAME loop was detected\&. +.sp +Added in version 246\&. .RE .PP \fBorg\&.freedesktop\&.resolve1\&.Aborted\fR .RS 4 The look\-up was aborted because the selected protocol became unavailable while the operation was ongoing\&. +.sp +Added in version 246\&. .RE .PP \fBorg\&.freedesktop\&.resolve1\&.NoSuchService\fR @@ -808,43 +848,59 @@ The look\-up was aborted because the selected protocol became unavailable while A service look\-up was successful, but the \fBSRV\fR record reported that the service is not available\&. +.sp +Added in version 246\&. .RE .PP \fBorg\&.freedesktop\&.resolve1\&.DnssecFailed\fR .RS 4 The acquired response did not pass DNSSEC validation\&. +.sp +Added in version 246\&. .RE .PP \fBorg\&.freedesktop\&.resolve1\&.NoTrustAnchor\fR .RS 4 No chain of trust could be established for the response to a configured DNSSEC trust anchor\&. +.sp +Added in version 246\&. .RE .PP \fBorg\&.freedesktop\&.resolve1\&.ResourceRecordTypeUnsupported\fR .RS 4 The requested resource record type is not supported on the selected DNS servers\&. This error is generated for example when an RRSIG record is requested from a DNS server that does not support DNSSEC\&. +.sp +Added in version 246\&. .RE .PP \fBorg\&.freedesktop\&.resolve1\&.NoSuchLink\fR .RS 4 No network interface with the specified network interface index exists\&. +.sp +Added in version 246\&. .RE .PP \fBorg\&.freedesktop\&.resolve1\&.LinkBusy\fR .RS 4 The requested configuration change could not be made because \fBsystemd-networkd\fR(8), already took possession of the interface and supplied configuration data for it\&. +.sp +Added in version 246\&. .RE .PP \fBorg\&.freedesktop\&.resolve1\&.NetworkDown\fR .RS 4 The requested look\-up failed because the system is currently not connected to any suitable network\&. +.sp +Added in version 246\&. .RE .PP \fBorg\&.freedesktop\&.resolve1\&.DnsError\&.NXDOMAIN\fR, \fBorg\&.freedesktop\&.resolve1\&.DnsError\&.REFUSED\fR, \&.\&.\&. .RS 4 The look\-up failed with a DNS return code reporting a failure\&. The error names used as suffixes here are defined in by IANA in \m[blue]\fBDNS\ \&RCODEs\fR\m[]\&\s-2\u[4]\d\s+2\&. +.sp +Added in version 246\&. .RE .SH "EXAMPLES" .PP diff --git a/upstream/opensuse-tumbleweed/man5/org.freedesktop.systemd1.5 b/upstream/opensuse-tumbleweed/man5/org.freedesktop.systemd1.5 index bb669b05..fc2f901e 100644 --- a/upstream/opensuse-tumbleweed/man5/org.freedesktop.systemd1.5 +++ b/upstream/opensuse-tumbleweed/man5/org.freedesktop.systemd1.5 @@ -1,5 +1,5 @@ '\" t -.TH "ORG\&.FREEDESKTOP\&.SYSTEMD1" "5" "" "systemd 254" "org.freedesktop.systemd1" +.TH "ORG\&.FREEDESKTOP\&.SYSTEMD1" "5" "" "systemd 255" "org.freedesktop.systemd1" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -807,7 +807,13 @@ enqueues a start job and possibly depending jobs\&. It takes the unit to activat "fail", the method will start the unit and its dependencies, but will fail if this would change an already queued job\&. If "isolate", the method will start the unit in question and terminate all units that aren\*(Aqt dependencies of it\&. If "ignore\-dependencies", it will start a unit but ignore all its dependencies\&. If -"ignore\-requirements", it will start a unit but only ignore the requirement dependencies\&. It is not recommended to make use of the latter two options\&. On completion, this method returns the newly created job object\&. +"ignore\-requirements", it will start a unit but only ignore the requirement dependencies\&. It is not recommended to make use of the latter two options\&. On reply, if successful, this method returns the newly created job object which has been enqueued for asynchronous activation\&. Callers that want to track the outcome of the actual start operation need to monitor the result of this job\&. This can be achieved in a race\-free manner by first subscribing to the +\fBJobRemoved()\fR +signal, then calling +\fBStartUnit()\fR +and using the returned job object to filter out unrelated +\fBJobRemoved()\fR +signals, until the desired one is received, which will then carry the result of the start operation\&. .PP \fBStartUnitReplace()\fR is similar to @@ -846,10 +852,10 @@ or for the marked units\&. .PP \fBBindMountUnit()\fR -can be used to bind mount new files or directories into a running service mount namespace\&. +can be used to bind mount new files or directories into a running service mount namespace\&. If supported by the kernel, any prior mount on the selected target will be replaced by the new mount\&. If not supported, any prior mount will be over\-mounted, but remain pinned and inaccessible\&. .PP \fBMountImageUnit()\fR -can be used to mount new images into a running service mount namespace\&. +can be used to mount new images into a running service mount namespace\&. If supported by the kernel, any prior mount on the selected target will be replaced by the new mount\&. If not supported, any prior mount will be over\-mounted, but remain pinned and inaccessible\&. .PP \fBKillUnit()\fR may be used to kill (i\&.e\&. send a signal to) all processes of a unit\&. It takes the unit @@ -1358,16 +1364,6 @@ encodes the features that have been enabled and disabled for this build\&. Enabl \fITainted\fR encodes taint flags as a colon\-separated list\&. When systemd detects it is running on a system with a certain problem, it will set an appropriate taint flag\&. Taints may be used to lower the chance of bogus bug reports\&. The following taints are currently known: .PP -"split\-usr" -.RS 4 -/usr/ -was not available when systemd was first invoked\&. It must either be part of the root file system, or it must be mounted before -\fBsystemd\fR -is invoked\&. See -\m[blue]\fBBooting Without /usr is Broken\fR\m[]\&\s-2\u[3]\d\s+2 -for details why this is bad\&. -.RE -.PP "unmerged\-usr" .RS 4 /bin, @@ -1376,22 +1372,30 @@ and /lib* are not symlinks to their counterparts under /usr/\&. For more information on this issue consult -\m[blue]\fBThe Case for the /usr Merge\fR\m[]\&\s-2\u[4]\d\s+2\&. +\m[blue]\fBThe Case for the /usr Merge\fR\m[]\&\s-2\u[3]\d\s+2\&. +.sp +Added in version 252\&. .RE .PP "cgroups\-missing" .RS 4 Support for cgroups is unavailable\&. +.sp +Added in version 252\&. .RE .PP "cgroupsv1" .RS 4 The system is using the old cgroup hierarchy\&. +.sp +Added in version 252\&. .RE .PP "local\-hwclock" .RS 4 The local hardware clock (RTC) is configured to be in local time rather than UTC\&. +.sp +Added in version 252\&. .RE .PP "support\-ended" @@ -1400,11 +1404,15 @@ The system is running past the end of support declared by the vendor\&. See the \fISUPPORT_END=\fR in \fBos-release\fR(5)\&. +.sp +Added in version 252\&. .RE .PP "old\-kernel" .RS 4 The system is running a kernel version that is older than the minimum supported by this version of systemd\&. +.sp +Added in version 252\&. .RE .PP "var\-run\-bad" @@ -1414,16 +1422,22 @@ does not exist or /var/run is not a symlink to /run/\&. +.sp +Added in version 252\&. .RE .PP "overflowuid\-not\-65534", "overflowgid\-not\-65534" .RS 4 The kernel overflow UID or GID have a value other than 65534\&. +.sp +Added in version 252\&. .RE .PP "short\-uid\-range", "short\-gid\-range" .RS 4 The UID or GID range assigned to the running systemd instance covers less than 0\&...65534\&. +.sp +Added in version 252\&. .RE .PP \fIFirmwareTimestamp\fR, @@ -1519,6 +1533,43 @@ easily\&. This value will be set to the empty string for the host instance and s .PP \fIAccessSELinuxContext\fR contains the SELinux context that is used to control access to the unit\&. It\*(Aqs read from the unit file when it is loaded and cached until the service manager is reloaded\&. This property contains an empty string if SELinux is not used or if no label could be read (for example because the unit is not backed by a file on disk)\&. +.PP +\fISystemState\fR +contains the current state of the system manager\&. The possible values are: +.PP +"initializing" +.RS 4 +The system is booting, and +basic\&.target +has not been reached yet\&. +.RE +.PP +"starting" +.RS 4 +The system is booting, and +basic\&.target +has been reached\&. +.RE +.PP +"running" +.RS 4 +The system has finished booting, and no units are in the failed state\&. +.RE +.PP +"degraded" +.RS 4 +The system has finished booting, but some units are in the failed state\&. +.RE +.PP +"maintenance" +.RS 4 +The system has finished booting, but it has been put in rescue or maintenance mode\&. +.RE +.PP +"stopping" +.RS 4 +The system is shutting down\&. +.RE .SS "Security" .PP Read access is generally granted to all clients\&. Additionally, for unprivileged clients, some operations are allowed through the polkit privilege system\&. Operations which modify unit state (\fBStartUnit()\fR, @@ -1711,6 +1762,8 @@ node /org/freedesktop/systemd1/unit/avahi_2ddaemon_2eservice { @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const") readonly b DefaultDependencies = \&.\&.\&.; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const") + readonly b SurviveFinalKillSignal = \&.\&.\&.; + @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const") readonly s OnSuccessJobMode = \*(Aq\&.\&.\&.\*(Aq; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const") readonly s OnFailureJobMode = \*(Aq\&.\&.\&.\*(Aq; @@ -1892,6 +1945,7 @@ node /org/freedesktop/systemd1/unit/avahi_2ddaemon_2eservice { + .SS "Methods" .PP \fBStart()\fR, @@ -2308,6 +2362,14 @@ node /org/freedesktop/systemd1/unit/avahi_2ddaemon_2eservice { @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") readonly t MemoryCurrent = \&.\&.\&.; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") + readonly t MemoryPeak = \&.\&.\&.; + @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") + readonly t MemorySwapCurrent = \&.\&.\&.; + @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") + readonly t MemorySwapPeak = \&.\&.\&.; + @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") + readonly t MemoryZSwapCurrent = \&.\&.\&.; + @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") readonly t MemoryAvailable = \&.\&.\&.; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") readonly t EffectiveMemoryMax = \&.\&.\&.; @@ -2469,6 +2531,10 @@ node /org/freedesktop/systemd1/unit/avahi_2ddaemon_2eservice { readonly s MemoryPressureWatch = \*(Aq\&.\&.\&.\*(Aq; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") readonly t MemoryPressureThresholdUSec = \&.\&.\&.; + @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") + readonly a(iiss) NFTSet = [\&.\&.\&.]; + @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") + readonly b CoredumpReceive = \&.\&.\&.; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const") readonly as Environment = [\*(Aq\&.\&.\&.\*(Aq, \&.\&.\&.]; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const") @@ -2658,6 +2724,8 @@ node /org/freedesktop/systemd1/unit/avahi_2ddaemon_2eservice { @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const") readonly b DynamicUser = \&.\&.\&.; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const") + readonly b SetLoginEnvironment = \&.\&.\&.; + @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const") readonly b RemoveIPC = \&.\&.\&.; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const") readonly a(say) SetCredential = [\&.\&.\&.]; @@ -3176,6 +3244,13 @@ node /org/freedesktop/systemd1/unit/avahi_2ddaemon_2eservice { + + + + + + + .SS "Methods" .PP \fBBindMount()\fR @@ -3305,11 +3380,13 @@ The following properties map 1:1 to corresponding settings in the unit file: see systemd\&.exec(5) for their meaning\&. .PP \fIMemoryAvailable\fR -indicates how much unused memory is available to the unit before the +takes into account unit\*(Aqs and parents\*(Aq "MemoryMax" or "MemoryHigh" -(whichever is lower) limit set by the cgroup memory controller is reached\&. It will take into consideration limits on all parent slices, other than the limits set on the unit itself\&. +or physically available RAM versus given level\*(Aqs memory consumption and takes minimum\&. Beware that other units below the tightest parent slice may consume the memory quicker and less than reported value would remain for own allocation\&. It works better in conjunction with +\fIMemoryAccounting=yes\fR +on involved units\&. .PP \fIDelegateSubgroup\fR contains the cgroup subgroup to place invoked unit processes in\&. As configured by the option of the same name in unit files\&. This is set to the empty string when it does not apply or no subgroup has been configured\&. @@ -3442,6 +3519,10 @@ node /org/freedesktop/systemd1/unit/avahi_2ddaemon_2esocket { readonly t TriggerLimitIntervalUSec = \&.\&.\&.; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const") readonly u TriggerLimitBurst = \&.\&.\&.; + @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const") + readonly t PollLimitIntervalUSec = \&.\&.\&.; + @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const") + readonly u PollLimitBurst = \&.\&.\&.; readonly u UID = \&.\&.\&.; readonly u GID = \&.\&.\&.; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("invalidates") @@ -3461,6 +3542,14 @@ node /org/freedesktop/systemd1/unit/avahi_2ddaemon_2esocket { @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") readonly t MemoryCurrent = \&.\&.\&.; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") + readonly t MemoryPeak = \&.\&.\&.; + @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") + readonly t MemorySwapCurrent = \&.\&.\&.; + @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") + readonly t MemorySwapPeak = \&.\&.\&.; + @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") + readonly t MemoryZSwapCurrent = \&.\&.\&.; + @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") readonly t MemoryAvailable = \&.\&.\&.; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") readonly t EffectiveMemoryMax = \&.\&.\&.; @@ -3622,6 +3711,10 @@ node /org/freedesktop/systemd1/unit/avahi_2ddaemon_2esocket { readonly s MemoryPressureWatch = \*(Aq\&.\&.\&.\*(Aq; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") readonly t MemoryPressureThresholdUSec = \&.\&.\&.; + @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") + readonly a(iiss) NFTSet = [\&.\&.\&.]; + @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") + readonly b CoredumpReceive = \&.\&.\&.; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const") readonly as Environment = [\*(Aq\&.\&.\&.\*(Aq, \&.\&.\&.]; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const") @@ -3811,6 +3904,8 @@ node /org/freedesktop/systemd1/unit/avahi_2ddaemon_2esocket { @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const") readonly b DynamicUser = \&.\&.\&.; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const") + readonly b SetLoginEnvironment = \&.\&.\&.; + @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const") readonly b RemoveIPC = \&.\&.\&.; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const") readonly a(say) SetCredential = [\&.\&.\&.]; @@ -3991,6 +4086,8 @@ node /org/freedesktop/systemd1/unit/avahi_2ddaemon_2esocket { .if n \{\ .RE .\} +.sp + @@ -4318,6 +4415,17 @@ node /org/freedesktop/systemd1/unit/avahi_2ddaemon_2esocket { + + + + + + + + +.PP +\fIPollLimitIntervalUSec\fR/\fIPollLimitBurst\fR +properties configure the polling limit for the socket unit\&. Expects a time in \(mcs, resp\&. an unsigned integer\&. If either is set to zero the limiting feature is turned off\&. .SS "Properties" .PP Most of the properties map directly to the corresponding settings in socket unit files\&. As socket units can include @@ -4474,6 +4582,14 @@ node /org/freedesktop/systemd1/unit/home_2emount { @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") readonly t MemoryCurrent = \&.\&.\&.; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") + readonly t MemoryPeak = \&.\&.\&.; + @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") + readonly t MemorySwapCurrent = \&.\&.\&.; + @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") + readonly t MemorySwapPeak = \&.\&.\&.; + @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") + readonly t MemoryZSwapCurrent = \&.\&.\&.; + @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") readonly t MemoryAvailable = \&.\&.\&.; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") readonly t EffectiveMemoryMax = \&.\&.\&.; @@ -4635,6 +4751,10 @@ node /org/freedesktop/systemd1/unit/home_2emount { readonly s MemoryPressureWatch = \*(Aq\&.\&.\&.\*(Aq; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") readonly t MemoryPressureThresholdUSec = \&.\&.\&.; + @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") + readonly a(iiss) NFTSet = [\&.\&.\&.]; + @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") + readonly b CoredumpReceive = \&.\&.\&.; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const") readonly as Environment = [\*(Aq\&.\&.\&.\*(Aq, \&.\&.\&.]; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const") @@ -4824,6 +4944,8 @@ node /org/freedesktop/systemd1/unit/home_2emount { @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const") readonly b DynamicUser = \&.\&.\&.; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const") + readonly b SetLoginEnvironment = \&.\&.\&.; + @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const") readonly b RemoveIPC = \&.\&.\&.; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const") readonly a(say) SetCredential = [\&.\&.\&.]; @@ -5290,6 +5412,13 @@ node /org/freedesktop/systemd1/unit/home_2emount { + + + + + + + .SS "Properties" .PP Most of the properties map directly to the corresponding settings in mount unit files\&. As mount units invoke the @@ -5520,6 +5649,14 @@ node /org/freedesktop/systemd1/unit/dev_2dsda3_2eswap { @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") readonly t MemoryCurrent = \&.\&.\&.; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") + readonly t MemoryPeak = \&.\&.\&.; + @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") + readonly t MemorySwapCurrent = \&.\&.\&.; + @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") + readonly t MemorySwapPeak = \&.\&.\&.; + @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") + readonly t MemoryZSwapCurrent = \&.\&.\&.; + @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") readonly t MemoryAvailable = \&.\&.\&.; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") readonly t EffectiveMemoryMax = \&.\&.\&.; @@ -5681,6 +5818,10 @@ node /org/freedesktop/systemd1/unit/dev_2dsda3_2eswap { readonly s MemoryPressureWatch = \*(Aq\&.\&.\&.\*(Aq; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") readonly t MemoryPressureThresholdUSec = \&.\&.\&.; + @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") + readonly a(iiss) NFTSet = [\&.\&.\&.]; + @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") + readonly b CoredumpReceive = \&.\&.\&.; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const") readonly as Environment = [\*(Aq\&.\&.\&.\*(Aq, \&.\&.\&.]; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const") @@ -5870,6 +6011,8 @@ node /org/freedesktop/systemd1/unit/dev_2dsda3_2eswap { @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const") readonly b DynamicUser = \&.\&.\&.; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const") + readonly b SetLoginEnvironment = \&.\&.\&.; + @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const") readonly b RemoveIPC = \&.\&.\&.; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const") readonly a(say) SetCredential = [\&.\&.\&.]; @@ -6329,6 +6472,13 @@ node /org/freedesktop/systemd1/unit/dev_2dsda3_2eswap { + + + + + + + .SS "Properties" .PP Most of the properties map directly to the corresponding settings in swap unit files\&. As mount units invoke the @@ -6445,6 +6595,14 @@ node /org/freedesktop/systemd1/unit/system_2eslice { @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") readonly t MemoryCurrent = \&.\&.\&.; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") + readonly t MemoryPeak = \&.\&.\&.; + @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") + readonly t MemorySwapCurrent = \&.\&.\&.; + @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") + readonly t MemorySwapPeak = \&.\&.\&.; + @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") + readonly t MemoryZSwapCurrent = \&.\&.\&.; + @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") readonly t MemoryAvailable = \&.\&.\&.; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") readonly t EffectiveMemoryMax = \&.\&.\&.; @@ -6606,6 +6764,10 @@ node /org/freedesktop/systemd1/unit/system_2eslice { readonly s MemoryPressureWatch = \*(Aq\&.\&.\&.\*(Aq; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") readonly t MemoryPressureThresholdUSec = \&.\&.\&.; + @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") + readonly a(iiss) NFTSet = [\&.\&.\&.]; + @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") + readonly b CoredumpReceive = \&.\&.\&.; }; interface org\&.freedesktop\&.DBus\&.Peer { \&.\&.\&. }; interface org\&.freedesktop\&.DBus\&.Introspectable { \&.\&.\&. }; @@ -6707,6 +6869,12 @@ node /org/freedesktop/systemd1/unit/system_2eslice { + + + + + + .SS "Properties" .PP Most properties correspond directly with the matching settings in slice unit files\&. @@ -6751,6 +6919,14 @@ node /org/freedesktop/systemd1/unit/session_2d1_2escope { @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") readonly t MemoryCurrent = \&.\&.\&.; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") + readonly t MemoryPeak = \&.\&.\&.; + @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") + readonly t MemorySwapCurrent = \&.\&.\&.; + @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") + readonly t MemorySwapPeak = \&.\&.\&.; + @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") + readonly t MemoryZSwapCurrent = \&.\&.\&.; + @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") readonly t MemoryAvailable = \&.\&.\&.; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") readonly t EffectiveMemoryMax = \&.\&.\&.; @@ -6912,6 +7088,10 @@ node /org/freedesktop/systemd1/unit/session_2d1_2escope { readonly s MemoryPressureWatch = \*(Aq\&.\&.\&.\*(Aq; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") readonly t MemoryPressureThresholdUSec = \&.\&.\&.; + @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") + readonly a(iiss) NFTSet = [\&.\&.\&.]; + @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") + readonly b CoredumpReceive = \&.\&.\&.; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const") readonly s KillMode = \*(Aq\&.\&.\&.\*(Aq; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const") @@ -7042,6 +7222,12 @@ node /org/freedesktop/systemd1/unit/session_2d1_2escope { + + + + + + .SS "Methods" .PP \fBAbandon()\fR @@ -7191,7 +7377,299 @@ $ gdbus introspect \-\-system \-\-dest org\&.freedesktop\&.systemd1 \e .SH "VERSIONING" .PP These D\-Bus interfaces follow -\m[blue]\fBthe usual interface versioning guidelines\fR\m[]\&\s-2\u[5]\d\s+2\&. +\m[blue]\fBthe usual interface versioning guidelines\fR\m[]\&\s-2\u[4]\d\s+2\&. +.SH "HISTORY" +.SS "The Manager Object" +.PP +\fIRuntimeWatchdogPreUSec\fR +and +\fIRuntimeWatchdogPreGovernor\fR +were added in version 251\&. +.PP +\fIWatchdogDevice\fR, +\fIWatchdogLastPingTimestamp\fR, +\fIWatchdogLastPingTimestampMonotonic\fR, +\fIDefaultDeviceTimeoutUSec\fR, +\fBDumpUnitsMatchingPatterns()\fR, and +\fBDumpUnitsMatchingPatternsByFileDescriptor()\fR +were added in version 252\&. +.PP +\fBGetUnitByPIDFD()\fR +and +\fBDisableUnitFilesWithFlagsAndInstallInfo()\fR +were added in version 253\&. +.PP +\fIConfidentialVirtualization\fR, +\fIDefaultIOAccounting\fR, +\fIDefaultIPAccounting\fR, +\fIDefaultMemoryPressureThresholdUSec\fR, +\fIDefaultMemoryPressureWatch\fR, +\fBQueueSignalUnit()\fR, +\fBSoftReboot()\fR, and +\fBDumpUnitFileDescriptorStore()\fR +were added in version 254\&. +.SS "Unit Objects" +.PP +\fIUpholds\fR +and +\fIUpheldBy\fR +were added in version 251\&. +.PP +\fIAccessSELinuxContext\fR +and +\fIActivationDetails\fR +were added in version 252\&. +.PP +\fBQueueSignal()\fR +was added in version 254\&. +.PP +\fISurviveFinalKillSignal\fR +was added in version 255\&. +.SS "Service Unit Objects" +.PP +\fIControlGroupId\fR +and +\fIExtensionDirectories\fR +were added in version 251\&. +.PP +\fIOpenFile\fR, +\fIReloadSignal\fR, +\fIMemoryZSwapMax\fR, and +\fILogFilterPatterns\fR +were added in version 253\&. +.PP +\fIRestartMode\fR, +\fIRestartSteps\fR, +\fIRestartMaxDelayUSec\fR, +\fIRestartUSecNext\fR, +\fIFileDescriptorStorePreserve\fR, +\fBDumpFileDescriptorStore()\fR, +\fIDelegateSubgroup\fR, +\fIDefaultStartupMemoryLow\fR, +\fIStartupMemoryLow\fR, +\fIStartupMemoryHigh\fR, +\fIStartupMemoryMax\fR, +\fIStartupMemorySwapMax\fR, +\fIStartupMemoryZSwapMax\fR, +\fIMemoryPressureWatch\fR, +\fIMemoryPressureThresholdUSec\fR, +\fIRootEphemeral\fR, +\fIImportCredential\fR, +\fIMemoryKSM\fR, +\fIRootImagePolicy\fR, +\fIMountImagePolicy\fR, and +\fIExtensionImagePolicy\fR +were added in version 254\&. +.PP +\fINFTSet\fR, +\fISetLoginEnvironment\fR, +\fICoredumpReceive\fR, +\fIMemoryPeak\fR, +\fIMemorySwapCurrent\fR, +\fIMemorySwapPeak\fR, and +\fIMemoryZSwapCurrent\fR +were added in version 255\&. +.PP +\fIEffectiveMemoryHigh\fR, +\fIEffectiveMemoryMax\fR, +\fIEffectiveTasksMax\fR +were added in version 256\&. +.SS "Socket Unit Objects" +.PP +\fIControlGroupId\fR +and +\fIExtensionDirectories\fR +were added in version 251\&. +.PP +\fIMemoryZSwapMax\fR +and +\fILogFilterPatterns\fR +were added in version 253\&. +.PP +\fIDelegateSubgroup\fR, +\fIDefaultStartupMemoryLow\fR, +\fIStartupMemoryLow\fR, +\fIStartupMemoryHigh\fR, +\fIStartupMemoryMax\fR, +\fIStartupMemorySwapMax\fR, +\fIStartupMemoryZSwapMax\fR, +\fIMemoryPressureWatch\fR, +\fIMemoryPressureThresholdUSec\fR, +\fIRootEphemeral\fR, +\fIImportCredential\fR, +\fIMemoryKSM\fR, +\fIRootImagePolicy\fR, +\fIMountImagePolicy\fR, and +\fIExtensionImagePolicy\fR +were added in version 254\&. +.PP +\fIPollLimitIntervalUSec\fR, +\fIPollLimitBurst\fR, +\fINFTSet\fR, +\fISetLoginEnvironment\fR, +\fICoredumpReceive\fR, +\fIMemoryPeak\fR, +\fIMemorySwapCurrent\fR, +\fIMemorySwapPeak\fR, and +\fIMemoryZSwapCurrent\fR +were added in version 255\&. +.PP +\fIEffectiveMemoryHigh\fR, +\fIEffectiveMemoryMax\fR, +\fIEffectiveTasksMax\fR +were added in version 256\&. +.SS "Mount Unit Objects" +.PP +\fIControlGroupId\fR +and +\fIExtensionDirectories\fR +were added in version 251\&. +.PP +\fIMemoryZSwapMax\fR +and +\fILogFilterPatterns\fR +were added in version 253\&. +.PP +\fIDelegateSubgroup\fR, +\fIDefaultStartupMemoryLow\fR, +\fIStartupMemoryLow\fR, +\fIStartupMemoryHigh\fR, +\fIStartupMemoryMax\fR, +\fIStartupMemorySwapMax\fR, +\fIStartupMemoryZSwapMax\fR, +\fIMemoryPressureWatch\fR, +\fIMemoryPressureThresholdUSec\fR, +\fIRootEphemeral\fR, +\fIImportCredential\fR, +\fIMemoryKSM\fR, +\fIRootImagePolicy\fR, +\fIMountImagePolicy\fR, and +\fIExtensionImagePolicy\fR +were added in version 254\&. +.PP +\fINFTSet\fR, +\fISetLoginEnvironment\fR, +\fICoredumpReceive\fR, +\fIMemoryPeak\fR, +\fIMemorySwapCurrent\fR, +\fIMemorySwapPeak\fR, and +\fIMemoryZSwapCurrent\fR +were added in version 255\&. +.PP +\fIEffectiveMemoryHigh\fR, +\fIEffectiveMemoryMax\fR, +\fIEffectiveTasksMax\fR +were added in version 256\&. +.SS "Swap Unit Objects" +.PP +\fIControlGroupId\fR +and +\fIExtensionDirectories\fR +were added in version 251\&. +.PP +\fIMemoryZSwapMax\fR +and +\fILogFilterPatterns\fR +were added in version 253\&. +.PP +\fIDelegateSubgroup\fR, +\fIDefaultStartupMemoryLow\fR, +\fIStartupMemoryLow\fR, +\fIStartupMemoryHigh\fR, +\fIStartupMemoryMax\fR, +\fIStartupMemorySwapMax\fR, +\fIStartupMemoryZSwapMax\fR, +\fIMemoryPressureWatch\fR, +\fIMemoryPressureThresholdUSec\fR, +\fIRootEphemeral\fR, +\fIImportCredential\fR, +\fIMemoryKSM\fR, +\fIRootImagePolicy\fR, +\fIMountImagePolicy\fR, and +\fIExtensionImagePolicy\fR +were added in version 254\&. +.PP +\fINFTSet\fR, +\fISetLoginEnvironment\fR, +\fICoredumpReceive\fR, +\fIMemoryPeak\fR, +\fIMemorySwapCurrent\fR, +\fIMemorySwapPeak\fR, and +\fIMemoryZSwapCurrent\fR +were added in version 255\&. +.PP +\fIEffectiveMemoryHigh\fR, +\fIEffectiveMemoryMax\fR, +\fIEffectiveTasksMax\fR +were added in version 256\&. +.SS "Slice Unit Objects" +.PP +\fIControlGroupId\fR +was added in version 251\&. +.PP +\fIMemoryZSwapMax\fR +was added in version 253\&. +.PP +\fIDelegateSubgroup\fR, +\fIDefaultStartupMemoryLow\fR, +\fIStartupMemoryLow\fR, +\fIStartupMemoryHigh\fR, +\fIStartupMemoryMax\fR, +\fIStartupMemorySwapMax\fR, +\fIStartupMemoryZSwapMax\fR, +\fIMemoryPressureWatch\fR, and +\fIMemoryPressureThresholdUSec\fR +were added in version 254\&. +.PP +\fINFTSet\fR, +\fICoredumpReceive\fR, +\fIMemoryPeak\fR, +\fIMemorySwapCurrent\fR, +\fIMemorySwapPeak\fR, and +\fIMemoryZSwapCurrent\fR +were added in version 255\&. +.PP +\fIEffectiveMemoryHigh\fR, +\fIEffectiveMemoryMax\fR, +\fIEffectiveTasksMax\fR +were added in version 256\&. +.SS "Scope Unit Objects" +.PP +\fIControlGroupId\fR +was added in version 251\&. +.PP +\fIOOMPolicy\fR +and +\fIMemoryZSwapMax\fR +were added in version 253\&. +.PP +\fIDelegateSubgroup\fR, +\fIDefaultStartupMemoryLow\fR, +\fIStartupMemoryLow\fR, +\fIStartupMemoryHigh\fR, +\fIStartupMemoryMax\fR, +\fIStartupMemorySwapMax\fR, +\fIStartupMemoryZSwapMax\fR, +\fIMemoryPressureWatch\fR, and +\fIMemoryPressureThresholdUSec\fR +were added in version 254\&. +.PP +\fINFTSet\fR, +\fICoredumpReceive\fR, +\fIMemoryPeak\fR, +\fIMemorySwapCurrent\fR, +\fIMemorySwapPeak\fR, and +\fIMemoryZSwapCurrent\fR +were added in version 255\&. +.PP +\fIEffectiveMemoryHigh\fR, +\fIEffectiveMemoryMax\fR, +\fIEffectiveTasksMax\fR +were added in version 256\&. +.SS "Job Objects" +.PP +\fIActivationDetails\fR +was added in version 252\&. .SH "NOTES" .IP " 1." 4 polkit @@ -7204,16 +7682,11 @@ New Control Group Interface \%https://www.freedesktop.org/wiki/Software/systemd/ControlGroupInterface .RE .IP " 3." 4 -Booting Without /usr is Broken -.RS 4 -\%https://www.freedesktop.org/wiki/Software/systemd/separate-usr-is-broken -.RE -.IP " 4." 4 The Case for the /usr Merge .RS 4 \%https://www.freedesktop.org/wiki/Software/systemd/TheCaseForTheUsrMerge .RE -.IP " 5." 4 +.IP " 4." 4 the usual interface versioning guidelines .RS 4 \%https://0pointer.de/blog/projects/versioning-dbus.html diff --git a/upstream/opensuse-tumbleweed/man5/org.freedesktop.timedate1.5 b/upstream/opensuse-tumbleweed/man5/org.freedesktop.timedate1.5 index 2f1c705c..63adbcd7 100644 --- a/upstream/opensuse-tumbleweed/man5/org.freedesktop.timedate1.5 +++ b/upstream/opensuse-tumbleweed/man5/org.freedesktop.timedate1.5 @@ -1,5 +1,5 @@ '\" t -.TH "ORG\&.FREEDESKTOP\&.TIMEDATE1" "5" "" "systemd 254" "org.freedesktop.timedate1" +.TH "ORG\&.FREEDESKTOP\&.TIMEDATE1" "5" "" "systemd 255" "org.freedesktop.timedate1" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/upstream/opensuse-tumbleweed/man5/os-release.5 b/upstream/opensuse-tumbleweed/man5/os-release.5 index 97864860..795363d3 100644 --- a/upstream/opensuse-tumbleweed/man5/os-release.5 +++ b/upstream/opensuse-tumbleweed/man5/os-release.5 @@ -1,5 +1,5 @@ '\" t -.TH "OS\-RELEASE" "5" "" "systemd 254" "os-release" +.TH "OS\-RELEASE" "5" "" "systemd 255" "os-release" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -99,7 +99,8 @@ too\&. plays the same role for extension images as os\-release for the main system, and follows the syntax and rules as described in the -\m[blue]\fBPortable Services Documentation\fR\m[]\&\s-2\u[3]\d\s+2\&. The purpose of this file is to identify the extension and to allow the operating system to verify that the extension image matches the base OS\&. This is typically implemented by checking that the +\m[blue]\fBPortable Services\fR\m[]\&\s-2\u[3]\d\s+2 +page\&. The purpose of this file is to identify the extension and to allow the operating system to verify that the extension image matches the base OS\&. This is typically implemented by checking that the \fIID=\fR options match, and either \fISYSEXT_LEVEL=\fR @@ -208,6 +209,8 @@ Examples: Note: this field is for display purposes only\&. The \fIVARIANT_ID\fR field should be used for making programmatic decisions\&. +.sp +Added in version 220\&. .RE .PP \fIVARIANT_ID=\fR @@ -217,6 +220,8 @@ A lower\-case string (no spaces or other characters outside of 0\(en9, a\(enz, " Examples: "VARIANT_ID=server", "VARIANT_ID=embedded"\&. +.sp +Added in version 220\&. .RE .SS "Information about the version of the operating system" .PP @@ -245,6 +250,8 @@ A lower\-case string (no spaces or other characters outside of 0\(en9, a\(enz, " Examples: "VERSION_CODENAME=buster", "VERSION_CODENAME=xenial"\&. +.sp +Added in version 231\&. .RE .PP \fIBUILD_ID=\fR @@ -264,6 +271,8 @@ would not\&. This field is optional\&. Examples: "BUILD_ID="2013\-03\-20\&.3"", "BUILD_ID=201303203"\&. +.sp +Added in version 200\&. .RE .PP \fIIMAGE_ID=\fR @@ -273,6 +282,8 @@ A lower\-case string (no spaces or other characters outside of 0\(en9, a\(enz, " Examples: "IMAGE_ID=vendorx\-cashier\-system", "IMAGE_ID=netbook\-image"\&. +.sp +Added in version 249\&. .RE .PP \fIIMAGE_VERSION=\fR @@ -284,6 +295,8 @@ described above, to discern different versions of the same image\&. Examples: "IMAGE_VERSION=33", "IMAGE_VERSION=47\&.1rc1"\&. +.sp +Added in version 249\&. .RE .PP To summarize: if the image updates are built and shipped as comprehensive units, @@ -334,6 +347,8 @@ provided\&. For example, "SUPPORT_END=2001\-01\-01" means that the system was supported until the end of the last day of the previous millennium\&. +.sp +Added in version 252\&. .RE .PP \fILOGO=\fR @@ -344,6 +359,8 @@ A string, specifying the name of an icon as defined by Examples: "LOGO=fedora\-logo", "LOGO=distributor\-logo\-opensuse" +.sp +Added in version 240\&. .RE .PP \fIANSI_COLOR=\fR @@ -370,6 +387,8 @@ Examples: for Fedora Linux, "VENDOR_NAME="Canonical"" for Ubuntu\&. +.sp +Added in version 254\&. .RE .PP \fIVENDOR_URL=\fR @@ -388,6 +407,8 @@ URLs\&. Only one URL shall be listed in the setting\&. Examples: "VENDOR_URL="https://fedoraproject\&.org/"", "VENDOR_URL="https://canonical\&.com/""\&. +.sp +Added in version 254\&. .RE .SS "Distribution\-level defaults and metadata" .PP @@ -402,6 +423,8 @@ See for a description of how \fBsystemd-hostnamed.service\fR(8) determines the fallback hostname\&. +.sp +Added in version 248\&. .RE .PP \fIARCHITECTURE=\fR @@ -410,6 +433,8 @@ A string that specifies which CPU architecture the userspace binaries require\&. \fIConditionArchitecture=\fR described in \fBsystemd.unit\fR(5)\&. The field is optional and should only be used when just single architecture is supported\&. It may provide redundant information when used in a GPT partition with a GUID type that already encodes the architecture\&. If this is not the case, the architecture should be specified in e\&.g\&., an extension image, to prevent an incompatible host from loading it\&. +.sp +Added in version 252\&. .RE .PP \fISYSEXT_LEVEL=\fR @@ -423,6 +448,8 @@ and Examples: "SYSEXT_LEVEL=2", "SYSEXT_LEVEL=15\&.14"\&. +.sp +Added in version 248\&. .RE .PP \fICONFEXT_LEVEL=\fR @@ -436,6 +463,8 @@ for more information\&. Examples: "CONFEXT_LEVEL=2", "CONFEXT_LEVEL=15\&.14"\&. +.sp +Added in version 254\&. .RE .PP \fISYSEXT_SCOPE=\fR @@ -449,6 +478,8 @@ extension\-release\&.d/ files and indicates what environments the system extension is applicable to: i\&.e\&. to regular systems, to initrds, or to portable service images\&. If unspecified, "SYSEXT_SCOPE=system portable" is implied, i\&.e\&. any system extension without this field is applicable to regular systems and to portable service environments, but not to initrd environments\&. +.sp +Added in version 250\&. .RE .PP \fICONFEXT_SCOPE=\fR @@ -456,13 +487,17 @@ is implied, i\&.e\&. any system extension without this field is applicable to re Semantically the same as \fISYSEXT_SCOPE=\fR but for confext images\&. +.sp +Added in version 254\&. .RE .PP \fIPORTABLE_PREFIXES=\fR .RS 4 Takes a space\-separated list of one or more valid prefix match strings for the -\m[blue]\fBPortable Services Documentation\fR\m[]\&\s-2\u[3]\d\s+2 +\m[blue]\fBPortable Services\fR\m[]\&\s-2\u[3]\d\s+2 logic\&. This field serves two purposes: it is informational, identifying portable service images as such (and thus allowing them to be distinguished from other OS images, such as bootable system images)\&. It is also used when a portable service image is attached: the specified or implied portable service prefix is checked against the list specified here, to enforce restrictions how images may be attached to a system\&. +.sp +Added in version 250\&. .RE .SS "Notes" .PP @@ -656,7 +691,7 @@ initrd \%https://docs.kernel.org/admin-guide/initrd.html .RE .IP " 3." 4 -Portable Services Documentation +Portable Services .RS 4 \%https://systemd.io/PORTABLE_SERVICES .RE diff --git a/upstream/opensuse-tumbleweed/man5/passwd.5 b/upstream/opensuse-tumbleweed/man5/passwd.5 index 9b9a1368..cd46fdf5 100644 --- a/upstream/opensuse-tumbleweed/man5/passwd.5 +++ b/upstream/opensuse-tumbleweed/man5/passwd.5 @@ -8,7 +8,7 @@ .\" Modified Sun Jun 18 01:53:57 1995 by Andries Brouwer (aeb@cwi.nl) .\" Modified Mon Jan 5 20:24:40 MET 1998 by Michael Haardt .\" (michael@cantor.informatik.rwth-aachen.de) -.TH passwd 5 2023-02-05 "Linux man-pages 6.05.01" +.TH passwd 5 2024-05-02 "Linux man-pages (unreleased)" .SH NAME passwd \- password file .SH DESCRIPTION @@ -19,7 +19,7 @@ It should have read permission allowed for all users (many utilities, like .BR ls (1) use it to map user IDs to usernames), but write access only for the superuser. -.PP +.P In the good old days there was no great problem with this general read permission. Everybody could read the encrypted passwords, but the @@ -31,7 +31,7 @@ has an \[aq]x\[aq] character in the password field, and the encrypted passwords are in .IR /etc/shadow , which is readable by the superuser only. -.PP +.P If the encrypted password, whether in .I /etc/passwd or in @@ -44,32 +44,32 @@ or .RB \[dq] nonull \[dq] arguments to .BR pam_unix (8)). -.PP +.P If the encrypted password in .I /etc/passwd is "\fI*NP*\fP" (without the quotes), the shadow record should be obtained from an NIS+ server. -.PP +.P Regardless of whether shadow passwords are used, many system administrators use an asterisk (*) in the encrypted password field to make sure that this user can not authenticate themself using a password. (But see NOTES below.) -.PP +.P If you create a new login, first put an asterisk (*) in the password field, then use .BR passwd (1) to set it. -.PP +.P Each line of the file describes a single user, and contains seven colon-separated fields: -.PP +.P .in +4n .EX name:password:UID:GID:GECOS:directory:shell .EE .in -.PP +.P The field are as follows: .TP 12 .I name @@ -132,7 +132,7 @@ environment variable. If you want to create user groups, there must be an entry in .IR /etc/group , or no group will exist. -.PP +.P If the encrypted password is set to an asterisk (*), the user will be unable to login using .BR login (1), diff --git a/upstream/opensuse-tumbleweed/man5/proc.5 b/upstream/opensuse-tumbleweed/man5/proc.5 index 9a488419..bbdf162c 100644 --- a/upstream/opensuse-tumbleweed/man5/proc.5 +++ b/upstream/opensuse-tumbleweed/man5/proc.5 @@ -1,40 +1,10 @@ -'\" t -.\" Copyright (C) 1994, 1995 by Daniel Quinlan (quinlan@yggdrasil.com) -.\" and Copyright (C) 2002-2008,2017 Michael Kerrisk <mtk.manpages@gmail.com> -.\" with networking additions from Alan Cox (A.Cox@swansea.ac.uk) -.\" and scsi additions from Michael Neuffer (neuffer@mail.uni-mainz.de) -.\" and sysctl additions from Andries Brouwer (aeb@cwi.nl) -.\" and System V IPC (as well as various other) additions from -.\" Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> .\" -.\" SPDX-License-Identifier: GPL-2.0-or-later +.\" SPDX-License-Identifier: GPL-3.0-or-later .\" -.\" Modified 1995-05-17 by faith@cs.unc.edu -.\" Minor changes by aeb and Marty Leisner (leisner@sdsp.mc.xerox.com). -.\" Modified 1996-04-13, 1996-07-22 by aeb@cwi.nl -.\" Modified 2001-12-16 by rwhron@earthlink.net -.\" Modified 2002-07-13 by jbelton@shaw.ca -.\" Modified 2002-07-22, 2003-05-27, 2004-04-06, 2004-05-25 -.\" by Michael Kerrisk <mtk.manpages@gmail.com> -.\" 2004-11-17, mtk -- updated notes on /proc/loadavg -.\" 2004-12-01, mtk, rtsig-max and rtsig-nr went away in Linux 2.6.8 -.\" 2004-12-14, mtk, updated 'statm', and fixed error in order of list -.\" 2005-05-12, mtk, updated 'stat' -.\" 2005-07-13, mtk, added /proc/sys/fs/mqueue/* -.\" 2005-09-16, mtk, Added /proc/sys/fs/suid_dumpable -.\" 2005-09-19, mtk, added /proc/zoneinfo -.\" 2005-03-01, mtk, moved /proc/sys/fs/mqueue/* material to mq_overview.7. -.\" 2008-06-05, mtk, Added /proc/[pid]/oom_score, /proc/[pid]/oom_adj, -.\" /proc/[pid]/limits, /proc/[pid]/mountinfo, /proc/[pid]/mountstats, -.\" and /proc/[pid]/fdinfo/*. -.\" 2008-06-19, mtk, Documented /proc/[pid]/status. -.\" 2008-07-15, mtk, added /proc/config.gz -.\" -.\" FIXME cross check against Documentation/filesystems/proc.txt -.\" to see what information could be imported from that file -.\" into this file. -.\" -.TH proc 5 2023-07-08 "Linux man-pages 6.05.01" +.TH proc 5 2024-05-19 "Linux man-pages (unreleased)" .SH NAME proc \- process information, system information, and sysctl pseudo-filesystem .SH DESCRIPTION @@ -46,13 +16,13 @@ It is commonly mounted at .IR /proc . Typically, it is mounted automatically by the system, but it can also be mounted manually using a command such as: -.PP +.P .in +4n .EX mount \-t proc proc /proc .EE .in -.PP +.P Most of the files in the .B proc filesystem are read-only, @@ -120,7 +90,6 @@ information about running processes (e.g., discovering whether some daemon is running with elevated privileges, whether another user is running some sensitive program, whether other users are running any program at all, and so on). -.RE .TP .BR gid "=\fIgid\fP (since Linux 3.3)" .\" commit 0499680a42141d86417a8fbaa8c8db806bea1201 @@ -135,7 +104,13 @@ This group should be used instead of approaches such as putting nonroot users into the .BR sudoers (5) file. -.\" +.RE +.TP +.BR subset = pid " (since Linux 5.8)" +.\" commit 6814ef2d992af09451bbeda4770daa204461329e +Show only the specified subset of procfs, +hiding all top level files and directories in the procfs +that are not related to tasks. .SS Overview Underneath .IR /proc , @@ -205,1741 +180,12 @@ directory. Various other files and subdirectories under .I /proc expose system-wide information. -.PP -All of the above are described in more detail below. -.\" -.SS Files and directories -The following list provides details of many of the files and directories -under the -.I /proc -hierarchy. -.TP -.IR /proc/ pid -There is a numerical subdirectory for each running process; the -subdirectory is named by the process ID. -Each -.IR /proc/ pid -subdirectory contains the pseudo-files and directories described below. -.IP -The files inside each -.IR /proc/ pid -directory are normally owned by the effective user and -effective group ID of the process. -However, as a security measure, the ownership is made -.I root:root -if the process's "dumpable" attribute is set to a value other than 1. -.IP -Before Linux 4.11, -.\" commit 68eb94f16227336a5773b83ecfa8290f1d6b78ce -.I root:root -meant the "global" root user ID and group ID -(i.e., UID 0 and GID 0 in the initial user namespace). -Since Linux 4.11, -if the process is in a noninitial user namespace that has a -valid mapping for user (group) ID 0 inside the namespace, then -the user (group) ownership of the files under -.IR /proc/ pid -is instead made the same as the root user (group) ID of the namespace. -This means that inside a container, -things work as expected for the container "root" user. -.IP -The process's "dumpable" attribute may change for the following reasons: -.RS -.IP \[bu] 3 -The attribute was explicitly set via the -.BR prctl (2) -.B PR_SET_DUMPABLE -operation. -.IP \[bu] -The attribute was reset to the value in the file -.I /proc/sys/fs/suid_dumpable -(described below), for the reasons described in -.BR prctl (2). -.RE -.IP -Resetting the "dumpable" attribute to 1 reverts the ownership of the -.IR /proc/ pid /* -files to the process's effective UID and GID. -Note, however, that if the effective UID or GID is subsequently modified, -then the "dumpable" attribute may be reset, as described in -.BR prctl (2). -Therefore, it may be desirable to reset the "dumpable" attribute -.I after -making any desired changes to the process's effective UID or GID. -.TP -.IR /proc/ pid /attr -.\" https://lwn.net/Articles/28222/ -.\" From: Stephen Smalley <sds@epoch.ncsc.mil> -.\" To: LKML and others -.\" Subject: [RFC][PATCH] Process Attribute API for Security Modules -.\" Date: 08 Apr 2003 16:17:52 -0400 -.\" -.\" http://www.nsa.gov/research/_files/selinux/papers/module/x362.shtml -.\" -The files in this directory provide an API for security modules. -The contents of this directory are files that can be read and written -in order to set security-related attributes. -This directory was added to support SELinux, -but the intention was that the API be general enough to support -other security modules. -For the purpose of explanation, -examples of how SELinux uses these files are provided below. -.IP -This directory is present only if the kernel was configured with -.BR CONFIG_SECURITY . -.TP -.IR /proc/ pid /attr/current " (since Linux 2.6.0)" -The contents of this file represent the current -security attributes of the process. -.IP -In SELinux, this file is used to get the security context of a process. -Prior to Linux 2.6.11, this file could not be used to set the security -context (a write was always denied), since SELinux limited process security -transitions to -.BR execve (2) -(see the description of -.IR /proc/ pid /attr/exec , -below). -Since Linux 2.6.11, SELinux lifted this restriction and began supporting -"set" operations via writes to this node if authorized by policy, -although use of this operation is only suitable for applications that are -trusted to maintain any desired separation between the old and new security -contexts. -.IP -Prior to Linux 2.6.28, SELinux did not allow threads within a -multithreaded process to set their security context via this node -as it would yield an inconsistency among the security contexts of the -threads sharing the same memory space. -Since Linux 2.6.28, SELinux lifted -this restriction and began supporting "set" operations for threads within -a multithreaded process if the new security context is bounded by the old -security context, where the bounded relation is defined in policy and -guarantees that the new security context has a subset of the permissions -of the old security context. -.IP -Other security modules may choose to support "set" operations via -writes to this node. -.TP -.IR /proc/ pid /attr/exec " (since Linux 2.6.0)" -This file represents the attributes to assign to the -process upon a subsequent -.BR execve (2). -.IP -In SELinux, -this is needed to support role/domain transitions, and -.BR execve (2) -is the preferred point to make such transitions because it offers better -control over the initialization of the process in the new security label -and the inheritance of state. -In SELinux, this attribute is reset on -.BR execve (2) -so that the new program reverts to the default behavior for any -.BR execve (2) -calls that it may make. -In SELinux, a process can set -only its own -.IR /proc/ pid /attr/exec -attribute. -.TP -.IR /proc/ pid /attr/fscreate " (since Linux 2.6.0)" -This file represents the attributes to assign to files -created by subsequent calls to -.BR open (2), -.BR mkdir (2), -.BR symlink (2), -and -.BR mknod (2) -.IP -SELinux employs this file to support creation of a file -(using the aforementioned system calls) -in a secure state, -so that there is no risk of inappropriate access being obtained -between the time of creation and the time that attributes are set. -In SELinux, this attribute is reset on -.BR execve (2), -so that the new program reverts to the default behavior for -any file creation calls it may make, but the attribute will persist -across multiple file creation calls within a program unless it is -explicitly reset. -In SELinux, a process can set only its own -.IR /proc/ pid /attr/fscreate -attribute. -.TP -.IR /proc/ pid /attr/keycreate " (since Linux 2.6.18)" -.\" commit 4eb582cf1fbd7b9e5f466e3718a59c957e75254e -If a process writes a security context into this file, -all subsequently created keys -.RB ( add_key (2)) -will be labeled with this context. -For further information, see the kernel source file -.I Documentation/security/keys/core.rst -(or file -.\" commit b68101a1e8f0263dbc7b8375d2a7c57c6216fb76 -.I Documentation/security/keys.txt -between Linux 3.0 and Linux 4.13, or -.\" commit d410fa4ef99112386de5f218dd7df7b4fca910b4 -.I Documentation/keys.txt -before Linux 3.0). -.TP -.IR /proc/ pid /attr/prev " (since Linux 2.6.0)" -This file contains the security context of the process before the last -.BR execve (2); -that is, the previous value of -.IR /proc/ pid /attr/current . -.TP -.IR /proc/ pid /attr/socketcreate " (since Linux 2.6.18)" -.\" commit 42c3e03ef6b298813557cdb997bd6db619cd65a2 -If a process writes a security context into this file, -all subsequently created sockets will be labeled with this context. -.TP -.IR /proc/ pid /autogroup " (since Linux 2.6.38)" -.\" commit 5091faa449ee0b7d73bc296a93bca9540fc51d0a -See -.BR sched (7). -.TP -.IR /proc/ pid /auxv " (since Linux 2.6.0)" -.\" Precisely: Linux 2.6.0-test7 -This contains the contents of the ELF interpreter information passed -to the process at exec time. -The format is one \fIunsigned long\fP ID -plus one \fIunsigned long\fP value for each entry. -The last entry contains two zeros. -See also -.BR getauxval (3). -.IP -Permission to access this file is governed by a ptrace access mode -.B PTRACE_MODE_READ_FSCREDS -check; see -.BR ptrace (2). -.TP -.IR /proc/ pid /cgroup " (since Linux 2.6.24)" -See -.BR cgroups (7). -.TP -.IR /proc/ pid /clear_refs " (since Linux 2.6.22)" -.\" commit b813e931b4c8235bb42e301096ea97dbdee3e8fe (2.6.22) -.\" commit 398499d5f3613c47f2143b8c54a04efb5d7a6da9 (2.6.32) -.\" commit 040fa02077de01c7e08fa75be6125e4ca5636011 (3.11) +.P +All of the above are described in more detail in separate manpages +whose names start with +.BR proc_ . .\" -.\" "Clears page referenced bits shown in smaps output" -.\" write-only, writable only by the owner of the process -.IP -This is a write-only file, writable only by owner of the process. -.IP -The following values may be written to the file: -.RS -.TP -1 (since Linux 2.6.22) -.\" Internally: CLEAR_REFS_ALL -Reset the PG_Referenced and ACCESSED/YOUNG -bits for all the pages associated with the process. -(Before Linux 2.6.32, writing any nonzero value to this file -had this effect.) -.TP -2 (since Linux 2.6.32) -.\" Internally: CLEAR_REFS_ANON -Reset the PG_Referenced and ACCESSED/YOUNG -bits for all anonymous pages associated with the process. -.TP -3 (since Linux 2.6.32) -.\" Internally: CLEAR_REFS_MAPPED -Reset the PG_Referenced and ACCESSED/YOUNG -bits for all file-mapped pages associated with the process. -.RE -.IP -Clearing the PG_Referenced and ACCESSED/YOUNG bits provides a method -to measure approximately how much memory a process is using. -One first inspects the values in the "Referenced" fields -for the VMAs shown in -.IR /proc/ pid /smaps -to get an idea of the memory footprint of the -process. -One then clears the PG_Referenced and ACCESSED/YOUNG bits -and, after some measured time interval, -once again inspects the values in the "Referenced" fields -to get an idea of the change in memory footprint of the -process during the measured interval. -If one is interested only in inspecting the selected mapping types, -then the value 2 or 3 can be used instead of 1. -.IP -Further values can be written to affect different properties: -.RS -.TP -4 (since Linux 3.11) -Clear the soft-dirty bit for all the pages associated with the process. -.\" Internally: CLEAR_REFS_SOFT_DIRTY -This is used (in conjunction with -.IR /proc/ pid /pagemap ) -by the check-point restore system to discover which pages of a process -have been dirtied since the file -.IR /proc/ pid /clear_refs -was written to. -.TP -5 (since Linux 4.0) -.\" Internally: CLEAR_REFS_MM_HIWATER_RSS -Reset the peak resident set size ("high water mark") to the process's -current resident set size value. -.RE -.IP -Writing any value to -.IR /proc/ pid /clear_refs -other than those listed above has no effect. -.IP -The -.IR /proc/ pid /clear_refs -file is present only if the -.B CONFIG_PROC_PAGE_MONITOR -kernel configuration option is enabled. -.TP -.IR /proc/ pid /cmdline -This read-only file holds the complete command line for the process, -unless the process is a zombie. -.\" In Linux 2.3.26, this also used to be true if the process was swapped out. -In the latter case, there is nothing in this file: -that is, a read on this file will return 0 characters. -.IP -For processes which are still running, -the command-line arguments appear in this file -in the same layout as they do in process memory: -If the process is well-behaved, -it is a set of strings separated by null bytes (\[aq]\e0\[aq]), -with a further null byte after the last string. -.IP -This is the common case, -but processes have the freedom to -override the memory region and -break assumptions about the contents or format of the -.IR /proc/ pid /cmdline -file. -.IP -If, after an -.BR execve (2), -the process modifies its -.I argv -strings, those changes will show up here. -This is not the same thing as modifying the -.I argv -array. -.IP -Furthermore, a process may change the memory location that this file refers via -.BR prctl (2) -operations such as -.BR PR_SET_MM_ARG_START . -.IP -Think of this file as the command line that the process wants you to see. -.TP -.IR /proc/ pid /comm " (since Linux 2.6.33)" -.\" commit 4614a696bd1c3a9af3a08f0e5874830a85b889d4 -This file exposes the process's -.I comm -value\[em]that is, the command name associated with the process. -Different threads in the same process may have different -.I comm -values, accessible via -.IR /proc/ pid /task/ tid /comm . -A thread may modify its -.I comm -value, or that of any of other thread in the same thread group (see -the discussion of -.B CLONE_THREAD -in -.BR clone (2)), -by writing to the file -.IR /proc/self/task/ tid /comm . -Strings longer than -.B TASK_COMM_LEN -(16) characters (including the terminating null byte) are silently truncated. -.IP -This file provides a superset of the -.BR prctl (2) -.B PR_SET_NAME -and -.B PR_GET_NAME -operations, and is employed by -.BR pthread_setname_np (3) -when used to rename threads other than the caller. -The value in this file is used for the -.I %e -specifier in -.IR /proc/sys/kernel/core_pattern ; -see -.BR core (5). -.TP -.IR /proc/ pid /coredump_filter " (since Linux 2.6.23)" -See -.BR core (5). -.TP -.IR /proc/ pid /cpuset " (since Linux 2.6.12)" -.\" and/proc/[pid]/task/[tid]/cpuset -See -.BR cpuset (7). -.TP -.IR /proc/ pid /cwd -This is a symbolic link to the current working directory of the process. -To find out the current working directory of process 20, -for instance, you can do this: -.IP -.in +4n -.EX -.RB "$" " cd /proc/20/cwd; pwd \-P" -.EE -.in -.IP -.\" The following was still true as at kernel 2.6.13 -In a multithreaded process, the contents of this symbolic link -are not available if the main thread has already terminated -(typically by calling -.BR pthread_exit (3)). -.IP -Permission to dereference or read -.RB ( readlink (2)) -this symbolic link is governed by a ptrace access mode -.B PTRACE_MODE_READ_FSCREDS -check; see -.BR ptrace (2). -.TP -.IR /proc/ pid /environ -This file contains the initial environment that was set -when the currently executing program was started via -.BR execve (2). -The entries are separated by null bytes (\[aq]\e0\[aq]), -and there may be a null byte at the end. -Thus, to print out the environment of process 1, you would do: -.IP -.in +4n -.EX -.RB "$" " cat /proc/1/environ | tr \[aq]\e000\[aq] \[aq]\en\[aq]" -.EE -.in -.IP -If, after an -.BR execve (2), -the process modifies its environment -(e.g., by calling functions such as -.BR putenv (3) -or modifying the -.BR environ (7) -variable directly), -this file will -.I not -reflect those changes. -.IP -Furthermore, a process may change the memory location that this file refers via -.BR prctl (2) -operations such as -.BR PR_SET_MM_ENV_START . -.IP -Permission to access this file is governed by a ptrace access mode -.B PTRACE_MODE_READ_FSCREDS -check; see -.BR ptrace (2). -.TP -.IR /proc/ pid /exe -Under Linux 2.2 and later, this file is a symbolic link -containing the actual pathname of the executed command. -This symbolic link can be dereferenced normally; attempting to open -it will open the executable. -You can even type -.IR /proc/ pid /exe -to run another copy of the same executable that is being run by -process -.IR pid . -If the pathname has been unlinked, the symbolic link will contain the -string \[aq]\ (deleted)\[aq] appended to the original pathname. -.\" The following was still true as at kernel 2.6.13 -In a multithreaded process, the contents of this symbolic link -are not available if the main thread has already terminated -(typically by calling -.BR pthread_exit (3)). -.IP -Permission to dereference or read -.RB ( readlink (2)) -this symbolic link is governed by a ptrace access mode -.B PTRACE_MODE_READ_FSCREDS -check; see -.BR ptrace (2). -.IP -Under Linux 2.0 and earlier, -.IR /proc/ pid /exe -is a pointer to the binary which was executed, -and appears as a symbolic link. -A -.BR readlink (2) -call on this file under Linux 2.0 returns a string in the format: -.IP -.in +4n -.EX -[device]:inode -.EE -.in -.IP -For example, [0301]:1502 would be inode 1502 on device major 03 (IDE, -MFM, etc. drives) minor 01 (first partition on the first drive). -.IP -.BR find (1) -with the -.I \-inum -option can be used to locate the file. -.TP -.IR /proc/ pid /fd/ -This is a subdirectory containing one entry for each file which the -process has open, named by its file descriptor, and which is a -symbolic link to the actual file. -Thus, 0 is standard input, 1 standard output, 2 standard error, and so on. -.IP -For file descriptors for pipes and sockets, -the entries will be symbolic links whose content is the -file type with the inode. -A -.BR readlink (2) -call on this file returns a string in the format: -.IP -.in +4n -.EX -type:[inode] -.EE -.in -.IP -For example, -.I socket:[2248868] -will be a socket and its inode is 2248868. -For sockets, that inode can be used to find more information -in one of the files under -.IR /proc/net/ . -.IP -For file descriptors that have no corresponding inode -(e.g., file descriptors produced by -.BR bpf (2), -.BR epoll_create (2), -.BR eventfd (2), -.BR inotify_init (2), -.BR perf_event_open (2), -.BR signalfd (2), -.BR timerfd_create (2), -and -.BR userfaultfd (2)), -the entry will be a symbolic link with contents of the form -.IP -.in +4n -.EX -.RI anon_inode: file-type -.EE -.in -.IP -In many cases (but not all), the -.I file-type -is surrounded by square brackets. -.IP -For example, an epoll file descriptor will have a symbolic link -whose content is the string -.IR "anon_inode:[eventpoll]" . -.IP -.\"The following was still true as at kernel 2.6.13 -In a multithreaded process, the contents of this directory -are not available if the main thread has already terminated -(typically by calling -.BR pthread_exit (3)). -.IP -Programs that take a filename as a command-line argument, -but don't take input from standard input if no argument is supplied, -and programs that write to a file named as a command-line argument, -but don't send their output to standard output -if no argument is supplied, can nevertheless be made to use -standard input or standard output by using -.IR /proc/ pid /fd -files as command-line arguments. -For example, assuming that -.I \-i -is the flag designating an input file and -.I \-o -is the flag designating an output file: -.IP -.in +4n -.EX -.RB "$" " foobar \-i /proc/self/fd/0 \-o /proc/self/fd/1 ..." -.EE -.in -.IP -and you have a working filter. -.\" The following is not true in my tests (MTK): -.\" Note that this will not work for -.\" programs that seek on their files, as the files in the fd directory -.\" are not seekable. -.IP -.I /proc/self/fd/N -is approximately the same as -.I /dev/fd/N -in some UNIX and UNIX-like systems. -Most Linux MAKEDEV scripts symbolically link -.I /dev/fd -to -.IR /proc/self/fd , -in fact. -.IP -Most systems provide symbolic links -.IR /dev/stdin , -.IR /dev/stdout , -and -.IR /dev/stderr , -which respectively link to the files -.IR 0 , -.IR 1 , -and -.I 2 -in -.IR /proc/self/fd . -Thus the example command above could be written as: -.IP -.in +4n -.EX -.RB "$" " foobar \-i /dev/stdin \-o /dev/stdout ..." -.EE -.in -.IP -Permission to dereference or read -.RB ( readlink (2)) -the symbolic links in this directory is governed by a ptrace access mode -.B PTRACE_MODE_READ_FSCREDS -check; see -.BR ptrace (2). -.IP -Note that for file descriptors referring to inodes -(pipes and sockets, see above), -those inodes still have permission bits and ownership information -distinct from those of the -.IR /proc/ pid /fd -entry, -and that the owner may differ from the user and group IDs of the process. -An unprivileged process may lack permissions to open them, as in this example: -.IP -.in +4n -.EX -.RB "$" " echo test | sudo \-u nobody cat" -test -.RB "$" " echo test | sudo \-u nobody cat /proc/self/fd/0" -cat: /proc/self/fd/0: Permission denied -.EE -.in -.IP -File descriptor 0 refers to the pipe created by the shell -and owned by that shell's user, which is not -.IR nobody , -so -.B cat -does not have permission -to create a new file descriptor to read from that inode, -even though it can still read from its existing file descriptor 0. -.TP -.IR /proc/ pid /fdinfo/ " (since Linux 2.6.22)" -This is a subdirectory containing one entry for each file which the -process has open, named by its file descriptor. -The files in this directory are readable only by the owner of the process. -The contents of each file can be read to obtain information -about the corresponding file descriptor. -The content depends on the type of file referred to by the -corresponding file descriptor. -.IP -For regular files and directories, we see something like: -.IP -.in +4n -.EX -.RB "$" " cat /proc/12015/fdinfo/4" -pos: 1000 -flags: 01002002 -mnt_id: 21 -.EE -.in -.IP -The fields are as follows: -.RS -.TP -.I pos -This is a decimal number showing the file offset. -.TP -.I flags -This is an octal number that displays the -file access mode and file status flags (see -.BR open (2)). -If the close-on-exec file descriptor flag is set, then -.I flags -will also include the value -.BR O_CLOEXEC . -.IP -Before Linux 3.1, -.\" commit 1117f72ea0217ba0cc19f05adbbd8b9a397f5ab7 -this field incorrectly displayed the setting of -.B O_CLOEXEC -at the time the file was opened, -rather than the current setting of the close-on-exec flag. -.TP -.I -.I mnt_id -This field, present since Linux 3.15, -.\" commit 49d063cb353265c3af701bab215ac438ca7df36d -is the ID of the mount containing this file. -See the description of -.IR /proc/ pid /mountinfo . -.RE -.IP -For eventfd file descriptors (see -.BR eventfd (2)), -we see (since Linux 3.8) -.\" commit cbac5542d48127b546a23d816380a7926eee1c25 -the following fields: -.IP -.in +4n -.EX -pos: 0 -flags: 02 -mnt_id: 10 -eventfd\-count: 40 -.EE -.in -.IP -.I eventfd\-count -is the current value of the eventfd counter, in hexadecimal. -.IP -For epoll file descriptors (see -.BR epoll (7)), -we see (since Linux 3.8) -.\" commit 138d22b58696c506799f8de759804083ff9effae -the following fields: -.IP -.in +4n -.EX -pos: 0 -flags: 02 -mnt_id: 10 -tfd: 9 events: 19 data: 74253d2500000009 -tfd: 7 events: 19 data: 74253d2500000007 -.EE -.in -.IP -Each of the lines beginning -.I tfd -describes one of the file descriptors being monitored via -the epoll file descriptor (see -.BR epoll_ctl (2) -for some details). -The -.I tfd -field is the number of the file descriptor. -The -.I events -field is a hexadecimal mask of the events being monitored for this file -descriptor. -The -.I data -field is the data value associated with this file descriptor. -.IP -For signalfd file descriptors (see -.BR signalfd (2)), -we see (since Linux 3.8) -.\" commit 138d22b58696c506799f8de759804083ff9effae -the following fields: -.IP -.in +4n -.EX -pos: 0 -flags: 02 -mnt_id: 10 -sigmask: 0000000000000006 -.EE -.in -.IP -.I sigmask -is the hexadecimal mask of signals that are accepted via this -signalfd file descriptor. -(In this example, bits 2 and 3 are set, corresponding to the signals -.B SIGINT -and -.BR SIGQUIT ; -see -.BR signal (7).) -.IP -For inotify file descriptors (see -.BR inotify (7)), -we see (since Linux 3.8) -the following fields: -.IP -.in +4n -.EX -pos: 0 -flags: 00 -mnt_id: 11 -inotify wd:2 ino:7ef82a sdev:800001 mask:800afff ignored_mask:0 fhandle\-bytes:8 fhandle\-type:1 f_handle:2af87e00220ffd73 -inotify wd:1 ino:192627 sdev:800001 mask:800afff ignored_mask:0 fhandle\-bytes:8 fhandle\-type:1 f_handle:27261900802dfd73 -.EE -.in -.IP -Each of the lines beginning with "inotify" displays information about -one file or directory that is being monitored. -The fields in this line are as follows: -.RS -.TP -.I wd -A watch descriptor number (in decimal). -.TP -.I ino -The inode number of the target file (in hexadecimal). -.TP -.I sdev -The ID of the device where the target file resides (in hexadecimal). -.TP -.I mask -The mask of events being monitored for the target file (in hexadecimal). -.RE -.IP -If the kernel was built with exportfs support, the path to the target -file is exposed as a file handle, via three hexadecimal fields: -.IR fhandle\-bytes , -.IR fhandle\-type , -and -.IR f_handle . -.IP -For fanotify file descriptors (see -.BR fanotify (7)), -we see (since Linux 3.8) -the following fields: -.IP -.in +4n -.EX -pos: 0 -flags: 02 -mnt_id: 11 -fanotify flags:0 event\-flags:88002 -fanotify ino:19264f sdev:800001 mflags:0 mask:1 ignored_mask:0 fhandle\-bytes:8 fhandle\-type:1 f_handle:4f261900a82dfd73 -.EE -.in -.IP -The fourth line displays information defined when the fanotify group -was created via -.BR fanotify_init (2): -.RS -.TP -.I flags -The -.I flags -argument given to -.BR fanotify_init (2) -(expressed in hexadecimal). -.TP -.I event\-flags -The -.I event_f_flags -argument given to -.BR fanotify_init (2) -(expressed in hexadecimal). -.RE -.IP -Each additional line shown in the file contains information -about one of the marks in the fanotify group. -Most of these fields are as for inotify, except: -.RS -.TP -.I mflags -The flags associated with the mark -(expressed in hexadecimal). -.TP -.I mask -The events mask for this mark -(expressed in hexadecimal). -.TP -.I ignored_mask -The mask of events that are ignored for this mark -(expressed in hexadecimal). -.RE -.IP -For details on these fields, see -.BR fanotify_mark (2). -.IP -For timerfd file descriptors (see -.BR timerfd (2)), -we see (since Linux 3.17) -.\" commit af9c4957cf212ad9cf0bee34c95cb11de5426e85 -the following fields: -.IP -.in +4n -.EX -pos: 0 -flags: 02004002 -mnt_id: 13 -clockid: 0 -ticks: 0 -settime flags: 03 -it_value: (7695568592, 640020877) -it_interval: (0, 0) -.EE -.in -.RS -.TP -.I clockid -This is the numeric value of the clock ID -(corresponding to one of the -.B CLOCK_* -constants defined via -.IR <time.h> ) -that is used to mark the progress of the timer (in this example, 0 is -.BR CLOCK_REALTIME ). -.TP -.I ticks -This is the number of timer expirations that have occurred, -(i.e., the value that -.BR read (2) -on it would return). -.TP -.I settime flags -This field lists the flags with which the timerfd was last armed (see -.BR timerfd_settime (2)), -in octal -(in this example, both -.B TFD_TIMER_ABSTIME -and -.B TFD_TIMER_CANCEL_ON_SET -are set). -.TP -.I it_value -This field contains the amount of time until the timer will next expire, -expressed in seconds and nanoseconds. -This is always expressed as a relative value, -regardless of whether the timer was created using the -.B TFD_TIMER_ABSTIME -flag. -.TP -.I it_interval -This field contains the interval of the timer, -in seconds and nanoseconds. -(The -.I it_value -and -.I it_interval -fields contain the values that -.BR timerfd_gettime (2) -on this file descriptor would return.) -.RE -.TP -.IR /proc/ pid /gid_map " (since Linux 3.5)" -See -.BR user_namespaces (7). -.TP -.IR /proc/ pid /io " (since Linux 2.6.20)" -.\" commit 7c3ab7381e79dfc7db14a67c6f4f3285664e1ec2 -This file contains I/O statistics for the process, for example: -.IP -.in +4n -.EX -.RB "#" " cat /proc/3828/io" -rchar: 323934931 -wchar: 323929600 -syscr: 632687 -syscw: 632675 -read_bytes: 0 -write_bytes: 323932160 -cancelled_write_bytes: 0 -.EE -.in -.IP -The fields are as follows: -.RS -.TP -.IR rchar ": characters read" -The number of bytes which this task has caused to be read from storage. -This is simply the sum of bytes which this process passed to -.BR read (2) -and similar system calls. -It includes things such as terminal I/O and -is unaffected by whether or not actual -physical disk I/O was required (the read might have been satisfied from -pagecache). -.TP -.IR wchar ": characters written" -The number of bytes which this task has caused, or shall cause to be written -to disk. -Similar caveats apply here as with -.IR rchar . -.TP -.IR syscr ": read syscalls" -Attempt to count the number of read I/O operations\[em]that is, -system calls such as -.BR read (2) -and -.BR pread (2). -.TP -.IR syscw ": write syscalls" -Attempt to count the number of write I/O operations\[em]that is, -system calls such as -.BR write (2) -and -.BR pwrite (2). -.TP -.IR read_bytes ": bytes read" -Attempt to count the number of bytes which this process really did cause to -be fetched from the storage layer. -This is accurate for block-backed filesystems. -.TP -.IR write_bytes ": bytes written" -Attempt to count the number of bytes which this process caused to be sent to -the storage layer. -.TP -.IR cancelled_write_bytes : -The big inaccuracy here is truncate. -If a process writes 1 MB to a file and then deletes the file, -it will in fact perform no writeout. -But it will have been accounted as having caused 1 MB of write. -In other words: this field represents the number of bytes which this process -caused to not happen, by truncating pagecache. -A task can cause "negative" I/O too. -If this task truncates some dirty pagecache, -some I/O which another task has been accounted for -(in its -.IR write_bytes ) -will not be happening. -.RE -.IP -.IR Note : -In the current implementation, things are a bit racy on 32-bit systems: -if process A reads process B's -.IR /proc/ pid /io -while process B is updating one of these 64-bit counters, -process A could see an intermediate result. -.IP -Permission to access this file is governed by a ptrace access mode -.B PTRACE_MODE_READ_FSCREDS -check; see -.BR ptrace (2). -.TP -.IR /proc/ pid /limits " (since Linux 2.6.24)" -This file displays the soft limit, hard limit, and units of measurement -for each of the process's resource limits (see -.BR getrlimit (2)). -Up to and including Linux 2.6.35, -this file is protected to allow reading only by the real UID of the process. -Since Linux 2.6.36, -.\" commit 3036e7b490bf7878c6dae952eec5fb87b1106589 -this file is readable by all users on the system. -.\" FIXME Describe /proc/[pid]/loginuid -.\" Added in Linux 2.6.11; updating requires CAP_AUDIT_CONTROL -.\" CONFIG_AUDITSYSCALL -.TP -.IR /proc/ pid /map_files/ " (since Linux 3.3)" -.\" commit 640708a2cff7f81e246243b0073c66e6ece7e53e -This subdirectory contains entries corresponding to memory-mapped -files (see -.BR mmap (2)). -Entries are named by memory region start and end -address pair (expressed as hexadecimal numbers), -and are symbolic links to the mapped files themselves. -Here is an example, -with the output wrapped and reformatted to fit on an 80-column display: -.IP -.in +4n -.EX -.RB "#" " ls \-l /proc/self/map_files/" -lr\-\-\-\-\-\-\-\-. 1 root root 64 Apr 16 21:31 - 3252e00000\-3252e20000 \-> /usr/lib64/ld\-2.15.so -\&... -.EE -.in -.IP -Although these entries are present for memory regions that were -mapped with the -.B MAP_FILE -flag, the way anonymous shared memory (regions created with the -.B MAP_ANON | MAP_SHARED -flags) -is implemented in Linux -means that such regions also appear on this directory. -Here is an example where the target file is the deleted -.I /dev/zero -one: -.IP -.in +4n -.EX -lrw\-\-\-\-\-\-\-. 1 root root 64 Apr 16 21:33 - 7fc075d2f000\-7fc075e6f000 \-> /dev/zero (deleted) -.EE -.in -.IP -Permission to access this file is governed by a ptrace access mode -.B PTRACE_MODE_READ_FSCREDS -check; see -.BR ptrace (2). -.IP -Until Linux 4.3, -.\" commit bdb4d100afe9818aebd1d98ced575c5ef143456c -this directory appeared only if the -.B CONFIG_CHECKPOINT_RESTORE -kernel configuration option was enabled. -.IP -Capabilities are required to read the contents of the symbolic links in -this directory: before Linux 5.9, the reading process requires -.B CAP_SYS_ADMIN -in the initial user namespace; -since Linux 5.9, the reading process must have either -.B CAP_SYS_ADMIN -or -.B CAP_CHECKPOINT_RESTORE -in the initial (i.e. root) user namespace. -.TP -.IR /proc/ pid /maps -A file containing the currently mapped memory regions and their access -permissions. -See -.BR mmap (2) -for some further information about memory mappings. -.IP -Permission to access this file is governed by a ptrace access mode -.B PTRACE_MODE_READ_FSCREDS -check; see -.BR ptrace (2). -.IP -The format of the file is: -.IP -.in +4n -.EX -.I "address perms offset dev inode pathname" -00400000\-00452000 r\-xp 00000000 08:02 173521 /usr/bin/dbus\-daemon -00651000\-00652000 r\-\-p 00051000 08:02 173521 /usr/bin/dbus\-daemon -00652000\-00655000 rw\-p 00052000 08:02 173521 /usr/bin/dbus\-daemon -00e03000\-00e24000 rw\-p 00000000 00:00 0 [heap] -00e24000\-011f7000 rw\-p 00000000 00:00 0 [heap] -\&... -35b1800000\-35b1820000 r\-xp 00000000 08:02 135522 /usr/lib64/ld\-2.15.so -35b1a1f000\-35b1a20000 r\-\-p 0001f000 08:02 135522 /usr/lib64/ld\-2.15.so -35b1a20000\-35b1a21000 rw\-p 00020000 08:02 135522 /usr/lib64/ld\-2.15.so -35b1a21000\-35b1a22000 rw\-p 00000000 00:00 0 -35b1c00000\-35b1dac000 r\-xp 00000000 08:02 135870 /usr/lib64/libc\-2.15.so -35b1dac000\-35b1fac000 \-\-\-p 001ac000 08:02 135870 /usr/lib64/libc\-2.15.so -35b1fac000\-35b1fb0000 r\-\-p 001ac000 08:02 135870 /usr/lib64/libc\-2.15.so -35b1fb0000\-35b1fb2000 rw\-p 001b0000 08:02 135870 /usr/lib64/libc\-2.15.so -\&... -f2c6ff8c000\-7f2c7078c000 rw\-p 00000000 00:00 0 [stack:986] -\&... -7fffb2c0d000\-7fffb2c2e000 rw\-p 00000000 00:00 0 [stack] -7fffb2d48000\-7fffb2d49000 r\-xp 00000000 00:00 0 [vdso] -.EE -.in -.IP -The -.I address -field is the address space in the process that the mapping occupies. -The -.I perms -field is a set of permissions: -.IP -.in +4n -.EX -r = read -w = write -x = execute -s = shared -p = private (copy on write) -.EE -.in -.IP -The -.I offset -field is the offset into the file/whatever; -.I dev -is the device -(major:minor); -.I inode -is the inode on that device. -0 indicates that no inode is associated with the memory region, -as would be the case with BSS (uninitialized data). -.IP -The -.I pathname -field will usually be the file that is backing the mapping. -For ELF files, -you can easily coordinate with the -.I offset -field by looking at the -Offset field in the ELF program headers -.RI ( "readelf\ \-l" ). -.IP -There are additional helpful pseudo-paths: -.RS -.TP -.I [stack] -The initial process's (also known as the main thread's) stack. -.TP -.IR [stack: tid ] " (from Linux 3.4 to Linux 4.4)" -.\" commit b76437579d1344b612cf1851ae610c636cec7db0 (added) -.\" commit 65376df582174ffcec9e6471bf5b0dd79ba05e4a (removed) -A thread's stack (where the -.I tid -is a thread ID). -It corresponds to the -.IR /proc/ pid /task/ tid / -path. -This field was removed in Linux 4.5, since providing this information -for a process with large numbers of threads is expensive. -.TP -.I [vdso] -The virtual dynamically linked shared object. -See -.BR vdso (7). -.TP -.I [heap] -The process's heap. -.TP -.IR [anon: name ] " (since Linux 5.17)" -.\" Commit 9a10064f5625d5572c3626c1516e0bebc6c9fe9b -A named private anonymous mapping. -Set with -.BR prctl (2) -.BR PR_SET_VMA_ANON_NAME . -.TP -.IR [anon_shmem: name ] " (since Linux 6.2)" -.\" Commit d09e8ca6cb93bb4b97517a18fbbf7eccb0e9ff43 -A named shared anonymous mapping. -Set with -.BR prctl (2) -.BR PR_SET_VMA_ANON_NAME . -.in -.RE -.IP -If the -.I pathname -field is blank, -this is an anonymous mapping as obtained via -.BR mmap (2). -There is no easy way to coordinate this back to a process's source, -short of running it through -.BR gdb (1), -.BR strace (1), -or similar. -.IP -.I pathname -is shown unescaped except for newline characters, which are replaced -with an octal escape sequence. -As a result, it is not possible to determine whether the original -pathname contained a newline character or the literal -.I \e012 -character sequence. -.IP -If the mapping is file-backed and the file has been deleted, the string -" (deleted)" is appended to the pathname. -Note that this is ambiguous too. -.IP -Under Linux 2.0, there is no field giving pathname. -.TP -.IR /proc/ pid /mem -This file can be used to access the pages of a process's memory through -.BR open (2), -.BR read (2), -and -.BR lseek (2). -.IP -Permission to access this file is governed by a ptrace access mode -.B PTRACE_MODE_ATTACH_FSCREDS -check; see -.BR ptrace (2). -.TP -.IR /proc/ pid /mountinfo " (since Linux 2.6.26)" -.\" This info adapted from Documentation/filesystems/proc.txt -.\" commit 2d4d4864ac08caff5c204a752bd004eed4f08760 -This file contains information about mounts -in the process's mount namespace (see -.BR mount_namespaces (7)). -It supplies various information -(e.g., propagation state, root of mount for bind mounts, -identifier for each mount and its parent) that is missing from the (older) -.IR /proc/ pid /mounts -file, and fixes various other problems with that file -(e.g., nonextensibility, -failure to distinguish per-mount versus per-superblock options). -.IP -The file contains lines of the form: -.IP -.EX -36 35 98:0 /mnt1 /mnt2 rw,noatime master:1 \- ext3 /dev/root rw,errors=continue -(1)(2)(3) (4) (5) (6) (7) (8) (9) (10) (11) -.EE -.IP -The numbers in parentheses are labels for the descriptions below: -.RS 7 -.TP 5 -(1) -mount ID: a unique ID for the mount (may be reused after -.BR umount (2)). -.TP -(2) -parent ID: the ID of the parent mount -(or of self for the root of this mount namespace's mount tree). -.IP -If a new mount is stacked on top of a previous existing mount -(so that it hides the existing mount) at pathname P, -then the parent of the new mount is the previous mount at that location. -Thus, when looking at all the mounts stacked at a particular location, -the top-most mount is the one that is not the parent -of any other mount at the same location. -(Note, however, that this top-most mount will be accessible only if -the longest path subprefix of P that is a mount point -is not itself hidden by a stacked mount.) -.IP -If the parent mount lies outside the process's root directory (see -.BR chroot (2)), -the ID shown here won't have a corresponding record in -.I mountinfo -whose mount ID (field 1) matches this parent mount ID -(because mounts that lie outside the process's root directory -are not shown in -.IR mountinfo ). -As a special case of this point, -the process's root mount may have a parent mount -(for the initramfs filesystem) that lies -.\" Miklos Szeredi, Nov 2017: The hidden one is the initramfs, I believe -.\" mtk: In the initial mount namespace, this hidden ID has the value 0 -outside the process's root directory, -and an entry for that mount will not appear in -.IR mountinfo . -.TP -(3) -major:minor: the value of -.I st_dev -for files on this filesystem (see -.BR stat (2)). -.TP -(4) -root: the pathname of the directory in the filesystem -which forms the root of this mount. -.TP -(5) -mount point: the pathname of the mount point relative -to the process's root directory. -.TP -(6) -mount options: per-mount options (see -.BR mount (2)). -.TP -(7) -optional fields: zero or more fields of the form "tag[:value]"; see below. -.TP -(8) -separator: the end of the optional fields is marked by a single hyphen. -.TP -(9) -filesystem type: the filesystem type in the form "type[.subtype]". -.TP -(10) -mount source: filesystem-specific information or "none". -.TP -(11) -super options: per-superblock options (see -.BR mount (2)). -.RE -.IP -Currently, the possible optional fields are -.IR shared , -.IR master , -.IR propagate_from , -and -.IR unbindable . -See -.BR mount_namespaces (7) -for a description of these fields. -Parsers should ignore all unrecognized optional fields. -.IP -For more information on mount propagation see -.I Documentation/filesystems/sharedsubtree.rst -(or -.I Documentation/filesystems/sharedsubtree.txt -before Linux 5.8) -in the Linux kernel source tree. -.TP -.IR /proc/ pid /mounts " (since Linux 2.4.19)" -This file lists all the filesystems currently mounted in the -process's mount namespace (see -.BR mount_namespaces (7)). -The format of this file is documented in -.BR fstab (5). -.IP -Since Linux 2.6.15, this file is pollable: -after opening the file for reading, a change in this file -(i.e., a filesystem mount or unmount) causes -.BR select (2) -to mark the file descriptor as having an exceptional condition, and -.BR poll (2) -and -.BR epoll_wait (2) -mark the file as having a priority event -.RB ( POLLPRI ). -(Before Linux 2.6.30, -a change in this file was indicated by the file descriptor -being marked as readable for -.BR select (2), -and being marked as having an error condition for -.BR poll (2) -and -.BR epoll_wait (2).) -.TP -.IR /proc/ pid /mountstats " (since Linux 2.6.17)" -This file exports information (statistics, configuration information) -about the mounts in the process's mount namespace (see -.BR mount_namespaces (7)). -Lines in this file have the form: -.IP -.in +4n -.EX -device /dev/sda7 mounted on /home with fstype ext3 [stats] -( 1 ) ( 2 ) (3 ) ( 4 ) -.EE -.in -.IP -The fields in each line are: -.RS 7 -.TP 5 -(1) -The name of the mounted device -(or "nodevice" if there is no corresponding device). -.TP -(2) -The mount point within the filesystem tree. -.TP -(3) -The filesystem type. -.TP -(4) -Optional statistics and configuration information. -Currently (as at Linux 2.6.26), only NFS filesystems export -information via this field. -.RE -.IP -This file is readable only by the owner of the process. -.TP -.IR /proc/ pid /net " (since Linux 2.6.25)" -See the description of -.IR /proc/net . -.TP -.IR /proc/ pid /ns/ " (since Linux 3.0)" -.\" See commit 6b4e306aa3dc94a0545eb9279475b1ab6209a31f -This is a subdirectory containing one entry for each namespace that -supports being manipulated by -.BR setns (2). -For more information, see -.BR namespaces (7). -.TP -.IR /proc/ pid /numa_maps " (since Linux 2.6.14)" -See -.BR numa (7). -.TP -.IR /proc/ pid /oom_adj " (since Linux 2.6.11)" -This file can be used to adjust the score used to select which process -should be killed in an out-of-memory (OOM) situation. -The kernel uses this value for a bit-shift operation of the process's -.I oom_score -value: -valid values are in the range \-16 to +15, -plus the special value \-17, -which disables OOM-killing altogether for this process. -A positive score increases the likelihood of this -process being killed by the OOM-killer; -a negative score decreases the likelihood. -.IP -The default value for this file is 0; -a new process inherits its parent's -.I oom_adj -setting. -A process must be privileged -.RB ( CAP_SYS_RESOURCE ) -to update this file, -although a process can always increase its own -.I oom_adj -setting (since Linux 2.6.20). -.IP -Since Linux 2.6.36, use of this file is deprecated in favor of -.IR /proc/ pid /oom_score_adj , -and finally removed in Linux 3.7. -.TP -.IR /proc/ pid /oom_score " (since Linux 2.6.11)" -.\" See mm/oom_kill.c::badness() before Linux 2.6.36 sources -.\" See mm/oom_kill.c::oom_badness() after Linux 2.6.36 -.\" commit a63d83f427fbce97a6cea0db2e64b0eb8435cd10 -This file displays the current score that the kernel gives to -this process for the purpose of selecting a process -for the OOM-killer. -A higher score means that the process is more likely to be -selected by the OOM-killer. -The basis for this score is the amount of memory used by the process, -with increases (+) or decreases (\-) for factors including: -.\" See mm/oom_kill.c::badness() before Linux 2.6.36 sources -.\" See mm/oom_kill.c::oom_badness() after Linux 2.6.36 -.\" commit a63d83f427fbce97a6cea0db2e64b0eb8435cd10 -.RS -.IP \[bu] 3 -whether the process is privileged (\-). -.\" More precisely, if it has CAP_SYS_ADMIN or (pre 2.6.36) CAP_SYS_RESOURCE -.RE -.IP -Before Linux 2.6.36 -the following factors were also used in the calculation of oom_score: -.RS -.IP \[bu] 3 -whether the process creates a lot of children using -.BR fork (2) -(+); -.IP \[bu] -whether the process has been running a long time, -or has used a lot of CPU time (\-); -.IP \[bu] -whether the process has a low nice value (i.e., > 0) (+); and -.IP \[bu] -whether the process is making direct hardware access (\-). -.\" More precisely, if it has CAP_SYS_RAWIO -.RE -.IP -The -.I oom_score -also reflects the adjustment specified by the -.I oom_score_adj -or -.I oom_adj -setting for the process. -.TP -.IR /proc/ pid /oom_score_adj " (since Linux 2.6.36)" -.\" Text taken from Linux 3.7 Documentation/filesystems/proc.txt -This file can be used to adjust the badness heuristic used to select which -process gets killed in out-of-memory conditions. -.IP -The badness heuristic assigns a value to each candidate task ranging from 0 -(never kill) to 1000 (always kill) to determine which process is targeted. -The units are roughly a proportion along that range of -allowed memory the process may allocate from, -based on an estimation of its current memory and swap use. -For example, if a task is using all allowed memory, -its badness score will be 1000. -If it is using half of its allowed memory, its score will be 500. -.IP -There is an additional factor included in the badness score: root -processes are given 3% extra memory over other tasks. -.IP -The amount of "allowed" memory depends on the context -in which the OOM-killer was called. -If it is due to the memory assigned to the allocating task's cpuset -being exhausted, -the allowed memory represents the set of mems assigned to that -cpuset (see -.BR cpuset (7)). -If it is due to a mempolicy's node(s) being exhausted, -the allowed memory represents the set of mempolicy nodes. -If it is due to a memory limit (or swap limit) being reached, -the allowed memory is that configured limit. -Finally, if it is due to the entire system being out of memory, the -allowed memory represents all allocatable resources. -.IP -The value of -.I oom_score_adj -is added to the badness score before it -is used to determine which task to kill. -Acceptable values range from \-1000 -(OOM_SCORE_ADJ_MIN) to +1000 (OOM_SCORE_ADJ_MAX). -This allows user space to control the preference for OOM-killing, -ranging from always preferring a certain -task or completely disabling it from OOM-killing. -The lowest possible value, \-1000, is -equivalent to disabling OOM-killing entirely for that task, -since it will always report a badness score of 0. -.IP -Consequently, it is very simple for user space to define -the amount of memory to consider for each task. -Setting an -.I oom_score_adj -value of +500, for example, -is roughly equivalent to allowing the remainder of tasks sharing the -same system, cpuset, mempolicy, or memory controller resources -to use at least 50% more memory. -A value of \-500, on the other hand, would be roughly -equivalent to discounting 50% of the task's -allowed memory from being considered as scoring against the task. -.IP -For backward compatibility with previous kernels, -.IR /proc/ pid /oom_adj -can still be used to tune the badness score. -Its value is -scaled linearly with -.IR oom_score_adj . -.IP -Writing to -.IR /proc/ pid /oom_score_adj -or -.IR /proc/ pid /oom_adj -will change the other with its scaled value. -.IP -The -.BR choom (1) -program provides a command-line interface for adjusting the -.I oom_score_adj -value of a running process or a newly executed command. -.TP -.IR /proc/ pid /pagemap " (since Linux 2.6.25)" -This file shows the mapping of each of the process's virtual pages -into physical page frames or swap area. -It contains one 64-bit value for each virtual page, -with the bits set as follows: -.RS -.TP -63 -If set, the page is present in RAM. -.TP -62 -If set, the page is in swap space -.TP -61 (since Linux 3.5) -The page is a file-mapped page or a shared anonymous page. -.TP -60\[en]58 (since Linux 3.11) -Zero -.\" Not quite true; see commit 541c237c0923f567c9c4cabb8a81635baadc713f -.TP -57 (since Linux 5.14) -If set, the page is write-protected through -.BR userfaultfd (2). -.TP -56 (since Linux 4.2) -.\" commit 77bb499bb60f4b79cca7d139c8041662860fcf87 -.\" commit 83b4b0bb635eee2b8e075062e4e008d1bc110ed7 -The page is exclusively mapped. -.TP -55 (since Linux 3.11) -PTE is soft-dirty -(see the kernel source file -.IR Documentation/admin\-guide/mm/soft\-dirty.rst ). -.TP -54\[en]0 -If the page is present in RAM (bit 63), then these bits -provide the page frame number, which can be used to index -.I /proc/kpageflags -and -.IR /proc/kpagecount . -If the page is present in swap (bit 62), -then bits 4\[en]0 give the swap type, and bits 54\[en]5 encode the swap offset. -.RE -.IP -Before Linux 3.11, bits 60\[en]55 were -used to encode the base-2 log of the page size. -.IP -To employ -.IR /proc/ pid /pagemap -efficiently, use -.IR /proc/ pid /maps -to determine which areas of memory are actually mapped and seek -to skip over unmapped regions. -.IP -The -.IR /proc/ pid /pagemap -file is present only if the -.B CONFIG_PROC_PAGE_MONITOR -kernel configuration option is enabled. -.IP -Permission to access this file is governed by a ptrace access mode -.B PTRACE_MODE_READ_FSCREDS -check; see -.BR ptrace (2). -.TP -.IR /proc/ pid /personality " (since Linux 2.6.28)" -.\" commit 478307230810d7e2a753ed220db9066dfdf88718 -This read-only file exposes the process's execution domain, as set by -.BR personality (2). -The value is displayed in hexadecimal notation. -.IP -Permission to access this file is governed by a ptrace access mode -.B PTRACE_MODE_ATTACH_FSCREDS -check; see -.BR ptrace (2). -.TP -.IR /proc/ pid /root -UNIX and Linux support the idea of a per-process root of the -filesystem, set by the -.BR chroot (2) -system call. -This file is a symbolic link that points to the process's -root directory, and behaves in the same way as -.IR exe , -and -.IR fd/* . -.IP -Note however that this file is not merely a symbolic link. -It provides the same view of the filesystem (including namespaces and the -set of per-process mounts) as the process itself. -An example illustrates this point. -In one terminal, we start a shell in new user and mount namespaces, -and in that shell we create some new mounts: -.IP -.in +4n -.EX -$ \fBPS1=\[aq]sh1# \[aq] unshare \-Urnm\fP -sh1# \fBmount \-t tmpfs tmpfs /etc\fP # Mount empty tmpfs at /etc -sh1# \fBmount \-\-bind /usr /dev\fP # Mount /usr at /dev -sh1# \fBecho $$\fP -27123 -.EE -.in -.IP -In a second terminal window, in the initial mount namespace, -we look at the contents of the corresponding mounts in -the initial and new namespaces: -.IP -.in +4n -.EX -$ \fBPS1=\[aq]sh2# \[aq] sudo sh\fP -sh2# \fBls /etc | wc \-l\fP # In initial NS -309 -sh2# \fBls /proc/27123/root/etc | wc \-l\fP # /etc in other NS -0 # The empty tmpfs dir -sh2# \fBls /dev | wc \-l\fP # In initial NS -205 -sh2# \fBls /proc/27123/root/dev | wc \-l\fP # /dev in other NS -11 # Actually bind - # mounted to /usr -sh2# \fBls /usr | wc \-l\fP # /usr in initial NS -11 -.EE -.in -.IP -.\" The following was still true as at kernel 2.6.13 -In a multithreaded process, the contents of the -.IR /proc/ pid /root -symbolic link are not available if the main thread has already terminated -(typically by calling -.BR pthread_exit (3)). -.IP -Permission to dereference or read -.RB ( readlink (2)) -this symbolic link is governed by a ptrace access mode -.B PTRACE_MODE_READ_FSCREDS -check; see -.BR ptrace (2). -.TP -.IR /proc/ pid /projid_map " (since Linux 3.7)" -.\" commit f76d207a66c3a53defea67e7d36c3eb1b7d6d61d -See -.BR user_namespaces (7). -.TP -.IR /proc/ pid /seccomp " (Linux 2.6.12 to Linux 2.6.22)" -This file can be used to read and change the process's -secure computing (seccomp) mode setting. -It contains the value 0 if the process is not in seccomp mode, -and 1 if the process is in strict seccomp mode (see -.BR seccomp (2)). -Writing 1 to this file places the process irreversibly in strict seccomp mode. -(Further attempts to write to the file fail with the -.B EPERM -error.) -.IP -In Linux 2.6.23, -this file went away, to be replaced by the -.BR prctl (2) -.B PR_GET_SECCOMP -and -.B PR_SET_SECCOMP -operations (and later by -.BR seccomp (2) -and the -.I Seccomp -field in -.IR /proc/ pid /status ). +.\" .SH FILES .\" FIXME Describe /proc/[pid]/sessionid .\" commit 1e0bd7550ea9cf474b1ad4c6ff5729a507f75fdc .\" CONFIG_AUDITSYSCALL @@ -1958,4970 +204,25 @@ field in .\" /proc/[pid]/task/[tid]/schedstats .\" Added in Linux 2.6.9 .\" CONFIG_SCHEDSTATS -.TP -.IR /proc/ pid /setgroups " (since Linux 3.19)" -See -.BR user_namespaces (7). -.TP -.IR /proc/ pid /smaps " (since Linux 2.6.14)" -This file shows memory consumption for each of the process's mappings. -(The -.BR pmap (1) -command displays similar information, -in a form that may be easier for parsing.) -For each mapping there is a series of lines such as the following: -.IP -.in +4n -.EX -00400000\-0048a000 r\-xp 00000000 fd:03 960637 /bin/bash -Size: 552 kB -Rss: 460 kB -Pss: 100 kB -Shared_Clean: 452 kB -Shared_Dirty: 0 kB -Private_Clean: 8 kB -Private_Dirty: 0 kB -Referenced: 460 kB -Anonymous: 0 kB -AnonHugePages: 0 kB -ShmemHugePages: 0 kB -ShmemPmdMapped: 0 kB -Swap: 0 kB -KernelPageSize: 4 kB -MMUPageSize: 4 kB -Locked: 0 kB -ProtectionKey: 0 -VmFlags: rd ex mr mw me dw -.EE -.in -.IP -The first of these lines shows the same information as is displayed -for the mapping in -.IR /proc/ pid /maps . -The following lines show the size of the mapping, -the amount of the mapping that is currently resident in RAM ("Rss"), -the process's proportional share of this mapping ("Pss"), -the number of clean and dirty shared pages in the mapping, -and the number of clean and dirty private pages in the mapping. -"Referenced" indicates the amount of memory currently marked as -referenced or accessed. -"Anonymous" shows the amount of memory -that does not belong to any file. -"Swap" shows how much -would-be-anonymous memory is also used, but out on swap. -.IP -The "KernelPageSize" line (available since Linux 2.6.29) -is the page size used by the kernel to back the virtual memory area. -This matches the size used by the MMU in the majority of cases. -However, one counter-example occurs on PPC64 kernels -whereby a kernel using 64 kB as a base page size may still use 4 kB -pages for the MMU on older processors. -To distinguish the two attributes, the "MMUPageSize" line -(also available since Linux 2.6.29) -reports the page size used by the MMU. -.IP -The "Locked" indicates whether the mapping is locked in memory -or not. -.IP -The "ProtectionKey" line (available since Linux 4.9, on x86 only) -contains the memory protection key (see -.BR pkeys (7)) -associated with the virtual memory area. -This entry is present only if the kernel was built with the -.B CONFIG_X86_INTEL_MEMORY_PROTECTION_KEYS -configuration option (since Linux 4.6). -.IP -The "VmFlags" line (available since Linux 3.8) -represents the kernel flags associated with the virtual memory area, -encoded using the following two-letter codes: -.RS -.IP -.TS -l l l. -rd - readable -wr - writable -ex - executable -sh - shared -mr - may read -mw - may write -me - may execute -ms - may share -gd - stack segment grows down -pf - pure PFN range -dw - disabled write to the mapped file -lo - pages are locked in memory -io - memory mapped I/O area -sr - sequential read advise provided -rr - random read advise provided -dc - do not copy area on fork -de - do not expand area on remapping -ac - area is accountable -nr - swap space is not reserved for the area -ht - area uses huge tlb pages -sf - perform synchronous page faults (since Linux 4.15) -nl - non-linear mapping (removed in Linux 4.0) -ar - architecture specific flag -wf - wipe on fork (since Linux 4.14) -dd - do not include area into core dump -sd - soft-dirty flag (since Linux 3.13) -mm - mixed map area -hg - huge page advise flag -nh - no-huge page advise flag -mg - mergeable advise flag -um - userfaultfd missing pages tracking (since Linux 4.3) -uw - userfaultfd wprotect pages tracking (since Linux 4.3) -.TE -.RE -.IP -The -.IR /proc/ pid /smaps -file is present only if the -.B CONFIG_PROC_PAGE_MONITOR -kernel configuration option is enabled. -.TP -.IR /proc/ pid /stack " (since Linux 2.6.29)" -.\" 2ec220e27f5040aec1e88901c1b6ea3d135787ad -This file provides a symbolic trace of the function calls in this -process's kernel stack. -This file is provided only if the kernel was built with the -.B CONFIG_STACKTRACE -configuration option. -.IP -Permission to access this file is governed by a ptrace access mode -.B PTRACE_MODE_ATTACH_FSCREDS -check; see -.BR ptrace (2). -.TP -.IR /proc/ pid /stat -Status information about the process. -This is used by -.BR ps (1). -It is defined in the kernel source file -.IR fs/proc/array.c "." -.IP -The fields, in order, with their proper -.BR scanf (3) -format specifiers, are listed below. -Whether or not certain of these fields display valid information is governed by -a ptrace access mode -.BR PTRACE_MODE_READ_FSCREDS " | " PTRACE_MODE_NOAUDIT -check (refer to -.BR ptrace (2)). -If the check denies access, then the field value is displayed as 0. -The affected fields are indicated with the marking [PT]. -.RS -.TP -(1) \fIpid\fP \ %d -.br -The process ID. -.TP -(2) \fIcomm\fP \ %s -The filename of the executable, in parentheses. -Strings longer than -.B TASK_COMM_LEN -(16) characters (including the terminating null byte) are silently truncated. -This is visible whether or not the executable is swapped out. -.TP -(3) \fIstate\fP \ %c -One of the following characters, indicating process state: -.RS -.TP -R -Running -.TP -S -Sleeping in an interruptible wait -.TP -D -Waiting in uninterruptible -disk sleep -.TP -Z -Zombie -.TP -T -Stopped (on a signal) or (before Linux 2.6.33) trace stopped -.TP -t -.\" commit 44d90df6b757c59651ddd55f1a84f28132b50d29 -Tracing stop (Linux 2.6.33 onward) -.TP -W -Paging (only before Linux 2.6.0) -.TP -X -Dead (from Linux 2.6.0 onward) -.TP -x -.\" commit 44d90df6b757c59651ddd55f1a84f28132b50d29 -Dead (Linux 2.6.33 to -.\" commit 74e37200de8e9c4e09b70c21c3f13c2071e77457 -3.13 only) -.TP -K -.\" commit 44d90df6b757c59651ddd55f1a84f28132b50d29 -Wakekill (Linux 2.6.33 to -.\" commit 74e37200de8e9c4e09b70c21c3f13c2071e77457 -3.13 only) -.TP -W -.\" commit 44d90df6b757c59651ddd55f1a84f28132b50d29 -Waking (Linux 2.6.33 to -.\" commit 74e37200de8e9c4e09b70c21c3f13c2071e77457 -3.13 only) -.TP -P -.\" commit f2530dc71cf0822f90bb63ea4600caaef33a66bb -Parked (Linux 3.9 to -.\" commit 74e37200de8e9c4e09b70c21c3f13c2071e77457 -3.13 only) -.TP -I -.\" commit 06eb61844d841d0032a9950ce7f8e783ee49c0d0 -Idle (Linux 4.14 onward) -.RE -.TP -(4) \fIppid\fP \ %d -The PID of the parent of this process. -.TP -(5) \fIpgrp\fP \ %d -The process group ID of the process. -.TP -(6) \fIsession\fP \ %d -The session ID of the process. -.TP -(7) \fItty_nr\fP \ %d -The controlling terminal of the process. -(The minor device number is contained in the combination of bits -31 to 20 and 7 to 0; -the major device number is in bits 15 to 8.) -.TP -(8) \fItpgid\fP \ %d -.\" This field and following, up to and including wchan added 0.99.1 -The ID of the foreground process group of the controlling -terminal of the process. -.TP -(9) \fIflags\fP \ %u -The kernel flags word of the process. -For bit meanings, -see the PF_* defines in the Linux kernel source file -.IR include/linux/sched.h . -Details depend on the kernel version. -.IP -The format for this field was %lu before Linux 2.6. -.TP -(10) \fIminflt\fP \ %lu -The number of minor faults the process has made which have not -required loading a memory page from disk. -.TP -(11) \fIcminflt\fP \ %lu -The number of minor faults that the process's -waited-for children have made. -.TP -(12) \fImajflt\fP \ %lu -The number of major faults the process has made which have -required loading a memory page from disk. -.TP -(13) \fIcmajflt\fP \ %lu -The number of major faults that the process's -waited-for children have made. -.TP -(14) \fIutime\fP \ %lu -Amount of time that this process has been scheduled in user mode, -measured in clock ticks (divide by -.IR sysconf(_SC_CLK_TCK) ). -This includes guest time, \fIguest_time\fP -(time spent running a virtual CPU, see below), -so that applications that are not aware of the guest time field -do not lose that time from their calculations. -.TP -(15) \fIstime\fP \ %lu -Amount of time that this process has been scheduled in kernel mode, -measured in clock ticks (divide by -.IR sysconf(_SC_CLK_TCK) ). -.TP -(16) \fIcutime\fP \ %ld -Amount of time that this process's -waited-for children have been scheduled in user mode, -measured in clock ticks (divide by -.IR sysconf(_SC_CLK_TCK) ). -(See also -.BR times (2).) -This includes guest time, \fIcguest_time\fP -(time spent running a virtual CPU, see below). -.TP -(17) \fIcstime\fP \ %ld -Amount of time that this process's -waited-for children have been scheduled in kernel mode, -measured in clock ticks (divide by -.IR sysconf(_SC_CLK_TCK) ). -.TP -(18) \fIpriority\fP \ %ld -(Explanation for Linux 2.6) -For processes running a real-time scheduling policy -.RI ( policy -below; see -.BR sched_setscheduler (2)), -this is the negated scheduling priority, minus one; -that is, a number in the range \-2 to \-100, -corresponding to real-time priorities 1 to 99. -For processes running under a non-real-time scheduling policy, -this is the raw nice value -.RB ( setpriority (2)) -as represented in the kernel. -The kernel stores nice values as numbers -in the range 0 (high) to 39 (low), -corresponding to the user-visible nice range of \-20 to 19. -.IP -Before Linux 2.6, this was a scaled value based on -the scheduler weighting given to this process. -.\" And back in Linux 1.2 days things were different again. -.TP -(19) \fInice\fP \ %ld -The nice value (see -.BR setpriority (2)), -a value in the range 19 (low priority) to \-20 (high priority). -.\" Back in Linux 1.2 days things were different. -.\" .TP -.\" \fIcounter\fP %ld -.\" The current maximum size in jiffies of the process's next timeslice, -.\" or what is currently left of its current timeslice, if it is the -.\" currently running process. -.\" .TP -.\" \fItimeout\fP %u -.\" The time in jiffies of the process's next timeout. -.\" timeout was removed sometime around 2.1/2.2 -.TP -(20) \fInum_threads\fP \ %ld -Number of threads in this process (since Linux 2.6). -Before Linux 2.6, this field was hard coded to 0 as a placeholder -for an earlier removed field. -.TP -(21) \fIitrealvalue\fP \ %ld -The time in jiffies before the next -.B SIGALRM -is sent to the process due to an interval timer. -Since Linux 2.6.17, this field is no longer maintained, -and is hard coded as 0. -.TP -(22) \fIstarttime\fP \ %llu -The time the process started after system boot. -Before Linux 2.6, this value was expressed in jiffies. -Since Linux 2.6, the value is expressed in clock ticks (divide by -.IR sysconf(_SC_CLK_TCK) ). -.IP -The format for this field was %lu before Linux 2.6. -.TP -(23) \fIvsize\fP \ %lu -Virtual memory size in bytes. -.TP -(24) \fIrss\fP \ %ld -Resident Set Size: number of pages the process has in real memory. -This is just the pages which -count toward text, data, or stack space. -This does not include pages -which have not been demand-loaded in, or which are swapped out. -This value is inaccurate; see -.IR /proc/ pid /statm -below. -.TP -(25) \fIrsslim\fP \ %lu -Current soft limit in bytes on the rss of the process; -see the description of -.B RLIMIT_RSS -in -.BR getrlimit (2). -.TP -(26) \fIstartcode\fP \ %lu \ [PT] -The address above which program text can run. -.TP -(27) \fIendcode\fP \ %lu \ [PT] -The address below which program text can run. -.TP -(28) \fIstartstack\fP \ %lu \ [PT] -The address of the start (i.e., bottom) of the stack. -.TP -(29) \fIkstkesp\fP \ %lu \ [PT] -The current value of ESP (stack pointer), as found in the -kernel stack page for the process. -.TP -(30) \fIkstkeip\fP \ %lu \ [PT] -The current EIP (instruction pointer). -.TP -(31) \fIsignal\fP \ %lu -The bitmap of pending signals, displayed as a decimal number. -Obsolete, because it does not provide information on real-time signals; use -.IR /proc/ pid /status -instead. -.TP -(32) \fIblocked\fP \ %lu -The bitmap of blocked signals, displayed as a decimal number. -Obsolete, because it does not provide information on real-time signals; use -.IR /proc/ pid /status -instead. -.TP -(33) \fIsigignore\fP \ %lu -The bitmap of ignored signals, displayed as a decimal number. -Obsolete, because it does not provide information on real-time signals; use -.IR /proc/ pid /status -instead. -.TP -(34) \fIsigcatch\fP \ %lu -The bitmap of caught signals, displayed as a decimal number. -Obsolete, because it does not provide information on real-time signals; use -.IR /proc/ pid /status -instead. -.TP -(35) \fIwchan\fP \ %lu \ [PT] -This is the "channel" in which the process is waiting. -It is the address of a location in the kernel where the process is sleeping. -The corresponding symbolic name can be found in -.IR /proc/ pid /wchan . -.TP -(36) \fInswap\fP \ %lu -.\" nswap was added in Linux 2.0 -Number of pages swapped (not maintained). -.TP -(37) \fIcnswap\fP \ %lu -.\" cnswap was added in Linux 2.0 -Cumulative \fInswap\fP for child processes (not maintained). -.TP -(38) \fIexit_signal\fP \ %d \ (since Linux 2.1.22) -Signal to be sent to parent when we die. -.TP -(39) \fIprocessor\fP \ %d \ (since Linux 2.2.8) -CPU number last executed on. -.TP -(40) \fIrt_priority\fP \ %u \ (since Linux 2.5.19) -Real-time scheduling priority, a number in the range 1 to 99 for -processes scheduled under a real-time policy, -or 0, for non-real-time processes (see -.BR sched_setscheduler (2)). -.TP -(41) \fIpolicy\fP \ %u \ (since Linux 2.5.19) -Scheduling policy (see -.BR sched_setscheduler (2)). -Decode using the SCHED_* constants in -.IR linux/sched.h . -.IP -The format for this field was %lu before Linux 2.6.22. -.TP -(42) \fIdelayacct_blkio_ticks\fP \ %llu \ (since Linux 2.6.18) -Aggregated block I/O delays, measured in clock ticks (centiseconds). -.TP -(43) \fIguest_time\fP \ %lu \ (since Linux 2.6.24) -Guest time of the process (time spent running a virtual CPU -for a guest operating system), measured in clock ticks (divide by -.IR sysconf(_SC_CLK_TCK) ). -.TP -(44) \fIcguest_time\fP \ %ld \ (since Linux 2.6.24) -Guest time of the process's children, measured in clock ticks (divide by -.IR sysconf(_SC_CLK_TCK) ). -.TP -(45) \fIstart_data\fP \ %lu \ (since Linux 3.3) \ [PT] -.\" commit b3f7f573a20081910e34e99cbc91831f4f02f1ff -Address above which program initialized and -uninitialized (BSS) data are placed. -.TP -(46) \fIend_data\fP \ %lu \ (since Linux 3.3) \ [PT] -.\" commit b3f7f573a20081910e34e99cbc91831f4f02f1ff -Address below which program initialized and -uninitialized (BSS) data are placed. -.TP -(47) \fIstart_brk\fP \ %lu \ (since Linux 3.3) \ [PT] -.\" commit b3f7f573a20081910e34e99cbc91831f4f02f1ff -Address above which program heap can be expanded with -.BR brk (2). -.TP -(48) \fIarg_start\fP \ %lu \ (since Linux 3.5) \ [PT] -.\" commit 5b172087f99189416d5f47fd7ab5e6fb762a9ba3 -Address above which program command-line arguments -.RI ( argv ) -are placed. -.TP -(49) \fIarg_end\fP \ %lu \ (since Linux 3.5) \ [PT] -.\" commit 5b172087f99189416d5f47fd7ab5e6fb762a9ba3 -Address below program command-line arguments -.RI ( argv ) -are placed. -.TP -(50) \fIenv_start\fP \ %lu \ (since Linux 3.5) \ [PT] -.\" commit 5b172087f99189416d5f47fd7ab5e6fb762a9ba3 -Address above which program environment is placed. -.TP -(51) \fIenv_end\fP \ %lu \ (since Linux 3.5) \ [PT] -.\" commit 5b172087f99189416d5f47fd7ab5e6fb762a9ba3 -Address below which program environment is placed. -.TP -(52) \fIexit_code\fP \ %d \ (since Linux 3.5) \ [PT] -.\" commit 5b172087f99189416d5f47fd7ab5e6fb762a9ba3 -The thread's exit status in the form reported by -.BR waitpid (2). -.RE -.TP -.IR /proc/ pid /statm -Provides information about memory usage, measured in pages. -The columns are: -.IP -.in +4n -.EX -size (1) total program size - (same as VmSize in \fI/proc/\fPpid\fI/status\fP) -resident (2) resident set size - (inaccurate; same as VmRSS in \fI/proc/\fPpid\fI/status\fP) -shared (3) number of resident shared pages - (i.e., backed by a file) - (inaccurate; same as RssFile+RssShmem in - \fI/proc/\fPpid\fI/status\fP) -text (4) text (code) -.\" (not including libs; broken, includes data segment) -lib (5) library (unused since Linux 2.6; always 0) -data (6) data + stack -.\" (including libs; broken, includes library text) -dt (7) dirty pages (unused since Linux 2.6; always 0) -.EE -.in -.IP -.\" See SPLIT_RSS_COUNTING in the kernel. -.\" Inaccuracy is bounded by TASK_RSS_EVENTS_THRESH. -Some of these values are inaccurate because -of a kernel-internal scalability optimization. -If accurate values are required, use -.IR /proc/ pid /smaps -or -.IR /proc/ pid /smaps_rollup -instead, which are much slower but provide accurate, detailed information. -.TP -.IR /proc/ pid /status -Provides much of the information in -.IR /proc/ pid /stat -and -.IR /proc/ pid /statm -in a format that's easier for humans to parse. -Here's an example: -.IP -.in +4n -.EX -.RB "$" " cat /proc/$$/status" -Name: bash -Umask: 0022 -State: S (sleeping) -Tgid: 17248 -Ngid: 0 -Pid: 17248 -PPid: 17200 -TracerPid: 0 -Uid: 1000 1000 1000 1000 -Gid: 100 100 100 100 -FDSize: 256 -Groups: 16 33 100 -NStgid: 17248 -NSpid: 17248 -NSpgid: 17248 -NSsid: 17200 -VmPeak: 131168 kB -VmSize: 131168 kB -VmLck: 0 kB -VmPin: 0 kB -VmHWM: 13484 kB -VmRSS: 13484 kB -RssAnon: 10264 kB -RssFile: 3220 kB -RssShmem: 0 kB -VmData: 10332 kB -VmStk: 136 kB -VmExe: 992 kB -VmLib: 2104 kB -VmPTE: 76 kB -VmPMD: 12 kB -VmSwap: 0 kB -HugetlbPages: 0 kB # 4.4 -CoreDumping: 0 # 4.15 -Threads: 1 -SigQ: 0/3067 -SigPnd: 0000000000000000 -ShdPnd: 0000000000000000 -SigBlk: 0000000000010000 -SigIgn: 0000000000384004 -SigCgt: 000000004b813efb -CapInh: 0000000000000000 -CapPrm: 0000000000000000 -CapEff: 0000000000000000 -CapBnd: ffffffffffffffff -CapAmb: 0000000000000000 -NoNewPrivs: 0 -Seccomp: 0 -Speculation_Store_Bypass: vulnerable -Cpus_allowed: 00000001 -Cpus_allowed_list: 0 -Mems_allowed: 1 -Mems_allowed_list: 0 -voluntary_ctxt_switches: 150 -nonvoluntary_ctxt_switches: 545 -.EE -.in -.IP -The fields are as follows: -.RS -.TP -.I Name -Command run by this process. -Strings longer than -.B TASK_COMM_LEN -(16) characters (including the terminating null byte) are silently truncated. -.TP -.I Umask -Process umask, expressed in octal with a leading zero; see -.BR umask (2). -(Since Linux 4.7.) -.TP -.I State -Current state of the process. -One of -"R (running)", -"S (sleeping)", -"D (disk sleep)", -"T (stopped)", -"t (tracing stop)", -"Z (zombie)", -or -"X (dead)". -.TP -.I Tgid -Thread group ID (i.e., Process ID). -.TP -.I Ngid -NUMA group ID (0 if none; since Linux 3.13). -.TP -.I Pid -Thread ID (see -.BR gettid (2)). -.TP -.I PPid -PID of parent process. -.TP -.I TracerPid -PID of process tracing this process (0 if not being traced). -.TP -.IR Uid ", " Gid -Real, effective, saved set, and filesystem UIDs (GIDs). -.TP -.I FDSize -Number of file descriptor slots currently allocated. -.TP -.I Groups -Supplementary group list. -.TP -.I NStgid -Thread group ID (i.e., PID) in each of the PID namespaces of which -.I pid -is a member. -The leftmost entry shows the value with respect to the PID namespace -of the process that mounted this procfs (or the root namespace -if mounted by the kernel), -followed by the value in successively nested inner namespaces. -.\" commit e4bc33245124db69b74a6d853ac76c2976f472d5 -(Since Linux 4.1.) -.TP -.I NSpid -Thread ID in each of the PID namespaces of which -.I pid -is a member. -The fields are ordered as for -.IR NStgid . -(Since Linux 4.1.) -.TP -.I NSpgid -Process group ID in each of the PID namespaces of which -.I pid -is a member. -The fields are ordered as for -.IR NStgid . -(Since Linux 4.1.) -.TP -.I NSsid -descendant namespace session ID hierarchy -Session ID in each of the PID namespaces of which -.I pid -is a member. -The fields are ordered as for -.IR NStgid . -(Since Linux 4.1.) -.TP -.I VmPeak -Peak virtual memory size. -.TP -.I VmSize -Virtual memory size. -.TP -.I VmLck -Locked memory size (see -.BR mlock (2)). -.TP -.I VmPin -Pinned memory size -.\" commit bc3e53f682d93df677dbd5006a404722b3adfe18 -(since Linux 3.2). -These are pages that can't be moved because something needs to -directly access physical memory. -.TP -.I VmHWM -Peak resident set size ("high water mark"). -This value is inaccurate; see -.IR /proc/ pid /statm -above. -.TP -.I VmRSS -Resident set size. -Note that the value here is the sum of -.IR RssAnon , -.IR RssFile , -and -.IR RssShmem . -This value is inaccurate; see -.IR /proc/ pid /statm -above. -.TP -.I RssAnon -Size of resident anonymous memory. -.\" commit bf9683d6990589390b5178dafe8fd06808869293 -(since Linux 4.5). -This value is inaccurate; see -.IR /proc/ pid /statm -above. -.TP -.I RssFile -Size of resident file mappings. -.\" commit bf9683d6990589390b5178dafe8fd06808869293 -(since Linux 4.5). -This value is inaccurate; see -.IR /proc/ pid /statm -above. -.TP -.I RssShmem -Size of resident shared memory (includes System V shared memory, -mappings from -.BR tmpfs (5), -and shared anonymous mappings). -.\" commit bf9683d6990589390b5178dafe8fd06808869293 -(since Linux 4.5). -.TP -.IR VmData ", " VmStk ", " VmExe -Size of data, stack, and text segments. -This value is inaccurate; see -.IR /proc/ pid /statm -above. -.TP -.I VmLib -Shared library code size. -.TP -.I VmPTE -Page table entries size (since Linux 2.6.10). -.TP -.I VmPMD -.\" commit dc6c9a35b66b520cf67e05d8ca60ebecad3b0479 -Size of second-level page tables (added in Linux 4.0; removed in Linux 4.15). -.TP -.I VmSwap -.\" commit b084d4353ff99d824d3bc5a5c2c22c70b1fba722 -Swapped-out virtual memory size by anonymous private pages; -shmem swap usage is not included (since Linux 2.6.34). -This value is inaccurate; see -.IR /proc/ pid /statm -above. -.TP -.I HugetlbPages -Size of hugetlb memory portions -.\" commit 5d317b2b6536592a9b51fe65faed43d65ca9158e -(since Linux 4.4). -.TP -.I CoreDumping -Contains the value 1 if the process is currently dumping core, -and 0 if it is not -.\" commit c643401218be0f4ab3522e0c0a63016596d6e9ca -(since Linux 4.15). -This information can be used by a monitoring process to avoid killing -a process that is currently dumping core, -which could result in a corrupted core dump file. -.TP -.I Threads -Number of threads in process containing this thread. -.TP -.I SigQ -This field contains two slash-separated numbers that relate to -queued signals for the real user ID of this process. -The first of these is the number of currently queued -signals for this real user ID, and the second is the -resource limit on the number of queued signals for this process -(see the description of -.B RLIMIT_SIGPENDING -in -.BR getrlimit (2)). -.TP -.IR SigPnd ", " ShdPnd -Mask (expressed in hexadecimal) -of signals pending for thread and for process as a whole (see -.BR pthreads (7) -and -.BR signal (7)). -.TP -.IR SigBlk ", " SigIgn ", " SigCgt -Masks (expressed in hexadecimal) -indicating signals being blocked, ignored, and caught (see -.BR signal (7)). -.TP -.IR CapInh ", " CapPrm ", " CapEff -Masks (expressed in hexadecimal) -of capabilities enabled in inheritable, permitted, and effective sets -(see -.BR capabilities (7)). -.TP -.I CapBnd -Capability bounding set, expressed in hexadecimal -(since Linux 2.6.26, see -.BR capabilities (7)). -.TP -.I CapAmb -Ambient capability set, expressed in hexadecimal -(since Linux 4.3, see -.BR capabilities (7)). -.TP -.I NoNewPrivs -.\" commit af884cd4a5ae62fcf5e321fecf0ec1014730353d -Value of the -.I no_new_privs -bit -(since Linux 4.10, see -.BR prctl (2)). -.TP -.I Seccomp -.\" commit 2f4b3bf6b2318cfaa177ec5a802f4d8d6afbd816 -Seccomp mode of the process -(since Linux 3.8, see -.BR seccomp (2)). -0 means -.BR SECCOMP_MODE_DISABLED ; -1 means -.BR SECCOMP_MODE_STRICT ; -2 means -.BR SECCOMP_MODE_FILTER . -This field is provided only if the kernel was built with the -.B CONFIG_SECCOMP -kernel configuration option enabled. -.TP -.I Speculation_Store_Bypass -.\" commit fae1fa0fc6cca8beee3ab8ed71d54f9a78fa3f64 -Speculation flaw mitigation state -(since Linux 4.17, see -.BR prctl (2)). -.TP -.I Cpus_allowed -Hexadecimal mask of CPUs on which this process may run -(since Linux 2.6.24, see -.BR cpuset (7)). -.TP -.I Cpus_allowed_list -Same as previous, but in "list format" -(since Linux 2.6.26, see -.BR cpuset (7)). -.TP -.I Mems_allowed -Mask of memory nodes allowed to this process -(since Linux 2.6.24, see -.BR cpuset (7)). -.TP -.I Mems_allowed_list -Same as previous, but in "list format" -(since Linux 2.6.26, see -.BR cpuset (7)). -.TP -.IR voluntary_ctxt_switches ", " nonvoluntary_ctxt_switches -Number of voluntary and involuntary context switches (since Linux 2.6.23). -.RE -.TP -.IR /proc/ pid /syscall " (since Linux 2.6.27)" -.\" commit ebcb67341fee34061430f3367f2e507e52ee051b -This file exposes the system call number and argument registers for the -system call currently being executed by the process, -followed by the values of the stack pointer and program counter registers. -The values of all six argument registers are exposed, -although most system calls use fewer registers. -.IP -If the process is blocked, but not in a system call, -then the file displays \-1 in place of the system call number, -followed by just the values of the stack pointer and program counter. -If process is not blocked, then the file contains just the string "running". -.IP -This file is present only if the kernel was configured with -.BR CONFIG_HAVE_ARCH_TRACEHOOK . -.IP -Permission to access this file is governed by a ptrace access mode -.B PTRACE_MODE_ATTACH_FSCREDS -check; see -.BR ptrace (2). -.TP -.IR /proc/ pid /task " (since Linux 2.6.0)" -.\" Precisely: Linux 2.6.0-test6 -This is a directory that contains one subdirectory -for each thread in the process. -The name of each subdirectory is the numerical thread ID -.RI ( tid ) -of the thread (see -.BR gettid (2)). -.IP -Within each of these subdirectories, there is a set of -files with the same names and contents as under the -.IR /proc/ pid -directories. -For attributes that are shared by all threads, the contents for -each of the files under the -.IR task/ tid -subdirectories will be the same as in the corresponding -file in the parent -.IR /proc/ pid -directory -(e.g., in a multithreaded process, all of the -.IR task/ tid /cwd -files will have the same value as the -.IR /proc/ pid /cwd -file in the parent directory, since all of the threads in a process -share a working directory). -For attributes that are distinct for each thread, -the corresponding files under -.IR task/ tid -may have different values (e.g., various fields in each of the -.IR task/ tid /status -files may be different for each thread), -.\" in particular: "children" :/ -or they might not exist in -.IR /proc/ pid -at all. -.IP -.\" The following was still true as at kernel 2.6.13 -In a multithreaded process, the contents of the -.IR /proc/ pid /task -directory are not available if the main thread has already terminated -(typically by calling -.BR pthread_exit (3)). -.TP -.IR /proc/ pid /task/ tid /children " (since Linux 3.5)" -.\" commit 818411616baf46ceba0cff6f05af3a9b294734f7 -A space-separated list of child tasks of this task. -Each child task is represented by its TID. -.IP -.\" see comments in get_children_pid() in fs/proc/array.c -This option is intended for use by the checkpoint-restore (CRIU) system, -and reliably provides a list of children only if all of the child processes -are stopped or frozen. -It does not work properly if children of the target task exit while -the file is being read! -Exiting children may cause non-exiting children to be omitted from the list. -This makes this interface even more unreliable than classic PID-based -approaches if the inspected task and its children aren't frozen, -and most code should probably not use this interface. -.IP -Until Linux 4.2, the presence of this file was governed by the -.B CONFIG_CHECKPOINT_RESTORE -kernel configuration option. -Since Linux 4.2, -.\" commit 2e13ba54a2682eea24918b87ad3edf70c2cf085b -it is governed by the -.B CONFIG_PROC_CHILDREN -option. -.TP -.IR /proc/ pid /timers " (since Linux 3.10)" -.\" commit 5ed67f05f66c41e39880a6d61358438a25f9fee5 -.\" commit 48f6a7a511ef8823fdff39afee0320092d43a8a0 -A list of the POSIX timers for this process. -Each timer is listed with a line that starts with the string "ID:". -For example: -.IP -.in +4n -.EX -ID: 1 -signal: 60/00007fff86e452a8 -notify: signal/pid.2634 -ClockID: 0 -ID: 0 -signal: 60/00007fff86e452a8 -notify: signal/pid.2634 -ClockID: 1 -.EE -.in -.IP -The lines shown for each timer have the following meanings: -.RS -.TP -.I ID -The ID for this timer. -This is not the same as the timer ID returned by -.BR timer_create (2); -rather, it is the same kernel-internal ID that is available via the -.I si_timerid -field of the -.I siginfo_t -structure (see -.BR sigaction (2)). -.TP -.I signal -This is the signal number that this timer uses to deliver notifications -followed by a slash, and then the -.I sigev_value -value supplied to the signal handler. -Valid only for timers that notify via a signal. -.TP -.I notify -The part before the slash specifies the mechanism -that this timer uses to deliver notifications, -and is one of "thread", "signal", or "none". -Immediately following the slash is either the string "tid" for timers -with -.B SIGEV_THREAD_ID -notification, or "pid" for timers that notify by other mechanisms. -Following the "." is the PID of the process -(or the kernel thread ID of the thread) that will be delivered -a signal if the timer delivers notifications via a signal. -.TP -.I ClockID -This field identifies the clock that the timer uses for measuring time. -For most clocks, this is a number that matches one of the user-space -.B CLOCK_* -constants exposed via -.IR <time.h> . -.B CLOCK_PROCESS_CPUTIME_ID -timers display with a value of \-6 -in this field. -.B CLOCK_THREAD_CPUTIME_ID -timers display with a value of \-2 -in this field. -.RE -.IP -This file is available only when the kernel was configured with -.BR CONFIG_CHECKPOINT_RESTORE . -.TP -.IR /proc/ pid /timerslack_ns " (since Linux 4.6)" -.\" commit da8b44d5a9f8bf26da637b7336508ca534d6b319 -.\" commit 5de23d435e88996b1efe0e2cebe242074ce67c9e -This file exposes the process's "current" timer slack value, -expressed in nanoseconds. -The file is writable, -allowing the process's timer slack value to be changed. -Writing 0 to this file resets the "current" timer slack to the -"default" timer slack value. -For further details, see the discussion of -.B PR_SET_TIMERSLACK -in -.BR prctl (2). -.IP -Initially, -permission to access this file was governed by a ptrace access mode -.B PTRACE_MODE_ATTACH_FSCREDS -check (see -.BR ptrace (2)). -However, this was subsequently deemed too strict a requirement -(and had the side effect that requiring a process to have the -.B CAP_SYS_PTRACE -capability would also allow it to view and change any process's memory). -Therefore, since Linux 4.9, -.\" commit 7abbaf94049914f074306d960b0f968ffe52e59f -only the (weaker) -.B CAP_SYS_NICE -capability is required to access this file. -.TP -.IR /proc/ pid /uid_map " (since Linux 3.5)" -See -.BR user_namespaces (7). -.TP -.IR /proc/ pid /wchan " (since Linux 2.6.0)" -The symbolic name corresponding to the location -in the kernel where the process is sleeping. -.IP -Permission to access this file is governed by a ptrace access mode -.B PTRACE_MODE_READ_FSCREDS -check; see -.BR ptrace (2). -.TP -.IR /proc/ tid -There is a numerical subdirectory for each running thread -that is not a thread group leader -(i.e., a thread whose thread ID is not the same as its process ID); -the subdirectory is named by the thread ID. -Each one of these subdirectories contains files and subdirectories -exposing information about the thread with the thread ID -.IR tid . -The contents of these directories are the same as the corresponding -.IR /proc/ pid /task/ tid -directories. -.IP -The -.IR /proc/ tid -subdirectories are -.I not -visible when iterating through -.I /proc -with -.BR getdents (2) -(and thus are -.I not -visible when one uses -.BR ls (1) -to view the contents of -.IR /proc ). -However, the pathnames of these directories are visible to -(i.e., usable as arguments in) -system calls that operate on pathnames. -.TP -.I /proc/apm -Advanced power management version and battery information when -.B CONFIG_APM -is defined at kernel compilation time. -.TP -.I /proc/buddyinfo -This file contains information which is used for diagnosing memory -fragmentation issues. -Each line starts with the identification of the node and the name -of the zone which together identify a memory region. -This is then -followed by the count of available chunks of a certain order in -which these zones are split. -The size in bytes of a certain order is given by the formula: -.IP -.in +4n -.EX -(2\[ha]order)\ *\ PAGE_SIZE -.EE -.in -.IP -The binary buddy allocator algorithm inside the kernel will split -one chunk into two chunks of a smaller order (thus with half the -size) or combine two contiguous chunks into one larger chunk of -a higher order (thus with double the size) to satisfy allocation -requests and to counter memory fragmentation. -The order matches the column number, when starting to count at zero. -.IP -For example on an x86-64 system: -.RS -12 -.EX -Node 0, zone DMA 1 1 1 0 2 1 1 0 1 1 3 -Node 0, zone DMA32 65 47 4 81 52 28 13 10 5 1 404 -Node 0, zone Normal 216 55 189 101 84 38 37 27 5 3 587 -.EE -.RE -.IP -In this example, there is one node containing three zones and there -are 11 different chunk sizes. -If the page size is 4 kilobytes, then the first zone called -.I DMA -(on x86 the first 16 megabyte of memory) has 1 chunk of 4 kilobytes -(order 0) available and has 3 chunks of 4 megabytes (order 10) available. -.IP -If the memory is heavily fragmented, the counters for higher -order chunks will be zero and allocation of large contiguous areas -will fail. -.IP -Further information about the zones can be found in -.IR /proc/zoneinfo . -.TP -.I /proc/bus -Contains subdirectories for installed buses. -.TP -.I /proc/bus/pccard -Subdirectory for PCMCIA devices when -.B CONFIG_PCMCIA -is set at kernel compilation time. -.TP -.I /proc/bus/pccard/drivers -.TP -.I /proc/bus/pci -Contains various bus subdirectories and pseudo-files containing -information about PCI buses, installed devices, and device -drivers. -Some of these files are not ASCII. -.TP -.I /proc/bus/pci/devices -Information about PCI devices. -They may be accessed through -.BR lspci (8) -and -.BR setpci (8). -.TP -.IR /proc/cgroups " (since Linux 2.6.24)" -See -.BR cgroups (7). -.TP -.I /proc/cmdline -Arguments passed to the Linux kernel at boot time. -Often done via a boot manager such as -.BR lilo (8) -or -.BR grub (8). -Any arguments embedded in the kernel image or initramfs via -.B CONFIG_BOOT_CONFIG -will also be displayed. -.TP -.IR /proc/config.gz " (since Linux 2.6)" -This file exposes the configuration options that were used -to build the currently running kernel, -in the same format as they would be shown in the -.I .config -file that resulted when configuring the kernel (using -.IR "make xconfig" , -.IR "make config" , -or similar). -The file contents are compressed; view or search them using -.BR zcat (1) -and -.BR zgrep (1). -As long as no changes have been made to the following file, -the contents of -.I /proc/config.gz -are the same as those provided by: -.IP -.in +4n -.EX -cat /lib/modules/$(uname \-r)/build/.config -.EE -.in -.IP -.I /proc/config.gz -is provided only if the kernel is configured with -.BR CONFIG_IKCONFIG_PROC . -.TP -.I /proc/crypto -A list of the ciphers provided by the kernel crypto API. -For details, see the kernel -.I "Linux Kernel Crypto API" -documentation available under the kernel source directory -.I Documentation/crypto/ -.\" commit 3b72c814a8e8cd638e1ba0da4dfce501e9dff5af -(or -.I Documentation/DocBook -before Linux 4.10; -the documentation can be built using a command such as -.I make htmldocs -in the root directory of the kernel source tree). -.TP -.I /proc/cpuinfo -This is a collection of CPU and system architecture dependent items, -for each supported architecture a different list. -Two common entries are \fIprocessor\fP which gives CPU number and -\fIbogomips\fP; a system constant that is calculated -during kernel initialization. -SMP machines have information for -each CPU. -The -.BR lscpu (1) -command gathers its information from this file. -.TP -.I /proc/devices -Text listing of major numbers and device groups. -This can be used by MAKEDEV scripts for consistency with the kernel. -.TP -.IR /proc/diskstats " (since Linux 2.5.69)" -This file contains disk I/O statistics for each disk device. -See the Linux kernel source file -.I Documentation/admin\-guide/iostats.rst -(or -.I Documentation/iostats.txt -before Linux 5.3) -for further information. -.TP -.I /proc/dma -This is a list of the registered \fIISA\fP DMA (direct memory access) -channels in use. -.TP -.I /proc/driver -Empty subdirectory. -.TP -.I /proc/execdomains -Used to list ABI personalities before Linux 4.1; -now contains a constant string for userspace compatibility. -.TP -.I /proc/fb -Frame buffer information when -.B CONFIG_FB -is defined during kernel compilation. -.TP -.I /proc/filesystems -A text listing of the filesystems which are supported by the kernel, -namely filesystems which were compiled into the kernel or whose kernel -modules are currently loaded. -(See also -.BR filesystems (5).) -If a filesystem is marked with "nodev", -this means that it does not require a block device to be mounted -(e.g., virtual filesystem, network filesystem). -.IP -Incidentally, this file may be used by -.BR mount (8) -when no filesystem is specified and it didn't manage to determine the -filesystem type. -Then filesystems contained in this file are tried -(excepted those that are marked with "nodev"). -.TP -.I /proc/fs -.\" FIXME Much more needs to be said about /proc/fs -.\" -Contains subdirectories that in turn contain files -with information about (certain) mounted filesystems. -.TP -.I /proc/ide -This directory -exists on systems with the IDE bus. -There are directories for each IDE channel and attached device. -Files include: -.IP -.in +4n -.EX -cache buffer size in KB -capacity number of sectors -driver driver version -geometry physical and logical geometry -identify in hexadecimal -media media type -model manufacturer\[aq]s model number -settings drive settings -smart_thresholds IDE disk management thresholds (in hex) -smart_values IDE disk management values (in hex) -.EE -.in -.IP -The -.BR hdparm (8) -utility provides access to this information in a friendly format. -.TP -.I /proc/interrupts -This is used to record the number of interrupts per CPU per IO device. -Since Linux 2.6.24, -for the i386 and x86-64 architectures, at least, this also includes -interrupts internal to the system (that is, not associated with a device -as such), such as NMI (nonmaskable interrupt), LOC (local timer interrupt), -and for SMP systems, TLB (TLB flush interrupt), RES (rescheduling -interrupt), CAL (remote function call interrupt), and possibly others. -Very easy to read formatting, done in ASCII. -.TP -.I /proc/iomem -I/O memory map in Linux 2.4. -.TP -.I /proc/ioports -This is a list of currently registered Input-Output port regions that -are in use. -.TP -.IR /proc/kallsyms " (since Linux 2.5.71)" -This holds the kernel exported symbol definitions used by the -.BR modules (X) -tools to dynamically link and bind loadable modules. -In Linux 2.5.47 and earlier, a similar file with slightly different syntax -was named -.IR ksyms . -.TP -.I /proc/kcore -This file represents the physical memory of the system and is stored -in the ELF core file format. -With this pseudo-file, and an unstripped -kernel -.RI ( /usr/src/linux/vmlinux ) -binary, GDB can be used to -examine the current state of any kernel data structures. -.IP -The total length of the file is the size of physical memory (RAM) plus -4\ KiB. -.TP -.IR /proc/keys " (since Linux 2.6.10)" -See -.BR keyrings (7). -.TP -.IR /proc/key\-users " (since Linux 2.6.10)" -See -.BR keyrings (7). -.TP -.I /proc/kmsg -This file can be used instead of the -.BR syslog (2) -system call to read kernel messages. -A process must have superuser -privileges to read this file, and only one process should read this -file. -This file should not be read if a syslog process is running -which uses the -.BR syslog (2) -system call facility to log kernel messages. -.IP -Information in this file is retrieved with the -.BR dmesg (1) -program. -.TP -.IR /proc/kpagecgroup " (since Linux 4.3)" -.\" commit 80ae2fdceba8313b0433f899bdd9c6c463291a17 -This file contains a 64-bit inode number of -the memory cgroup each page is charged to, -indexed by page frame number (see the discussion of -.IR /proc/ pid /pagemap ). -.IP -The -.I /proc/kpagecgroup -file is present only if the -.B CONFIG_MEMCG -kernel configuration option is enabled. -.TP -.IR /proc/kpagecount " (since Linux 2.6.25)" -This file contains a 64-bit count of the number of -times each physical page frame is mapped, -indexed by page frame number (see the discussion of -.IR /proc/ pid /pagemap ). -.IP -The -.I /proc/kpagecount -file is present only if the -.B CONFIG_PROC_PAGE_MONITOR -kernel configuration option is enabled. -.TP -.IR /proc/kpageflags " (since Linux 2.6.25)" -This file contains 64-bit masks corresponding to each physical page frame; -it is indexed by page frame number (see the discussion of -.IR /proc/ pid /pagemap ). -The bits are as follows: -.RS -.IP -.TS -r l l l. -0 - KPF_LOCKED -1 - KPF_ERROR -2 - KPF_REFERENCED -3 - KPF_UPTODATE -4 - KPF_DIRTY -5 - KPF_LRU -6 - KPF_ACTIVE -7 - KPF_SLAB -8 - KPF_WRITEBACK -9 - KPF_RECLAIM -10 - KPF_BUDDY -11 - KPF_MMAP (since Linux 2.6.31) -12 - KPF_ANON (since Linux 2.6.31) -13 - KPF_SWAPCACHE (since Linux 2.6.31) -14 - KPF_SWAPBACKED (since Linux 2.6.31) -15 - KPF_COMPOUND_HEAD (since Linux 2.6.31) -16 - KPF_COMPOUND_TAIL (since Linux 2.6.31) -17 - KPF_HUGE (since Linux 2.6.31) -18 - KPF_UNEVICTABLE (since Linux 2.6.31) -19 - KPF_HWPOISON (since Linux 2.6.31) -20 - KPF_NOPAGE (since Linux 2.6.31) -21 - KPF_KSM (since Linux 2.6.32) -22 - KPF_THP (since Linux 3.4) -23 - KPF_BALLOON (since Linux 3.18) -.\" KPF_BALLOON: commit 09316c09dde33aae14f34489d9e3d243ec0d5938 -24 - KPF_ZERO_PAGE (since Linux 4.0) -.\" KPF_ZERO_PAGE: commit 56873f43abdcd574b25105867a990f067747b2f4 -25 - KPF_IDLE (since Linux 4.3) -.\" KPF_IDLE: commit f074a8f49eb87cde95ac9d040ad5e7ea4f029738 -26 - KPF_PGTABLE (since Linux 4.18) -.\" KPF_PGTABLE: commit 1d40a5ea01d53251c23c7be541d3f4a656cfc537 -.TE -.RE -.IP -For further details on the meanings of these bits, -see the kernel source file -.IR Documentation/admin\-guide/mm/pagemap.rst . -Before Linux 2.6.29, -.\" commit ad3bdefe877afb47480418fdb05ecd42842de65e -.\" commit e07a4b9217d1e97d2f3a62b6b070efdc61212110 -.BR KPF_WRITEBACK , -.BR KPF_RECLAIM , -.BR KPF_BUDDY , -and -.B KPF_LOCKED -did not report correctly. -.IP -The -.I /proc/kpageflags -file is present only if the -.B CONFIG_PROC_PAGE_MONITOR -kernel configuration option is enabled. -.TP -.IR /proc/ksyms " (Linux 1.1.23\[en]2.5.47)" -See -.IR /proc/kallsyms . -.TP -.I /proc/loadavg -The first three fields in this file are load average figures -giving the number of jobs in the run queue (state R) -or waiting for disk I/O (state D) averaged over 1, 5, and 15 minutes. -They are the same as the load average numbers given by -.BR uptime (1) -and other programs. -The fourth field consists of two numbers separated by a slash (/). -The first of these is the number of currently runnable kernel -scheduling entities (processes, threads). -The value after the slash is the number of kernel scheduling entities -that currently exist on the system. -The fifth field is the PID of the process that was most -recently created on the system. -.TP -.I /proc/locks -This file shows current file locks -.RB ( flock "(2) and " fcntl (2)) -and leases -.RB ( fcntl (2)). -.IP -An example of the content shown in this file is the following: -.IP -.in +4n -.EX -1: POSIX ADVISORY READ 5433 08:01:7864448 128 128 -2: FLOCK ADVISORY WRITE 2001 08:01:7864554 0 EOF -3: FLOCK ADVISORY WRITE 1568 00:2f:32388 0 EOF -4: POSIX ADVISORY WRITE 699 00:16:28457 0 EOF -5: POSIX ADVISORY WRITE 764 00:16:21448 0 0 -6: POSIX ADVISORY READ 3548 08:01:7867240 1 1 -7: POSIX ADVISORY READ 3548 08:01:7865567 1826 2335 -8: OFDLCK ADVISORY WRITE \-1 08:01:8713209 128 191 -.EE -.in -.IP -The fields shown in each line are as follows: -.RS -.IP [1] 5 -The ordinal position of the lock in the list. -.IP [2] -The lock type. -Values that may appear here include: -.RS -.TP -.B FLOCK -This is a BSD file lock created using -.BR flock (2). -.TP -.B OFDLCK -This is an open file description (OFD) lock created using -.BR fcntl (2). -.TP -.B POSIX -This is a POSIX byte-range lock created using -.BR fcntl (2). -.RE -.IP [3] -Among the strings that can appear here are the following: -.RS -.TP -.B ADVISORY -This is an advisory lock. -.TP -.B MANDATORY -This is a mandatory lock. -.RE -.IP [4] -The type of lock. -Values that can appear here are: -.RS -.TP -.B READ -This is a POSIX or OFD read lock, or a BSD shared lock. -.TP -.B WRITE -This is a POSIX or OFD write lock, or a BSD exclusive lock. -.RE -.IP [5] -The PID of the process that owns the lock. -.IP -Because OFD locks are not owned by a single process -(since multiple processes may have file descriptors that -refer to the same open file description), -the value \-1 is displayed in this field for OFD locks. -(Before Linux 4.14, -.\" commit 9d5b86ac13c573795525ecac6ed2db39ab23e2a8 -a bug meant that the PID of the process that -initially acquired the lock was displayed instead of the value \-1.) -.IP [6] -Three colon-separated subfields that identify the major and minor device -ID of the device containing the filesystem where the locked file resides, -followed by the inode number of the locked file. -.IP [7] -The byte offset of the first byte of the lock. -For BSD locks, this value is always 0. -.IP [8] -The byte offset of the last byte of the lock. -.B EOF -in this field means that the lock extends to the end of the file. -For BSD locks, the value shown is always -.IR EOF . -.RE -.IP -Since Linux 4.9, -.\" commit d67fd44f697dff293d7cdc29af929241b669affe -the list of locks shown in -.I /proc/locks -is filtered to show just the locks for the processes in the PID -namespace (see -.BR pid_namespaces (7)) -for which the -.I /proc -filesystem was mounted. -(In the initial PID namespace, -there is no filtering of the records shown in this file.) -.IP -The -.BR lslocks (8) -command provides a bit more information about each lock. -.TP -.IR /proc/malloc " (only up to and including Linux 2.2)" -.\" It looks like this only ever did something back in 1.0 days -This file is present only if -.B CONFIG_DEBUG_MALLOC -was defined during compilation. -.TP -.I /proc/meminfo -This file reports statistics about memory usage on the system. -It is used by -.BR free (1) -to report the amount of free and used memory (both physical and swap) -on the system as well as the shared memory and buffers used by the -kernel. -Each line of the file consists of a parameter name, followed by a colon, -the value of the parameter, and an option unit of measurement (e.g., "kB"). -The list below describes the parameter names and -the format specifier required to read the field value. -Except as noted below, -all of the fields have been present since at least Linux 2.6.0. -Some fields are displayed only if the kernel was configured -with various options; those dependencies are noted in the list. -.RS -.TP -.IR MemTotal " %lu" -Total usable RAM (i.e., physical RAM minus a few reserved -bits and the kernel binary code). -.TP -.IR MemFree " %lu" -The sum of -.IR LowFree + HighFree . -.TP -.IR MemAvailable " %lu (since Linux 3.14)" -An estimate of how much memory is available for starting new -applications, without swapping. -.TP -.IR Buffers " %lu" -Relatively temporary storage for raw disk blocks that -shouldn't get tremendously large (20 MB or so). -.TP -.IR Cached " %lu" -In-memory cache for files read from the disk (the page cache). -Doesn't include -.IR SwapCached . -.TP -.IR SwapCached " %lu" -Memory that once was swapped out, is swapped back in but -still also is in the swap file. -(If memory pressure is high, these pages -don't need to be swapped out again because they are already -in the swap file. -This saves I/O.) -.TP -.IR Active " %lu" -Memory that has been used more recently and usually not -reclaimed unless absolutely necessary. -.TP -.IR Inactive " %lu" -Memory which has been less recently used. -It is more eligible to be reclaimed for other purposes. -.TP -.IR Active(anon) " %lu (since Linux 2.6.28)" -[To be documented.] -.TP -.IR Inactive(anon) " %lu (since Linux 2.6.28)" -[To be documented.] -.TP -.IR Active(file) " %lu (since Linux 2.6.28)" -[To be documented.] -.TP -.IR Inactive(file) " %lu (since Linux 2.6.28)" -[To be documented.] -.TP -.IR Unevictable " %lu (since Linux 2.6.28)" -(From Linux 2.6.28 to Linux 2.6.30, -\fBCONFIG_UNEVICTABLE_LRU\fP was required.) -[To be documented.] -.TP -.IR Mlocked " %lu (since Linux 2.6.28)" -(From Linux 2.6.28 to Linux 2.6.30, -\fBCONFIG_UNEVICTABLE_LRU\fP was required.) -[To be documented.] -.TP -.IR HighTotal " %lu" -(Starting with Linux 2.6.19, \fBCONFIG_HIGHMEM\fP is required.) -Total amount of highmem. -Highmem is all memory above \[ti]860 MB of physical memory. -Highmem areas are for use by user-space programs, -or for the page cache. -The kernel must use tricks to access -this memory, making it slower to access than lowmem. -.TP -.IR HighFree " %lu" -(Starting with Linux 2.6.19, \fBCONFIG_HIGHMEM\fP is required.) -Amount of free highmem. -.TP -.IR LowTotal " %lu" -(Starting with Linux 2.6.19, \fBCONFIG_HIGHMEM\fP is required.) -Total amount of lowmem. -Lowmem is memory which can be used for everything that -highmem can be used for, but it is also available for the -kernel's use for its own data structures. -Among many other things, -it is where everything from -.I Slab -is allocated. -Bad things happen when you're out of lowmem. -.TP -.IR LowFree " %lu" -(Starting with Linux 2.6.19, \fBCONFIG_HIGHMEM\fP is required.) -Amount of free lowmem. -.TP -.IR MmapCopy " %lu (since Linux 2.6.29)" -.RB ( CONFIG_MMU -is required.) -[To be documented.] -.TP -.IR SwapTotal " %lu" -Total amount of swap space available. -.TP -.IR SwapFree " %lu" -Amount of swap space that is currently unused. -.TP -.IR Dirty " %lu" -Memory which is waiting to get written back to the disk. -.TP -.IR Writeback " %lu" -Memory which is actively being written back to the disk. -.TP -.IR AnonPages " %lu (since Linux 2.6.18)" -Non-file backed pages mapped into user-space page tables. -.TP -.IR Mapped " %lu" -Files which have been mapped into memory (with -.BR mmap (2)), -such as libraries. -.TP -.IR Shmem " %lu (since Linux 2.6.32)" -Amount of memory consumed in -.BR tmpfs (5) -filesystems. -.TP -.IR KReclaimable " %lu (since Linux 4.20)" -Kernel allocations that the kernel will attempt to reclaim -under memory pressure. -Includes -.I SReclaimable -(below), and other direct allocations with a shrinker. -.TP -.IR Slab " %lu" -In-kernel data structures cache. -(See -.BR slabinfo (5).) -.TP -.IR SReclaimable " %lu (since Linux 2.6.19)" -Part of -.IR Slab , -that might be reclaimed, such as caches. -.TP -.IR SUnreclaim " %lu (since Linux 2.6.19)" -Part of -.IR Slab , -that cannot be reclaimed on memory pressure. -.TP -.IR KernelStack " %lu (since Linux 2.6.32)" -Amount of memory allocated to kernel stacks. -.TP -.IR PageTables " %lu (since Linux 2.6.18)" -Amount of memory dedicated to the lowest level of page tables. -.TP -.IR Quicklists " %lu (since Linux 2.6.27)" -(\fBCONFIG_QUICKLIST\fP is required.) -[To be documented.] -.TP -.IR NFS_Unstable " %lu (since Linux 2.6.18)" -NFS pages sent to the server, but not yet committed to stable storage. -.TP -.IR Bounce " %lu (since Linux 2.6.18)" -Memory used for block device "bounce buffers". -.TP -.IR WritebackTmp " %lu (since Linux 2.6.26)" -Memory used by FUSE for temporary writeback buffers. -.TP -.IR CommitLimit " %lu (since Linux 2.6.10)" -This is the total amount of memory currently available to -be allocated on the system, expressed in kilobytes. -This limit is adhered to -only if strict overcommit accounting is enabled (mode 2 in -.IR /proc/sys/vm/overcommit_memory ). -The limit is calculated according to the formula described under -.IR /proc/sys/vm/overcommit_memory . -For further details, see the kernel source file -.IR Documentation/vm/overcommit\-accounting.rst . -.TP -.IR Committed_AS " %lu" -The amount of memory presently allocated on the system. -The committed memory is a sum of all of the memory which -has been allocated by processes, even if it has not been -"used" by them as of yet. -A process which allocates 1 GB of memory (using -.BR malloc (3) -or similar), but touches only 300 MB of that memory will show up -as using only 300 MB of memory even if it has the address space -allocated for the entire 1 GB. -.IP -This 1 GB is memory which has been "committed" to by the VM -and can be used at any time by the allocating application. -With strict overcommit enabled on the system (mode 2 in -.IR /proc/sys/vm/overcommit_memory ), -allocations which would exceed the -.I CommitLimit -will not be permitted. -This is useful if one needs to guarantee that processes will not -fail due to lack of memory once that memory has been successfully allocated. -.TP -.IR VmallocTotal " %lu" -Total size of vmalloc memory area. -.TP -.IR VmallocUsed " %lu" -Amount of vmalloc area which is used. -Since Linux 4.4, -.\" commit a5ad88ce8c7fae7ddc72ee49a11a75aa837788e0 -this field is no longer calculated, and is hard coded as 0. -See -.IR /proc/vmallocinfo . -.TP -.IR VmallocChunk " %lu" -Largest contiguous block of vmalloc area which is free. -Since Linux 4.4, -.\" commit a5ad88ce8c7fae7ddc72ee49a11a75aa837788e0 -this field is no longer calculated and is hard coded as 0. -See -.IR /proc/vmallocinfo . -.TP -.IR HardwareCorrupted " %lu (since Linux 2.6.32)" -(\fBCONFIG_MEMORY_FAILURE\fP is required.) -[To be documented.] -.TP -.IR LazyFree " %lu (since Linux 4.12)" -Shows the amount of memory marked by -.BR madvise (2) -.BR MADV_FREE . -.TP -.IR AnonHugePages " %lu (since Linux 2.6.38)" -(\fBCONFIG_TRANSPARENT_HUGEPAGE\fP is required.) -Non-file backed huge pages mapped into user-space page tables. -.TP -.IR ShmemHugePages " %lu (since Linux 4.8)" -(\fBCONFIG_TRANSPARENT_HUGEPAGE\fP is required.) -Memory used by shared memory (shmem) and -.BR tmpfs (5) -allocated with huge pages. -.TP -.IR ShmemPmdMapped " %lu (since Linux 4.8)" -(\fBCONFIG_TRANSPARENT_HUGEPAGE\fP is required.) -Shared memory mapped into user space with huge pages. -.TP -.IR CmaTotal " %lu (since Linux 3.1)" -Total CMA (Contiguous Memory Allocator) pages. -(\fBCONFIG_CMA\fP is required.) -.TP -.IR CmaFree " %lu (since Linux 3.1)" -Free CMA (Contiguous Memory Allocator) pages. -(\fBCONFIG_CMA\fP is required.) -.TP -.IR HugePages_Total " %lu" -(\fBCONFIG_HUGETLB_PAGE\fP is required.) -The size of the pool of huge pages. -.TP -.IR HugePages_Free " %lu" -(\fBCONFIG_HUGETLB_PAGE\fP is required.) -The number of huge pages in the pool that are not yet allocated. -.TP -.IR HugePages_Rsvd " %lu (since Linux 2.6.17)" -(\fBCONFIG_HUGETLB_PAGE\fP is required.) -This is the number of huge pages for -which a commitment to allocate from the pool has been made, -but no allocation has yet been made. -These reserved huge pages -guarantee that an application will be able to allocate a -huge page from the pool of huge pages at fault time. -.TP -.IR HugePages_Surp " %lu (since Linux 2.6.24)" -(\fBCONFIG_HUGETLB_PAGE\fP is required.) -This is the number of huge pages in -the pool above the value in -.IR /proc/sys/vm/nr_hugepages . -The maximum number of surplus huge pages is controlled by -.IR /proc/sys/vm/nr_overcommit_hugepages . -.TP -.IR Hugepagesize " %lu" -(\fBCONFIG_HUGETLB_PAGE\fP is required.) -The size of huge pages. -.TP -.IR DirectMap4k " %lu (since Linux 2.6.27)" -Number of bytes of RAM linearly mapped by kernel in 4 kB pages. -(x86.) -.TP -.IR DirectMap4M " %lu (since Linux 2.6.27)" -Number of bytes of RAM linearly mapped by kernel in 4 MB pages. -(x86 with -.B CONFIG_X86_64 -or -.B CONFIG_X86_PAE -enabled.) -.TP -.IR DirectMap2M " %lu (since Linux 2.6.27)" -Number of bytes of RAM linearly mapped by kernel in 2 MB pages. -(x86 with neither -.B CONFIG_X86_64 -nor -.B CONFIG_X86_PAE -enabled.) -.TP -.IR DirectMap1G " %lu (since Linux 2.6.27)" -(x86 with -.B CONFIG_X86_64 -and -.B CONFIG_X86_DIRECT_GBPAGES -enabled.) -.RE -.TP -.I /proc/modules -A text list of the modules that have been loaded by the system. -See also -.BR lsmod (8). -.TP -.I /proc/mounts -Before Linux 2.4.19, this file was a list -of all the filesystems currently mounted on the system. -With the introduction of per-process mount namespaces in Linux 2.4.19 (see -.BR mount_namespaces (7)), -this file became a link to -.IR /proc/self/mounts , -which lists the mounts of the process's own mount namespace. -The format of this file is documented in -.BR fstab (5). -.TP -.I /proc/mtrr -Memory Type Range Registers. -See the Linux kernel source file -.I Documentation/x86/mtrr.rst -(or -.I Documentation/x86/mtrr.txt -.\" commit 7225e75144b9718cbbe1820d9c011c809d5773fd -before Linux 5.2, or -.I Documentation/mtrr.txt -before Linux 2.6.28) -for details. -.TP -.I /proc/net -This directory contains various files and subdirectories containing -information about the networking layer. -The files contain ASCII structures and are, -therefore, readable with -.BR cat (1). -However, the standard -.BR netstat (8) -suite provides much cleaner access to these files. -.IP -With the advent of network namespaces, -various information relating to the network stack is virtualized (see -.BR network_namespaces (7)). -Thus, since Linux 2.6.25, -.\" commit e9720acd728a46cb40daa52c99a979f7c4ff195c -.I /proc/net -is a symbolic link to the directory -.IR /proc/self/net , -which contains the same files and directories as listed below. -However, these files and directories now expose information -for the network namespace of which the process is a member. -.TP -.I /proc/net/arp -This holds an ASCII readable dump of the kernel ARP table used for -address resolutions. -It will show both dynamically learned and preprogrammed ARP entries. -The format is: -.IP -.in +4n -.EX -IP address HW type Flags HW address Mask Device -192.168.0.50 0x1 0x2 00:50:BF:25:68:F3 * eth0 -192.168.0.250 0x1 0xc 00:00:00:00:00:00 * eth0 -.EE -.in -.IP -Here "IP address" is the IPv4 address of the machine and the "HW type" -is the hardware type of the address from RFC\ 826. -The flags are the internal -flags of the ARP structure (as defined in -.IR /usr/include/linux/if_arp.h ) -and -the "HW address" is the data link layer mapping for that IP address if -it is known. -.TP -.I /proc/net/dev -The dev pseudo-file contains network device status information. -This gives -the number of received and sent packets, the number of errors and -collisions -and other basic statistics. -These are used by the -.BR ifconfig (8) -program to report device status. -The format is: -.IP -.EX -Inter\-| Receive | Transmit - face |bytes packets errs drop fifo frame compressed multicast|bytes packets errs drop fifo colls carrier compressed - lo: 2776770 11307 0 0 0 0 0 0 2776770 11307 0 0 0 0 0 0 - eth0: 1215645 2751 0 0 0 0 0 0 1782404 4324 0 0 0 427 0 0 - ppp0: 1622270 5552 1 0 0 0 0 0 354130 5669 0 0 0 0 0 0 - tap0: 7714 81 0 0 0 0 0 0 7714 81 0 0 0 0 0 0 -.EE -.\" .TP -.\" .I /proc/net/ipx -.\" No information. -.\" .TP -.\" .I /proc/net/ipx_route -.\" No information. -.TP -.I /proc/net/dev_mcast -Defined in -.IR /usr/src/linux/net/core/dev_mcast.c : -.IP -.in +4n -.EX -indx interface_name dmi_u dmi_g dmi_address -2 eth0 1 0 01005e000001 -3 eth1 1 0 01005e000001 -4 eth2 1 0 01005e000001 -.EE -.in -.TP -.I /proc/net/igmp -Internet Group Management Protocol. -Defined in -.IR /usr/src/linux/net/core/igmp.c . -.TP -.I /proc/net/rarp -This file uses the same format as the -.I arp -file and contains the current reverse mapping database used to provide -.BR rarp (8) -reverse address lookup services. -If RARP is not configured into the -kernel, -this file will not be present. -.TP -.I /proc/net/raw -Holds a dump of the RAW socket table. -Much of the information is not of -use -apart from debugging. -The "sl" value is the kernel hash slot for the -socket, -the "local_address" is the local address and protocol number pair. -\&"St" is -the internal status of the socket. -The "tx_queue" and "rx_queue" are the -outgoing and incoming data queue in terms of kernel memory usage. -The "tr", "tm\->when", and "rexmits" fields are not used by RAW. -The "uid" -field holds the effective UID of the creator of the socket. -.\" .TP -.\" .I /proc/net/route -.\" No information, but looks similar to -.\" .BR route (8). -.TP -.I /proc/net/snmp -This file holds the ASCII data needed for the IP, ICMP, TCP, and UDP -management -information bases for an SNMP agent. -.TP -.I /proc/net/tcp -Holds a dump of the TCP socket table. -Much of the information is not -of use apart from debugging. -The "sl" value is the kernel hash slot -for the socket, the "local_address" is the local address and port number pair. -The "rem_address" is the remote address and port number pair -(if connected). -\&"St" is the internal status of the socket. -The "tx_queue" and "rx_queue" are the -outgoing and incoming data queue in terms of kernel memory usage. -The "tr", "tm\->when", and "rexmits" fields hold internal information of -the kernel socket state and are useful only for debugging. -The "uid" -field holds the effective UID of the creator of the socket. -.TP -.I /proc/net/udp -Holds a dump of the UDP socket table. -Much of the information is not of -use apart from debugging. -The "sl" value is the kernel hash slot for the -socket, the "local_address" is the local address and port number pair. -The "rem_address" is the remote address and port number pair -(if connected). -"St" is the internal status of the socket. -The "tx_queue" and "rx_queue" are the outgoing and incoming data queue -in terms of kernel memory usage. -The "tr", "tm\->when", and "rexmits" fields -are not used by UDP. -The "uid" -field holds the effective UID of the creator of the socket. -The format is: -.IP -.EX -sl local_address rem_address st tx_queue rx_queue tr rexmits tm\->when uid - 1: 01642C89:0201 0C642C89:03FF 01 00000000:00000001 01:000071BA 00000000 0 - 1: 00000000:0801 00000000:0000 0A 00000000:00000000 00:00000000 6F000100 0 - 1: 00000000:0201 00000000:0000 0A 00000000:00000000 00:00000000 00000000 0 -.EE -.TP -.I /proc/net/unix -Lists the UNIX domain sockets present within the system and their -status. -The format is: -.IP -.EX -Num RefCount Protocol Flags Type St Inode Path - 0: 00000002 00000000 00000000 0001 03 42 - 1: 00000001 00000000 00010000 0001 01 1948 /dev/printer -.EE -.IP -The fields are as follows: -.RS -.TP 10 -.IR Num : -the kernel table slot number. -.TP -.IR RefCount : -the number of users of the socket. -.TP -.IR Protocol : -currently always 0. -.TP -.IR Flags : -the internal kernel flags holding the status of the socket. -.TP -.IR Type : -the socket type. -For -.B SOCK_STREAM -sockets, this is 0001; for -.B SOCK_DGRAM -sockets, it is 0002; and for -.B SOCK_SEQPACKET -sockets, it is 0005. -.TP -.IR St : -the internal state of the socket. -.TP -.IR Inode : -the inode number of the socket. -.TP -.IR Path : -the bound pathname (if any) of the socket. -Sockets in the abstract namespace are included in the list, -and are shown with a -.I Path -that commences with the character '@'. -.RE -.TP -.I /proc/net/netfilter/nfnetlink_queue -This file contains information about netfilter user-space queueing, if used. -Each line represents a queue. -Queues that have not been subscribed to -by user space are not shown. -.IP -.in +4n -.EX - 1 4207 0 2 65535 0 0 0 1 - (1) (2) (3)(4) (5) (6) (7) (8) -.EE -.in -.IP -The fields in each line are: -.RS 7 -.TP 5 -(1) -The ID of the queue. -This matches what is specified in the -.B \-\-queue\-num -or -.B \-\-queue\-balance -options to the -.BR iptables (8) -NFQUEUE target. -See -.BR iptables\-extensions (8) -for more information. -.TP -(2) -The netlink port ID subscribed to the queue. -.TP -(3) -The number of packets currently queued and waiting to be processed by -the application. -.TP -(4) -The copy mode of the queue. -It is either 1 (metadata only) or 2 -(also copy payload data to user space). -.TP -(5) -Copy range; that is, how many bytes of packet payload should be copied to -user space at most. -.TP -(6) -queue dropped. -Number of packets that had to be dropped by the kernel because -too many packets are already waiting for user space to send back the mandatory -accept/drop verdicts. -.TP -(7) -queue user dropped. -Number of packets that were dropped within the netlink -subsystem. -Such drops usually happen when the corresponding socket buffer is -full; that is, user space is not able to read messages fast enough. -.TP -(8) -sequence number. -Every queued packet is associated with a (32-bit) -monotonically increasing sequence number. -This shows the ID of the most recent packet queued. -.RE -.IP -The last number exists only for compatibility reasons and is always 1. -.TP -.I /proc/partitions -Contains the major and minor numbers of each partition as well as the number -of 1024-byte blocks and the partition name. -.TP -.I /proc/pci -This is a listing of all PCI devices found during kernel initialization -and their configuration. -.IP -This file has been deprecated in favor of a new -.I /proc -interface for PCI -.RI ( /proc/bus/pci ). -It became optional in Linux 2.2 (available with -.B CONFIG_PCI_OLD_PROC -set at kernel compilation). -It became once more nonoptionally enabled in Linux 2.4. -Next, it was deprecated in Linux 2.6 (still available with -.B CONFIG_PCI_LEGACY_PROC -set), and finally removed altogether since Linux 2.6.17. .\" FIXME Document /proc/sched_debug (since Linux 2.6.23) .\" See also /proc/[pid]/sched -.TP -.IR /proc/profile " (since Linux 2.4)" -This file is present only if the kernel was booted with the -.I profile=1 -command-line option. -It exposes kernel profiling information in a binary format for use by -.BR readprofile (1). -Writing (e.g., an empty string) to this file resets the profiling counters; -on some architectures, -writing a binary integer "profiling multiplier" of size -.I sizeof(int) -sets the profiling interrupt frequency. -.TP -.I /proc/scsi -A directory with the -.I scsi -mid-level pseudo-file and various SCSI low-level -driver directories, -which contain a file for each SCSI host in this system, all of -which give the status of some part of the SCSI IO subsystem. -These files contain ASCII structures and are, therefore, readable with -.BR cat (1). -.IP -You can also write to some of the files to reconfigure the subsystem or -switch certain features on or off. -.TP -.I /proc/scsi/scsi -This is a listing of all SCSI devices known to the kernel. -The listing is similar to the one seen during bootup. -scsi currently supports only the \fIadd\-single\-device\fP command which -allows root to add a hotplugged device to the list of known devices. -.IP -The command -.IP -.in +4n -.EX -echo \[aq]scsi add\-single\-device 1 0 5 0\[aq] > /proc/scsi/scsi -.EE -.in -.IP -will cause -host scsi1 to scan on SCSI channel 0 for a device on ID 5 LUN 0. -If there -is already a device known on this address or the address is invalid, an -error will be returned. -.TP -.IR /proc/scsi/ drivername -\fIdrivername\fP can currently be NCR53c7xx, aha152x, aha1542, aha1740, -aic7xxx, buslogic, eata_dma, eata_pio, fdomain, in2000, pas16, qlogic, -scsi_debug, seagate, t128, u15\-24f, ultrastore, or wd7000. -These directories show up for all drivers that registered at least one -SCSI HBA. -Every directory contains one file per registered host. -Every host-file is named after the number the host was assigned during -initialization. -.IP -Reading these files will usually show driver and host configuration, -statistics, and so on. -.IP -Writing to these files allows different things on different hosts. -For example, with the \fIlatency\fP and \fInolatency\fP commands, -root can switch on and off command latency measurement code in the -eata_dma driver. -With the \fIlockup\fP and \fIunlock\fP commands, -root can control bus lockups simulated by the scsi_debug driver. -.TP -.I /proc/self -This directory refers to the process accessing the -.I /proc -filesystem, -and is identical to the -.I /proc -directory named by the process ID of the same process. -.TP -.I /proc/slabinfo -Information about kernel caches. -See -.BR slabinfo (5) -for details. -.TP -.I /proc/stat -kernel/system statistics. -Varies with architecture. -Common -entries include: -.RS -.TP -.I cpu 10132153 290696 3084719 46828483 16683 0 25195 0 175628 0 -.TQ -.I cpu0 1393280 32966 572056 13343292 6130 0 17875 0 23933 0 -The amount of time, measured in units of -USER_HZ (1/100ths of a second on most architectures, use -.I sysconf(_SC_CLK_TCK) -to obtain the right value), -.\" 1024 on Alpha and ia64 -that the system ("cpu" line) or the specific CPU ("cpu\fIN\fR" line) -spent in various states: -.RS -.TP -.I user -(1) Time spent in user mode. -.TP -.I nice -(2) Time spent in user mode with low priority (nice). -.TP -.I system -(3) Time spent in system mode. -.TP -.I idle -(4) Time spent in the idle task. -.\" FIXME . Actually, the following info about the /proc/stat 'cpu' field -.\" does not seem to be quite right (at least in Linux 2.6.12 or Linux 3.6): -.\" the idle time in /proc/uptime does not quite match this value -This value should be USER_HZ times the -second entry in the -.I /proc/uptime -pseudo-file. -.TP -.IR iowait " (since Linux 2.5.41)" -(5) Time waiting for I/O to complete. -This value is not reliable, for the following reasons: -.\" See kernel commit 9c240d757658a3ae9968dd309e674c61f07c7f48 -.RS -.IP \[bu] 3 -The CPU will not wait for I/O to complete; -iowait is the time that a task is waiting for I/O to complete. -When a CPU goes into idle state for outstanding task I/O, -another task will be scheduled on this CPU. -.IP \[bu] -On a multi-core CPU, -the task waiting for I/O to complete is not running on any CPU, -so the iowait of each CPU is difficult to calculate. -.IP \[bu] -The value in this field may -.I decrease -in certain conditions. -.RE -.TP -.IR irq " (since Linux 2.6.0)" -.\" Precisely: Linux 2.6.0-test4 -(6) Time servicing interrupts. -.TP -.IR softirq " (since Linux 2.6.0)" -.\" Precisely: Linux 2.6.0-test4 -(7) Time servicing softirqs. -.TP -.IR steal " (since Linux 2.6.11)" -(8) Stolen time, which is the time spent in other operating systems when -running in a virtualized environment -.TP -.IR guest " (since Linux 2.6.24)" -(9) Time spent running a virtual CPU for guest -operating systems under the control of the Linux kernel. -.\" See Changelog entry for 5e84cfde51cf303d368fcb48f22059f37b3872de -.TP -.IR guest_nice " (since Linux 2.6.33)" -.\" commit ce0e7b28fb75cb003cfc8d0238613aaf1c55e797 -(10) Time spent running a niced guest (virtual CPU for guest -operating systems under the control of the Linux kernel). -.RE -.TP -\fIpage 5741 1808\fP -The number of pages the system paged in and the number that were paged -out (from disk). -.TP -\fIswap 1 0\fP -The number of swap pages that have been brought in and out. -.TP -.\" FIXME . The following is not the full picture for the 'intr' of -.\" /proc/stat on 2.6: -\fIintr 1462898\fP -This line shows counts of interrupts serviced since boot time, -for each of the possible system interrupts. -The first column is the total of all interrupts serviced -including unnumbered architecture specific interrupts; -each subsequent column is the total for that particular numbered interrupt. -Unnumbered interrupts are not shown, only summed into the total. -.TP -\fIdisk_io: (2,0):(31,30,5764,1,2) (3,0):\fP... -(major,disk_idx):(noinfo, read_io_ops, blks_read, write_io_ops, blks_written) -.br -(Linux 2.4 only) -.TP -\fIctxt 115315\fP -The number of context switches that the system underwent. -.TP -\fIbtime 769041601\fP -boot time, in seconds since the Epoch, 1970-01-01 00:00:00 +0000 (UTC). -.TP -\fIprocesses 86031\fP -Number of forks since boot. -.TP -\fIprocs_running 6\fP -Number of processes in runnable state. -(Linux 2.5.45 onward.) -.TP -\fIprocs_blocked 2\fP -Number of processes blocked waiting for I/O to complete. -(Linux 2.5.45 onward.) -.TP -.I softirq 229245889 94 60001584 13619 5175704 2471304 28 51212741 59130143 0 51240672 -.\" commit d3d64df21d3d0de675a0d3ffa7c10514f3644b30 -This line shows the number of softirq for all CPUs. -The first column is the total of all softirqs and -each subsequent column is the total for particular softirq. -(Linux 2.6.31 onward.) -.RE -.TP -.I /proc/swaps -Swap areas in use. -See also -.BR swapon (8). -.TP -.I /proc/sys -This directory (present since Linux 1.3.57) contains a number of files -and subdirectories corresponding to kernel variables. -These variables can be read and in some cases modified using -the \fI/proc\fP filesystem, and the (deprecated) -.BR sysctl (2) -system call. -.IP -String values may be terminated by either \[aq]\e0\[aq] or \[aq]\en\[aq]. -.IP -Integer and long values may be written either in decimal or in -hexadecimal notation (e.g., 0x3FFF). -When writing multiple integer or long values, these may be separated -by any of the following whitespace characters: -\[aq]\ \[aq], \[aq]\et\[aq], or \[aq]\en\[aq]. -Using other separators leads to the error -.BR EINVAL . -.TP -.IR /proc/sys/abi " (since Linux 2.4.10)" -This directory may contain files with application binary information. -.\" On some systems, it is not present. -See the Linux kernel source file -.I Documentation/sysctl/abi.rst -(or -.I Documentation/sysctl/abi.txt -before Linux 5.3) -for more information. -.TP -.I /proc/sys/debug -This directory may be empty. -.TP -.I /proc/sys/dev -This directory contains device-specific information (e.g., -.IR dev/cdrom/info ). -On -some systems, it may be empty. -.TP -.I /proc/sys/fs -This directory contains the files and subdirectories for kernel variables -related to filesystems. -.TP -.IR /proc/sys/fs/aio\-max\-nr " and " /proc/sys/fs/aio\-nr " (since Linux 2.6.4)" -.I aio\-nr -is the running total of the number of events specified by -.BR io_setup (2) -calls for all currently active AIO contexts. -If -.I aio\-nr -reaches -.IR aio\-max\-nr , -then -.BR io_setup (2) -will fail with the error -.BR EAGAIN . -Raising -.I aio\-max\-nr -does not result in the preallocation or resizing -of any kernel data structures. -.TP -.I /proc/sys/fs/binfmt_misc -Documentation for files in this directory can be found -in the Linux kernel source in the file -.I Documentation/admin\-guide/binfmt\-misc.rst -(or in -.I Documentation/binfmt_misc.txt -on older kernels). -.TP -.IR /proc/sys/fs/dentry\-state " (since Linux 2.2)" -This file contains information about the status of the -directory cache (dcache). -The file contains six numbers, -.IR nr_dentry , -.IR nr_unused , -.I age_limit -(age in seconds), -.I want_pages -(pages requested by system) and two dummy values. -.RS -.IP \[bu] 3 -.I nr_dentry -is the number of allocated dentries (dcache entries). -This field is unused in Linux 2.2. -.IP \[bu] -.I nr_unused -is the number of unused dentries. -.IP \[bu] -.I age_limit -.\" looks like this is unused in Linux 2.2 to Linux 2.6 -is the age in seconds after which dcache entries -can be reclaimed when memory is short. -.IP \[bu] -.I want_pages -.\" looks like this is unused in Linux 2.2 to Linux 2.6 -is nonzero when the kernel has called shrink_dcache_pages() and the -dcache isn't pruned yet. -.RE -.TP -.I /proc/sys/fs/dir\-notify\-enable -This file can be used to disable or enable the -.I dnotify -interface described in -.BR fcntl (2) -on a system-wide basis. -A value of 0 in this file disables the interface, -and a value of 1 enables it. -.TP -.I /proc/sys/fs/dquot\-max -This file shows the maximum number of cached disk quota entries. -On some (2.4) systems, it is not present. -If the number of free cached disk quota entries is very low and -you have some awesome number of simultaneous system users, -you might want to raise the limit. -.TP -.I /proc/sys/fs/dquot\-nr -This file shows the number of allocated disk quota -entries and the number of free disk quota entries. -.TP -.IR /proc/sys/fs/epoll " (since Linux 2.6.28)" -This directory contains the file -.IR max_user_watches , -which can be used to limit the amount of kernel memory consumed by the -.I epoll -interface. -For further details, see -.BR epoll (7). -.TP -.I /proc/sys/fs/file\-max -This file defines -a system-wide limit on the number of open files for all processes. -System calls that fail when encountering this limit fail with the error -.BR ENFILE . -(See also -.BR setrlimit (2), -which can be used by a process to set the per-process limit, -.BR RLIMIT_NOFILE , -on the number of files it may open.) -If you get lots -of error messages in the kernel log about running out of file handles -(open file descriptions) -(look for "VFS: file\-max limit <number> reached"), -try increasing this value: -.IP -.in +4n -.EX -echo 100000 > /proc/sys/fs/file\-max -.EE -.in -.IP -Privileged processes -.RB ( CAP_SYS_ADMIN ) -can override the -.I file\-max -limit. -.TP -.I /proc/sys/fs/file\-nr -This (read-only) file contains three numbers: -the number of allocated file handles -(i.e., the number of open file descriptions; see -.BR open (2)); -the number of free file handles; -and the maximum number of file handles (i.e., the same value as -.IR /proc/sys/fs/file\-max ). -If the number of allocated file handles is close to the -maximum, you should consider increasing the maximum. -Before Linux 2.6, -the kernel allocated file handles dynamically, -but it didn't free them again. -Instead the free file handles were kept in a list for reallocation; -the "free file handles" value indicates the size of that list. -A large number of free file handles indicates that there was -a past peak in the usage of open file handles. -Since Linux 2.6, the kernel does deallocate freed file handles, -and the "free file handles" value is always zero. -.TP -.IR /proc/sys/fs/inode\-max " (only present until Linux 2.2)" -This file contains the maximum number of in-memory inodes. -This value should be 3\[en]4 times larger -than the value in -.IR file\-max , -since \fIstdin\fP, \fIstdout\fP -and network sockets also need an inode to handle them. -When you regularly run out of inodes, you need to increase this value. -.IP -Starting with Linux 2.4, -there is no longer a static limit on the number of inodes, -and this file is removed. -.TP -.I /proc/sys/fs/inode\-nr -This file contains the first two values from -.IR inode\-state . -.TP -.I /proc/sys/fs/inode\-state -This file -contains seven numbers: -.IR nr_inodes , -.IR nr_free_inodes , -.IR preshrink , -and four dummy values (always zero). -.IP -.I nr_inodes -is the number of inodes the system has allocated. -.\" This can be slightly more than -.\" .I inode\-max -.\" because Linux allocates them one page full at a time. -.I nr_free_inodes -represents the number of free inodes. -.IP -.I preshrink -is nonzero when the -.I nr_inodes -> -.I inode\-max -and the system needs to prune the inode list instead of allocating more; -since Linux 2.4, this field is a dummy value (always zero). -.TP -.IR /proc/sys/fs/inotify " (since Linux 2.6.13)" -This directory contains files -.IR max_queued_events ", " max_user_instances ", and " max_user_watches , -that can be used to limit the amount of kernel memory consumed by the -.I inotify -interface. -For further details, see -.BR inotify (7). -.TP -.I /proc/sys/fs/lease\-break\-time -This file specifies the grace period that the kernel grants to a process -holding a file lease -.RB ( fcntl (2)) -after it has sent a signal to that process notifying it -that another process is waiting to open the file. -If the lease holder does not remove or downgrade the lease within -this grace period, the kernel forcibly breaks the lease. -.TP -.I /proc/sys/fs/leases\-enable -This file can be used to enable or disable file leases -.RB ( fcntl (2)) -on a system-wide basis. -If this file contains the value 0, leases are disabled. -A nonzero value enables leases. -.TP -.IR /proc/sys/fs/mount\-max " (since Linux 4.9)" -.\" commit d29216842a85c7970c536108e093963f02714498 -The value in this file specifies the maximum number of mounts that may exist -in a mount namespace. -The default value in this file is 100,000. -.TP -.IR /proc/sys/fs/mqueue " (since Linux 2.6.6)" -This directory contains files -.IR msg_max ", " msgsize_max ", and " queues_max , -controlling the resources used by POSIX message queues. -See -.BR mq_overview (7) -for details. -.TP -.IR /proc/sys/fs/nr_open " (since Linux 2.6.25)" -.\" commit 9cfe015aa424b3c003baba3841a60dd9b5ad319b -This file imposes a ceiling on the value to which the -.B RLIMIT_NOFILE -resource limit can be raised (see -.BR getrlimit (2)). -This ceiling is enforced for both unprivileged and privileged process. -The default value in this file is 1048576. -(Before Linux 2.6.25, the ceiling for -.B RLIMIT_NOFILE -was hard-coded to the same value.) -.TP -.IR /proc/sys/fs/overflowgid " and " /proc/sys/fs/overflowuid -These files -allow you to change the value of the fixed UID and GID. -The default is 65534. -Some filesystems support only 16-bit UIDs and GIDs, although in Linux -UIDs and GIDs are 32 bits. -When one of these filesystems is mounted -with writes enabled, any UID or GID that would exceed 65535 is translated -to the overflow value before being written to disk. -.TP -.IR /proc/sys/fs/pipe\-max\-size " (since Linux 2.6.35)" -See -.BR pipe (7). -.TP -.IR /proc/sys/fs/pipe\-user\-pages\-hard " (since Linux 4.5)" -See -.BR pipe (7). -.TP -.IR /proc/sys/fs/pipe\-user\-pages\-soft " (since Linux 4.5)" -See -.BR pipe (7). -.TP -.IR /proc/sys/fs/protected_fifos " (since Linux 4.19)" -The value in this file is/can be set to one of the following: -.RS -.TP 4 -0 -Writing to FIFOs is unrestricted. -.TP -1 -Don't allow -.B O_CREAT -.BR open (2) -on FIFOs that the caller doesn't own in world-writable sticky directories, -unless the FIFO is owned by the owner of the directory. -.TP -2 -As for the value 1, -but the restriction also applies to group-writable sticky directories. -.RE -.IP -The intent of the above protections is to avoid unintentional writes to an -attacker-controlled FIFO when a program expected to create a regular file. -.TP -.IR /proc/sys/fs/protected_hardlinks " (since Linux 3.6)" -.\" commit 800179c9b8a1e796e441674776d11cd4c05d61d7 -When the value in this file is 0, -no restrictions are placed on the creation of hard links -(i.e., this is the historical behavior before Linux 3.6). -When the value in this file is 1, -a hard link can be created to a target file -only if one of the following conditions is true: -.RS -.IP \[bu] 3 -The calling process has the -.B CAP_FOWNER -capability in its user namespace -and the file UID has a mapping in the namespace. -.IP \[bu] -The filesystem UID of the process creating the link matches -the owner (UID) of the target file -(as described in -.BR credentials (7), -a process's filesystem UID is normally the same as its effective UID). -.IP \[bu] -All of the following conditions are true: -.RS 4 -.IP \[bu] 3 -the target is a regular file; -.IP \[bu] -the target file does not have its set-user-ID mode bit enabled; -.IP \[bu] -the target file does not have both its set-group-ID and -group-executable mode bits enabled; and -.IP \[bu] -the caller has permission to read and write the target file -(either via the file's permissions mask or because it has -suitable capabilities). -.RE -.RE -.IP -The default value in this file is 0. -Setting the value to 1 -prevents a longstanding class of security issues caused by -hard-link-based time-of-check, time-of-use races, -most commonly seen in world-writable directories such as -.IR /tmp . -The common method of exploiting this flaw -is to cross privilege boundaries when following a given hard link -(i.e., a root process follows a hard link created by another user). -Additionally, on systems without separated partitions, -this stops unauthorized users from "pinning" vulnerable set-user-ID and -set-group-ID files against being upgraded by -the administrator, or linking to special files. -.TP -.IR /proc/sys/fs/protected_regular " (since Linux 4.19)" -The value in this file is/can be set to one of the following: -.RS -.TP 4 -0 -Writing to regular files is unrestricted. -.TP -1 -Don't allow -.B O_CREAT -.BR open (2) -on regular files that the caller doesn't own in -world-writable sticky directories, -unless the regular file is owned by the owner of the directory. -.TP -2 -As for the value 1, -but the restriction also applies to group-writable sticky directories. -.RE -.IP -The intent of the above protections is similar to -.IR protected_fifos , -but allows an application to -avoid writes to an attacker-controlled regular file, -where the application expected to create one. -.TP -.IR /proc/sys/fs/protected_symlinks " (since Linux 3.6)" -.\" commit 800179c9b8a1e796e441674776d11cd4c05d61d7 -When the value in this file is 0, -no restrictions are placed on following symbolic links -(i.e., this is the historical behavior before Linux 3.6). -When the value in this file is 1, symbolic links are followed only -in the following circumstances: -.RS -.IP \[bu] 3 -the filesystem UID of the process following the link matches -the owner (UID) of the symbolic link -(as described in -.BR credentials (7), -a process's filesystem UID is normally the same as its effective UID); -.IP \[bu] -the link is not in a sticky world-writable directory; or -.IP \[bu] -the symbolic link and its parent directory have the same owner (UID) -.RE -.IP -A system call that fails to follow a symbolic link -because of the above restrictions returns the error -.B EACCES -in -.IR errno . -.IP -The default value in this file is 0. -Setting the value to 1 avoids a longstanding class of security issues -based on time-of-check, time-of-use races when accessing symbolic links. -.TP -.IR /proc/sys/fs/suid_dumpable " (since Linux 2.6.13)" -.\" The following is based on text from Documentation/sysctl/kernel.txt -The value in this file is assigned to a process's "dumpable" flag -in the circumstances described in -.BR prctl (2). -In effect, -the value in this file determines whether core dump files are -produced for set-user-ID or otherwise protected/tainted binaries. -The "dumpable" setting also affects the ownership of files in a process's -.IR /proc/ pid -directory, as described above. -.IP -Three different integer values can be specified: -.RS -.TP -\fI0\ (default)\fP -.\" In kernel source: SUID_DUMP_DISABLE -This provides the traditional (pre-Linux 2.6.13) behavior. -A core dump will not be produced for a process which has -changed credentials (by calling -.BR seteuid (2), -.BR setgid (2), -or similar, or by executing a set-user-ID or set-group-ID program) -or whose binary does not have read permission enabled. -.TP -\fI1\ ("debug")\fP -.\" In kernel source: SUID_DUMP_USER -All processes dump core when possible. -(Reasons why a process might nevertheless not dump core are described in -.BR core (5).) -The core dump is owned by the filesystem user ID of the dumping process -and no security is applied. -This is intended for system debugging situations only: -this mode is insecure because it allows unprivileged users to -examine the memory contents of privileged processes. -.TP -\fI2\ ("suidsafe")\fP -.\" In kernel source: SUID_DUMP_ROOT -Any binary which normally would not be dumped (see "0" above) -is dumped readable by root only. -This allows the user to remove the core dump file but not to read it. -For security reasons core dumps in this mode will not overwrite one -another or other files. -This mode is appropriate when administrators are -attempting to debug problems in a normal environment. -.IP -Additionally, since Linux 3.6, -.\" 9520628e8ceb69fa9a4aee6b57f22675d9e1b709 -.I /proc/sys/kernel/core_pattern -must either be an absolute pathname -or a pipe command, as detailed in -.BR core (5). -Warnings will be written to the kernel log if -.I core_pattern -does not follow these rules, and no core dump will be produced. -.\" 54b501992dd2a839e94e76aa392c392b55080ce8 -.RE -.IP -For details of the effect of a process's "dumpable" setting -on ptrace access mode checking, see -.BR ptrace (2). -.TP -.I /proc/sys/fs/super\-max -This file -controls the maximum number of superblocks, and -thus the maximum number of mounted filesystems the kernel -can have. -You need increase only -.I super\-max -if you need to mount more filesystems than the current value in -.I super\-max -allows you to. -.TP -.I /proc/sys/fs/super\-nr -This file -contains the number of filesystems currently mounted. -.TP -.I /proc/sys/kernel -This directory contains files controlling a range of kernel parameters, -as described below. -.TP -.I /proc/sys/kernel/acct -This file -contains three numbers: -.IR highwater , -.IR lowwater , -and -.IR frequency . -If BSD-style process accounting is enabled, these values control -its behavior. -If free space on filesystem where the log lives goes below -.I lowwater -percent, accounting suspends. -If free space gets above -.I highwater -percent, accounting resumes. -.I frequency -determines -how often the kernel checks the amount of free space (value is in -seconds). -Default values are 4, 2, and 30. -That is, suspend accounting if 2% or less space is free; resume it -if 4% or more space is free; consider information about amount of free space -valid for 30 seconds. -.TP -.IR /proc/sys/kernel/auto_msgmni " (Linux 2.6.27 to Linux 3.18)" -.\" commit 9eefe520c814f6f62c5d36a2ddcd3fb99dfdb30e (introduces feature) -.\" commit 0050ee059f7fc86b1df2527aaa14ed5dc72f9973 (rendered redundant) -From Linux 2.6.27 to Linux 3.18, -this file was used to control recomputing of the value in -.I /proc/sys/kernel/msgmni -upon the addition or removal of memory or upon IPC namespace creation/removal. -Echoing "1" into this file enabled -.I msgmni -automatic recomputing (and triggered a recomputation of -.I msgmni -based on the current amount of available memory and number of IPC namespaces). -Echoing "0" disabled automatic recomputing. -(Automatic recomputing was also disabled if a value was explicitly assigned to -.IR /proc/sys/kernel/msgmni .) -The default value in -.I auto_msgmni -was 1. -.IP -Since Linux 3.19, the content of this file has no effect (because -.I msgmni -.\" FIXME Must document the 3.19 'msgmni' changes. -defaults to near the maximum value possible), -and reads from this file always return the value "0". -.TP -.IR /proc/sys/kernel/cap_last_cap " (since Linux 3.2)" -See -.BR capabilities (7). -.TP -.IR /proc/sys/kernel/cap\-bound " (from Linux 2.2 to Linux 2.6.24)" -This file holds the value of the kernel -.I "capability bounding set" -(expressed as a signed decimal number). -This set is ANDed against the capabilities permitted to a process -during -.BR execve (2). -Starting with Linux 2.6.25, -the system-wide capability bounding set disappeared, -and was replaced by a per-thread bounding set; see -.BR capabilities (7). -.TP -.I /proc/sys/kernel/core_pattern -See -.BR core (5). -.TP -.I /proc/sys/kernel/core_pipe_limit -See -.BR core (5). -.TP -.I /proc/sys/kernel/core_uses_pid -See -.BR core (5). -.TP -.I /proc/sys/kernel/ctrl\-alt\-del -This file -controls the handling of Ctrl-Alt-Del from the keyboard. -When the value in this file is 0, Ctrl-Alt-Del is trapped and -sent to the -.BR init (1) -program to handle a graceful restart. -When the value is greater than zero, Linux's reaction to a Vulcan -Nerve Pinch (tm) will be an immediate reboot, without even -syncing its dirty buffers. -Note: when a program (like dosemu) has the keyboard in "raw" -mode, the Ctrl-Alt-Del is intercepted by the program before it -ever reaches the kernel tty layer, and it's up to the program -to decide what to do with it. -.TP -.IR /proc/sys/kernel/dmesg_restrict " (since Linux 2.6.37)" -The value in this file determines who can see kernel syslog contents. -A value of 0 in this file imposes no restrictions. -If the value is 1, only privileged users can read the kernel syslog. -(See -.BR syslog (2) -for more details.) -Since Linux 3.4, -.\" commit 620f6e8e855d6d447688a5f67a4e176944a084e8 -only users with the -.B CAP_SYS_ADMIN -capability may change the value in this file. -.TP -.IR /proc/sys/kernel/domainname " and " /proc/sys/kernel/hostname -can be used to set the NIS/YP domainname and the -hostname of your box in exactly the same way as the commands -.BR domainname (1) -and -.BR hostname (1), -that is: -.IP -.in +4n -.EX -.RB "#" " echo \[aq]darkstar\[aq] > /proc/sys/kernel/hostname" -.RB "#" " echo \[aq]mydomain\[aq] > /proc/sys/kernel/domainname" -.EE -.in -.IP -has the same effect as -.IP -.in +4n -.EX -.RB "#" " hostname \[aq]darkstar\[aq]" -.RB "#" " domainname \[aq]mydomain\[aq]" -.EE -.in -.IP -Note, however, that the classic darkstar.frop.org has the -hostname "darkstar" and DNS (Internet Domain Name Server) -domainname "frop.org", not to be confused with the NIS (Network -Information Service) or YP (Yellow Pages) domainname. -These two -domain names are in general different. -For a detailed discussion -see the -.BR hostname (1) -man page. -.TP -.I /proc/sys/kernel/hotplug -This file -contains the pathname for the hotplug policy agent. -The default value in this file is -.IR /sbin/hotplug . -.TP -.\" Removed in commit 87f504e5c78b910b0c1d6ffb89bc95e492322c84 (tglx/history.git) -.IR /proc/sys/kernel/htab\-reclaim " (before Linux 2.4.9.2)" -(PowerPC only) If this file is set to a nonzero value, -the PowerPC htab -.\" removed in commit 1b483a6a7b2998e9c98ad985d7494b9b725bd228, before Linux 2.6.28 -(see kernel file -.IR Documentation/powerpc/ppc_htab.txt ) -is pruned -each time the system hits the idle loop. -.TP -.I /proc/sys/kernel/keys/* -This directory contains various files that define parameters and limits -for the key-management facility. -These files are described in -.BR keyrings (7). -.TP -.IR /proc/sys/kernel/kptr_restrict " (since Linux 2.6.38)" -.\" 455cd5ab305c90ffc422dd2e0fb634730942b257 -The value in this file determines whether kernel addresses are exposed via -.I /proc -files and other interfaces. -A value of 0 in this file imposes no restrictions. -If the value is 1, kernel pointers printed using the -.I %pK -format specifier will be replaced with zeros unless the user has the -.B CAP_SYSLOG -capability. -If the value is 2, kernel pointers printed using the -.I %pK -format specifier will be replaced with zeros regardless -of the user's capabilities. -The initial default value for this file was 1, -but the default was changed -.\" commit 411f05f123cbd7f8aa1edcae86970755a6e2a9d9 -to 0 in Linux 2.6.39. -Since Linux 3.4, -.\" commit 620f6e8e855d6d447688a5f67a4e176944a084e8 -only users with the -.B CAP_SYS_ADMIN -capability can change the value in this file. -.TP -.I /proc/sys/kernel/l2cr -(PowerPC only) This file -contains a flag that controls the L2 cache of G3 processor -boards. -If 0, the cache is disabled. -Enabled if nonzero. -.TP -.I /proc/sys/kernel/modprobe -This file contains the pathname for the kernel module loader. -The default value is -.IR /sbin/modprobe . -The file is present only if the kernel is built with the -.B CONFIG_MODULES -.RB ( CONFIG_KMOD -in Linux 2.6.26 and earlier) -option enabled. -It is described by the Linux kernel source file -.I Documentation/kmod.txt -(present only in Linux 2.4 and earlier). -.TP -.IR /proc/sys/kernel/modules_disabled " (since Linux 2.6.31)" -.\" 3d43321b7015387cfebbe26436d0e9d299162ea1 -.\" From Documentation/sysctl/kernel.txt -A toggle value indicating if modules are allowed to be loaded -in an otherwise modular kernel. -This toggle defaults to off (0), but can be set true (1). -Once true, modules can be neither loaded nor unloaded, -and the toggle cannot be set back to false. -The file is present only if the kernel is built with the -.B CONFIG_MODULES -option enabled. -.TP -.IR /proc/sys/kernel/msgmax " (since Linux 2.2)" -This file defines -a system-wide limit specifying the maximum number of bytes in -a single message written on a System V message queue. -.TP -.IR /proc/sys/kernel/msgmni " (since Linux 2.4)" -This file defines the system-wide limit on the number of -message queue identifiers. -See also -.IR /proc/sys/kernel/auto_msgmni . -.TP -.IR /proc/sys/kernel/msgmnb " (since Linux 2.2)" -This file defines a system-wide parameter used to initialize the -.I msg_qbytes -setting for subsequently created message queues. -The -.I msg_qbytes -setting specifies the maximum number of bytes that may be written to the -message queue. -.TP -.IR /proc/sys/kernel/ngroups_max " (since Linux 2.6.4)" -This is a read-only file that displays the upper limit on the -number of a process's group memberships. -.TP -.IR /proc/sys/kernel/ns_last_pid " (since Linux 3.3)" -See -.BR pid_namespaces (7). -.TP -.IR /proc/sys/kernel/ostype " and " /proc/sys/kernel/osrelease -These files -give substrings of -.IR /proc/version . -.TP -.IR /proc/sys/kernel/overflowgid " and " /proc/sys/kernel/overflowuid -These files duplicate the files -.I /proc/sys/fs/overflowgid -and -.IR /proc/sys/fs/overflowuid . -.TP -.I /proc/sys/kernel/panic -This file gives read/write access to the kernel variable -.IR panic_timeout . -If this is zero, the kernel will loop on a panic; if nonzero, -it indicates that the kernel should autoreboot after this number -of seconds. -When you use the -software watchdog device driver, the recommended setting is 60. -.TP -.IR /proc/sys/kernel/panic_on_oops " (since Linux 2.5.68)" -This file controls the kernel's behavior when an oops -or BUG is encountered. -If this file contains 0, then the system -tries to continue operation. -If it contains 1, then the system -delays a few seconds (to give klogd time to record the oops output) -and then panics. -If the -.I /proc/sys/kernel/panic -file is also nonzero, then the machine will be rebooted. -.TP -.IR /proc/sys/kernel/pid_max " (since Linux 2.5.34)" -This file specifies the value at which PIDs wrap around -(i.e., the value in this file is one greater than the maximum PID). -PIDs greater than this value are not allocated; -thus, the value in this file also acts as a system-wide limit -on the total number of processes and threads. -The default value for this file, 32768, -results in the same range of PIDs as on earlier kernels. -On 32-bit platforms, 32768 is the maximum value for -.IR pid_max . -On 64-bit systems, -.I pid_max -can be set to any value up to 2\[ha]22 -.RB ( PID_MAX_LIMIT , -approximately 4 million). -.\" Prior to Linux 2.6.10, pid_max could also be raised above 32768 on 32-bit -.\" platforms, but this broke /proc/[pid] -.\" See http://marc.theaimsgroup.com/?l=linux-kernel&m=109513010926152&w=2 -.TP -.IR /proc/sys/kernel/powersave\-nap " (PowerPC only)" -This file contains a flag. -If set, Linux-PPC will use the "nap" mode of -powersaving, -otherwise the "doze" mode will be used. -.TP -.I /proc/sys/kernel/printk -See -.BR syslog (2). -.TP -.IR /proc/sys/kernel/pty " (since Linux 2.6.4)" -This directory contains two files relating to the number of UNIX 98 -pseudoterminals (see -.BR pts (4)) -on the system. -.TP -.I /proc/sys/kernel/pty/max -This file defines the maximum number of pseudoterminals. -.\" FIXME Document /proc/sys/kernel/pty/reserve -.\" New in Linux 3.3 -.\" commit e9aba5158a80098447ff207a452a3418ae7ee386 -.TP -.I /proc/sys/kernel/pty/nr -This read-only file -indicates how many pseudoterminals are currently in use. -.TP -.I /proc/sys/kernel/random -This directory -contains various parameters controlling the operation of the file -.IR /dev/random . -See -.BR random (4) -for further information. -.TP -.IR /proc/sys/kernel/random/uuid " (since Linux 2.4)" -Each read from this read-only file returns a randomly generated 128-bit UUID, -as a string in the standard UUID format. -.TP -.IR /proc/sys/kernel/randomize_va_space " (since Linux 2.6.12)" -.\" Some further details can be found in Documentation/sysctl/kernel.txt -Select the address space layout randomization (ASLR) policy for the system -(on architectures that support ASLR). -Three values are supported for this file: -.RS -.TP -.B 0 -Turn ASLR off. -This is the default for architectures that don't support ASLR, -and when the kernel is booted with the -.I norandmaps -parameter. -.TP -.B 1 -Make the addresses of -.BR mmap (2) -allocations, the stack, and the VDSO page randomized. -Among other things, this means that shared libraries will be -loaded at randomized addresses. -The text segment of PIE-linked binaries will also be loaded -at a randomized address. -This value is the default if the kernel was configured with -.BR CONFIG_COMPAT_BRK . -.TP -.B 2 -(Since Linux 2.6.25) -.\" commit c1d171a002942ea2d93b4fbd0c9583c56fce0772 -Also support heap randomization. -This value is the default if the kernel was not configured with -.BR CONFIG_COMPAT_BRK . -.RE -.TP -.I /proc/sys/kernel/real\-root\-dev -This file is documented in the Linux kernel source file -.I Documentation/admin\-guide/initrd.rst -.\" commit 9d85025b0418163fae079c9ba8f8445212de8568 -(or -.I Documentation/initrd.txt -before Linux 4.10). -.TP -.IR /proc/sys/kernel/reboot\-cmd " (Sparc only)" -This file seems to be a way to give an argument to the SPARC -ROM/Flash boot loader. -Maybe to tell it what to do after -rebooting? -.TP -.I /proc/sys/kernel/rtsig\-max -(Up to and including Linux 2.6.7; see -.BR setrlimit (2)) -This file can be used to tune the maximum number -of POSIX real-time (queued) signals that can be outstanding -in the system. -.TP -.I /proc/sys/kernel/rtsig\-nr -(Up to and including Linux 2.6.7.) -This file shows the number of POSIX real-time signals currently queued. -.TP -.IR /proc/ pid /sched_autogroup_enabled " (since Linux 2.6.38)" -.\" commit 5091faa449ee0b7d73bc296a93bca9540fc51d0a -See -.BR sched (7). -.TP -.IR /proc/sys/kernel/sched_child_runs_first " (since Linux 2.6.23)" -If this file contains the value zero, then, after a -.BR fork (2), -the parent is first scheduled on the CPU. -If the file contains a nonzero value, -then the child is scheduled first on the CPU. -(Of course, on a multiprocessor system, -the parent and the child might both immediately be scheduled on a CPU.) -.TP -.IR /proc/sys/kernel/sched_rr_timeslice_ms " (since Linux 3.9)" -See -.BR sched_rr_get_interval (2). -.TP -.IR /proc/sys/kernel/sched_rt_period_us " (since Linux 2.6.25)" -See -.BR sched (7). -.TP -.IR /proc/sys/kernel/sched_rt_runtime_us " (since Linux 2.6.25)" -See -.BR sched (7). -.TP -.IR /proc/sys/kernel/seccomp " (since Linux 4.14)" -.\" commit 8e5f1ad116df6b0de65eac458d5e7c318d1c05af -This directory provides additional seccomp information and -configuration. -See -.BR seccomp (2) -for further details. -.TP -.IR /proc/sys/kernel/sem " (since Linux 2.4)" -This file contains 4 numbers defining limits for System V IPC semaphores. -These fields are, in order: -.RS -.TP -SEMMSL -The maximum semaphores per semaphore set. -.TP -SEMMNS -A system-wide limit on the number of semaphores in all semaphore sets. -.TP -SEMOPM -The maximum number of operations that may be specified in a -.BR semop (2) -call. -.TP -SEMMNI -A system-wide limit on the maximum number of semaphore identifiers. -.RE -.TP -.I /proc/sys/kernel/sg\-big\-buff -This file -shows the size of the generic SCSI device (sg) buffer. -You can't tune it just yet, but you could change it at -compile time by editing -.I include/scsi/sg.h -and changing -the value of -.BR SG_BIG_BUFF . -However, there shouldn't be any reason to change this value. -.TP -.IR /proc/sys/kernel/shm_rmid_forced " (since Linux 3.1)" -.\" commit b34a6b1da371ed8af1221459a18c67970f7e3d53 -.\" See also Documentation/sysctl/kernel.txt -If this file is set to 1, all System V shared memory segments will -be marked for destruction as soon as the number of attached processes -falls to zero; -in other words, it is no longer possible to create shared memory segments -that exist independently of any attached process. -.IP -The effect is as though a -.BR shmctl (2) -.B IPC_RMID -is performed on all existing segments as well as all segments -created in the future (until this file is reset to 0). -Note that existing segments that are attached to no process will be -immediately destroyed when this file is set to 1. -Setting this option will also destroy segments that were created, -but never attached, -upon termination of the process that created the segment with -.BR shmget (2). -.IP -Setting this file to 1 provides a way of ensuring that -all System V shared memory segments are counted against the -resource usage and resource limits (see the description of -.B RLIMIT_AS -in -.BR getrlimit (2)) -of at least one process. -.IP -Because setting this file to 1 produces behavior that is nonstandard -and could also break existing applications, -the default value in this file is 0. -Set this file to 1 only if you have a good understanding -of the semantics of the applications using -System V shared memory on your system. -.TP -.IR /proc/sys/kernel/shmall " (since Linux 2.2)" -This file -contains the system-wide limit on the total number of pages of -System V shared memory. -.TP -.IR /proc/sys/kernel/shmmax " (since Linux 2.2)" -This file -can be used to query and set the run-time limit -on the maximum (System V IPC) shared memory segment size that can be -created. -Shared memory segments up to 1 GB are now supported in the -kernel. -This value defaults to -.BR SHMMAX . -.TP -.IR /proc/sys/kernel/shmmni " (since Linux 2.4)" -This file -specifies the system-wide maximum number of System V shared memory -segments that can be created. -.TP -.IR /proc/sys/kernel/sysctl_writes_strict " (since Linux 3.16)" -.\" commit f88083005ab319abba5d0b2e4e997558245493c8 -.\" commit 2ca9bb456ada8bcbdc8f77f8fc78207653bbaa92 -.\" commit f4aacea2f5d1a5f7e3154e967d70cf3f711bcd61 -.\" commit 24fe831c17ab8149413874f2fd4e5c8a41fcd294 -The value in this file determines how the file offset affects -the behavior of updating entries in files under -.IR /proc/sys . -The file has three possible values: -.RS -.TP 4 -\-1 -This provides legacy handling, with no printk warnings. -Each -.BR write (2) -must fully contain the value to be written, -and multiple writes on the same file descriptor -will overwrite the entire value, regardless of the file position. -.TP -0 -(default) This provides the same behavior as for \-1, -but printk warnings are written for processes that -perform writes when the file offset is not 0. -.TP -1 -Respect the file offset when writing strings into -.I /proc/sys -files. -Multiple writes will -.I append -to the value buffer. -Anything written beyond the maximum length -of the value buffer will be ignored. -Writes to numeric -.I /proc/sys -entries must always be at file offset 0 and the value must be -fully contained in the buffer provided to -.BR write (2). -.\" FIXME . -.\" With /proc/sys/kernel/sysctl_writes_strict==1, writes at an -.\" offset other than 0 do not generate an error. Instead, the -.\" write() succeeds, but the file is left unmodified. -.\" This is surprising. The behavior may change in the future. -.\" See thread.gmane.org/gmane.linux.man/9197 -.\" From: Michael Kerrisk (man-pages <mtk.manpages@...> -.\" Subject: sysctl_writes_strict documentation + an oddity? -.\" Newsgroups: gmane.linux.man, gmane.linux.kernel -.\" Date: 2015-05-09 08:54:11 GMT -.RE -.TP -.I /proc/sys/kernel/sysrq -This file controls the functions allowed to be invoked by the SysRq key. -By default, -the file contains 1 meaning that every possible SysRq request is allowed -(in older kernel versions, SysRq was disabled by default, -and you were required to specifically enable it at run-time, -but this is not the case any more). -Possible values in this file are: -.RS -.TP 5 -0 -Disable sysrq completely -.TP -1 -Enable all functions of sysrq -.TP -> 1 -Bit mask of allowed sysrq functions, as follows: -.PD 0 -.RS -.TP 5 -\ \ 2 -Enable control of console logging level -.TP -\ \ 4 -Enable control of keyboard (SAK, unraw) -.TP -\ \ 8 -Enable debugging dumps of processes etc. -.TP -\ 16 -Enable sync command -.TP -\ 32 -Enable remount read-only -.TP -\ 64 -Enable signaling of processes (term, kill, oom-kill) -.TP -128 -Allow reboot/poweroff -.TP -256 -Allow nicing of all real-time tasks -.RE -.PD -.RE -.IP -This file is present only if the -.B CONFIG_MAGIC_SYSRQ -kernel configuration option is enabled. -For further details see the Linux kernel source file -.I Documentation/admin\-guide/sysrq.rst -.\" commit 9d85025b0418163fae079c9ba8f8445212de8568 -(or -.I Documentation/sysrq.txt -before Linux 4.10). -.TP -.I /proc/sys/kernel/version -This file contains a string such as: -.IP -.in +4n -.EX -#5 Wed Feb 25 21:49:24 MET 1998 -.EE -.in -.IP -The "#5" means that -this is the fifth kernel built from this source base and the -date following it indicates the time the kernel was built. -.TP -.IR /proc/sys/kernel/threads\-max " (since Linux 2.3.11)" -.\" The following is based on Documentation/sysctl/kernel.txt -This file specifies the system-wide limit on the number of -threads (tasks) that can be created on the system. -.IP -Since Linux 4.1, -.\" commit 230633d109e35b0a24277498e773edeb79b4a331 -the value that can be written to -.I threads\-max -is bounded. -The minimum value that can be written is 20. -The maximum value that can be written is given by the -constant -.B FUTEX_TID_MASK -(0x3fffffff). -If a value outside of this range is written to -.IR threads\-max , -the error -.B EINVAL -occurs. -.IP -The value written is checked against the available RAM pages. -If the thread structures would occupy too much (more than 1/8th) -of the available RAM pages, -.I threads\-max -is reduced accordingly. -.TP -.IR /proc/sys/kernel/yama/ptrace_scope " (since Linux 3.5)" -See -.BR ptrace (2). -.TP -.IR /proc/sys/kernel/zero\-paged " (PowerPC only)" -This file -contains a flag. -When enabled (nonzero), Linux-PPC will pre-zero pages in -the idle loop, possibly speeding up get_free_pages. -.TP -.I /proc/sys/net -This directory contains networking stuff. -Explanations for some of the files under this directory can be found in -.BR tcp (7) -and -.BR ip (7). -.TP -.I /proc/sys/net/core/bpf_jit_enable -See -.BR bpf (2). -.TP -.I /proc/sys/net/core/somaxconn -This file defines a ceiling value for the -.I backlog -argument of -.BR listen (2); -see the -.BR listen (2) -manual page for details. -.TP -.I /proc/sys/proc -This directory may be empty. -.TP -.I /proc/sys/sunrpc -This directory supports Sun remote procedure call for network filesystem -(NFS). -On some systems, it is not present. -.TP -.IR /proc/sys/user " (since Linux 4.9)" -See -.BR namespaces (7). -.TP -.I /proc/sys/vm -This directory contains files for memory management tuning, buffer, and -cache management. -.TP -.IR /proc/sys/vm/admin_reserve_kbytes " (since Linux 3.10)" -.\" commit 4eeab4f5580d11bffedc697684b91b0bca0d5009 -This file defines the amount of free memory (in KiB) on the system that -should be reserved for users with the capability -.BR CAP_SYS_ADMIN . -.IP -The default value in this file is the minimum of [3% of free pages, 8MiB] -expressed as KiB. -The default is intended to provide enough for the superuser -to log in and kill a process, if necessary, -under the default overcommit 'guess' mode (i.e., 0 in -.IR /proc/sys/vm/overcommit_memory ). -.IP -Systems running in "overcommit never" mode (i.e., 2 in -.IR /proc/sys/vm/overcommit_memory ) -should increase the value in this file to account -for the full virtual memory size of the programs used to recover (e.g., -.BR login (1) -.BR ssh (1), -and -.BR top (1)) -Otherwise, the superuser may not be able to log in to recover the system. -For example, on x86-64 a suitable value is 131072 (128MiB reserved). -.IP -Changing the value in this file takes effect whenever -an application requests memory. -.TP -.IR /proc/sys/vm/compact_memory " (since Linux 2.6.35)" -When 1 is written to this file, all zones are compacted such that free -memory is available in contiguous blocks where possible. -The effect of this action can be seen by examining -.IR /proc/buddyinfo . -.IP -Present only if the kernel was configured with -.BR CONFIG_COMPACTION . -.TP -.IR /proc/sys/vm/drop_caches " (since Linux 2.6.16)" -Writing to this file causes the kernel to drop clean caches, dentries, and -inodes from memory, causing that memory to become free. -This can be useful for memory management testing and -performing reproducible filesystem benchmarks. -Because writing to this file causes the benefits of caching to be lost, -it can degrade overall system performance. -.IP -To free pagecache, use: -.IP -.in +4n -.EX -echo 1 > /proc/sys/vm/drop_caches -.EE -.in -.IP -To free dentries and inodes, use: -.IP -.in +4n -.EX -echo 2 > /proc/sys/vm/drop_caches -.EE -.in -.IP -To free pagecache, dentries, and inodes, use: -.IP -.in +4n -.EX -echo 3 > /proc/sys/vm/drop_caches -.EE -.in -.IP -Because writing to this file is a nondestructive operation and dirty objects -are not freeable, the -user should run -.BR sync (1) -first. -.TP -.IR /proc/sys/vm/sysctl_hugetlb_shm_group " (since Linux 2.6.7)" -This writable file contains a group ID that is allowed -to allocate memory using huge pages. -If a process has a filesystem group ID or any supplementary group ID that -matches this group ID, -then it can make huge-page allocations without holding the -.B CAP_IPC_LOCK -capability; see -.BR memfd_create (2), -.BR mmap (2), -and -.BR shmget (2). -.TP -.IR /proc/sys/vm/legacy_va_layout " (since Linux 2.6.9)" -.\" The following is from Documentation/filesystems/proc.txt -If nonzero, this disables the new 32-bit memory-mapping layout; -the kernel will use the legacy (2.4) layout for all processes. -.TP -.IR /proc/sys/vm/memory_failure_early_kill " (since Linux 2.6.32)" -.\" The following is based on the text in Documentation/sysctl/vm.txt -Control how to kill processes when an uncorrected memory error -(typically a 2-bit error in a memory module) -that cannot be handled by the kernel -is detected in the background by hardware. -In some cases (like the page still having a valid copy on disk), -the kernel will handle the failure -transparently without affecting any applications. -But if there is no other up-to-date copy of the data, -it will kill processes to prevent any data corruptions from propagating. -.IP -The file has one of the following values: -.RS -.TP -.B 1 -Kill all processes that have the corrupted-and-not-reloadable page mapped -as soon as the corruption is detected. -Note that this is not supported for a few types of pages, -such as kernel internally -allocated data or the swap cache, but works for the majority of user pages. -.TP -.B 0 -Unmap the corrupted page from all processes and kill a process -only if it tries to access the page. -.RE -.IP -The kill is performed using a -.B SIGBUS -signal with -.I si_code -set to -.BR BUS_MCEERR_AO . -Processes can handle this if they want to; see -.BR sigaction (2) -for more details. -.IP -This feature is active only on architectures/platforms with advanced machine -check handling and depends on the hardware capabilities. -.IP -Applications can override the -.I memory_failure_early_kill -setting individually with the -.BR prctl (2) -.B PR_MCE_KILL -operation. -.IP -Present only if the kernel was configured with -.BR CONFIG_MEMORY_FAILURE . -.TP -.IR /proc/sys/vm/memory_failure_recovery " (since Linux 2.6.32)" -.\" The following is based on the text in Documentation/sysctl/vm.txt -Enable memory failure recovery (when supported by the platform). -.RS -.TP -.B 1 -Attempt recovery. -.TP -.B 0 -Always panic on a memory failure. -.RE -.IP -Present only if the kernel was configured with -.BR CONFIG_MEMORY_FAILURE . -.TP -.IR /proc/sys/vm/oom_dump_tasks " (since Linux 2.6.25)" -.\" The following is from Documentation/sysctl/vm.txt -Enables a system-wide task dump (excluding kernel threads) to be -produced when the kernel performs an OOM-killing. -The dump includes the following information -for each task (thread, process): -thread ID, real user ID, thread group ID (process ID), -virtual memory size, resident set size, -the CPU that the task is scheduled on, -oom_adj score (see the description of -.IR /proc/ pid /oom_adj ), -and command name. -This is helpful to determine why the OOM-killer was invoked -and to identify the rogue task that caused it. -.IP -If this contains the value zero, this information is suppressed. -On very large systems with thousands of tasks, -it may not be feasible to dump the memory state information for each one. -Such systems should not be forced to incur a performance penalty in -OOM situations when the information may not be desired. -.IP -If this is set to nonzero, this information is shown whenever the -OOM-killer actually kills a memory-hogging task. -.IP -The default value is 0. -.TP -.IR /proc/sys/vm/oom_kill_allocating_task " (since Linux 2.6.24)" -.\" The following is from Documentation/sysctl/vm.txt -This enables or disables killing the OOM-triggering task in -out-of-memory situations. -.IP -If this is set to zero, the OOM-killer will scan through the entire -tasklist and select a task based on heuristics to kill. -This normally selects a rogue memory-hogging task that -frees up a large amount of memory when killed. -.IP -If this is set to nonzero, the OOM-killer simply kills the task that -triggered the out-of-memory condition. -This avoids a possibly expensive tasklist scan. -.IP -If -.I /proc/sys/vm/panic_on_oom -is nonzero, it takes precedence over whatever value is used in -.IR /proc/sys/vm/oom_kill_allocating_task . -.IP -The default value is 0. -.TP -.IR /proc/sys/vm/overcommit_kbytes " (since Linux 3.14)" -.\" commit 49f0ce5f92321cdcf741e35f385669a421013cb7 -This writable file provides an alternative to -.I /proc/sys/vm/overcommit_ratio -for controlling the -.I CommitLimit -when -.I /proc/sys/vm/overcommit_memory -has the value 2. -It allows the amount of memory overcommitting to be specified as -an absolute value (in kB), -rather than as a percentage, as is done with -.IR overcommit_ratio . -This allows for finer-grained control of -.I CommitLimit -on systems with extremely large memory sizes. -.IP -Only one of -.I overcommit_kbytes -or -.I overcommit_ratio -can have an effect: -if -.I overcommit_kbytes -has a nonzero value, then it is used to calculate -.IR CommitLimit , -otherwise -.I overcommit_ratio -is used. -Writing a value to either of these files causes the -value in the other file to be set to zero. -.TP -.I /proc/sys/vm/overcommit_memory -This file contains the kernel virtual memory accounting mode. -Values are: -.RS -.IP -0: heuristic overcommit (this is the default) -.br -1: always overcommit, never check -.br -2: always check, never overcommit -.RE -.IP -In mode 0, calls of -.BR mmap (2) -with -.B MAP_NORESERVE -are not checked, and the default check is very weak, -leading to the risk of getting a process "OOM-killed". -.IP -In mode 1, the kernel pretends there is always enough memory, -until memory actually runs out. -One use case for this mode is scientific computing applications -that employ large sparse arrays. -Before Linux 2.6.0, any nonzero value implies mode 1. -.IP -In mode 2 (available since Linux 2.6), the total virtual address space -that can be allocated -.RI ( CommitLimit -in -.IR /proc/meminfo ) -is calculated as -.IP -.in +4n -.EX -CommitLimit = (total_RAM \- total_huge_TLB) * - overcommit_ratio / 100 + total_swap -.EE -.in -.IP -where: -.RS -.IP \[bu] 3 -.I total_RAM -is the total amount of RAM on the system; -.IP \[bu] -.I total_huge_TLB -is the amount of memory set aside for huge pages; -.IP \[bu] -.I overcommit_ratio -is the value in -.IR /proc/sys/vm/overcommit_ratio ; -and -.IP \[bu] -.I total_swap -is the amount of swap space. -.RE -.IP -For example, on a system with 16 GB of physical RAM, 16 GB -of swap, no space dedicated to huge pages, and an -.I overcommit_ratio -of 50, this formula yields a -.I CommitLimit -of 24 GB. -.IP -Since Linux 3.14, if the value in -.I /proc/sys/vm/overcommit_kbytes -is nonzero, then -.I CommitLimit -is instead calculated as: -.IP -.in +4n -.EX -CommitLimit = overcommit_kbytes + total_swap -.EE -.in -.IP -See also the description of -.I /proc/sys/vm/admin_reserve_kbytes -and -.IR /proc/sys/vm/user_reserve_kbytes . -.TP -.IR /proc/sys/vm/overcommit_ratio " (since Linux 2.6.0)" -This writable file defines a percentage by which memory -can be overcommitted. -The default value in the file is 50. -See the description of -.IR /proc/sys/vm/overcommit_memory . -.TP -.IR /proc/sys/vm/panic_on_oom " (since Linux 2.6.18)" -.\" The following is adapted from Documentation/sysctl/vm.txt -This enables or disables a kernel panic in -an out-of-memory situation. -.IP -If this file is set to the value 0, -the kernel's OOM-killer will kill some rogue process. -Usually, the OOM-killer is able to kill a rogue process and the -system will survive. -.IP -If this file is set to the value 1, -then the kernel normally panics when out-of-memory happens. -However, if a process limits allocations to certain nodes -using memory policies -.RB ( mbind (2) -.BR MPOL_BIND ) -or cpusets -.RB ( cpuset (7)) -and those nodes reach memory exhaustion status, -one process may be killed by the OOM-killer. -No panic occurs in this case: -because other nodes' memory may be free, -this means the system as a whole may not have reached -an out-of-memory situation yet. -.IP -If this file is set to the value 2, -the kernel always panics when an out-of-memory condition occurs. -.IP -The default value is 0. -1 and 2 are for failover of clustering. -Select either according to your policy of failover. -.TP -.I /proc/sys/vm/swappiness -.\" The following is from Documentation/sysctl/vm.txt -The value in this file controls how aggressively the kernel will swap -memory pages. -Higher values increase aggressiveness, lower values -decrease aggressiveness. -The default value is 60. -.TP -.IR /proc/sys/vm/user_reserve_kbytes " (since Linux 3.10)" -.\" commit c9b1d0981fcce3d9976d7b7a56e4e0503bc610dd -Specifies an amount of memory (in KiB) to reserve for user processes. -This is intended to prevent a user from starting a single memory hogging -process, such that they cannot recover (kill the hog). -The value in this file has an effect only when -.I /proc/sys/vm/overcommit_memory -is set to 2 ("overcommit never" mode). -In this case, the system reserves an amount of memory that is the minimum -of [3% of current process size, -.IR user_reserve_kbytes ]. -.IP -The default value in this file is the minimum of [3% of free pages, 128MiB] -expressed as KiB. -.IP -If the value in this file is set to zero, -then a user will be allowed to allocate all free memory with a single process -(minus the amount reserved by -.IR /proc/sys/vm/admin_reserve_kbytes ). -Any subsequent attempts to execute a command will result in -"fork: Cannot allocate memory". -.IP -Changing the value in this file takes effect whenever -an application requests memory. -.TP -.IR /proc/sys/vm/unprivileged_userfaultfd " (since Linux 5.2)" -.\" cefdca0a86be517bc390fc4541e3674b8e7803b0 -This (writable) file exposes a flag that controls whether -unprivileged processes are allowed to employ -.BR userfaultfd (2). -If this file has the value 1, then unprivileged processes may use -.BR userfaultfd (2). -If this file has the value 0, then only processes that have the -.B CAP_SYS_PTRACE -capability may employ -.BR userfaultfd (2). -The default value in this file is 1. -.TP -.IR /proc/sysrq\-trigger " (since Linux 2.4.21)" -Writing a character to this file triggers the same SysRq function as -typing ALT-SysRq-<character> (see the description of -.IR /proc/sys/kernel/sysrq ). -This file is normally writable only by -.IR root . -For further details see the Linux kernel source file -.I Documentation/admin\-guide/sysrq.rst -.\" commit 9d85025b0418163fae079c9ba8f8445212de8568 -(or -.I Documentation/sysrq.txt -before Linux 4.10). -.TP -.I /proc/sysvipc -Subdirectory containing the pseudo-files -.IR msg ", " sem " and " shm "." -These files list the System V Interprocess Communication (IPC) objects -(respectively: message queues, semaphores, and shared memory) -that currently exist on the system, -providing similar information to that available via -.BR ipcs (1). -These files have headers and are formatted (one IPC object per line) -for easy understanding. -.BR sysvipc (7) -provides further background on the information shown by these files. -.TP -.IR /proc/thread\-self " (since Linux 3.17)" -.\" commit 0097875bd41528922fb3bb5f348c53f17e00e2fd -This directory refers to the thread accessing the -.I /proc -filesystem, -and is identical to the -.IR /proc/self/task/ tid -directory named by the process thread ID -.RI ( tid ) -of the same thread. -.TP -.IR /proc/timer_list " (since Linux 2.6.21)" -.\" commit 289f480af87e45f7a6de6ba9b4c061c2e259fe98 -This read-only file exposes a list of all currently pending -(high-resolution) timers, -all clock-event sources, and their parameters in a human-readable form. -.TP -.IR /proc/timer_stats " (from Linux 2.6.21 until Linux 4.10)" -.\" commit 82f67cd9fca8c8762c15ba7ed0d5747588c1e221 -.\" Date: Fri Feb 16 01:28:13 2007 -0800 -.\" Text largely derived from Documentation/timers/timer_stats.txt -.\" removed in commit dfb4357da6ddbdf57d583ba64361c9d792b0e0b1 -.\" Date: Wed Feb 8 11:26:59 2017 -0800 -This is a debugging facility to make timer (ab)use in a Linux -system visible to kernel and user-space developers. -It can be used by kernel and user-space developers to verify that -their code does not make undue use of timers. -The goal is to avoid unnecessary wakeups, -thereby optimizing power consumption. -.IP -If enabled in the kernel -.RB ( CONFIG_TIMER_STATS ), -but not used, -it has almost zero run-time overhead and a relatively small -data-structure overhead. -Even if collection is enabled at run time, overhead is low: -all the locking is per-CPU and lookup is hashed. -.IP -The -.I /proc/timer_stats -file is used both to control sampling facility and to read out the -sampled information. -.IP -The -.I timer_stats -functionality is inactive on bootup. -A sampling period can be started using the following command: -.IP -.in +4n -.EX -# echo 1 > /proc/timer_stats -.EE -.in -.IP -The following command stops a sampling period: -.IP -.in +4n -.EX -# echo 0 > /proc/timer_stats -.EE -.in -.IP -The statistics can be retrieved by: -.IP -.in +4n -.EX -$ cat /proc/timer_stats -.EE -.in -.IP -While sampling is enabled, each readout from -.I /proc/timer_stats -will see -newly updated statistics. -Once sampling is disabled, the sampled information -is kept until a new sample period is started. -This allows multiple readouts. -.IP -Sample output from -.IR /proc/timer_stats : -.IP -.in +4n -.EX -.RB $ " cat /proc/timer_stats" -Timer Stats Version: v0.3 -Sample period: 1.764 s -Collection: active - 255, 0 swapper/3 hrtimer_start_range_ns (tick_sched_timer) - 71, 0 swapper/1 hrtimer_start_range_ns (tick_sched_timer) - 58, 0 swapper/0 hrtimer_start_range_ns (tick_sched_timer) - 4, 1694 gnome\-shell mod_delayed_work_on (delayed_work_timer_fn) - 17, 7 rcu_sched rcu_gp_kthread (process_timeout) -\&... - 1, 4911 kworker/u16:0 mod_delayed_work_on (delayed_work_timer_fn) - 1D, 2522 kworker/0:0 queue_delayed_work_on (delayed_work_timer_fn) -1029 total events, 583.333 events/sec -.EE -.in -.IP -The output columns are: -.RS -.IP [1] 5 -a count of the number of events, -optionally (since Linux 2.6.23) followed by the letter \[aq]D\[aq] -.\" commit c5c061b8f9726bc2c25e19dec227933a13d1e6b7 deferrable timers -if this is a deferrable timer; -.IP [2] -the PID of the process that initialized the timer; -.IP [3] -the name of the process that initialized the timer; -.IP [4] -the function where the timer was initialized; and -(in parentheses) -the callback function that is associated with the timer. -.RE -.IP -During the Linux 4.11 development cycle, -this file was removed because of security concerns, -as it exposes information across namespaces. -Furthermore, it is possible to obtain -the same information via in-kernel tracing facilities such as ftrace. -.TP -.I /proc/tty -Subdirectory containing the pseudo-files and subdirectories for -tty drivers and line disciplines. -.TP -.I /proc/uptime -This file contains two numbers (values in seconds): the uptime of the -system (including time spent in suspend) and the amount of time spent -in the idle process. -.TP -.I /proc/version -This string identifies the kernel version that is currently running. -It includes the contents of -.IR /proc/sys/kernel/ostype , -.IR /proc/sys/kernel/osrelease , -and -.IR /proc/sys/kernel/version . -For example: -.IP -.in +4n -.EX -Linux version 1.0.9 (quinlan@phaze) #1 Sat May 14 01:51:54 EDT 1994 -.EE -.in .\" FIXME 2.6.13 seems to have /proc/vmcore implemented; document this .\" See Documentation/kdump/kdump.txt .\" commit 666bfddbe8b8fd4fd44617d6c55193d5ac7edb29 .\" Needs CONFIG_VMCORE .\" -.TP -.IR /proc/vmstat " (since Linux 2.6.0)" -This file displays various virtual memory statistics. -Each line of this file contains a single name-value pair, -delimited by white space. -Some lines are present only if the kernel was configured with -suitable options. -(In some cases, the options required for particular files have changed -across kernel versions, so they are not listed here. -Details can be found by consulting the kernel source code.) -The following fields may be present: -.\" FIXME We need explanations for each of the following fields... -.RS -.TP -.IR nr_free_pages " (since Linux 2.6.31)" -.\" commit d23ad42324cc4378132e51f2fc5c9ba6cbe75182 -.TP -.IR nr_alloc_batch " (since Linux 3.12)" -.\" commit 81c0a2bb515fd4daae8cab64352877480792b515 -.TP -.IR nr_inactive_anon " (since Linux 2.6.28)" -.\" commit 4f98a2fee8acdb4ac84545df98cccecfd130f8db -.TP -.IR nr_active_anon " (since Linux 2.6.28)" -.\" commit 4f98a2fee8acdb4ac84545df98cccecfd130f8db -.TP -.IR nr_inactive_file " (since Linux 2.6.28)" -.\" commit 4f98a2fee8acdb4ac84545df98cccecfd130f8db -.TP -.IR nr_active_file " (since Linux 2.6.28)" -.\" commit 4f98a2fee8acdb4ac84545df98cccecfd130f8db -.TP -.IR nr_unevictable " (since Linux 2.6.28)" -.\" commit 7b854121eb3e5ba0241882ff939e2c485228c9c5 -.TP -.IR nr_mlock " (since Linux 2.6.28)" -.\" commit 5344b7e648980cc2ca613ec03a56a8222ff48820 -.TP -.IR nr_anon_pages " (since Linux 2.6.18)" -.\" commit f3dbd34460ff54962d3e3244b6bcb7f5295356e6 -.TP -.IR nr_mapped " (since Linux 2.6.0)" -.TP -.IR nr_file_pages " (since Linux 2.6.18)" -.\" commit 347ce434d57da80fd5809c0c836f206a50999c26 -.TP -.IR nr_dirty " (since Linux 2.6.0)" -.TP -.IR nr_writeback " (since Linux 2.6.0)" -.TP -.IR nr_slab_reclaimable " (since Linux 2.6.19)" -.\" commit 972d1a7b140569084439a81265a0f15b74e924e0 -.\" Linux 2.6.0 had nr_slab -.TP -.IR nr_slab_unreclaimable " (since Linux 2.6.19)" -.\" commit 972d1a7b140569084439a81265a0f15b74e924e0 -.TP -.IR nr_page_table_pages " (since Linux 2.6.0)" -.TP -.IR nr_kernel_stack " (since Linux 2.6.32)" -.\" commit c6a7f5728a1db45d30df55a01adc130b4ab0327c -Amount of memory allocated to kernel stacks. -.TP -.IR nr_unstable " (since Linux 2.6.0)" -.TP -.IR nr_bounce " (since Linux 2.6.12)" -.\" commit edfbe2b0038723e5699ab22695ccd62b5542a5c1 -.TP -.IR nr_vmscan_write " (since Linux 2.6.19)" -.\" commit e129b5c23c2b471d47f1c5d2b8b193fc2034af43 -.TP -.IR nr_vmscan_immediate_reclaim " (since Linux 3.2)" -.\" commit 49ea7eb65e7c5060807fb9312b1ad4c3eab82e2c -.TP -.IR nr_writeback_temp " (since Linux 2.6.26)" -.\" commit fc3ba692a4d19019387c5acaea63131f9eab05dd -.TP -.IR nr_isolated_anon " (since Linux 2.6.32)" -.\" commit a731286de62294b63d8ceb3c5914ac52cc17e690 -.TP -.IR nr_isolated_file " (since Linux 2.6.32)" -.\" commit a731286de62294b63d8ceb3c5914ac52cc17e690 -.TP -.IR nr_shmem " (since Linux 2.6.32)" -.\" commit 4b02108ac1b3354a22b0d83c684797692efdc395 -Pages used by shmem and -.BR tmpfs (5). -.TP -.IR nr_dirtied " (since Linux 2.6.37)" -.\" commit ea941f0e2a8c02ae876cd73deb4e1557248f258c -.TP -.IR nr_written " (since Linux 2.6.37)" -.\" commit ea941f0e2a8c02ae876cd73deb4e1557248f258c -.TP -.IR nr_pages_scanned " (since Linux 3.17)" -.\" commit 0d5d823ab4e608ec7b52ac4410de4cb74bbe0edd -.TP -.IR numa_hit " (since Linux 2.6.18)" -.\" commit ca889e6c45e0b112cb2ca9d35afc66297519b5d5 -.\" Present only if the kernel was configured with -.\" .BR CONFIG_NUMA . -.TP -.IR numa_miss " (since Linux 2.6.18)" -.\" commit ca889e6c45e0b112cb2ca9d35afc66297519b5d5 -.\" Present only if the kernel was configured with -.\" .BR CONFIG_NUMA . -.TP -.IR numa_foreign " (since Linux 2.6.18)" -.\" commit ca889e6c45e0b112cb2ca9d35afc66297519b5d5 -.\" Present only if the kernel was configured with -.\" .BR CONFIG_NUMA . -.TP -.IR numa_interleave " (since Linux 2.6.18)" -.\" commit ca889e6c45e0b112cb2ca9d35afc66297519b5d5 -.\" Present only if the kernel was configured with -.\" .BR CONFIG_NUMA . -.TP -.IR numa_local " (since Linux 2.6.18)" -.\" commit ca889e6c45e0b112cb2ca9d35afc66297519b5d5 -.\" Present only if the kernel was configured with -.\" .BR CONFIG_NUMA . -.TP -.IR numa_other " (since Linux 2.6.18)" -.\" commit ca889e6c45e0b112cb2ca9d35afc66297519b5d5 -.\" Present only if the kernel was configured with -.\" .BR CONFIG_NUMA . -.TP -.IR workingset_refault " (since Linux 3.15)" -.\" commit a528910e12ec7ee203095eb1711468a66b9b60b0 -.\" Present only if the kernel was configured with -.\" .BR CONFIG_VM_EVENT_COUNTERS . -.TP -.IR workingset_activate " (since Linux 3.15)" -.\" commit a528910e12ec7ee203095eb1711468a66b9b60b0 -.\" Present only if the kernel was configured with -.\" .BR CONFIG_VM_EVENT_COUNTERS . -.TP -.IR workingset_nodereclaim " (since Linux 3.15)" -.\" commit 449dd6984d0e47643c04c807f609dd56d48d5bcc -.\" Present only if the kernel was configured with -.\" .BR CONFIG_VM_EVENT_COUNTERS . -.TP -.IR nr_anon_transparent_hugepages " (since Linux 2.6.38)" -.\" Present only if the kernel was configured with -.\" .BR CONFIG_VM_EVENT_COUNTERS . -.TP -.IR nr_free_cma " (since Linux 3.7)" -.\" commit d1ce749a0db12202b711d1aba1d29e823034648d -Number of free CMA (Contiguous Memory Allocator) pages. -.\" Present only if the kernel was configured with -.\" .BR CONFIG_VM_EVENT_COUNTERS . -.TP -.IR nr_dirty_threshold " (since Linux 2.6.37)" -.\" commit 79da826aee6a10902ef411bc65864bd02102fa83 -.\" Present only if the kernel was configured with -.\" .BR CONFIG_VM_EVENT_COUNTERS . -.TP -.IR nr_dirty_background_threshold " (since Linux 2.6.37)" -.\" commit 79da826aee6a10902ef411bc65864bd02102fa83 -.\" Present only if the kernel was configured with -.\" .BR CONFIG_VM_EVENT_COUNTERS . -.TP -.IR pgpgin " (since Linux 2.6.0)" -.\" Present only if the kernel was configured with -.\" .BR CONFIG_VM_EVENT_COUNTERS . -.TP -.IR pgpgout " (since Linux 2.6.0)" -.\" Present only if the kernel was configured with -.\" .BR CONFIG_VM_EVENT_COUNTERS . -.TP -.IR pswpin " (since Linux 2.6.0)" -.\" Present only if the kernel was configured with -.\" .BR CONFIG_VM_EVENT_COUNTERS . -.TP -.IR pswpout " (since Linux 2.6.0)" -.\" Present only if the kernel was configured with -.\" .BR CONFIG_VM_EVENT_COUNTERS . -.TP -.IR pgalloc_dma " (since Linux 2.6.5)" -.\" Linux 2.6.0 had pgalloc -.\" Present only if the kernel was configured with -.\" .BR CONFIG_VM_EVENT_COUNTERS . -.TP -.IR pgalloc_dma32 " (since Linux 2.6.16)" -.\" commit 9328b8faae922e52073785ed6c1eaa8565648a0e -.\" Present only if the kernel was configured with -.\" .BR CONFIG_VM_EVENT_COUNTERS . -.TP -.IR pgalloc_normal " (since Linux 2.6.5)" -.\" Present only if the kernel was configured with -.\" .BR CONFIG_VM_EVENT_COUNTERS . -.TP -.IR pgalloc_high " (since Linux 2.6.5)" -.\" Present only if the kernel was configured with -.\" .BR CONFIG_VM_EVENT_COUNTERS -.\" and -.\" .BR CONFIG_HIGHMEM . -.TP -.IR pgalloc_movable " (since Linux 2.6.23)" -.\" commit 2a1e274acf0b1c192face19a4be7c12d4503eaaf -.\" Present only if the kernel was configured with -.\" .BR CONFIG_VM_EVENT_COUNTERS . -.TP -.IR pgfree " (since Linux 2.6.0)" -.\" Present only if the kernel was configured with -.\" .BR CONFIG_VM_EVENT_COUNTERS . -.TP -.IR pgactivate " (since Linux 2.6.0)" -.\" Present only if the kernel was configured with -.\" .BR CONFIG_VM_EVENT_COUNTERS . -.TP -.IR pgdeactivate " (since Linux 2.6.0)" -.\" Present only if the kernel was configured with -.\" .BR CONFIG_VM_EVENT_COUNTERS . -.TP -.IR pgfault " (since Linux 2.6.0)" -.\" Present only if the kernel was configured with -.\" .BR CONFIG_VM_EVENT_COUNTERS . -.TP -.IR pgmajfault " (since Linux 2.6.0)" -.\" Present only if the kernel was configured with -.\" .BR CONFIG_VM_EVENT_COUNTERS . -.TP -.IR pgrefill_dma " (since Linux 2.6.5)" -.\" Linux 2.6.0 had pgrefill -.\" Present only if the kernel was configured with -.\" .BR CONFIG_VM_EVENT_COUNTERS . -.TP -.IR pgrefill_dma32 " (since Linux 2.6.16)" -.\" commit 9328b8faae922e52073785ed6c1eaa8565648a0e -.\" Present only if the kernel was configured with -.\" .BR CONFIG_VM_EVENT_COUNTERS . -.TP -.IR pgrefill_normal " (since Linux 2.6.5)" -.\" Present only if the kernel was configured with -.\" .BR CONFIG_VM_EVENT_COUNTERS . -.TP -.IR pgrefill_high " (since Linux 2.6.5)" -.\" Present only if the kernel was configured with -.\" .BR CONFIG_VM_EVENT_COUNTERS -.\" and -.\" .BR CONFIG_HIGHMEM . -.TP -.IR pgrefill_movable " (since Linux 2.6.23)" -.\" commit 2a1e274acf0b1c192face19a4be7c12d4503eaaf -.\" Present only if the kernel was configured with -.\" .BR CONFIG_VM_EVENT_COUNTERS . -.\" Formerly there were -.\" pgsteal_high -.\" pgsteal_normal -.\" pgsteal_dma32 -.\" pgsteal_dma -.\" These were split out into pgsteal_kswapd* and pgsteal_direct* -.\" in commit 904249aa68010c8e223263c922fcbb840a3f42e4 -.TP -.IR pgsteal_kswapd_dma " (since Linux 3.4)" -.\" commit 904249aa68010c8e223263c922fcbb840a3f42e4 -.\" Linux 2.6.0 had pgsteal -.\" Present only if the kernel was configured with -.\" .\" .BR CONFIG_VM_EVENT_COUNTERS . -.TP -.IR pgsteal_kswapd_dma32 " (since Linux 3.4)" -.\" commit 904249aa68010c8e223263c922fcbb840a3f42e4 -.\" commit 9328b8faae922e52073785ed6c1eaa8565648a0e -.\" Present only if the kernel was configured with -.\" .BR CONFIG_VM_EVENT_COUNTERS . -.TP -.IR pgsteal_kswapd_normal " (since Linux 3.4)" -.\" commit 904249aa68010c8e223263c922fcbb840a3f42e4 -.\" Present only if the kernel was configured with -.\" .BR CONFIG_VM_EVENT_COUNTERS . -.TP -.IR pgsteal_kswapd_high " (since Linux 3.4)" -.\" commit 904249aa68010c8e223263c922fcbb840a3f42e4 -.\" Present only if the kernel was configured with -.\" .BR CONFIG_VM_EVENT_COUNTERS -.\" and -.\" .BR CONFIG_HIGHMEM . -.TP -.IR pgsteal_kswapd_movable " (since Linux 3.4)" -.\" commit 904249aa68010c8e223263c922fcbb840a3f42e4 -.\" Present only if the kernel was configured with -.\" .BR CONFIG_VM_EVENT_COUNTERS . -.TP -.I pgsteal_direct_dma -.\" Present only if the kernel was configured with -.\" .BR CONFIG_VM_EVENT_COUNTERS . -.TP -.IR pgsteal_direct_dma32 " (since Linux 3.4)" -.\" commit 904249aa68010c8e223263c922fcbb840a3f42e4 -.\" Present only if the kernel was configured with -.\" .BR CONFIG_VM_EVENT_COUNTERS . -.TP -.IR pgsteal_direct_normal " (since Linux 3.4)" -.\" commit 904249aa68010c8e223263c922fcbb840a3f42e4 -.\" Present only if the kernel was configured with -.\" .BR CONFIG_VM_EVENT_COUNTERS . -.TP -.IR pgsteal_direct_high " (since Linux 3.4)" -.\" commit 904249aa68010c8e223263c922fcbb840a3f42e4 -.\" Present only if the kernel was configured with -.\" .BR CONFIG_VM_EVENT_COUNTERS -.\" and -.\" .BR CONFIG_HIGHMEM . -.TP -.IR pgsteal_direct_movable " (since Linux 2.6.23)" -.\" commit 2a1e274acf0b1c192face19a4be7c12d4503eaaf -.\" Present only if the kernel was configured with -.\" .BR CONFIG_VM_EVENT_COUNTERS . -.TP -.I pgscan_kswapd_dma -.\" Linux 2.6.0 had pgscan -.\" Present only if the kernel was configured with -.\" .BR CONFIG_VM_EVENT_COUNTERS . -.TP -.IR pgscan_kswapd_dma32 " (since Linux 2.6.16)" -.\" commit 9328b8faae922e52073785ed6c1eaa8565648a0e -.\" Present only if the kernel was configured with -.\" .BR CONFIG_VM_EVENT_COUNTERS . -.TP -.IR pgscan_kswapd_normal " (since Linux 2.6.5)" -.\" Present only if the kernel was configured with -.\" .BR CONFIG_VM_EVENT_COUNTERS . -.TP -.I pgscan_kswapd_high -.\" Present only if the kernel was configured with -.\" .BR CONFIG_VM_EVENT_COUNTERS -.\" and -.\" .BR CONFIG_HIGHMEM . -.TP -.IR pgscan_kswapd_movable " (since Linux 2.6.23)" -.\" commit 2a1e274acf0b1c192face19a4be7c12d4503eaaf -.\" Present only if the kernel was configured with -.\" .BR CONFIG_VM_EVENT_COUNTERS . -.TP -.I pgscan_direct_dma -.\" Present only if the kernel was configured with -.\" .BR CONFIG_VM_EVENT_COUNTERS . -.TP -.IR pgscan_direct_dma32 " (since Linux 2.6.16)" -.\" commit 9328b8faae922e52073785ed6c1eaa8565648a0e -.\" Present only if the kernel was configured with -.\" .BR CONFIG_VM_EVENT_COUNTERS . -.TP -.I pgscan_direct_normal -.\" Present only if the kernel was configured with -.\" .BR CONFIG_VM_EVENT_COUNTERS . -.TP -.I pgscan_direct_high -.\" Present only if the kernel was configured with -.\" .BR CONFIG_VM_EVENT_COUNTERS -.\" and -.\" .BR CONFIG_HIGHMEM . -.TP -.IR pgscan_direct_movable " (since Linux 2.6.23)" -.\" commit 2a1e274acf0b1c192face19a4be7c12d4503eaaf -.\" Present only if the kernel was configured with -.\" .BR CONFIG_VM_EVENT_COUNTERS . -.TP -.IR pgscan_direct_throttle " (since Linux 3.6)" -.\" commit 68243e76ee343d63c6cf76978588a885951e2818 -.\" Present only if the kernel was configured with -.\" .BR CONFIG_VM_EVENT_COUNTERS . -.TP -.IR zone_reclaim_failed " (since linux 2.6.31)" -.\" commit 24cf72518c79cdcda486ed26074ff8151291cf65 -.\" Present only if the kernel was configured with -.\" .BR CONFIG_VM_EVENT_COUNTERS -.\" and -.\" .BR CONFIG_NUMA . -.TP -.IR pginodesteal " (since linux 2.6.0)" -.\" Present only if the kernel was configured with -.\" .BR CONFIG_VM_EVENT_COUNTERS . -.TP -.IR slabs_scanned " (since linux 2.6.5)" -.\" Present only if the kernel was configured with -.\" .BR CONFIG_VM_EVENT_COUNTERS . -.TP -.IR kswapd_inodesteal " (since linux 2.6.0)" -.\" Present only if the kernel was configured with -.\" .BR CONFIG_VM_EVENT_COUNTERS . -.TP -.IR kswapd_low_wmark_hit_quickly " (since Linux 2.6.33)" -.\" commit bb3ab596832b920c703d1aea1ce76d69c0f71fb7 -.\" Present only if the kernel was configured with -.\" .BR CONFIG_VM_EVENT_COUNTERS . -.TP -.IR kswapd_high_wmark_hit_quickly " (since Linux 2.6.33)" -.\" commit bb3ab596832b920c703d1aea1ce76d69c0f71fb7 -.\" Present only if the kernel was configured with -.\" .BR CONFIG_VM_EVENT_COUNTERS . -.TP -.IR pageoutrun " (since Linux 2.6.0)" -.\" Present only if the kernel was configured with -.\" .BR CONFIG_VM_EVENT_COUNTERS . -.TP -.IR allocstall " (since Linux 2.6.0)" -.\" Present only if the kernel was configured with -.\" .BR CONFIG_VM_EVENT_COUNTERS . -.TP -.IR pgrotated " (since Linux 2.6.0)" -.\" Present only if the kernel was configured with -.\" .BR CONFIG_VM_EVENT_COUNTERS . -.TP -.IR drop_pagecache " (since Linux 3.15)" -.\" commit 5509a5d27b971a90b940e148ca9ca53312e4fa7a -.\" Present only if the kernel was configured with -.\" .BR CONFIG_VM_EVENT_COUNTERS . -.TP -.IR drop_slab " (since Linux 3.15)" -.\" commit 5509a5d27b971a90b940e148ca9ca53312e4fa7a -.\" Present only if the kernel was configured with -.\" .BR CONFIG_VM_EVENT_COUNTERS . -.TP -.IR numa_pte_updates " (since Linux 3.8)" -.\" commit 03c5a6e16322c997bf8f264851bfa3f532ad515f -.\" Present only if the kernel was configured with -.\" .BR CONFIG_VM_EVENT_COUNTERS -.\" and -.\" .BR CONFIG_NUMA_BALANCING . -.TP -.IR numa_huge_pte_updates " (since Linux 3.13)" -.\" commit 72403b4a0fbdf433c1fe0127e49864658f6f6468 -.\" Present only if the kernel was configured with -.\" .BR CONFIG_VM_EVENT_COUNTERS -.\" and -.\" .BR CONFIG_NUMA_BALANCING . -.TP -.IR numa_hint_faults " (since Linux 3.8)" -.\" commit 03c5a6e16322c997bf8f264851bfa3f532ad515f -.\" Present only if the kernel was configured with -.\" .BR CONFIG_VM_EVENT_COUNTERS -.\" and -.\" .BR CONFIG_NUMA_BALANCING . -.TP -.IR numa_hint_faults_local " (since Linux 3.8)" -.\" commit 03c5a6e16322c997bf8f264851bfa3f532ad515f -.\" Present only if the kernel was configured with -.\" .BR CONFIG_VM_EVENT_COUNTERS -.\" and -.\" .BR CONFIG_NUMA_BALANCING . -.TP -.IR numa_pages_migrated " (since Linux 3.8)" -.\" commit 03c5a6e16322c997bf8f264851bfa3f532ad515f -.\" Present only if the kernel was configured with -.\" .BR CONFIG_VM_EVENT_COUNTERS -.\" and -.\" .BR CONFIG_NUMA_BALANCING -.\" and -.\" .BR CONFIG_NUMA_BALANCING . -.TP -.IR pgmigrate_success " (since Linux 3.8)" -.\" commit 5647bc293ab15f66a7b1cda850c5e9d162a6c7c2 -.\" Present only if the kernel was configured with -.\" .BR CONFIG_VM_EVENT_COUNTERS -.\" and -.\" .BR CONFIG_MIGRATION . -.TP -.IR pgmigrate_fail " (since Linux 3.8)" -.\" commit 5647bc293ab15f66a7b1cda850c5e9d162a6c7c2 -.\" Present only if the kernel was configured with -.\" .BR CONFIG_VM_EVENT_COUNTERS -.\" and -.\" .BR CONFIG_MIGRATION . -.TP -.IR compact_migrate_scanned " (since Linux 3.8)" -.\" commit 397487db696cae0b026a474a5cd66f4e372995e6 -.\" Linux 3.8 dropped compact_blocks_moved, compact_pages_moved, and -.\" compact_pagemigrate_failed -.\" Present only if the kernel was configured with -.\" .BR CONFIG_VM_EVENT_COUNTERS -.\" and -.\" .BR CONFIG_COMPACTION . -.TP -.IR compact_free_scanned " (since Linux 3.8)" -.\" commit 397487db696cae0b026a474a5cd66f4e372995e6 -.\" Present only if the kernel was configured with -.\" .BR CONFIG_VM_EVENT_COUNTERS -.\" and -.\" .BR CONFIG_COMPACTION . -.TP -.IR compact_isolated " (since Linux 3.8)" -.\" commit 397487db696cae0b026a474a5cd66f4e372995e6 -.\" Present only if the kernel was configured with -.\" .BR CONFIG_VM_EVENT_COUNTERS -.\" and -.\" .BR CONFIG_COMPACTION . -.TP -.IR compact_stall " (since Linux 2.6.35)" -.\" commit 56de7263fcf3eb10c8dcdf8d59a9cec831795f3f -See the kernel source file -.IR Documentation/admin\-guide/mm/transhuge.rst . -.\" Present only if the kernel was configured with -.\" .BR CONFIG_VM_EVENT_COUNTERS -.\" and -.\" .BR CONFIG_COMPACTION . -.TP -.IR compact_fail " (since Linux 2.6.35)" -.\" commit 56de7263fcf3eb10c8dcdf8d59a9cec831795f3f -See the kernel source file -.IR Documentation/admin\-guide/mm/transhuge.rst . -.\" Present only if the kernel was configured with -.\" .BR CONFIG_VM_EVENT_COUNTERS -.\" and -.\" .BR CONFIG_COMPACTION . -.TP -.IR compact_success " (since Linux 2.6.35)" -.\" commit 56de7263fcf3eb10c8dcdf8d59a9cec831795f3f -See the kernel source file -.IR Documentation/admin\-guide/mm/transhuge.rst . -.\" Present only if the kernel was configured with -.\" .BR CONFIG_VM_EVENT_COUNTERS -.\" and -.\" .BR CONFIG_COMPACTION . -.TP -.IR htlb_buddy_alloc_success " (since Linux 2.6.26)" -.\" commit 3b1163006332302117b1b2acf226d4014ff46525 -.\" Present only if the kernel was configured with -.\" .BR CONFIG_VM_EVENT_COUNTERS -.\" and -.\" .BR CONFIG_HUGETLB_PAGE . -.TP -.IR htlb_buddy_alloc_fail " (since Linux 2.6.26)" -.\" commit 3b1163006332302117b1b2acf226d4014ff46525 -.\" Present only if the kernel was configured with -.\" .BR CONFIG_VM_EVENT_COUNTERS -.\" and -.\" .BR CONFIG_HUGETLB_PAGE . -.TP -.IR unevictable_pgs_culled " (since Linux 2.6.28)" -.\" commit bbfd28eee9fbd73e780b19beb3dc562befbb94fa -.\" Present only if the kernel was configured with -.\" .BR CONFIG_VM_EVENT_COUNTERS . -.TP -.IR unevictable_pgs_scanned " (since Linux 2.6.28)" -.\" commit bbfd28eee9fbd73e780b19beb3dc562befbb94fa -.\" Present only if the kernel was configured with -.\" .BR CONFIG_VM_EVENT_COUNTERS . -.TP -.IR unevictable_pgs_rescued " (since Linux 2.6.28)" -.\" commit bbfd28eee9fbd73e780b19beb3dc562befbb94fa -.\" Present only if the kernel was configured with -.\" .BR CONFIG_VM_EVENT_COUNTERS . -.TP -.IR unevictable_pgs_mlocked " (since Linux 2.6.28)" -.\" commit 5344b7e648980cc2ca613ec03a56a8222ff48820 -.\" Present only if the kernel was configured with -.\" .BR CONFIG_VM_EVENT_COUNTERS . -.TP -.IR unevictable_pgs_munlocked " (since Linux 2.6.28)" -.\" commit 5344b7e648980cc2ca613ec03a56a8222ff48820 -.\" Present only if the kernel was configured with -.\" .BR CONFIG_VM_EVENT_COUNTERS . -.TP -.IR unevictable_pgs_cleared " (since Linux 2.6.28)" -.\" commit 5344b7e648980cc2ca613ec03a56a8222ff48820 -.\" Present only if the kernel was configured with -.\" .BR CONFIG_VM_EVENT_COUNTERS . -.TP -.IR unevictable_pgs_stranded " (since Linux 2.6.28)" -.\" commit 5344b7e648980cc2ca613ec03a56a8222ff48820 -.\" Present only if the kernel was configured with -.\" .BR CONFIG_VM_EVENT_COUNTERS . -.\" Linux 3.7 removed unevictable_pgs_mlockfreed -.TP -.IR thp_fault_alloc " (since Linux 2.6.39)" -.\" commit 81ab4201fb7d91d6b0cd9ad5b4b16776e4bed145 -See the kernel source file -.IR Documentation/admin\-guide/mm/transhuge.rst . -.\" Present only if the kernel was configured with -.\" .BR CONFIG_VM_EVENT_COUNTERS -.\" and -.\" .BR CONFIG_TRANSPARENT_HUGEPAGE . -.TP -.IR thp_fault_fallback " (since Linux 2.6.39)" -.\" commit 81ab4201fb7d91d6b0cd9ad5b4b16776e4bed145 -See the kernel source file -.IR Documentation/admin\-guide/mm/transhuge.rst . -.\" Present only if the kernel was configured with -.\" .BR CONFIG_VM_EVENT_COUNTERS -.\" and -.\" .BR CONFIG_TRANSPARENT_HUGEPAGE . -.TP -.IR thp_collapse_alloc " (since Linux 2.6.39)" -.\" commit 81ab4201fb7d91d6b0cd9ad5b4b16776e4bed145 -See the kernel source file -.IR Documentation/admin\-guide/mm/transhuge.rst . -.\" Present only if the kernel was configured with -.\" .BR CONFIG_VM_EVENT_COUNTERS -.\" and -.\" .BR CONFIG_TRANSPARENT_HUGEPAGE . -.TP -.IR thp_collapse_alloc_failed " (since Linux 2.6.39)" -.\" commit 81ab4201fb7d91d6b0cd9ad5b4b16776e4bed145 -See the kernel source file -.IR Documentation/admin\-guide/mm/transhuge.rst . -.\" Present only if the kernel was configured with -.\" .BR CONFIG_VM_EVENT_COUNTERS -.\" and -.\" .BR CONFIG_TRANSPARENT_HUGEPAGE . -.TP -.IR thp_split " (since Linux 2.6.39)" -.\" commit 81ab4201fb7d91d6b0cd9ad5b4b16776e4bed145 -See the kernel source file -.IR Documentation/admin\-guide/mm/transhuge.rst . -.\" Present only if the kernel was configured with -.\" .BR CONFIG_VM_EVENT_COUNTERS -.\" and -.\" .BR CONFIG_TRANSPARENT_HUGEPAGE . -.TP -.IR thp_zero_page_alloc " (since Linux 3.8)" -.\" commit d8a8e1f0da3d29d7268b3300c96a059d63901b76 -See the kernel source file -.IR Documentation/admin\-guide/mm/transhuge.rst . -.\" Present only if the kernel was configured with -.\" .BR CONFIG_VM_EVENT_COUNTERS -.\" and -.\" .BR CONFIG_TRANSPARENT_HUGEPAGE . -.TP -.IR thp_zero_page_alloc_failed " (since Linux 3.8)" -.\" commit d8a8e1f0da3d29d7268b3300c96a059d63901b76 -See the kernel source file -.IR Documentation/admin\-guide/mm/transhuge.rst . -.\" Present only if the kernel was configured with -.\" .BR CONFIG_VM_EVENT_COUNTERS -.\" and -.\" .BR CONFIG_TRANSPARENT_HUGEPAGE . -.TP -.IR balloon_inflate " (since Linux 3.18)" -.\" commit 09316c09dde33aae14f34489d9e3d243ec0d5938 -.\" Present only if the kernel was configured with -.\" .BR CONFIG_VM_EVENT_COUNTERS -.\" and -.\" .BR CONFIG_MEMORY_BALLOON . -.TP -.IR balloon_deflate " (since Linux 3.18)" -.\" commit 09316c09dde33aae14f34489d9e3d243ec0d5938 -.\" Present only if the kernel was configured with -.\" .BR CONFIG_VM_EVENT_COUNTERS -.\" and -.\" .BR CONFIG_MEMORY_BALLOON . -.TP -.IR balloon_migrate " (since Linux 3.18)" -.\" commit 09316c09dde33aae14f34489d9e3d243ec0d5938 -.\" Present only if the kernel was configured with -.\" .BR CONFIG_VM_EVENT_COUNTERS , -.\" .BR CONFIG_MEMORY_BALLOON , -.\" and -.\" .BR CONFIG_BALLOON_COMPACTION . -.TP -.IR nr_tlb_remote_flush " (since Linux 3.12)" -.\" commit 9824cf9753ecbe8f5b47aa9b2f218207defea211 -.\" Present only if the kernel was configured with -.\" .BR CONFIG_DEBUG_TLBFLUSH -.\" and -.\" .BR CONFIG_SMP . -.TP -.IR nr_tlb_remote_flush_received " (since Linux 3.12)" -.\" commit 9824cf9753ecbe8f5b47aa9b2f218207defea211 -.\" Present only if the kernel was configured with -.\" .BR CONFIG_DEBUG_TLBFLUSH -.\" and -.\" .BR CONFIG_SMP . -.TP -.IR nr_tlb_local_flush_all " (since Linux 3.12)" -.\" commit 9824cf9753ecbe8f5b47aa9b2f218207defea211 -.\" Present only if the kernel was configured with -.\" .BR CONFIG_DEBUG_TLBFLUSH . -.TP -.IR nr_tlb_local_flush_one " (since Linux 3.12)" -.\" commit 9824cf9753ecbe8f5b47aa9b2f218207defea211 -.\" Present only if the kernel was configured with -.\" .BR CONFIG_DEBUG_TLBFLUSH . -.TP -.IR vmacache_find_calls " (since Linux 3.16)" -.\" commit 4f115147ff802267d0aa41e361c5aa5bd933d896 -.\" Present only if the kernel was configured with -.\" .BR CONFIG_DEBUG_VM_VMACACHE . -.TP -.IR vmacache_find_hits " (since Linux 3.16)" -.\" commit 4f115147ff802267d0aa41e361c5aa5bd933d896 -.\" Present only if the kernel was configured with -.\" .BR CONFIG_DEBUG_VM_VMACACHE . -.TP -.IR vmacache_full_flushes " (since Linux 3.19)" -.\" commit f5f302e21257ebb0c074bbafc37606c26d28cc3d -.\" Present only if the kernel was configured with -.\" .BR CONFIG_DEBUG_VM_VMACACHE . -.RE -.TP -.IR /proc/zoneinfo " (since Linux 2.6.13)" -This file displays information about memory zones. -This is useful for analyzing virtual memory behavior. -.\" FIXME more should be said about /proc/zoneinfo .SH NOTES Many files contain strings (e.g., the environment and command line) that are in the internal format, with subfields terminated by null bytes (\[aq]\e0\[aq]). When inspecting such files, you may find that the results are more readable if you use a command of the following form to display them: -.PP +.P .in +4n .EX .RB "$" " cat \fIfile\fP | tr \[aq]\e000\[aq] \[aq]\en\[aq]" .EE .in -.PP -This manual page is incomplete, possibly inaccurate, and is the kind -of thing that needs to be updated very often. .\" .SH ACKNOWLEDGEMENTS .\" The material on /proc/sys/fs and /proc/sys/kernel is closely based on .\" kernel source documentation files written by Rik van Riel. @@ -6955,7 +256,7 @@ of thing that needs to be updated very often. .BR procinfo (8), .BR route (8), .BR sysctl (8) -.PP +.P The Linux kernel source files: .IR Documentation/filesystems/proc.rst , .IR Documentation/admin\-guide/sysctl/fs.rst , diff --git a/upstream/opensuse-tumbleweed/man5/proc_apm.5 b/upstream/opensuse-tumbleweed/man5/proc_apm.5 new file mode 100644 index 00000000..295d69e7 --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_apm.5 @@ -0,0 +1,17 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_apm 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/apm \- advanced power management +.SH DESCRIPTION +.TP +.I /proc/apm +Advanced power management version and battery information when +.B CONFIG_APM +is defined at kernel compilation time. +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_buddyinfo.5 b/upstream/opensuse-tumbleweed/man5/proc_buddyinfo.5 new file mode 100644 index 00000000..0ee9519f --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_buddyinfo.5 @@ -0,0 +1,58 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_buddyinfo 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/buddyinfo \- memory fragmentation +.SH DESCRIPTION +.TP +.I /proc/buddyinfo +This file contains information which is used for diagnosing memory +fragmentation issues. +Each line starts with the identification of the node and the name +of the zone which together identify a memory region. +This is then +followed by the count of available chunks of a certain order in +which these zones are split. +The size in bytes of a certain order is given by the formula: +.IP +.in +4n +.EX +(2\[ha]order)\ *\ PAGE_SIZE +.EE +.in +.IP +The binary buddy allocator algorithm inside the kernel will split +one chunk into two chunks of a smaller order (thus with half the +size) or combine two contiguous chunks into one larger chunk of +a higher order (thus with double the size) to satisfy allocation +requests and to counter memory fragmentation. +The order matches the column number, when starting to count at zero. +.IP +For example on an x86-64 system: +.RS -12 +.EX +Node 0, zone DMA 1 1 1 0 2 1 1 0 1 1 3 +Node 0, zone DMA32 65 47 4 81 52 28 13 10 5 1 404 +Node 0, zone Normal 216 55 189 101 84 38 37 27 5 3 587 +.EE +.RE +.IP +In this example, there is one node containing three zones and there +are 11 different chunk sizes. +If the page size is 4 kilobytes, then the first zone called +.I DMA +(on x86 the first 16 megabyte of memory) has 1 chunk of 4 kilobytes +(order 0) available and has 3 chunks of 4 megabytes (order 10) available. +.IP +If the memory is heavily fragmented, the counters for higher +order chunks will be zero and allocation of large contiguous areas +will fail. +.IP +Further information about the zones can be found in +.IR /proc/zoneinfo . +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_bus.5 b/upstream/opensuse-tumbleweed/man5/proc_bus.5 new file mode 100644 index 00000000..92c27afb --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_bus.5 @@ -0,0 +1,35 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_bus 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/bus/ \- installed buses +.SH DESCRIPTION +.TP +.I /proc/bus/ +Contains subdirectories for installed buses. +.TP +.I /proc/bus/pccard/ +Subdirectory for PCMCIA devices when +.B CONFIG_PCMCIA +is set at kernel compilation time. +.TP +.I /proc/bus/pccard/drivers +.TP +.I /proc/bus/pci/ +Contains various bus subdirectories and pseudo-files containing +information about PCI buses, installed devices, and device +drivers. +Some of these files are not ASCII. +.TP +.I /proc/bus/pci/devices +Information about PCI devices. +They may be accessed through +.BR lspci (8) +and +.BR setpci (8). +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_cgroups.5 b/upstream/opensuse-tumbleweed/man5/proc_cgroups.5 new file mode 100644 index 00000000..b0e69253 --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_cgroups.5 @@ -0,0 +1,16 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_cgroups 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/cgroups \- control groups +.SH DESCRIPTION +.TP +.IR /proc/cgroups " (since Linux 2.6.24)" +See +.BR cgroups (7). +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_cmdline.5 b/upstream/opensuse-tumbleweed/man5/proc_cmdline.5 new file mode 100644 index 00000000..d9e55df6 --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_cmdline.5 @@ -0,0 +1,22 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_cmdline 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/cmdline \- kernel boot arguments +.SH DESCRIPTION +.TP +.I /proc/cmdline +Arguments passed to the Linux kernel at boot time. +Often done via a boot manager such as +.BR lilo (8) +or +.BR grub (8). +Any arguments embedded in the kernel image or initramfs via +.B CONFIG_BOOT_CONFIG +will also be displayed. +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_config.gz.5 b/upstream/opensuse-tumbleweed/man5/proc_config.gz.5 new file mode 100644 index 00000000..97c82417 --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_config.gz.5 @@ -0,0 +1,40 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_config.gz 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/config.gz \- kernel build configuration +.SH DESCRIPTION +.TP +.IR /proc/config.gz " (since Linux 2.6)" +This file exposes the configuration options that were used +to build the currently running kernel, +in the same format as they would be shown in the +.I .config +file that resulted when configuring the kernel (using +.IR "make xconfig" , +.IR "make config" , +or similar). +The file contents are compressed; view or search them using +.BR zcat (1) +and +.BR zgrep (1). +As long as no changes have been made to the following file, +the contents of +.I /proc/config.gz +are the same as those provided by: +.IP +.in +4n +.EX +cat /lib/modules/$(uname \-r)/build/.config +.EE +.in +.IP +.I /proc/config.gz +is provided only if the kernel is configured with +.BR CONFIG_IKCONFIG_PROC . +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_cpuinfo.5 b/upstream/opensuse-tumbleweed/man5/proc_cpuinfo.5 new file mode 100644 index 00000000..89502944 --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_cpuinfo.5 @@ -0,0 +1,24 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_cpuinfo 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/cpuinfo \- CPU and system architecture information +.SH DESCRIPTION +.TP +.I /proc/cpuinfo +This is a collection of CPU and system architecture dependent items, +for each supported architecture a different list. +Two common entries are \fIprocessor\fP which gives CPU number and +\fIbogomips\fP; a system constant that is calculated +during kernel initialization. +SMP machines have information for +each CPU. +The +.BR lscpu (1) +command gathers its information from this file. +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_crypto.5 b/upstream/opensuse-tumbleweed/man5/proc_crypto.5 new file mode 100644 index 00000000..2b9ed198 --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_crypto.5 @@ -0,0 +1,26 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_crypto 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/crypto \- ciphers provided by kernel crypto API +.SH DESCRIPTION +.TP +.I /proc/crypto +A list of the ciphers provided by the kernel crypto API. +For details, see the kernel +.I "Linux Kernel Crypto API" +documentation available under the kernel source directory +.I Documentation/crypto/ +.\" commit 3b72c814a8e8cd638e1ba0da4dfce501e9dff5af +(or +.I Documentation/DocBook +before Linux 4.10; +the documentation can be built using a command such as +.I make htmldocs +in the root directory of the kernel source tree). +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_devices.5 b/upstream/opensuse-tumbleweed/man5/proc_devices.5 new file mode 100644 index 00000000..3944337a --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_devices.5 @@ -0,0 +1,16 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_devices 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/devices \- major numbers and device groups +.SH DESCRIPTION +.TP +.I /proc/devices +Text listing of major numbers and device groups. +This can be used by MAKEDEV scripts for consistency with the kernel. +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_diskstats.5 b/upstream/opensuse-tumbleweed/man5/proc_diskstats.5 new file mode 100644 index 00000000..e0af6106 --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_diskstats.5 @@ -0,0 +1,21 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_diskstats 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/diskstats \- disk I/O statistics +.SH DESCRIPTION +.TP +.IR /proc/diskstats " (since Linux 2.5.69)" +This file contains disk I/O statistics for each disk device. +See the Linux kernel source file +.I Documentation/admin\-guide/iostats.rst +(or +.I Documentation/iostats.txt +before Linux 5.3) +for further information. +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_dma.5 b/upstream/opensuse-tumbleweed/man5/proc_dma.5 new file mode 100644 index 00000000..e769c31c --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_dma.5 @@ -0,0 +1,16 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_dma 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/dma \- ISA DMA channels +.SH DESCRIPTION +.TP +.I /proc/dma +This is a list of the registered \fIISA\fP DMA (direct memory access) +channels in use. +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_driver.5 b/upstream/opensuse-tumbleweed/man5/proc_driver.5 new file mode 100644 index 00000000..f400eafa --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_driver.5 @@ -0,0 +1,15 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_driver 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/driver/ \- empty dir +.SH DESCRIPTION +.TP +.I /proc/driver/ +Empty subdirectory. +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_execdomains.5 b/upstream/opensuse-tumbleweed/man5/proc_execdomains.5 new file mode 100644 index 00000000..2178c1b5 --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_execdomains.5 @@ -0,0 +1,16 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_execdomains 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/execdomains \- ABI personalities (obsolete) +.SH DESCRIPTION +.TP +.I /proc/execdomains +Used to list ABI personalities before Linux 4.1; +now contains a constant string for userspace compatibility. +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_fb.5 b/upstream/opensuse-tumbleweed/man5/proc_fb.5 new file mode 100644 index 00000000..13d28e5f --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_fb.5 @@ -0,0 +1,17 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_fb 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/fb \- frame buffer +.SH DESCRIPTION +.TP +.I /proc/fb +Frame buffer information when +.B CONFIG_FB +is defined during kernel compilation. +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_filesystems.5 b/upstream/opensuse-tumbleweed/man5/proc_filesystems.5 new file mode 100644 index 00000000..ca035fe7 --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_filesystems.5 @@ -0,0 +1,33 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.\" FIXME cross check against Documentation/filesystems/proc.txt +.\" to see what information could be imported from that file +.\" into this file. +.\" +.TH proc_filesystems 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/filesystems \- supported filesystems +.SH DESCRIPTION +.TP +.I /proc/filesystems +A text listing of the filesystems which are supported by the kernel, +namely filesystems which were compiled into the kernel or whose kernel +modules are currently loaded. +(See also +.BR filesystems (5).) +If a filesystem is marked with "nodev", +this means that it does not require a block device to be mounted +(e.g., virtual filesystem, network filesystem). +.IP +Incidentally, this file may be used by +.BR mount (8) +when no filesystem is specified and it didn't manage to determine the +filesystem type. +Then filesystems contained in this file are tried +(excepted those that are marked with "nodev"). +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_fs.5 b/upstream/opensuse-tumbleweed/man5/proc_fs.5 new file mode 100644 index 00000000..ccf2310b --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_fs.5 @@ -0,0 +1,18 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_fs 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/fs/ \- mounted filesystems +.SH DESCRIPTION +.TP +.I /proc/fs/ +.\" FIXME Much more needs to be said about /proc/fs +.\" +Contains subdirectories that in turn contain files +with information about (certain) mounted filesystems. +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_ide.5 b/upstream/opensuse-tumbleweed/man5/proc_ide.5 new file mode 100644 index 00000000..e78a652b --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_ide.5 @@ -0,0 +1,37 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_ide 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/ide/ \- IDE channels and attached devices +.SH DESCRIPTION +.TP +.I /proc/ide +This directory +exists on systems with the IDE bus. +There are directories for each IDE channel and attached device. +Files include: +.IP +.in +4n +.EX +cache buffer size in KB +capacity number of sectors +driver driver version +geometry physical and logical geometry +identify in hexadecimal +media media type +model manufacturer\[aq]s model number +settings drive settings +smart_thresholds IDE disk management thresholds (in hex) +smart_values IDE disk management values (in hex) +.EE +.in +.IP +The +.BR hdparm (8) +utility provides access to this information in a friendly format. +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_interrupts.5 b/upstream/opensuse-tumbleweed/man5/proc_interrupts.5 new file mode 100644 index 00000000..8e46baab --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_interrupts.5 @@ -0,0 +1,22 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_interrupts 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/interrupts \- number of interrupts +.SH DESCRIPTION +.TP +.I /proc/interrupts +This is used to record the number of interrupts per CPU per IO device. +Since Linux 2.6.24, +for the i386 and x86-64 architectures, at least, this also includes +interrupts internal to the system (that is, not associated with a device +as such), such as NMI (nonmaskable interrupt), LOC (local timer interrupt), +and for SMP systems, TLB (TLB flush interrupt), RES (rescheduling +interrupt), CAL (remote function call interrupt), and possibly others. +Very easy to read formatting, done in ASCII. +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_iomem.5 b/upstream/opensuse-tumbleweed/man5/proc_iomem.5 new file mode 100644 index 00000000..573e5922 --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_iomem.5 @@ -0,0 +1,15 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_iomem 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/iomem \- I/O memory map +.SH DESCRIPTION +.TP +.I /proc/iomem +I/O memory map in Linux 2.4. +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_ioports.5 b/upstream/opensuse-tumbleweed/man5/proc_ioports.5 new file mode 100644 index 00000000..3f9d6b67 --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_ioports.5 @@ -0,0 +1,16 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_ioports 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/ioports \- I/O port regions +.SH DESCRIPTION +.TP +.I /proc/ioports +This is a list of currently registered Input-Output port regions that +are in use. +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_kallsyms.5 b/upstream/opensuse-tumbleweed/man5/proc_kallsyms.5 new file mode 100644 index 00000000..f2c6f11c --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_kallsyms.5 @@ -0,0 +1,25 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_kallsyms 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/kallsyms \- kernel exported symbols +.SH DESCRIPTION +.TP +.IR /proc/kallsyms " (since Linux 2.5.71)" +This holds the kernel exported symbol definitions used by the +.BR modules (X) +tools to dynamically link and bind loadable modules. +In Linux 2.5.47 and earlier, a similar file with slightly different syntax +was named +.IR ksyms . +.SH HISTORY +.TP +.IR /proc/ksyms " (Linux 1.1.23\[en]2.5.47)" +See +.IR /proc/kallsyms . +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_kcore.5 b/upstream/opensuse-tumbleweed/man5/proc_kcore.5 new file mode 100644 index 00000000..4f882dd2 --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_kcore.5 @@ -0,0 +1,24 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_kcore 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/kcore \- physical memory +.SH DESCRIPTION +.TP +.I /proc/kcore +This file represents the physical memory of the system and is stored +in the ELF core file format. +With this pseudo-file, and an unstripped +kernel +.RI ( /usr/src/linux/vmlinux ) +binary, GDB can be used to +examine the current state of any kernel data structures. +.IP +The total length of the file is the size of physical memory (RAM) plus +4\ KiB. +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_keys.5 b/upstream/opensuse-tumbleweed/man5/proc_keys.5 new file mode 100644 index 00000000..1722b6d2 --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_keys.5 @@ -0,0 +1,20 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_keys 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/keys, /proc/key\-users \- in-kernel key management +.SH DESCRIPTION +.TP +.IR /proc/keys " (since Linux 2.6.10)" +See +.BR keyrings (7). +.TP +.IR /proc/key\-users " (since Linux 2.6.10)" +See +.BR keyrings (7). +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_kmsg.5 b/upstream/opensuse-tumbleweed/man5/proc_kmsg.5 new file mode 100644 index 00000000..3e488e30 --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_kmsg.5 @@ -0,0 +1,28 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_kmsg 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/kmsg \- kernel messages +.SH DESCRIPTION +.TP +.I /proc/kmsg +This file can be used instead of the +.BR syslog (2) +system call to read kernel messages. +A process must have superuser +privileges to read this file, and only one process should read this +file. +This file should not be read if a syslog process is running +which uses the +.BR syslog (2) +system call facility to log kernel messages. +.IP +Information in this file is retrieved with the +.BR dmesg (1) +program. +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_kpagecgroup.5 b/upstream/opensuse-tumbleweed/man5/proc_kpagecgroup.5 new file mode 100644 index 00000000..1bb9cd91 --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_kpagecgroup.5 @@ -0,0 +1,25 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_kpagecgroup 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/kpagecgroup \- memory cgroups +.SH DESCRIPTION +.TP +.IR /proc/kpagecgroup " (since Linux 4.3)" +.\" commit 80ae2fdceba8313b0433f899bdd9c6c463291a17 +This file contains a 64-bit inode number of +the memory cgroup each page is charged to, +indexed by page frame number (see the discussion of +.IR /proc/ pid /pagemap ). +.IP +The +.I /proc/kpagecgroup +file is present only if the +.B CONFIG_MEMCG +kernel configuration option is enabled. +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_kpagecount.5 b/upstream/opensuse-tumbleweed/man5/proc_kpagecount.5 new file mode 100644 index 00000000..81b97927 --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_kpagecount.5 @@ -0,0 +1,24 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_kpagecount 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/kpagecount \- count of mappings of physical pages +.SH DESCRIPTION +.TP +.IR /proc/kpagecount " (since Linux 2.6.25)" +This file contains a 64-bit count of the number of +times each physical page frame is mapped, +indexed by page frame number (see the discussion of +.IR /proc/ pid /pagemap ). +.IP +The +.I /proc/kpagecount +file is present only if the +.B CONFIG_PROC_PAGE_MONITOR +kernel configuration option is enabled. +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_kpageflags.5 b/upstream/opensuse-tumbleweed/man5/proc_kpageflags.5 new file mode 100644 index 00000000..e525c6ed --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_kpageflags.5 @@ -0,0 +1,75 @@ +'\" t +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_kpageflags 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/kpageflags \- physical pages frame masks +.SH DESCRIPTION +.TP +.IR /proc/kpageflags " (since Linux 2.6.25)" +This file contains 64-bit masks corresponding to each physical page frame; +it is indexed by page frame number (see the discussion of +.IR /proc/ pid /pagemap ). +The bits are as follows: +.RS +.IP +.TS +r l l l. +0 - KPF_LOCKED +1 - KPF_ERROR +2 - KPF_REFERENCED +3 - KPF_UPTODATE +4 - KPF_DIRTY +5 - KPF_LRU +6 - KPF_ACTIVE +7 - KPF_SLAB +8 - KPF_WRITEBACK +9 - KPF_RECLAIM +10 - KPF_BUDDY +11 - KPF_MMAP (since Linux 2.6.31) +12 - KPF_ANON (since Linux 2.6.31) +13 - KPF_SWAPCACHE (since Linux 2.6.31) +14 - KPF_SWAPBACKED (since Linux 2.6.31) +15 - KPF_COMPOUND_HEAD (since Linux 2.6.31) +16 - KPF_COMPOUND_TAIL (since Linux 2.6.31) +17 - KPF_HUGE (since Linux 2.6.31) +18 - KPF_UNEVICTABLE (since Linux 2.6.31) +19 - KPF_HWPOISON (since Linux 2.6.31) +20 - KPF_NOPAGE (since Linux 2.6.31) +21 - KPF_KSM (since Linux 2.6.32) +22 - KPF_THP (since Linux 3.4) +23 - KPF_BALLOON (since Linux 3.18) +.\" KPF_BALLOON: commit 09316c09dde33aae14f34489d9e3d243ec0d5938 +24 - KPF_ZERO_PAGE (since Linux 4.0) +.\" KPF_ZERO_PAGE: commit 56873f43abdcd574b25105867a990f067747b2f4 +25 - KPF_IDLE (since Linux 4.3) +.\" KPF_IDLE: commit f074a8f49eb87cde95ac9d040ad5e7ea4f029738 +26 - KPF_PGTABLE (since Linux 4.18) +.\" KPF_PGTABLE: commit 1d40a5ea01d53251c23c7be541d3f4a656cfc537 +.TE +.RE +.IP +For further details on the meanings of these bits, +see the kernel source file +.IR Documentation/admin\-guide/mm/pagemap.rst . +Before Linux 2.6.29, +.\" commit ad3bdefe877afb47480418fdb05ecd42842de65e +.\" commit e07a4b9217d1e97d2f3a62b6b070efdc61212110 +.BR KPF_WRITEBACK , +.BR KPF_RECLAIM , +.BR KPF_BUDDY , +and +.B KPF_LOCKED +did not report correctly. +.IP +The +.I /proc/kpageflags +file is present only if the +.B CONFIG_PROC_PAGE_MONITOR +kernel configuration option is enabled. +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_loadavg.5 b/upstream/opensuse-tumbleweed/man5/proc_loadavg.5 new file mode 100644 index 00000000..6bc3eb2b --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_loadavg.5 @@ -0,0 +1,27 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_loadavg 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/loadavg \- load average +.SH DESCRIPTION +.TP +.I /proc/loadavg +The first three fields in this file are load average figures +giving the number of jobs in the run queue (state R) +or waiting for disk I/O (state D) averaged over 1, 5, and 15 minutes. +They are the same as the load average numbers given by +.BR uptime (1) +and other programs. +The fourth field consists of two numbers separated by a slash (/). +The first of these is the number of currently runnable kernel +scheduling entities (processes, threads). +The value after the slash is the number of kernel scheduling entities +that currently exist on the system. +The fifth field is the PID of the process that was most +recently created on the system. +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_locks.5 b/upstream/opensuse-tumbleweed/man5/proc_locks.5 new file mode 100644 index 00000000..9af488d3 --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_locks.5 @@ -0,0 +1,122 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_locks 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/locks \- current file locks and leases +.SH DESCRIPTION +.TP +.I /proc/locks +This file shows current file locks +(\c +.BR flock (2) +and +.BR fcntl (2)) +and leases +(\c +.BR fcntl (2)). +.IP +An example of the content shown in this file is the following: +.IP +.in +4n +.EX +1: POSIX ADVISORY READ 5433 08:01:7864448 128 128 +2: FLOCK ADVISORY WRITE 2001 08:01:7864554 0 EOF +3: FLOCK ADVISORY WRITE 1568 00:2f:32388 0 EOF +4: POSIX ADVISORY WRITE 699 00:16:28457 0 EOF +5: POSIX ADVISORY WRITE 764 00:16:21448 0 0 +6: POSIX ADVISORY READ 3548 08:01:7867240 1 1 +7: POSIX ADVISORY READ 3548 08:01:7865567 1826 2335 +8: OFDLCK ADVISORY WRITE \-1 08:01:8713209 128 191 +.EE +.in +.IP +The fields shown in each line are as follows: +.RS +.IP [1] 5 +The ordinal position of the lock in the list. +.IP [2] +The lock type. +Values that may appear here include: +.RS +.TP +.B FLOCK +This is a BSD file lock created using +.BR flock (2). +.TP +.B OFDLCK +This is an open file description (OFD) lock created using +.BR fcntl (2). +.TP +.B POSIX +This is a POSIX byte-range lock created using +.BR fcntl (2). +.RE +.IP [3] +Among the strings that can appear here are the following: +.RS +.TP +.B ADVISORY +This is an advisory lock. +.TP +.B MANDATORY +This is a mandatory lock. +.RE +.IP [4] +The type of lock. +Values that can appear here are: +.RS +.TP +.B READ +This is a POSIX or OFD read lock, or a BSD shared lock. +.TP +.B WRITE +This is a POSIX or OFD write lock, or a BSD exclusive lock. +.RE +.IP [5] +The PID of the process that owns the lock. +.IP +Because OFD locks are not owned by a single process +(since multiple processes may have file descriptors that +refer to the same open file description), +the value \-1 is displayed in this field for OFD locks. +(Before Linux 4.14, +.\" commit 9d5b86ac13c573795525ecac6ed2db39ab23e2a8 +a bug meant that the PID of the process that +initially acquired the lock was displayed instead of the value \-1.) +.IP [6] +Three colon-separated subfields that identify the major and minor device +ID of the device containing the filesystem where the locked file resides, +followed by the inode number of the locked file. +.IP [7] +The byte offset of the first byte of the lock. +For BSD locks, this value is always 0. +.IP [8] +The byte offset of the last byte of the lock. +.B EOF +in this field means that the lock extends to the end of the file. +For BSD locks, the value shown is always +.IR EOF . +.RE +.IP +Since Linux 4.9, +.\" commit d67fd44f697dff293d7cdc29af929241b669affe +the list of locks shown in +.I /proc/locks +is filtered to show just the locks for the processes in the PID +namespace (see +.BR pid_namespaces (7)) +for which the +.I /proc +filesystem was mounted. +(In the initial PID namespace, +there is no filtering of the records shown in this file.) +.IP +The +.BR lslocks (8) +command provides a bit more information about each lock. +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_malloc.5 b/upstream/opensuse-tumbleweed/man5/proc_malloc.5 new file mode 100644 index 00000000..b8ebc4a2 --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_malloc.5 @@ -0,0 +1,18 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_malloc 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/malloc \- debug malloc (obsolete) +.SH DESCRIPTION +.TP +.IR /proc/malloc " (only up to and including Linux 2.2)" +.\" It looks like this only ever did something back in 1.0 days +This file is present only if +.B CONFIG_DEBUG_MALLOC +was defined during compilation. +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_meminfo.5 b/upstream/opensuse-tumbleweed/man5/proc_meminfo.5 new file mode 100644 index 00000000..b344155c --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_meminfo.5 @@ -0,0 +1,327 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_meminfo 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/meminfo \- memory usage +.SH DESCRIPTION +.TP +.I /proc/meminfo +This file reports statistics about memory usage on the system. +It is used by +.BR free (1) +to report the amount of free and used memory (both physical and swap) +on the system as well as the shared memory and buffers used by the +kernel. +Each line of the file consists of a parameter name, followed by a colon, +the value of the parameter, and an option unit of measurement (e.g., "kB"). +The list below describes the parameter names and +the format specifier required to read the field value. +Except as noted below, +all of the fields have been present since at least Linux 2.6.0. +Some fields are displayed only if the kernel was configured +with various options; those dependencies are noted in the list. +.RS +.TP +.IR MemTotal " %lu" +Total usable RAM (i.e., physical RAM minus a few reserved +bits and the kernel binary code). +.TP +.IR MemFree " %lu" +The sum of +.IR LowFree + HighFree . +.TP +.IR MemAvailable " %lu (since Linux 3.14)" +An estimate of how much memory is available for starting new +applications, without swapping. +.TP +.IR Buffers " %lu" +Relatively temporary storage for raw disk blocks that +shouldn't get tremendously large (20 MB or so). +.TP +.IR Cached " %lu" +In-memory cache for files read from the disk (the page cache). +Doesn't include +.IR SwapCached . +.TP +.IR SwapCached " %lu" +Memory that once was swapped out, is swapped back in but +still also is in the swap file. +(If memory pressure is high, these pages +don't need to be swapped out again because they are already +in the swap file. +This saves I/O.) +.TP +.IR Active " %lu" +Memory that has been used more recently and usually not +reclaimed unless absolutely necessary. +.TP +.IR Inactive " %lu" +Memory which has been less recently used. +It is more eligible to be reclaimed for other purposes. +.TP +.IR Active(anon) " %lu (since Linux 2.6.28)" +[To be documented.] +.TP +.IR Inactive(anon) " %lu (since Linux 2.6.28)" +[To be documented.] +.TP +.IR Active(file) " %lu (since Linux 2.6.28)" +[To be documented.] +.TP +.IR Inactive(file) " %lu (since Linux 2.6.28)" +[To be documented.] +.TP +.IR Unevictable " %lu (since Linux 2.6.28)" +(From Linux 2.6.28 to Linux 2.6.30, +\fBCONFIG_UNEVICTABLE_LRU\fP was required.) +[To be documented.] +.TP +.IR Mlocked " %lu (since Linux 2.6.28)" +(From Linux 2.6.28 to Linux 2.6.30, +\fBCONFIG_UNEVICTABLE_LRU\fP was required.) +[To be documented.] +.TP +.IR HighTotal " %lu" +(Starting with Linux 2.6.19, \fBCONFIG_HIGHMEM\fP is required.) +Total amount of highmem. +Highmem is all memory above \[ti]860 MB of physical memory. +Highmem areas are for use by user-space programs, +or for the page cache. +The kernel must use tricks to access +this memory, making it slower to access than lowmem. +.TP +.IR HighFree " %lu" +(Starting with Linux 2.6.19, \fBCONFIG_HIGHMEM\fP is required.) +Amount of free highmem. +.TP +.IR LowTotal " %lu" +(Starting with Linux 2.6.19, \fBCONFIG_HIGHMEM\fP is required.) +Total amount of lowmem. +Lowmem is memory which can be used for everything that +highmem can be used for, but it is also available for the +kernel's use for its own data structures. +Among many other things, +it is where everything from +.I Slab +is allocated. +Bad things happen when you're out of lowmem. +.TP +.IR LowFree " %lu" +(Starting with Linux 2.6.19, \fBCONFIG_HIGHMEM\fP is required.) +Amount of free lowmem. +.TP +.IR MmapCopy " %lu (since Linux 2.6.29)" +.RB ( CONFIG_MMU +is required.) +[To be documented.] +.TP +.IR SwapTotal " %lu" +Total amount of swap space available. +.TP +.IR SwapFree " %lu" +Amount of swap space that is currently unused. +.TP +.IR Dirty " %lu" +Memory which is waiting to get written back to the disk. +.TP +.IR Writeback " %lu" +Memory which is actively being written back to the disk. +.TP +.IR AnonPages " %lu (since Linux 2.6.18)" +Non-file backed pages mapped into user-space page tables. +.TP +.IR Mapped " %lu" +Files which have been mapped into memory (with +.BR mmap (2)), +such as libraries. +.TP +.IR Shmem " %lu (since Linux 2.6.32)" +Amount of memory consumed in +.BR tmpfs (5) +filesystems. +.TP +.IR KReclaimable " %lu (since Linux 4.20)" +Kernel allocations that the kernel will attempt to reclaim +under memory pressure. +Includes +.I SReclaimable +(below), and other direct allocations with a shrinker. +.TP +.IR Slab " %lu" +In-kernel data structures cache. +(See +.BR slabinfo (5).) +.TP +.IR SReclaimable " %lu (since Linux 2.6.19)" +Part of +.IR Slab , +that might be reclaimed, such as caches. +.TP +.IR SUnreclaim " %lu (since Linux 2.6.19)" +Part of +.IR Slab , +that cannot be reclaimed on memory pressure. +.TP +.IR KernelStack " %lu (since Linux 2.6.32)" +Amount of memory allocated to kernel stacks. +.TP +.IR PageTables " %lu (since Linux 2.6.18)" +Amount of memory dedicated to the lowest level of page tables. +.TP +.IR Quicklists " %lu (since Linux 2.6.27)" +(\fBCONFIG_QUICKLIST\fP is required.) +[To be documented.] +.TP +.IR NFS_Unstable " %lu (since Linux 2.6.18)" +NFS pages sent to the server, but not yet committed to stable storage. +.TP +.IR Bounce " %lu (since Linux 2.6.18)" +Memory used for block device "bounce buffers". +.TP +.IR WritebackTmp " %lu (since Linux 2.6.26)" +Memory used by FUSE for temporary writeback buffers. +.TP +.IR CommitLimit " %lu (since Linux 2.6.10)" +This is the total amount of memory currently available to +be allocated on the system, expressed in kilobytes. +This limit is adhered to +only if strict overcommit accounting is enabled (mode 2 in +.IR /proc/sys/vm/overcommit_memory ). +The limit is calculated according to the formula described under +.IR /proc/sys/vm/overcommit_memory . +For further details, see the kernel source file +.IR Documentation/vm/overcommit\-accounting.rst . +.TP +.IR Committed_AS " %lu" +The amount of memory presently allocated on the system. +The committed memory is a sum of all of the memory which +has been allocated by processes, even if it has not been +"used" by them as of yet. +A process which allocates 1 GB of memory (using +.BR malloc (3) +or similar), but touches only 300 MB of that memory will show up +as using only 300 MB of memory even if it has the address space +allocated for the entire 1 GB. +.IP +This 1 GB is memory which has been "committed" to by the VM +and can be used at any time by the allocating application. +With strict overcommit enabled on the system (mode 2 in +.IR /proc/sys/vm/overcommit_memory ), +allocations which would exceed the +.I CommitLimit +will not be permitted. +This is useful if one needs to guarantee that processes will not +fail due to lack of memory once that memory has been successfully allocated. +.TP +.IR VmallocTotal " %lu" +Total size of vmalloc memory area. +.TP +.IR VmallocUsed " %lu" +Amount of vmalloc area which is used. +Since Linux 4.4, +.\" commit a5ad88ce8c7fae7ddc72ee49a11a75aa837788e0 +this field is no longer calculated, and is hard coded as 0. +See +.IR /proc/vmallocinfo . +.TP +.IR VmallocChunk " %lu" +Largest contiguous block of vmalloc area which is free. +Since Linux 4.4, +.\" commit a5ad88ce8c7fae7ddc72ee49a11a75aa837788e0 +this field is no longer calculated and is hard coded as 0. +See +.IR /proc/vmallocinfo . +.TP +.IR HardwareCorrupted " %lu (since Linux 2.6.32)" +(\fBCONFIG_MEMORY_FAILURE\fP is required.) +[To be documented.] +.TP +.IR LazyFree " %lu (since Linux 4.12)" +Shows the amount of memory marked by +.BR madvise (2) +.BR MADV_FREE . +.TP +.IR AnonHugePages " %lu (since Linux 2.6.38)" +(\fBCONFIG_TRANSPARENT_HUGEPAGE\fP is required.) +Non-file backed huge pages mapped into user-space page tables. +.TP +.IR ShmemHugePages " %lu (since Linux 4.8)" +(\fBCONFIG_TRANSPARENT_HUGEPAGE\fP is required.) +Memory used by shared memory (shmem) and +.BR tmpfs (5) +allocated with huge pages. +.TP +.IR ShmemPmdMapped " %lu (since Linux 4.8)" +(\fBCONFIG_TRANSPARENT_HUGEPAGE\fP is required.) +Shared memory mapped into user space with huge pages. +.TP +.IR CmaTotal " %lu (since Linux 3.1)" +Total CMA (Contiguous Memory Allocator) pages. +(\fBCONFIG_CMA\fP is required.) +.TP +.IR CmaFree " %lu (since Linux 3.1)" +Free CMA (Contiguous Memory Allocator) pages. +(\fBCONFIG_CMA\fP is required.) +.TP +.IR HugePages_Total " %lu" +(\fBCONFIG_HUGETLB_PAGE\fP is required.) +The size of the pool of huge pages. +.TP +.IR HugePages_Free " %lu" +(\fBCONFIG_HUGETLB_PAGE\fP is required.) +The number of huge pages in the pool that are not yet allocated. +.TP +.IR HugePages_Rsvd " %lu (since Linux 2.6.17)" +(\fBCONFIG_HUGETLB_PAGE\fP is required.) +This is the number of huge pages for +which a commitment to allocate from the pool has been made, +but no allocation has yet been made. +These reserved huge pages +guarantee that an application will be able to allocate a +huge page from the pool of huge pages at fault time. +.TP +.IR HugePages_Surp " %lu (since Linux 2.6.24)" +(\fBCONFIG_HUGETLB_PAGE\fP is required.) +This is the number of huge pages in +the pool above the value in +.IR /proc/sys/vm/nr_hugepages . +The maximum number of surplus huge pages is controlled by +.IR /proc/sys/vm/nr_overcommit_hugepages . +.TP +.IR Hugepagesize " %lu" +(\fBCONFIG_HUGETLB_PAGE\fP is required.) +The size of huge pages. +.TP +.IR DirectMap4k " %lu (since Linux 2.6.27)" +Number of bytes of RAM linearly mapped by kernel in 4 kB pages. +(x86.) +.TP +.IR DirectMap4M " %lu (since Linux 2.6.27)" +Number of bytes of RAM linearly mapped by kernel in 4 MB pages. +(x86 with +.B CONFIG_X86_64 +or +.B CONFIG_X86_PAE +enabled.) +.TP +.IR DirectMap2M " %lu (since Linux 2.6.27)" +Number of bytes of RAM linearly mapped by kernel in 2 MB pages. +(x86 with neither +.B CONFIG_X86_64 +nor +.B CONFIG_X86_PAE +enabled.) +.TP +.IR DirectMap1G " %lu (since Linux 2.6.27)" +(x86 with +.B CONFIG_X86_64 +and +.B CONFIG_X86_DIRECT_GBPAGES +enabled.) +.RE +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_modules.5 b/upstream/opensuse-tumbleweed/man5/proc_modules.5 new file mode 100644 index 00000000..d5d72367 --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_modules.5 @@ -0,0 +1,17 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_modules 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/modules \- loaded modules +.SH DESCRIPTION +.TP +.I /proc/modules +A text list of the modules that have been loaded by the system. +See also +.BR lsmod (8). +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_mtrr.5 b/upstream/opensuse-tumbleweed/man5/proc_mtrr.5 new file mode 100644 index 00000000..b80ff38d --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_mtrr.5 @@ -0,0 +1,24 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_mtrr 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/mtrr \- memory type range registers +.SH DESCRIPTION +.TP +.I /proc/mtrr +Memory Type Range Registers. +See the Linux kernel source file +.I Documentation/x86/mtrr.rst +(or +.I Documentation/x86/mtrr.txt +.\" commit 7225e75144b9718cbbe1820d9c011c809d5773fd +before Linux 5.2, or +.I Documentation/mtrr.txt +before Linux 2.6.28) +for details. +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_partitions.5 b/upstream/opensuse-tumbleweed/man5/proc_partitions.5 new file mode 100644 index 00000000..7fbe9657 --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_partitions.5 @@ -0,0 +1,16 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_partitions 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/partitions \- major and minor numbers of partitions +.SH DESCRIPTION +.TP +.I /proc/partitions +Contains the major and minor numbers of each partition as well as the number +of 1024-byte blocks and the partition name. +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_pci.5 b/upstream/opensuse-tumbleweed/man5/proc_pci.5 new file mode 100644 index 00000000..3b60c62f --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_pci.5 @@ -0,0 +1,28 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_pci 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/pci \- PCI devices +.SH DESCRIPTION +.TP +.I /proc/pci +This is a listing of all PCI devices found during kernel initialization +and their configuration. +.IP +This file has been deprecated in favor of a new +.I /proc +interface for PCI +.RI ( /proc/bus/pci ). +It became optional in Linux 2.2 (available with +.B CONFIG_PCI_OLD_PROC +set at kernel compilation). +It became once more nonoptionally enabled in Linux 2.4. +Next, it was deprecated in Linux 2.6 (still available with +.B CONFIG_PCI_LEGACY_PROC +set), and finally removed altogether since Linux 2.6.17. +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_pid.5 b/upstream/opensuse-tumbleweed/man5/proc_pid.5 new file mode 100644 index 00000000..6d1f6790 --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_pid.5 @@ -0,0 +1,73 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_pid 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/pid/, /proc/self/ \- process information +.SH DESCRIPTION +.TP +.IR /proc/ pid / +There is a numerical subdirectory for each running process; the +subdirectory is named by the process ID. +Each +.IR /proc/ pid +subdirectory contains the pseudo-files and directories described below. +.IP +The files inside each +.IR /proc/ pid +directory are normally owned by the effective user and +effective group ID of the process. +However, as a security measure, the ownership is made +.I root:root +if the process's "dumpable" attribute is set to a value other than 1. +.IP +Before Linux 4.11, +.\" commit 68eb94f16227336a5773b83ecfa8290f1d6b78ce +.I root:root +meant the "global" root user ID and group ID +(i.e., UID 0 and GID 0 in the initial user namespace). +Since Linux 4.11, +if the process is in a noninitial user namespace that has a +valid mapping for user (group) ID 0 inside the namespace, then +the user (group) ownership of the files under +.IR /proc/ pid +is instead made the same as the root user (group) ID of the namespace. +This means that inside a container, +things work as expected for the container "root" user. +.IP +The process's "dumpable" attribute may change for the following reasons: +.RS +.IP \[bu] 3 +The attribute was explicitly set via the +.BR prctl (2) +.B PR_SET_DUMPABLE +operation. +.IP \[bu] +The attribute was reset to the value in the file +.I /proc/sys/fs/suid_dumpable +(described below), for the reasons described in +.BR prctl (2). +.RE +.IP +Resetting the "dumpable" attribute to 1 reverts the ownership of the +.IR /proc/ pid /* +files to the process's effective UID and GID. +Note, however, that if the effective UID or GID is subsequently modified, +then the "dumpable" attribute may be reset, as described in +.BR prctl (2). +Therefore, it may be desirable to reset the "dumpable" attribute +.I after +making any desired changes to the process's effective UID or GID. +.TP +.I /proc/self/ +This directory refers to the process accessing the +.I /proc +filesystem, +and is identical to the +.I /proc +directory named by the process ID of the same process. +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_pid_attr.5 b/upstream/opensuse-tumbleweed/man5/proc_pid_attr.5 new file mode 100644 index 00000000..7963e0ed --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_pid_attr.5 @@ -0,0 +1,137 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com) +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_pid_attr 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/pid/attr/ \- security-related attributes +.SH DESCRIPTION +.TP +.IR /proc/ pid /attr/ +.\" https://lwn.net/Articles/28222/ +.\" From: Stephen Smalley <sds@epoch.ncsc.mil> +.\" To: LKML and others +.\" Subject: [RFC][PATCH] Process Attribute API for Security Modules +.\" Date: 08 Apr 2003 16:17:52 -0400 +.\" +.\" http://www.nsa.gov/research/_files/selinux/papers/module/x362.shtml +.\" +The files in this directory provide an API for security modules. +The contents of this directory are files that can be read and written +in order to set security-related attributes. +This directory was added to support SELinux, +but the intention was that the API be general enough to support +other security modules. +For the purpose of explanation, +examples of how SELinux uses these files are provided below. +.IP +This directory is present only if the kernel was configured with +.BR CONFIG_SECURITY . +.TP +.IR /proc/ pid /attr/current " (since Linux 2.6.0)" +The contents of this file represent the current +security attributes of the process. +.IP +In SELinux, this file is used to get the security context of a process. +Prior to Linux 2.6.11, this file could not be used to set the security +context (a write was always denied), since SELinux limited process security +transitions to +.BR execve (2) +(see the description of +.IR /proc/ pid /attr/exec , +below). +Since Linux 2.6.11, SELinux lifted this restriction and began supporting +"set" operations via writes to this node if authorized by policy, +although use of this operation is only suitable for applications that are +trusted to maintain any desired separation between the old and new security +contexts. +.IP +Prior to Linux 2.6.28, SELinux did not allow threads within a +multithreaded process to set their security context via this node +as it would yield an inconsistency among the security contexts of the +threads sharing the same memory space. +Since Linux 2.6.28, SELinux lifted +this restriction and began supporting "set" operations for threads within +a multithreaded process if the new security context is bounded by the old +security context, where the bounded relation is defined in policy and +guarantees that the new security context has a subset of the permissions +of the old security context. +.IP +Other security modules may choose to support "set" operations via +writes to this node. +.TP +.IR /proc/ pid /attr/exec " (since Linux 2.6.0)" +This file represents the attributes to assign to the +process upon a subsequent +.BR execve (2). +.IP +In SELinux, +this is needed to support role/domain transitions, and +.BR execve (2) +is the preferred point to make such transitions because it offers better +control over the initialization of the process in the new security label +and the inheritance of state. +In SELinux, this attribute is reset on +.BR execve (2) +so that the new program reverts to the default behavior for any +.BR execve (2) +calls that it may make. +In SELinux, a process can set +only its own +.IR /proc/ pid /attr/exec +attribute. +.TP +.IR /proc/ pid /attr/fscreate " (since Linux 2.6.0)" +This file represents the attributes to assign to files +created by subsequent calls to +.BR open (2), +.BR mkdir (2), +.BR symlink (2), +and +.BR mknod (2) +.IP +SELinux employs this file to support creation of a file +(using the aforementioned system calls) +in a secure state, +so that there is no risk of inappropriate access being obtained +between the time of creation and the time that attributes are set. +In SELinux, this attribute is reset on +.BR execve (2), +so that the new program reverts to the default behavior for +any file creation calls it may make, but the attribute will persist +across multiple file creation calls within a program unless it is +explicitly reset. +In SELinux, a process can set only its own +.IR /proc/ pid /attr/fscreate +attribute. +.TP +.IR /proc/ pid /attr/keycreate " (since Linux 2.6.18)" +.\" commit 4eb582cf1fbd7b9e5f466e3718a59c957e75254e +If a process writes a security context into this file, +all subsequently created keys +.RB ( add_key (2)) +will be labeled with this context. +For further information, see the kernel source file +.I Documentation/security/keys/core.rst +(or file +.\" commit b68101a1e8f0263dbc7b8375d2a7c57c6216fb76 +.I Documentation/security/keys.txt +between Linux 3.0 and Linux 4.13, or +.\" commit d410fa4ef99112386de5f218dd7df7b4fca910b4 +.I Documentation/keys.txt +before Linux 3.0). +.TP +.IR /proc/ pid /attr/prev " (since Linux 2.6.0)" +This file contains the security context of the process before the last +.BR execve (2); +that is, the previous value of +.IR /proc/ pid /attr/current . +.TP +.IR /proc/ pid /attr/socketcreate " (since Linux 2.6.18)" +.\" commit 42c3e03ef6b298813557cdb997bd6db619cd65a2 +If a process writes a security context into this file, +all subsequently created sockets will be labeled with this context. +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_pid_autogroup.5 b/upstream/opensuse-tumbleweed/man5/proc_pid_autogroup.5 new file mode 100644 index 00000000..4c22b979 --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_pid_autogroup.5 @@ -0,0 +1,17 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_pid_autogroup 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +proc_pid_autogroup \- group tasks for the scheduler +.SH DESCRIPTION +.TP +.IR /proc/ pid /autogroup " (since Linux 2.6.38)" +.\" commit 5091faa449ee0b7d73bc296a93bca9540fc51d0a +See +.BR sched (7). +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_pid_auxv.5 b/upstream/opensuse-tumbleweed/man5/proc_pid_auxv.5 new file mode 100644 index 00000000..8edccda7 --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_pid_auxv.5 @@ -0,0 +1,27 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_pid_auxv 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/pid/auxv \- exec(3) information +.SH DESCRIPTION +.TP +.IR /proc/ pid /auxv " (since Linux 2.6.0)" +.\" Precisely: Linux 2.6.0-test7 +This contains the contents of the ELF interpreter information passed +to the process at exec time. +The format is one \fIunsigned long\fP ID +plus one \fIunsigned long\fP value for each entry. +The last entry contains two zeros. +See also +.BR getauxval (3). +.IP +Permission to access this file is governed by a ptrace access mode +.B PTRACE_MODE_READ_FSCREDS +check; see +.BR ptrace (2). +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_pid_cgroup.5 b/upstream/opensuse-tumbleweed/man5/proc_pid_cgroup.5 new file mode 100644 index 00000000..3da0d7a0 --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_pid_cgroup.5 @@ -0,0 +1,16 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_pid_cgroup 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/pid/cgroup \- control group +.SH DESCRIPTION +.TP +.IR /proc/ pid /cgroup " (since Linux 2.6.24)" +See +.BR cgroups (7). +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_pid_clear_refs.5 b/upstream/opensuse-tumbleweed/man5/proc_pid_clear_refs.5 new file mode 100644 index 00000000..48a55225 --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_pid_clear_refs.5 @@ -0,0 +1,87 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_pid_clear_refs 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/pid/clear_refs \- reset the PG_Referenced and ACCESSED/YOUNG bits +.SH DESCRIPTION +.TP +.IR /proc/ pid /clear_refs " (since Linux 2.6.22)" +.\" commit b813e931b4c8235bb42e301096ea97dbdee3e8fe (2.6.22) +.\" commit 398499d5f3613c47f2143b8c54a04efb5d7a6da9 (2.6.32) +.\" commit 040fa02077de01c7e08fa75be6125e4ca5636011 (3.11) +.\" +.\" "Clears page referenced bits shown in smaps output" +.\" write-only, writable only by the owner of the process +.IP +This is a write-only file, writable only by owner of the process. +.IP +The following values may be written to the file: +.RS +.TP +1 (since Linux 2.6.22) +.\" Internally: CLEAR_REFS_ALL +Reset the PG_Referenced and ACCESSED/YOUNG +bits for all the pages associated with the process. +(Before Linux 2.6.32, writing any nonzero value to this file +had this effect.) +.TP +2 (since Linux 2.6.32) +.\" Internally: CLEAR_REFS_ANON +Reset the PG_Referenced and ACCESSED/YOUNG +bits for all anonymous pages associated with the process. +.TP +3 (since Linux 2.6.32) +.\" Internally: CLEAR_REFS_MAPPED +Reset the PG_Referenced and ACCESSED/YOUNG +bits for all file-mapped pages associated with the process. +.RE +.IP +Clearing the PG_Referenced and ACCESSED/YOUNG bits provides a method +to measure approximately how much memory a process is using. +One first inspects the values in the "Referenced" fields +for the VMAs shown in +.IR /proc/ pid /smaps +to get an idea of the memory footprint of the +process. +One then clears the PG_Referenced and ACCESSED/YOUNG bits +and, after some measured time interval, +once again inspects the values in the "Referenced" fields +to get an idea of the change in memory footprint of the +process during the measured interval. +If one is interested only in inspecting the selected mapping types, +then the value 2 or 3 can be used instead of 1. +.IP +Further values can be written to affect different properties: +.RS +.TP +4 (since Linux 3.11) +Clear the soft-dirty bit for all the pages associated with the process. +.\" Internally: CLEAR_REFS_SOFT_DIRTY +This is used (in conjunction with +.IR /proc/ pid /pagemap ) +by the check-point restore system to discover which pages of a process +have been dirtied since the file +.IR /proc/ pid /clear_refs +was written to. +.TP +5 (since Linux 4.0) +.\" Internally: CLEAR_REFS_MM_HIWATER_RSS +Reset the peak resident set size ("high water mark") to the process's +current resident set size value. +.RE +.IP +Writing any value to +.IR /proc/ pid /clear_refs +other than those listed above has no effect. +.IP +The +.IR /proc/ pid /clear_refs +file is present only if the +.B CONFIG_PROC_PAGE_MONITOR +kernel configuration option is enabled. +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_pid_cmdline.5 b/upstream/opensuse-tumbleweed/man5/proc_pid_cmdline.5 new file mode 100644 index 00000000..9388e103 --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_pid_cmdline.5 @@ -0,0 +1,49 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_pid_cmdline 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/pid/cmdline \- command line +.SH DESCRIPTION +.TP +.IR /proc/ pid /cmdline +This read-only file holds the complete command line for the process, +unless the process is a zombie. +.\" In Linux 2.3.26, this also used to be true if the process was swapped out. +In the latter case, there is nothing in this file: +that is, a read on this file will return 0 characters. +.IP +For processes which are still running, +the command-line arguments appear in this file +in the same layout as they do in process memory: +If the process is well-behaved, +it is a set of strings separated by null bytes (\[aq]\e0\[aq]), +with a further null byte after the last string. +.IP +This is the common case, +but processes have the freedom to +override the memory region and +break assumptions about the contents or format of the +.IR /proc/ pid /cmdline +file. +.IP +If, after an +.BR execve (2), +the process modifies its +.I argv +strings, those changes will show up here. +This is not the same thing as modifying the +.I argv +array. +.IP +Furthermore, a process may change the memory location that this file refers via +.BR prctl (2) +operations such as +.BR PR_SET_MM_ARG_START . +.IP +Think of this file as the command line that the process wants you to see. +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_pid_comm.5 b/upstream/opensuse-tumbleweed/man5/proc_pid_comm.5 new file mode 100644 index 00000000..f936ed65 --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_pid_comm.5 @@ -0,0 +1,49 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_pid_comm 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/pid/comm \- command name +.SH DESCRIPTION +.TP +.IR /proc/ pid /comm " (since Linux 2.6.33)" +.\" commit 4614a696bd1c3a9af3a08f0e5874830a85b889d4 +This file exposes the process's +.I comm +value\[em]that is, the command name associated with the process. +Different threads in the same process may have different +.I comm +values, accessible via +.IR /proc/ pid /task/ tid /comm . +A thread may modify its +.I comm +value, or that of any of other thread in the same thread group (see +the discussion of +.B CLONE_THREAD +in +.BR clone (2)), +by writing to the file +.IR /proc/self/task/ tid /comm . +Strings longer than +.B TASK_COMM_LEN +(16) characters (including the terminating null byte) are silently truncated. +.IP +This file provides a superset of the +.BR prctl (2) +.B PR_SET_NAME +and +.B PR_GET_NAME +operations, and is employed by +.BR pthread_setname_np (3) +when used to rename threads other than the caller. +The value in this file is used for the +.I %e +specifier in +.IR /proc/sys/kernel/core_pattern ; +see +.BR core (5). +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_pid_coredump_filter.5 b/upstream/opensuse-tumbleweed/man5/proc_pid_coredump_filter.5 new file mode 100644 index 00000000..770fb995 --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_pid_coredump_filter.5 @@ -0,0 +1,16 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_pid_coredump_filter 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/pid/coredump_filter \- core dump filter +.SH DESCRIPTION +.TP +.IR /proc/ pid /coredump_filter " (since Linux 2.6.23)" +See +.BR core (5). +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_pid_cpuset.5 b/upstream/opensuse-tumbleweed/man5/proc_pid_cpuset.5 new file mode 100644 index 00000000..380a0a97 --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_pid_cpuset.5 @@ -0,0 +1,17 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_pid_cpuset 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/pid/cpuset \- CPU affinity sets +.SH DESCRIPTION +.TP +.IR /proc/ pid /cpuset " (since Linux 2.6.12)" +.\" and/proc/[pid]/task/[tid]/cpuset +See +.BR cpuset (7). +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_pid_cwd.5 b/upstream/opensuse-tumbleweed/man5/proc_pid_cwd.5 new file mode 100644 index 00000000..027176b5 --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_pid_cwd.5 @@ -0,0 +1,36 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_pid_cwd 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/pid/cwd \- symbolic link to current working directory +.SH DESCRIPTION +.TP +.IR /proc/ pid /cwd +This is a symbolic link to the current working directory of the process. +To find out the current working directory of process 20, +for instance, you can do this: +.IP +.in +4n +.EX +.RB "$" " cd /proc/20/cwd; pwd \-P" +.EE +.in +.IP +.\" The following was still true as at kernel 2.6.13 +In a multithreaded process, the contents of this symbolic link +are not available if the main thread has already terminated +(typically by calling +.BR pthread_exit (3)). +.IP +Permission to dereference or read +.RB ( readlink (2)) +this symbolic link is governed by a ptrace access mode +.B PTRACE_MODE_READ_FSCREDS +check; see +.BR ptrace (2). +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_pid_environ.5 b/upstream/opensuse-tumbleweed/man5/proc_pid_environ.5 new file mode 100644 index 00000000..efbb1a82 --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_pid_environ.5 @@ -0,0 +1,48 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_pid_environ 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/pid/environ \- initial environment +.SH DESCRIPTION +.TP +.IR /proc/ pid /environ +This file contains the initial environment that was set +when the currently executing program was started via +.BR execve (2). +The entries are separated by null bytes (\[aq]\e0\[aq]), +and there may be a null byte at the end. +Thus, to print out the environment of process 1, you would do: +.IP +.in +4n +.EX +.RB "$" " cat /proc/1/environ | tr \[aq]\e000\[aq] \[aq]\en\[aq]" +.EE +.in +.IP +If, after an +.BR execve (2), +the process modifies its environment +(e.g., by calling functions such as +.BR putenv (3) +or modifying the +.BR environ (7) +variable directly), +this file will +.I not +reflect those changes. +.IP +Furthermore, a process may change the memory location that this file refers via +.BR prctl (2) +operations such as +.BR PR_SET_MM_ENV_START . +.IP +Permission to access this file is governed by a ptrace access mode +.B PTRACE_MODE_READ_FSCREDS +check; see +.BR ptrace (2). +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_pid_exe.5 b/upstream/opensuse-tumbleweed/man5/proc_pid_exe.5 new file mode 100644 index 00000000..dec2c90c --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_pid_exe.5 @@ -0,0 +1,59 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_pid_exe 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/pid/exe \- symbolic link to program pathname +.SH DESCRIPTION +.TP +.IR /proc/ pid /exe +Under Linux 2.2 and later, this file is a symbolic link +containing the actual pathname of the executed command. +This symbolic link can be dereferenced normally; attempting to open +it will open the executable. +You can even type +.IR /proc/ pid /exe +to run another copy of the same executable that is being run by +process +.IR pid . +If the pathname has been unlinked, the symbolic link will contain the +string \[aq]\ (deleted)\[aq] appended to the original pathname. +.\" The following was still true as at kernel 2.6.13 +In a multithreaded process, the contents of this symbolic link +are not available if the main thread has already terminated +(typically by calling +.BR pthread_exit (3)). +.IP +Permission to dereference or read +.RB ( readlink (2)) +this symbolic link is governed by a ptrace access mode +.B PTRACE_MODE_READ_FSCREDS +check; see +.BR ptrace (2). +.IP +Under Linux 2.0 and earlier, +.IR /proc/ pid /exe +is a pointer to the binary which was executed, +and appears as a symbolic link. +A +.BR readlink (2) +call on this file under Linux 2.0 returns a string in the format: +.IP +.in +4n +.EX +[device]:inode +.EE +.in +.IP +For example, [0301]:1502 would be inode 1502 on device major 03 (IDE, +MFM, etc. drives) minor 01 (first partition on the first drive). +.IP +.BR find (1) +with the +.I \-inum +option can be used to locate the file. +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_pid_fd.5 b/upstream/opensuse-tumbleweed/man5/proc_pid_fd.5 new file mode 100644 index 00000000..a765b210 --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_pid_fd.5 @@ -0,0 +1,161 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_pid_fd 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/pid/fd/ \- file descriptors +.SH DESCRIPTION +.TP +.IR /proc/ pid /fd/ +This is a subdirectory containing one entry for each file which the +process has open, named by its file descriptor, and which is a +symbolic link to the actual file. +Thus, 0 is standard input, 1 standard output, 2 standard error, and so on. +.IP +For file descriptors for pipes and sockets, +the entries will be symbolic links whose content is the +file type with the inode. +A +.BR readlink (2) +call on this file returns a string in the format: +.IP +.in +4n +.EX +type:[inode] +.EE +.in +.IP +For example, +.I socket:[2248868] +will be a socket and its inode is 2248868. +For sockets, that inode can be used to find more information +in one of the files under +.IR /proc/net/ . +.IP +For file descriptors that have no corresponding inode +(e.g., file descriptors produced by +.BR bpf (2), +.BR epoll_create (2), +.BR eventfd (2), +.BR inotify_init (2), +.BR perf_event_open (2), +.BR signalfd (2), +.BR timerfd_create (2), +and +.BR userfaultfd (2)), +the entry will be a symbolic link with contents of the form +.IP +.in +4n +.EX +.RI anon_inode: file-type +.EE +.in +.IP +In many cases (but not all), the +.I file-type +is surrounded by square brackets. +.IP +For example, an epoll file descriptor will have a symbolic link +whose content is the string +.IR "anon_inode:[eventpoll]" . +.IP +.\"The following was still true as at kernel 2.6.13 +In a multithreaded process, the contents of this directory +are not available if the main thread has already terminated +(typically by calling +.BR pthread_exit (3)). +.IP +Programs that take a filename as a command-line argument, +but don't take input from standard input if no argument is supplied, +and programs that write to a file named as a command-line argument, +but don't send their output to standard output +if no argument is supplied, can nevertheless be made to use +standard input or standard output by using +.IR /proc/ pid /fd +files as command-line arguments. +For example, assuming that +.I \-i +is the flag designating an input file and +.I \-o +is the flag designating an output file: +.IP +.in +4n +.EX +.RB "$" " foobar \-i /proc/self/fd/0 \-o /proc/self/fd/1 ..." +.EE +.in +.IP +and you have a working filter. +.\" The following is not true in my tests (MTK): +.\" Note that this will not work for +.\" programs that seek on their files, as the files in the fd directory +.\" are not seekable. +.IP +.I /proc/self/fd/N +is approximately the same as +.I /dev/fd/N +in some UNIX and UNIX-like systems. +Most Linux MAKEDEV scripts symbolically link +.I /dev/fd +to +.IR /proc/self/fd , +in fact. +.IP +Most systems provide symbolic links +.IR /dev/stdin , +.IR /dev/stdout , +and +.IR /dev/stderr , +which respectively link to the files +.IR 0 , +.IR 1 , +and +.I 2 +in +.IR /proc/self/fd . +Thus the example command above could be written as: +.IP +.in +4n +.EX +.RB "$" " foobar \-i /dev/stdin \-o /dev/stdout ..." +.EE +.in +.IP +Permission to dereference or read +.RB ( readlink (2)) +the symbolic links in this directory is governed by a ptrace access mode +.B PTRACE_MODE_READ_FSCREDS +check; see +.BR ptrace (2). +.IP +Note that for file descriptors referring to inodes +(pipes and sockets, see above), +those inodes still have permission bits and ownership information +distinct from those of the +.IR /proc/ pid /fd +entry, +and that the owner may differ from the user and group IDs of the process. +An unprivileged process may lack permissions to open them, as in this example: +.IP +.in +4n +.EX +.RB "$" " echo test | sudo \-u nobody cat" +test +.RB "$" " echo test | sudo \-u nobody cat /proc/self/fd/0" +cat: /proc/self/fd/0: Permission denied +.EE +.in +.IP +File descriptor 0 refers to the pipe created by the shell +and owned by that shell's user, which is not +.IR nobody , +so +.B cat +does not have permission +to create a new file descriptor to read from that inode, +even though it can still read from its existing file descriptor 0. +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_pid_fdinfo.5 b/upstream/opensuse-tumbleweed/man5/proc_pid_fdinfo.5 new file mode 100644 index 00000000..3f5b370e --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_pid_fdinfo.5 @@ -0,0 +1,300 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_pid_fdinfo 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/pid/fdinfo/ \- information about file descriptors +.SH DESCRIPTION +.TP +.IR /proc/ pid /fdinfo/ " (since Linux 2.6.22)" +This is a subdirectory containing one entry for each file which the +process has open, named by its file descriptor. +The files in this directory are readable only by the owner of the process. +The contents of each file can be read to obtain information +about the corresponding file descriptor. +The content depends on the type of file referred to by the +corresponding file descriptor. +.IP +For regular files and directories, we see something like: +.IP +.in +4n +.EX +.RB "$" " cat /proc/12015/fdinfo/4" +pos: 1000 +flags: 01002002 +mnt_id: 21 +.EE +.in +.IP +The fields are as follows: +.RS +.TP +.I pos +This is a decimal number showing the file offset. +.TP +.I flags +This is an octal number that displays the +file access mode and file status flags (see +.BR open (2)). +If the close-on-exec file descriptor flag is set, then +.I flags +will also include the value +.BR O_CLOEXEC . +.IP +Before Linux 3.1, +.\" commit 1117f72ea0217ba0cc19f05adbbd8b9a397f5ab7 +this field incorrectly displayed the setting of +.B O_CLOEXEC +at the time the file was opened, +rather than the current setting of the close-on-exec flag. +.TP +.I +.I mnt_id +This field, present since Linux 3.15, +.\" commit 49d063cb353265c3af701bab215ac438ca7df36d +is the ID of the mount containing this file. +See the description of +.IR /proc/ pid /mountinfo . +.RE +.IP +For eventfd file descriptors (see +.BR eventfd (2)), +we see (since Linux 3.8) +.\" commit cbac5542d48127b546a23d816380a7926eee1c25 +the following fields: +.IP +.in +4n +.EX +pos: 0 +flags: 02 +mnt_id: 10 +eventfd\-count: 40 +.EE +.in +.IP +.I eventfd\-count +is the current value of the eventfd counter, in hexadecimal. +.IP +For epoll file descriptors (see +.BR epoll (7)), +we see (since Linux 3.8) +.\" commit 138d22b58696c506799f8de759804083ff9effae +the following fields: +.IP +.in +4n +.EX +pos: 0 +flags: 02 +mnt_id: 10 +tfd: 9 events: 19 data: 74253d2500000009 +tfd: 7 events: 19 data: 74253d2500000007 +.EE +.in +.IP +Each of the lines beginning +.I tfd +describes one of the file descriptors being monitored via +the epoll file descriptor (see +.BR epoll_ctl (2) +for some details). +The +.I tfd +field is the number of the file descriptor. +The +.I events +field is a hexadecimal mask of the events being monitored for this file +descriptor. +The +.I data +field is the data value associated with this file descriptor. +.IP +For signalfd file descriptors (see +.BR signalfd (2)), +we see (since Linux 3.8) +.\" commit 138d22b58696c506799f8de759804083ff9effae +the following fields: +.IP +.in +4n +.EX +pos: 0 +flags: 02 +mnt_id: 10 +sigmask: 0000000000000006 +.EE +.in +.IP +.I sigmask +is the hexadecimal mask of signals that are accepted via this +signalfd file descriptor. +(In this example, bits 2 and 3 are set, corresponding to the signals +.B SIGINT +and +.BR SIGQUIT ; +see +.BR signal (7).) +.IP +For inotify file descriptors (see +.BR inotify (7)), +we see (since Linux 3.8) +the following fields: +.IP +.in +4n +.EX +pos: 0 +flags: 00 +mnt_id: 11 +inotify wd:2 ino:7ef82a sdev:800001 mask:800afff ignored_mask:0 fhandle\-bytes:8 fhandle\-type:1 f_handle:2af87e00220ffd73 +inotify wd:1 ino:192627 sdev:800001 mask:800afff ignored_mask:0 fhandle\-bytes:8 fhandle\-type:1 f_handle:27261900802dfd73 +.EE +.in +.IP +Each of the lines beginning with "inotify" displays information about +one file or directory that is being monitored. +The fields in this line are as follows: +.RS +.TP +.I wd +A watch descriptor number (in decimal). +.TP +.I ino +The inode number of the target file (in hexadecimal). +.TP +.I sdev +The ID of the device where the target file resides (in hexadecimal). +.TP +.I mask +The mask of events being monitored for the target file (in hexadecimal). +.RE +.IP +If the kernel was built with exportfs support, the path to the target +file is exposed as a file handle, via three hexadecimal fields: +.IR fhandle\-bytes , +.IR fhandle\-type , +and +.IR f_handle . +.IP +For fanotify file descriptors (see +.BR fanotify (7)), +we see (since Linux 3.8) +the following fields: +.IP +.in +4n +.EX +pos: 0 +flags: 02 +mnt_id: 11 +fanotify flags:0 event\-flags:88002 +fanotify ino:19264f sdev:800001 mflags:0 mask:1 ignored_mask:0 fhandle\-bytes:8 fhandle\-type:1 f_handle:4f261900a82dfd73 +.EE +.in +.IP +The fourth line displays information defined when the fanotify group +was created via +.BR fanotify_init (2): +.RS +.TP +.I flags +The +.I flags +argument given to +.BR fanotify_init (2) +(expressed in hexadecimal). +.TP +.I event\-flags +The +.I event_f_flags +argument given to +.BR fanotify_init (2) +(expressed in hexadecimal). +.RE +.IP +Each additional line shown in the file contains information +about one of the marks in the fanotify group. +Most of these fields are as for inotify, except: +.RS +.TP +.I mflags +The flags associated with the mark +(expressed in hexadecimal). +.TP +.I mask +The events mask for this mark +(expressed in hexadecimal). +.TP +.I ignored_mask +The mask of events that are ignored for this mark +(expressed in hexadecimal). +.RE +.IP +For details on these fields, see +.BR fanotify_mark (2). +.IP +For timerfd file descriptors (see +.BR timerfd (2)), +we see (since Linux 3.17) +.\" commit af9c4957cf212ad9cf0bee34c95cb11de5426e85 +the following fields: +.IP +.in +4n +.EX +pos: 0 +flags: 02004002 +mnt_id: 13 +clockid: 0 +ticks: 0 +settime flags: 03 +it_value: (7695568592, 640020877) +it_interval: (0, 0) +.EE +.in +.RS +.TP +.I clockid +This is the numeric value of the clock ID +(corresponding to one of the +.B CLOCK_* +constants defined via +.IR <time.h> ) +that is used to mark the progress of the timer (in this example, 0 is +.BR CLOCK_REALTIME ). +.TP +.I ticks +This is the number of timer expirations that have occurred, +(i.e., the value that +.BR read (2) +on it would return). +.TP +.I settime flags +This field lists the flags with which the timerfd was last armed (see +.BR timerfd_settime (2)), +in octal +(in this example, both +.B TFD_TIMER_ABSTIME +and +.B TFD_TIMER_CANCEL_ON_SET +are set). +.TP +.I it_value +This field contains the amount of time until the timer will next expire, +expressed in seconds and nanoseconds. +This is always expressed as a relative value, +regardless of whether the timer was created using the +.B TFD_TIMER_ABSTIME +flag. +.TP +.I it_interval +This field contains the interval of the timer, +in seconds and nanoseconds. +(The +.I it_value +and +.I it_interval +fields contain the values that +.BR timerfd_gettime (2) +on this file descriptor would return.) +.RE +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_pid_io.5 b/upstream/opensuse-tumbleweed/man5/proc_pid_io.5 new file mode 100644 index 00000000..493c7b8b --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_pid_io.5 @@ -0,0 +1,100 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_pid_io 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/pid/io \- I/O statistics +.SH DESCRIPTION +.TP +.IR /proc/ pid /io " (since Linux 2.6.20)" +.\" commit 7c3ab7381e79dfc7db14a67c6f4f3285664e1ec2 +This file contains I/O statistics +for the process and its waited-for children, +for example: +.IP +.in +4n +.EX +.RB "#" " cat /proc/3828/io" +rchar: 323934931 +wchar: 323929600 +syscr: 632687 +syscw: 632675 +read_bytes: 0 +write_bytes: 323932160 +cancelled_write_bytes: 0 +.EE +.in +.IP +The fields are as follows: +.RS +.TP +.IR rchar ": characters read" +The number of bytes +returned by successful +.BR read (2) +and similar system calls. +.TP +.IR wchar ": characters written" +The number of bytes +returned by successful +.BR write (2) +and similar system calls. +.TP +.IR syscr ": read syscalls" +The number of "file read" system calls\[em]those from the +.BR read (2) +family, +.BR sendfile (2), +.BR copy_file_range (2), +and +.BR ioctl (2) +.BR BTRFS_IOC_ENCODED_READ [ _32 ] +(including when invoked by the kernel as part of other syscalls). +.TP +.IR syscw ": write syscalls" +The number of "file write" system calls\[em]those from the +.BR write (2) +family, +.BR sendfile (2), +.BR copy_file_range (2), +and +.BR ioctl (2) +.BR BTRFS_IOC_ENCODED_WRITE [ _32 ] +(including when invoked by the kernel as part of other syscalls). +.TP +.IR read_bytes ": bytes read" +The number of bytes really fetched from the storage layer. +This is accurate for block-backed filesystems. +.TP +.IR write_bytes ": bytes written" +The number of bytes really sent to the storage layer. +.TP +.IR cancelled_write_bytes : +The above statistics fail to account for truncation: +if a process writes 1 MB to a regular file and then removes it, +said 1 MB will not be written, but +.I will +have nevertheless been accounted as a 1 MB write. +This field represents the number of bytes "saved" from I/O writeback. +This can yield to having done negative I/O +if caches dirtied by another process are truncated. +.I cancelled_write_bytes +applies to I/O already accounted-for in +.IR write_bytes . +.RE +.IP +Permission to access this file is governed by +.BR ptrace (2) +access mode +.BR PTRACE_MODE_READ_FSCREDS . +.SH CAVEATS +These counters are not atomic: +on systems where 64-bit integer operations may tear, +a counter could be updated simultaneously with a read, +yielding an incorrect intermediate value. +.SH SEE ALSO +.BR getrusage (2), +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_pid_limits.5 b/upstream/opensuse-tumbleweed/man5/proc_pid_limits.5 new file mode 100644 index 00000000..f8f60120 --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_pid_limits.5 @@ -0,0 +1,25 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_oid_limits 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/pid/limits \- resource limits +.SH DESCRIPTION +.TP +.IR /proc/ pid /limits " (since Linux 2.6.24)" +This file displays the soft limit, hard limit, and units of measurement +for each of the process's resource limits (see +.BR getrlimit (2)). +Up to and including Linux 2.6.35, +this file is protected to allow reading only by the real UID of the process. +Since Linux 2.6.36, +.\" commit 3036e7b490bf7878c6dae952eec5fb87b1106589 +this file is readable by all users on the system. +.\" FIXME Describe /proc/[pid]/loginuid +.\" Added in Linux 2.6.11; updating requires CAP_AUDIT_CONTROL +.\" CONFIG_AUDITSYSCALL +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_pid_map_files.5 b/upstream/opensuse-tumbleweed/man5/proc_pid_map_files.5 new file mode 100644 index 00000000..27e46ffe --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_pid_map_files.5 @@ -0,0 +1,72 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_pid_map_files 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/pid/map_files/ \- memory-mapped files +.SH DESCRIPTION +.TP +.IR /proc/ pid /map_files/ " (since Linux 3.3)" +.\" commit 640708a2cff7f81e246243b0073c66e6ece7e53e +This subdirectory contains entries corresponding to memory-mapped +files (see +.BR mmap (2)). +Entries are named by memory region start and end +address pair (expressed as hexadecimal numbers), +and are symbolic links to the mapped files themselves. +Here is an example, +with the output wrapped and reformatted to fit on an 80-column display: +.IP +.in +4n +.EX +.RB "#" " ls \-l /proc/self/map_files/" +lr\-\-\-\-\-\-\-\-. 1 root root 64 Apr 16 21:31 + 3252e00000\-3252e20000 \-> /usr/lib64/ld\-2.15.so +\&... +.EE +.in +.IP +Although these entries are present for memory regions that were +mapped with the +.B MAP_FILE +flag, the way anonymous shared memory (regions created with the +.B MAP_ANON | MAP_SHARED +flags) +is implemented in Linux +means that such regions also appear on this directory. +Here is an example where the target file is the deleted +.I /dev/zero +one: +.IP +.in +4n +.EX +lrw\-\-\-\-\-\-\-. 1 root root 64 Apr 16 21:33 + 7fc075d2f000\-7fc075e6f000 \-> /dev/zero (deleted) +.EE +.in +.IP +Permission to access this file is governed by a ptrace access mode +.B PTRACE_MODE_READ_FSCREDS +check; see +.BR ptrace (2). +.IP +Until Linux 4.3, +.\" commit bdb4d100afe9818aebd1d98ced575c5ef143456c +this directory appeared only if the +.B CONFIG_CHECKPOINT_RESTORE +kernel configuration option was enabled. +.IP +Capabilities are required to read the contents of the symbolic links in +this directory: before Linux 5.9, the reading process requires +.B CAP_SYS_ADMIN +in the initial user namespace; +since Linux 5.9, the reading process must have either +.B CAP_SYS_ADMIN +or +.B CAP_CHECKPOINT_RESTORE +in the initial (i.e. root) user namespace. +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_pid_maps.5 b/upstream/opensuse-tumbleweed/man5/proc_pid_maps.5 new file mode 100644 index 00000000..1d54b4dd --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_pid_maps.5 @@ -0,0 +1,156 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_pid_maps 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/pid/maps \- mapped memory regions +.SH DESCRIPTION +.TP +.IR /proc/ pid /maps +A file containing the currently mapped memory regions and their access +permissions. +See +.BR mmap (2) +for some further information about memory mappings. +.IP +Permission to access this file is governed by a ptrace access mode +.B PTRACE_MODE_READ_FSCREDS +check; see +.BR ptrace (2). +.IP +The format of the file is: +.IP +.in +4n +.EX +.I "address perms offset dev inode pathname" +00400000\-00452000 r\-xp 00000000 08:02 173521 /usr/bin/dbus\-daemon +00651000\-00652000 r\-\-p 00051000 08:02 173521 /usr/bin/dbus\-daemon +00652000\-00655000 rw\-p 00052000 08:02 173521 /usr/bin/dbus\-daemon +00e03000\-00e24000 rw\-p 00000000 00:00 0 [heap] +00e24000\-011f7000 rw\-p 00000000 00:00 0 [heap] +\&... +35b1800000\-35b1820000 r\-xp 00000000 08:02 135522 /usr/lib64/ld\-2.15.so +35b1a1f000\-35b1a20000 r\-\-p 0001f000 08:02 135522 /usr/lib64/ld\-2.15.so +35b1a20000\-35b1a21000 rw\-p 00020000 08:02 135522 /usr/lib64/ld\-2.15.so +35b1a21000\-35b1a22000 rw\-p 00000000 00:00 0 +35b1c00000\-35b1dac000 r\-xp 00000000 08:02 135870 /usr/lib64/libc\-2.15.so +35b1dac000\-35b1fac000 \-\-\-p 001ac000 08:02 135870 /usr/lib64/libc\-2.15.so +35b1fac000\-35b1fb0000 r\-\-p 001ac000 08:02 135870 /usr/lib64/libc\-2.15.so +35b1fb0000\-35b1fb2000 rw\-p 001b0000 08:02 135870 /usr/lib64/libc\-2.15.so +\&... +f2c6ff8c000\-7f2c7078c000 rw\-p 00000000 00:00 0 [stack:986] +\&... +7fffb2c0d000\-7fffb2c2e000 rw\-p 00000000 00:00 0 [stack] +7fffb2d48000\-7fffb2d49000 r\-xp 00000000 00:00 0 [vdso] +.EE +.in +.IP +The +.I address +field is the address space in the process that the mapping occupies. +The +.I perms +field is a set of permissions: +.IP +.in +4n +.EX +r = read +w = write +x = execute +s = shared +p = private (copy on write) +.EE +.in +.IP +The +.I offset +field is the offset into the file/whatever; +.I dev +is the device +(major:minor); +.I inode +is the inode on that device. +0 indicates that no inode is associated with the memory region, +as would be the case with BSS (uninitialized data). +.IP +The +.I pathname +field will usually be the file that is backing the mapping. +For ELF files, +you can easily coordinate with the +.I offset +field by looking at the +Offset field in the ELF program headers +.RI ( "readelf\ \-l" ). +.IP +There are additional helpful pseudo-paths: +.RS +.TP +.I [stack] +The initial process's (also known as the main thread's) stack. +.TP +.IR [stack: tid ] " (from Linux 3.4 to Linux 4.4)" +.\" commit b76437579d1344b612cf1851ae610c636cec7db0 (added) +.\" commit 65376df582174ffcec9e6471bf5b0dd79ba05e4a (removed) +A thread's stack (where the +.I tid +is a thread ID). +It corresponds to the +.IR /proc/ pid /task/ tid / +path. +This field was removed in Linux 4.5, since providing this information +for a process with large numbers of threads is expensive. +.TP +.I [vdso] +The virtual dynamically linked shared object. +See +.BR vdso (7). +.TP +.I [heap] +The process's heap. +.TP +.IR [anon: name ] " (since Linux 5.17)" +.\" Commit 9a10064f5625d5572c3626c1516e0bebc6c9fe9b +A named private anonymous mapping. +Set with +.BR prctl (2) +.BR PR_SET_VMA_ANON_NAME . +.TP +.IR [anon_shmem: name ] " (since Linux 6.2)" +.\" Commit d09e8ca6cb93bb4b97517a18fbbf7eccb0e9ff43 +A named shared anonymous mapping. +Set with +.BR prctl (2) +.BR PR_SET_VMA_ANON_NAME . +.in +.RE +.IP +If the +.I pathname +field is blank, +this is an anonymous mapping as obtained via +.BR mmap (2). +There is no easy way to coordinate this back to a process's source, +short of running it through +.BR gdb (1), +.BR strace (1), +or similar. +.IP +.I pathname +is shown unescaped except for newline characters, which are replaced +with an octal escape sequence. +As a result, it is not possible to determine whether the original +pathname contained a newline character or the literal +.I \e012 +character sequence. +.IP +If the mapping is file-backed and the file has been deleted, the string +" (deleted)" is appended to the pathname. +Note that this is ambiguous too. +.IP +Under Linux 2.0, there is no field giving pathname. +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_pid_mem.5 b/upstream/opensuse-tumbleweed/man5/proc_pid_mem.5 new file mode 100644 index 00000000..bde814da --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_pid_mem.5 @@ -0,0 +1,24 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_pid_mem 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/pid/mem \- memory +.SH DESCRIPTION +.TP +.IR /proc/ pid /mem +This file can be used to access the pages of a process's memory through +.BR open (2), +.BR read (2), +and +.BR lseek (2). +.IP +Permission to access this file is governed by a ptrace access mode +.B PTRACE_MODE_ATTACH_FSCREDS +check; see +.BR ptrace (2). +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_pid_mountinfo.5 b/upstream/opensuse-tumbleweed/man5/proc_pid_mountinfo.5 new file mode 100644 index 00000000..c43e0e65 --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_pid_mountinfo.5 @@ -0,0 +1,124 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_pid_mountinfo 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/pid/mountinfo \- mount information +.SH DESCRIPTION +.TP +.IR /proc/ pid /mountinfo " (since Linux 2.6.26)" +.\" This info adapted from Documentation/filesystems/proc.txt +.\" commit 2d4d4864ac08caff5c204a752bd004eed4f08760 +This file contains information about mounts +in the process's mount namespace (see +.BR mount_namespaces (7)). +It supplies various information +(e.g., propagation state, root of mount for bind mounts, +identifier for each mount and its parent) that is missing from the (older) +.IR /proc/ pid /mounts +file, and fixes various other problems with that file +(e.g., nonextensibility, +failure to distinguish per-mount versus per-superblock options). +.IP +The file contains lines of the form: +.IP +.EX +36 35 98:0 /mnt1 /mnt2 rw,noatime master:1 \- ext3 /dev/root rw,errors=continue +(1)(2)(3) (4) (5) (6) (7) (8) (9) (10) (11) +.EE +.IP +The numbers in parentheses are labels for the descriptions below: +.RS 7 +.TP 5 +(1) +mount ID: a unique ID for the mount (may be reused after +.BR umount (2)). +.TP +(2) +parent ID: the ID of the parent mount +(or of self for the root of this mount namespace's mount tree). +.IP +If a new mount is stacked on top of a previous existing mount +(so that it hides the existing mount) at pathname P, +then the parent of the new mount is the previous mount at that location. +Thus, when looking at all the mounts stacked at a particular location, +the top-most mount is the one that is not the parent +of any other mount at the same location. +(Note, however, that this top-most mount will be accessible only if +the longest path subprefix of P that is a mount point +is not itself hidden by a stacked mount.) +.IP +If the parent mount lies outside the process's root directory (see +.BR chroot (2)), +the ID shown here won't have a corresponding record in +.I mountinfo +whose mount ID (field 1) matches this parent mount ID +(because mounts that lie outside the process's root directory +are not shown in +.IR mountinfo ). +As a special case of this point, +the process's root mount may have a parent mount +(for the initramfs filesystem) that lies +.\" Miklos Szeredi, Nov 2017: The hidden one is the initramfs, I believe +.\" mtk: In the initial mount namespace, this hidden ID has the value 0 +outside the process's root directory, +and an entry for that mount will not appear in +.IR mountinfo . +.TP +(3) +major:minor: the value of +.I st_dev +for files on this filesystem (see +.BR stat (2)). +.TP +(4) +root: the pathname of the directory in the filesystem +which forms the root of this mount. +.TP +(5) +mount point: the pathname of the mount point relative +to the process's root directory. +.TP +(6) +mount options: per-mount options (see +.BR mount (2)). +.TP +(7) +optional fields: zero or more fields of the form "tag[:value]"; see below. +.TP +(8) +separator: the end of the optional fields is marked by a single hyphen. +.TP +(9) +filesystem type: the filesystem type in the form "type[.subtype]". +.TP +(10) +mount source: filesystem-specific information or "none". +.TP +(11) +super options: per-superblock options (see +.BR mount (2)). +.RE +.IP +Currently, the possible optional fields are +.IR shared , +.IR master , +.IR propagate_from , +and +.IR unbindable . +See +.BR mount_namespaces (7) +for a description of these fields. +Parsers should ignore all unrecognized optional fields. +.IP +For more information on mount propagation see +.I Documentation/filesystems/sharedsubtree.rst +(or +.I Documentation/filesystems/sharedsubtree.txt +before Linux 5.8) +in the Linux kernel source tree. +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_pid_mounts.5 b/upstream/opensuse-tumbleweed/man5/proc_pid_mounts.5 new file mode 100644 index 00000000..be318734 --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_pid_mounts.5 @@ -0,0 +1,49 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_pid_mounts 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/pid/mounts \- mounted filesystems +.SH DESCRIPTION +.TP +.IR /proc/ pid /mounts " (since Linux 2.4.19)" +This file lists all the filesystems currently mounted in the +process's mount namespace (see +.BR mount_namespaces (7)). +The format of this file is documented in +.BR fstab (5). +.IP +Since Linux 2.6.15, this file is pollable: +after opening the file for reading, a change in this file +(i.e., a filesystem mount or unmount) causes +.BR select (2) +to mark the file descriptor as having an exceptional condition, and +.BR poll (2) +and +.BR epoll_wait (2) +mark the file as having a priority event +.RB ( POLLPRI ). +(Before Linux 2.6.30, +a change in this file was indicated by the file descriptor +being marked as readable for +.BR select (2), +and being marked as having an error condition for +.BR poll (2) +and +.BR epoll_wait (2).) +.TP +.I /proc/mounts +Before Linux 2.4.19, this file was a list +of all the filesystems currently mounted on the system. +With the introduction of per-process mount namespaces in Linux 2.4.19 (see +.BR mount_namespaces (7)), +this file became a link to +.IR /proc/self/mounts , +which lists the mounts of the process's own mount namespace. +The format of this file is documented in +.BR fstab (5). +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_pid_mountstats.5 b/upstream/opensuse-tumbleweed/man5/proc_pid_mountstats.5 new file mode 100644 index 00000000..7cebb4b2 --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_pid_mountstats.5 @@ -0,0 +1,46 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_pid_mountstats 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/pid/mountstats \- mount statistics +.SH DESCRIPTION +.TP +.IR /proc/ pid /mountstats " (since Linux 2.6.17)" +This file exports information (statistics, configuration information) +about the mounts in the process's mount namespace (see +.BR mount_namespaces (7)). +Lines in this file have the form: +.IP +.in +4n +.EX +device /dev/sda7 mounted on /home with fstype ext3 [stats] +( 1 ) ( 2 ) (3 ) ( 4 ) +.EE +.in +.IP +The fields in each line are: +.RS 7 +.TP 5 +(1) +The name of the mounted device +(or "nodevice" if there is no corresponding device). +.TP +(2) +The mount point within the filesystem tree. +.TP +(3) +The filesystem type. +.TP +(4) +Optional statistics and configuration information. +Currently (as at Linux 2.6.26), only NFS filesystems export +information via this field. +.RE +.IP +This file is readable only by the owner of the process. +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_pid_net.5 b/upstream/opensuse-tumbleweed/man5/proc_pid_net.5 new file mode 100644 index 00000000..bc5ceb34 --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_pid_net.5 @@ -0,0 +1,298 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) , Alan Cox <A.Cox@swansea.ac.uk> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_pid_net 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/pid/net/, /proc/net/ \- network layer information +.SH DESCRIPTION +.TP +.IR /proc/ pid /net/ " (since Linux 2.6.25)" +See the description of +.IR /proc/net . +.TP +.I /proc/net/ +This directory contains various files and subdirectories containing +information about the networking layer. +The files contain ASCII structures and are, +therefore, readable with +.BR cat (1). +However, the standard +.BR netstat (8) +suite provides much cleaner access to these files. +.IP +With the advent of network namespaces, +various information relating to the network stack is virtualized (see +.BR network_namespaces (7)). +Thus, since Linux 2.6.25, +.\" commit e9720acd728a46cb40daa52c99a979f7c4ff195c +.I /proc/net +is a symbolic link to the directory +.IR /proc/self/net , +which contains the same files and directories as listed below. +However, these files and directories now expose information +for the network namespace of which the process is a member. +.TP +.I /proc/net/arp +This holds an ASCII readable dump of the kernel ARP table used for +address resolutions. +It will show both dynamically learned and preprogrammed ARP entries. +The format is: +.IP +.in +4n +.EX +IP address HW type Flags HW address Mask Device +192.168.0.50 0x1 0x2 00:50:BF:25:68:F3 * eth0 +192.168.0.250 0x1 0xc 00:00:00:00:00:00 * eth0 +.EE +.in +.IP +Here "IP address" is the IPv4 address of the machine and the "HW type" +is the hardware type of the address from RFC\ 826. +The flags are the internal +flags of the ARP structure (as defined in +.IR /usr/include/linux/if_arp.h ) +and +the "HW address" is the data link layer mapping for that IP address if +it is known. +.TP +.I /proc/net/dev +The dev pseudo-file contains network device status information. +This gives +the number of received and sent packets, the number of errors and +collisions +and other basic statistics. +These are used by the +.BR ifconfig (8) +program to report device status. +The format is: +.IP +.EX +Inter\-| Receive | Transmit + face |bytes packets errs drop fifo frame compressed multicast|bytes packets errs drop fifo colls carrier compressed + lo: 2776770 11307 0 0 0 0 0 0 2776770 11307 0 0 0 0 0 0 + eth0: 1215645 2751 0 0 0 0 0 0 1782404 4324 0 0 0 427 0 0 + ppp0: 1622270 5552 1 0 0 0 0 0 354130 5669 0 0 0 0 0 0 + tap0: 7714 81 0 0 0 0 0 0 7714 81 0 0 0 0 0 0 +.EE +.\" .TP +.\" .I /proc/net/ipx +.\" No information. +.\" .TP +.\" .I /proc/net/ipx_route +.\" No information. +.TP +.I /proc/net/dev_mcast +Defined in +.IR /usr/src/linux/net/core/dev_mcast.c : +.IP +.in +4n +.EX +indx interface_name dmi_u dmi_g dmi_address +2 eth0 1 0 01005e000001 +3 eth1 1 0 01005e000001 +4 eth2 1 0 01005e000001 +.EE +.in +.TP +.I /proc/net/igmp +Internet Group Management Protocol. +Defined in +.IR /usr/src/linux/net/core/igmp.c . +.TP +.I /proc/net/rarp +This file uses the same format as the +.I arp +file and contains the current reverse mapping database used to provide +.BR rarp (8) +reverse address lookup services. +If RARP is not configured into the +kernel, +this file will not be present. +.TP +.I /proc/net/raw +Holds a dump of the RAW socket table. +Much of the information is not of +use +apart from debugging. +The "sl" value is the kernel hash slot for the +socket, +the "local_address" is the local address and protocol number pair. +\&"St" is +the internal status of the socket. +The "tx_queue" and "rx_queue" are the +outgoing and incoming data queue in terms of kernel memory usage. +The "tr", "tm\->when", and "rexmits" fields are not used by RAW. +The "uid" +field holds the effective UID of the creator of the socket. +.\" .TP +.\" .I /proc/net/route +.\" No information, but looks similar to +.\" .BR route (8). +.TP +.I /proc/net/snmp +This file holds the ASCII data needed for the IP, ICMP, TCP, and UDP +management +information bases for an SNMP agent. +.TP +.I /proc/net/tcp +Holds a dump of the TCP socket table. +Much of the information is not +of use apart from debugging. +The "sl" value is the kernel hash slot +for the socket, the "local_address" is the local address and port number pair. +The "rem_address" is the remote address and port number pair +(if connected). +\&"St" is the internal status of the socket. +The "tx_queue" and "rx_queue" are the +outgoing and incoming data queue in terms of kernel memory usage. +The "tr", "tm\->when", and "rexmits" fields hold internal information of +the kernel socket state and are useful only for debugging. +The "uid" +field holds the effective UID of the creator of the socket. +.TP +.I /proc/net/udp +Holds a dump of the UDP socket table. +Much of the information is not of +use apart from debugging. +The "sl" value is the kernel hash slot for the +socket, the "local_address" is the local address and port number pair. +The "rem_address" is the remote address and port number pair +(if connected). +"St" is the internal status of the socket. +The "tx_queue" and "rx_queue" are the outgoing and incoming data queue +in terms of kernel memory usage. +The "tr", "tm\->when", and "rexmits" fields +are not used by UDP. +The "uid" +field holds the effective UID of the creator of the socket. +The format is: +.IP +.EX +sl local_address rem_address st tx_queue rx_queue tr rexmits tm\->when uid + 1: 01642C89:0201 0C642C89:03FF 01 00000000:00000001 01:000071BA 00000000 0 + 1: 00000000:0801 00000000:0000 0A 00000000:00000000 00:00000000 6F000100 0 + 1: 00000000:0201 00000000:0000 0A 00000000:00000000 00:00000000 00000000 0 +.EE +.TP +.I /proc/net/unix +Lists the UNIX domain sockets present within the system and their +status. +The format is: +.IP +.EX +Num RefCount Protocol Flags Type St Inode Path + 0: 00000002 00000000 00000000 0001 03 42 + 1: 00000001 00000000 00010000 0001 01 1948 /dev/printer +.EE +.IP +The fields are as follows: +.RS +.TP 10 +.IR Num : +the kernel table slot number. +.TP +.IR RefCount : +the number of users of the socket. +.TP +.IR Protocol : +currently always 0. +.TP +.IR Flags : +the internal kernel flags holding the status of the socket. +.TP +.IR Type : +the socket type. +For +.B SOCK_STREAM +sockets, this is 0001; for +.B SOCK_DGRAM +sockets, it is 0002; and for +.B SOCK_SEQPACKET +sockets, it is 0005. +.TP +.IR St : +the internal state of the socket. +.TP +.IR Inode : +the inode number of the socket. +.TP +.IR Path : +the bound pathname (if any) of the socket. +Sockets in the abstract namespace are included in the list, +and are shown with a +.I Path +that commences with the character '@'. +.RE +.TP +.I /proc/net/netfilter/nfnetlink_queue +This file contains information about netfilter user-space queueing, if used. +Each line represents a queue. +Queues that have not been subscribed to +by user space are not shown. +.IP +.in +4n +.EX + 1 4207 0 2 65535 0 0 0 1 + (1) (2) (3)(4) (5) (6) (7) (8) +.EE +.in +.IP +The fields in each line are: +.RS 7 +.TP 5 +(1) +The ID of the queue. +This matches what is specified in the +.B \-\-queue\-num +or +.B \-\-queue\-balance +options to the +.BR iptables (8) +NFQUEUE target. +See +.BR iptables\-extensions (8) +for more information. +.TP +(2) +The netlink port ID subscribed to the queue. +.TP +(3) +The number of packets currently queued and waiting to be processed by +the application. +.TP +(4) +The copy mode of the queue. +It is either 1 (metadata only) or 2 +(also copy payload data to user space). +.TP +(5) +Copy range; that is, how many bytes of packet payload should be copied to +user space at most. +.TP +(6) +queue dropped. +Number of packets that had to be dropped by the kernel because +too many packets are already waiting for user space to send back the mandatory +accept/drop verdicts. +.TP +(7) +queue user dropped. +Number of packets that were dropped within the netlink +subsystem. +Such drops usually happen when the corresponding socket buffer is +full; that is, user space is not able to read messages fast enough. +.TP +(8) +sequence number. +Every queued packet is associated with a (32-bit) +monotonically increasing sequence number. +This shows the ID of the most recent packet queued. +.RE +.IP +The last number exists only for compatibility reasons and is always 1. +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_pid_ns.5 b/upstream/opensuse-tumbleweed/man5/proc_pid_ns.5 new file mode 100644 index 00000000..954ea6fc --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_pid_ns.5 @@ -0,0 +1,20 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_pid_ns 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/pid/ns/ \- namespaces +.SH DESCRIPTION +.TP +.IR /proc/ pid /ns/ " (since Linux 3.0)" +.\" See commit 6b4e306aa3dc94a0545eb9279475b1ab6209a31f +This is a subdirectory containing one entry for each namespace that +supports being manipulated by +.BR setns (2). +For more information, see +.BR namespaces (7). +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_pid_numa_maps.5 b/upstream/opensuse-tumbleweed/man5/proc_pid_numa_maps.5 new file mode 100644 index 00000000..b1baafb1 --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_pid_numa_maps.5 @@ -0,0 +1,16 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_pid_numa_maps 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/pid/numa_maps \- NUMA memory policy and allocation +.SH DESCRIPTION +.TP +.IR /proc/ pid /numa_maps " (since Linux 2.6.14)" +See +.BR numa (7). +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_pid_oom_score.5 b/upstream/opensuse-tumbleweed/man5/proc_pid_oom_score.5 new file mode 100644 index 00000000..e187d28b --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_pid_oom_score.5 @@ -0,0 +1,58 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_pid_oom_score 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/pid/oom_score \- OOM-killer score +.SH DESCRIPTION +.TP +.IR /proc/ pid /oom_score " (since Linux 2.6.11)" +.\" See mm/oom_kill.c::badness() before Linux 2.6.36 sources +.\" See mm/oom_kill.c::oom_badness() after Linux 2.6.36 +.\" commit a63d83f427fbce97a6cea0db2e64b0eb8435cd10 +This file displays the current score that the kernel gives to +this process for the purpose of selecting a process +for the OOM-killer. +A higher score means that the process is more likely to be +selected by the OOM-killer. +The basis for this score is the amount of memory used by the process, +with increases (+) or decreases (\-) for factors including: +.\" See mm/oom_kill.c::badness() before Linux 2.6.36 sources +.\" See mm/oom_kill.c::oom_badness() after Linux 2.6.36 +.\" commit a63d83f427fbce97a6cea0db2e64b0eb8435cd10 +.RS +.IP \[bu] 3 +whether the process is privileged (\-). +.\" More precisely, if it has CAP_SYS_ADMIN or (pre 2.6.36) CAP_SYS_RESOURCE +.RE +.IP +Before Linux 2.6.36 +the following factors were also used in the calculation of oom_score: +.RS +.IP \[bu] 3 +whether the process creates a lot of children using +.BR fork (2) +(+); +.IP \[bu] +whether the process has been running a long time, +or has used a lot of CPU time (\-); +.IP \[bu] +whether the process has a low nice value (i.e., > 0) (+); and +.IP \[bu] +whether the process is making direct hardware access (\-). +.\" More precisely, if it has CAP_SYS_RAWIO +.RE +.IP +The +.I oom_score +also reflects the adjustment specified by the +.I oom_score_adj +or +.I oom_adj +setting for the process. +.SH SEE ALSO +.BR proc (5), +.BR proc_pid_oom_score_adj (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_pid_oom_score_adj.5 b/upstream/opensuse-tumbleweed/man5/proc_pid_oom_score_adj.5 new file mode 100644 index 00000000..82e4a66d --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_pid_oom_score_adj.5 @@ -0,0 +1,117 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_pid_oom_score_adj 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/pid/oom_score_adj \- OOM-killer score adjustment +.SH DESCRIPTION +.TP +.IR /proc/ pid /oom_score_adj " (since Linux 2.6.36)" +.\" Text taken from Linux 3.7 Documentation/filesystems/proc.txt +This file can be used to adjust the badness heuristic used to select which +process gets killed in out-of-memory conditions. +.IP +The badness heuristic assigns a value to each candidate task ranging from 0 +(never kill) to 1000 (always kill) to determine which process is targeted. +The units are roughly a proportion along that range of +allowed memory the process may allocate from, +based on an estimation of its current memory and swap use. +For example, if a task is using all allowed memory, +its badness score will be 1000. +If it is using half of its allowed memory, its score will be 500. +.IP +There is an additional factor included in the badness score: root +processes are given 3% extra memory over other tasks. +.IP +The amount of "allowed" memory depends on the context +in which the OOM-killer was called. +If it is due to the memory assigned to the allocating task's cpuset +being exhausted, +the allowed memory represents the set of mems assigned to that +cpuset (see +.BR cpuset (7)). +If it is due to a mempolicy's node(s) being exhausted, +the allowed memory represents the set of mempolicy nodes. +If it is due to a memory limit (or swap limit) being reached, +the allowed memory is that configured limit. +Finally, if it is due to the entire system being out of memory, the +allowed memory represents all allocatable resources. +.IP +The value of +.I oom_score_adj +is added to the badness score before it +is used to determine which task to kill. +Acceptable values range from \-1000 +(OOM_SCORE_ADJ_MIN) to +1000 (OOM_SCORE_ADJ_MAX). +This allows user space to control the preference for OOM-killing, +ranging from always preferring a certain +task or completely disabling it from OOM-killing. +The lowest possible value, \-1000, is +equivalent to disabling OOM-killing entirely for that task, +since it will always report a badness score of 0. +.IP +Consequently, it is very simple for user space to define +the amount of memory to consider for each task. +Setting an +.I oom_score_adj +value of +500, for example, +is roughly equivalent to allowing the remainder of tasks sharing the +same system, cpuset, mempolicy, or memory controller resources +to use at least 50% more memory. +A value of \-500, on the other hand, would be roughly +equivalent to discounting 50% of the task's +allowed memory from being considered as scoring against the task. +.IP +For backward compatibility with previous kernels, +.IR /proc/ pid /oom_adj +can still be used to tune the badness score. +Its value is +scaled linearly with +.IR oom_score_adj . +.IP +Writing to +.IR /proc/ pid /oom_score_adj +or +.IR /proc/ pid /oom_adj +will change the other with its scaled value. +.IP +The +.BR choom (1) +program provides a command-line interface for adjusting the +.I oom_score_adj +value of a running process or a newly executed command. +.SH HISTORY +.TP +.IR /proc/ pid /oom_adj " (since Linux 2.6.11)" +This file can be used to adjust the score used to select which process +should be killed in an out-of-memory (OOM) situation. +The kernel uses this value for a bit-shift operation of the process's +.I oom_score +value: +valid values are in the range \-16 to +15, +plus the special value \-17, +which disables OOM-killing altogether for this process. +A positive score increases the likelihood of this +process being killed by the OOM-killer; +a negative score decreases the likelihood. +.IP +The default value for this file is 0; +a new process inherits its parent's +.I oom_adj +setting. +A process must be privileged +.RB ( CAP_SYS_RESOURCE ) +to update this file, +although a process can always increase its own +.I oom_adj +setting (since Linux 2.6.20). +.IP +Since Linux 2.6.36, use of this file is deprecated in favor of +.IR /proc/ pid /oom_score_adj , +and finally removed in Linux 3.7. +.SH SEE ALSO +.BR proc (5), +.BR proc_pid_oom_score (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_pid_pagemap.5 b/upstream/opensuse-tumbleweed/man5/proc_pid_pagemap.5 new file mode 100644 index 00000000..87cb7e7e --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_pid_pagemap.5 @@ -0,0 +1,77 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_pid_pagemap 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/pid/pagemap \- mapping of virtual pages +.SH DESCRIPTION +.TP +.IR /proc/ pid /pagemap " (since Linux 2.6.25)" +This file shows the mapping of each of the process's virtual pages +into physical page frames or swap area. +It contains one 64-bit value for each virtual page, +with the bits set as follows: +.RS +.TP +63 +If set, the page is present in RAM. +.TP +62 +If set, the page is in swap space +.TP +61 (since Linux 3.5) +The page is a file-mapped page or a shared anonymous page. +.TP +60\[en]58 (since Linux 3.11) +Zero +.\" Not quite true; see commit 541c237c0923f567c9c4cabb8a81635baadc713f +.TP +57 (since Linux 5.14) +If set, the page is write-protected through +.BR userfaultfd (2). +.TP +56 (since Linux 4.2) +.\" commit 77bb499bb60f4b79cca7d139c8041662860fcf87 +.\" commit 83b4b0bb635eee2b8e075062e4e008d1bc110ed7 +The page is exclusively mapped. +.TP +55 (since Linux 3.11) +PTE is soft-dirty +(see the kernel source file +.IR Documentation/admin\-guide/mm/soft\-dirty.rst ). +.TP +54\[en]0 +If the page is present in RAM (bit 63), then these bits +provide the page frame number, which can be used to index +.I /proc/kpageflags +and +.IR /proc/kpagecount . +If the page is present in swap (bit 62), +then bits 4\[en]0 give the swap type, and bits 54\[en]5 encode the swap offset. +.RE +.IP +Before Linux 3.11, bits 60\[en]55 were +used to encode the base-2 log of the page size. +.IP +To employ +.IR /proc/ pid /pagemap +efficiently, use +.IR /proc/ pid /maps +to determine which areas of memory are actually mapped and seek +to skip over unmapped regions. +.IP +The +.IR /proc/ pid /pagemap +file is present only if the +.B CONFIG_PROC_PAGE_MONITOR +kernel configuration option is enabled. +.IP +Permission to access this file is governed by a ptrace access mode +.B PTRACE_MODE_READ_FSCREDS +check; see +.BR ptrace (2). +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_pid_personality.5 b/upstream/opensuse-tumbleweed/man5/proc_pid_personality.5 new file mode 100644 index 00000000..7e726889 --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_pid_personality.5 @@ -0,0 +1,23 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_pid_personality 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/pid/personality \- execution domain +.SH DESCRIPTION +.TP +.IR /proc/ pid /personality " (since Linux 2.6.28)" +.\" commit 478307230810d7e2a753ed220db9066dfdf88718 +This read-only file exposes the process's execution domain, as set by +.BR personality (2). +The value is displayed in hexadecimal notation. +.IP +Permission to access this file is governed by a ptrace access mode +.B PTRACE_MODE_ATTACH_FSCREDS +check; see +.BR ptrace (2). +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_pid_projid_map.5 b/upstream/opensuse-tumbleweed/man5/proc_pid_projid_map.5 new file mode 100644 index 00000000..d8dafcc6 --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_pid_projid_map.5 @@ -0,0 +1,17 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_pid_projid_map 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/pid/projid_map \- project ID mappings +.SH DESCRIPTION +.TP +.IR /proc/ pid /projid_map " (since Linux 3.7)" +.\" commit f76d207a66c3a53defea67e7d36c3eb1b7d6d61d +See +.BR user_namespaces (7). +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_pid_root.5 b/upstream/opensuse-tumbleweed/man5/proc_pid_root.5 new file mode 100644 index 00000000..84f361f6 --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_pid_root.5 @@ -0,0 +1,75 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_pid_root 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/pid/root/ \- symbolic link to root directory +.SH DESCRIPTION +.TP +.IR /proc/ pid /root/ +UNIX and Linux support the idea of a per-process root of the +filesystem, set by the +.BR chroot (2) +system call. +This file is a symbolic link that points to the process's +root directory, and behaves in the same way as +.IR exe , +and +.IR fd/* . +.IP +Note however that this file is not merely a symbolic link. +It provides the same view of the filesystem (including namespaces and the +set of per-process mounts) as the process itself. +An example illustrates this point. +In one terminal, we start a shell in new user and mount namespaces, +and in that shell we create some new mounts: +.IP +.in +4n +.EX +$ \fBPS1=\[aq]sh1# \[aq] unshare \-Urnm\fP +sh1# \fBmount \-t tmpfs tmpfs /etc\fP # Mount empty tmpfs at /etc +sh1# \fBmount \-\-bind /usr /dev\fP # Mount /usr at /dev +sh1# \fBecho $$\fP +27123 +.EE +.in +.IP +In a second terminal window, in the initial mount namespace, +we look at the contents of the corresponding mounts in +the initial and new namespaces: +.IP +.in +4n +.EX +$ \fBPS1=\[aq]sh2# \[aq] sudo sh\fP +sh2# \fBls /etc | wc \-l\fP # In initial NS +309 +sh2# \fBls /proc/27123/root/etc | wc \-l\fP # /etc in other NS +0 # The empty tmpfs dir +sh2# \fBls /dev | wc \-l\fP # In initial NS +205 +sh2# \fBls /proc/27123/root/dev | wc \-l\fP # /dev in other NS +11 # Actually bind + # mounted to /usr +sh2# \fBls /usr | wc \-l\fP # /usr in initial NS +11 +.EE +.in +.IP +.\" The following was still true as at kernel 2.6.13 +In a multithreaded process, the contents of the +.IR /proc/ pid /root +symbolic link are not available if the main thread has already terminated +(typically by calling +.BR pthread_exit (3)). +.IP +Permission to dereference or read +.RB ( readlink (2)) +this symbolic link is governed by a ptrace access mode +.B PTRACE_MODE_READ_FSCREDS +check; see +.BR ptrace (2). +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_pid_seccomp.5 b/upstream/opensuse-tumbleweed/man5/proc_pid_seccomp.5 new file mode 100644 index 00000000..08864b76 --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_pid_seccomp.5 @@ -0,0 +1,36 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_pid_seccomp 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/pid/seccomp \- secure computing mode +.SH DESCRIPTION +.TP +.IR /proc/ pid /seccomp " (Linux 2.6.12 to Linux 2.6.22)" +This file can be used to read and change the process's +secure computing (seccomp) mode setting. +It contains the value 0 if the process is not in seccomp mode, +and 1 if the process is in strict seccomp mode (see +.BR seccomp (2)). +Writing 1 to this file places the process irreversibly in strict seccomp mode. +(Further attempts to write to the file fail with the +.B EPERM +error.) +.IP +In Linux 2.6.23, +this file went away, to be replaced by the +.BR prctl (2) +.B PR_GET_SECCOMP +and +.B PR_SET_SECCOMP +operations (and later by +.BR seccomp (2) +and the +.I Seccomp +field in +.IR /proc/ pid /status ). +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_pid_setgroups.5 b/upstream/opensuse-tumbleweed/man5/proc_pid_setgroups.5 new file mode 100644 index 00000000..f912e428 --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_pid_setgroups.5 @@ -0,0 +1,16 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_pid_setgroups 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/pid/setgroups \- allow or deny setting groups +.SH DESCRIPTION +.TP +.IR /proc/ pid /setgroups " (since Linux 3.19)" +See +.BR user_namespaces (7). +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_pid_smaps.5 b/upstream/opensuse-tumbleweed/man5/proc_pid_smaps.5 new file mode 100644 index 00000000..0ebb543a --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_pid_smaps.5 @@ -0,0 +1,129 @@ +'\" t +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_pid_smaps 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/pid/smaps \- XXX: What does 's' in "smaps" stand for? +.SH DESCRIPTION +.TP +.IR /proc/ pid /smaps " (since Linux 2.6.14)" +This file shows memory consumption for each of the process's mappings. +(The +.BR pmap (1) +command displays similar information, +in a form that may be easier for parsing.) +For each mapping there is a series of lines such as the following: +.IP +.in +4n +.EX +00400000\-0048a000 r\-xp 00000000 fd:03 960637 /bin/bash +Size: 552 kB +Rss: 460 kB +Pss: 100 kB +Shared_Clean: 452 kB +Shared_Dirty: 0 kB +Private_Clean: 8 kB +Private_Dirty: 0 kB +Referenced: 460 kB +Anonymous: 0 kB +AnonHugePages: 0 kB +ShmemHugePages: 0 kB +ShmemPmdMapped: 0 kB +Swap: 0 kB +KernelPageSize: 4 kB +MMUPageSize: 4 kB +Locked: 0 kB +ProtectionKey: 0 +VmFlags: rd ex mr mw me dw +.EE +.in +.IP +The first of these lines shows the same information as is displayed +for the mapping in +.IR /proc/ pid /maps . +The following lines show the size of the mapping, +the amount of the mapping that is currently resident in RAM ("Rss"), +the process's proportional share of this mapping ("Pss"), +the number of clean and dirty shared pages in the mapping, +and the number of clean and dirty private pages in the mapping. +"Referenced" indicates the amount of memory currently marked as +referenced or accessed. +"Anonymous" shows the amount of memory +that does not belong to any file. +"Swap" shows how much +would-be-anonymous memory is also used, but out on swap. +.IP +The "KernelPageSize" line (available since Linux 2.6.29) +is the page size used by the kernel to back the virtual memory area. +This matches the size used by the MMU in the majority of cases. +However, one counter-example occurs on PPC64 kernels +whereby a kernel using 64 kB as a base page size may still use 4 kB +pages for the MMU on older processors. +To distinguish the two attributes, the "MMUPageSize" line +(also available since Linux 2.6.29) +reports the page size used by the MMU. +.IP +The "Locked" indicates whether the mapping is locked in memory +or not. +.IP +The "ProtectionKey" line (available since Linux 4.9, on x86 only) +contains the memory protection key (see +.BR pkeys (7)) +associated with the virtual memory area. +This entry is present only if the kernel was built with the +.B CONFIG_X86_INTEL_MEMORY_PROTECTION_KEYS +configuration option (since Linux 4.6). +.IP +The "VmFlags" line (available since Linux 3.8) +represents the kernel flags associated with the virtual memory area, +encoded using the following two-letter codes: +.RS +.IP +.TS +l l l. +rd - readable +wr - writable +ex - executable +sh - shared +mr - may read +mw - may write +me - may execute +ms - may share +gd - stack segment grows down +pf - pure PFN range +dw - disabled write to the mapped file +lo - pages are locked in memory +io - memory mapped I/O area +sr - sequential read advise provided +rr - random read advise provided +dc - do not copy area on fork +de - do not expand area on remapping +ac - area is accountable +nr - swap space is not reserved for the area +ht - area uses huge tlb pages +sf - perform synchronous page faults (since Linux 4.15) +nl - non-linear mapping (removed in Linux 4.0) +ar - architecture specific flag +wf - wipe on fork (since Linux 4.14) +dd - do not include area into core dump +sd - soft-dirty flag (since Linux 3.13) +mm - mixed map area +hg - huge page advise flag +nh - no-huge page advise flag +mg - mergeable advise flag +um - userfaultfd missing pages tracking (since Linux 4.3) +uw - userfaultfd wprotect pages tracking (since Linux 4.3) +.TE +.RE +.IP +The +.IR /proc/ pid /smaps +file is present only if the +.B CONFIG_PROC_PAGE_MONITOR +kernel configuration option is enabled. +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_pid_stack.5 b/upstream/opensuse-tumbleweed/man5/proc_pid_stack.5 new file mode 100644 index 00000000..75c6e7f7 --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_pid_stack.5 @@ -0,0 +1,25 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_pid_stack 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/pid/stack \- kernel stack +.SH DESCRIPTION +.TP +.IR /proc/ pid /stack " (since Linux 2.6.29)" +.\" 2ec220e27f5040aec1e88901c1b6ea3d135787ad +This file provides a symbolic trace of the function calls in this +process's kernel stack. +This file is provided only if the kernel was built with the +.B CONFIG_STACKTRACE +configuration option. +.IP +Permission to access this file is governed by a ptrace access mode +.B PTRACE_MODE_ATTACH_FSCREDS +check; see +.BR ptrace (2). +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_pid_stat.5 b/upstream/opensuse-tumbleweed/man5/proc_pid_stat.5 new file mode 100644 index 00000000..6cd29780 --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_pid_stat.5 @@ -0,0 +1,380 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_pid_stat 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/pid/stat \- status information +.SH DESCRIPTION +.TP +.IR /proc/ pid /stat +Status information about the process. +This is used by +.BR ps (1). +It is defined in the kernel source file +.IR fs/proc/array.c "." +.IP +The fields, in order, with their proper +.BR scanf (3) +format specifiers, are listed below. +Whether or not certain of these fields display valid information is governed by +a ptrace access mode +.BR PTRACE_MODE_READ_FSCREDS " | " PTRACE_MODE_NOAUDIT +check (refer to +.BR ptrace (2)). +If the check denies access, then the field value is displayed as 0. +The affected fields are indicated with the marking [PT]. +.RS +.TP +(1) \fIpid\fP \ %d +.br +The process ID. +.TP +(2) \fIcomm\fP \ %s +The filename of the executable, in parentheses. +Strings longer than +.B TASK_COMM_LEN +(16) characters (including the terminating null byte) are silently truncated. +This is visible whether or not the executable is swapped out. +.TP +(3) \fIstate\fP \ %c +One of the following characters, indicating process state: +.RS +.TP +R +Running +.TP +S +Sleeping in an interruptible wait +.TP +D +Waiting in uninterruptible +disk sleep +.TP +Z +Zombie +.TP +T +Stopped (on a signal) or (before Linux 2.6.33) trace stopped +.TP +t +.\" commit 44d90df6b757c59651ddd55f1a84f28132b50d29 +Tracing stop (Linux 2.6.33 onward) +.TP +W +Paging (only before Linux 2.6.0) +.TP +X +Dead (from Linux 2.6.0 onward) +.TP +x +.\" commit 44d90df6b757c59651ddd55f1a84f28132b50d29 +Dead (Linux 2.6.33 to +.\" commit 74e37200de8e9c4e09b70c21c3f13c2071e77457 +3.13 only) +.TP +K +.\" commit 44d90df6b757c59651ddd55f1a84f28132b50d29 +Wakekill (Linux 2.6.33 to +.\" commit 74e37200de8e9c4e09b70c21c3f13c2071e77457 +3.13 only) +.TP +W +.\" commit 44d90df6b757c59651ddd55f1a84f28132b50d29 +Waking (Linux 2.6.33 to +.\" commit 74e37200de8e9c4e09b70c21c3f13c2071e77457 +3.13 only) +.TP +P +.\" commit f2530dc71cf0822f90bb63ea4600caaef33a66bb +Parked (Linux 3.9 to +.\" commit 74e37200de8e9c4e09b70c21c3f13c2071e77457 +3.13 only) +.TP +I +.\" commit 06eb61844d841d0032a9950ce7f8e783ee49c0d0 +Idle (Linux 4.14 onward) +.RE +.TP +(4) \fIppid\fP \ %d +The PID of the parent of this process. +.TP +(5) \fIpgrp\fP \ %d +The process group ID of the process. +.TP +(6) \fIsession\fP \ %d +The session ID of the process. +.TP +(7) \fItty_nr\fP \ %d +The controlling terminal of the process. +(The minor device number is contained in the combination of bits +31 to 20 and 7 to 0; +the major device number is in bits 15 to 8.) +.TP +(8) \fItpgid\fP \ %d +.\" This field and following, up to and including wchan added 0.99.1 +The ID of the foreground process group of the controlling +terminal of the process. +.TP +(9) \fIflags\fP \ %u +The kernel flags word of the process. +For bit meanings, +see the PF_* defines in the Linux kernel source file +.IR include/linux/sched.h . +Details depend on the kernel version. +.IP +The format for this field was %lu before Linux 2.6. +.TP +(10) \fIminflt\fP \ %lu +The number of minor faults the process has made which have not +required loading a memory page from disk. +.TP +(11) \fIcminflt\fP \ %lu +The number of minor faults that the process's +waited-for children have made. +.TP +(12) \fImajflt\fP \ %lu +The number of major faults the process has made which have +required loading a memory page from disk. +.TP +(13) \fIcmajflt\fP \ %lu +The number of major faults that the process's +waited-for children have made. +.TP +(14) \fIutime\fP \ %lu +Amount of time that this process has been scheduled in user mode, +measured in clock ticks (divide by +.IR sysconf(_SC_CLK_TCK) ). +This includes guest time, \fIguest_time\fP +(time spent running a virtual CPU, see below), +so that applications that are not aware of the guest time field +do not lose that time from their calculations. +.TP +(15) \fIstime\fP \ %lu +Amount of time that this process has been scheduled in kernel mode, +measured in clock ticks (divide by +.IR sysconf(_SC_CLK_TCK) ). +.TP +(16) \fIcutime\fP \ %ld +Amount of time that this process's +waited-for children have been scheduled in user mode, +measured in clock ticks (divide by +.IR sysconf(_SC_CLK_TCK) ). +(See also +.BR times (2).) +This includes guest time, \fIcguest_time\fP +(time spent running a virtual CPU, see below). +.TP +(17) \fIcstime\fP \ %ld +Amount of time that this process's +waited-for children have been scheduled in kernel mode, +measured in clock ticks (divide by +.IR sysconf(_SC_CLK_TCK) ). +.TP +(18) \fIpriority\fP \ %ld +(Explanation for Linux 2.6) +For processes running a real-time scheduling policy +.RI ( policy +below; see +.BR sched_setscheduler (2)), +this is the negated scheduling priority, minus one; +that is, a number in the range \-2 to \-100, +corresponding to real-time priorities 1 to 99. +For processes running under a non-real-time scheduling policy, +this is the raw nice value +.RB ( setpriority (2)) +as represented in the kernel. +The kernel stores nice values as numbers +in the range 0 (high) to 39 (low), +corresponding to the user-visible nice range of \-20 to 19. +.IP +Before Linux 2.6, this was a scaled value based on +the scheduler weighting given to this process. +.\" And back in Linux 1.2 days things were different again. +.TP +(19) \fInice\fP \ %ld +The nice value (see +.BR setpriority (2)), +a value in the range 19 (low priority) to \-20 (high priority). +.\" Back in Linux 1.2 days things were different. +.\" .TP +.\" \fIcounter\fP %ld +.\" The current maximum size in jiffies of the process's next timeslice, +.\" or what is currently left of its current timeslice, if it is the +.\" currently running process. +.\" .TP +.\" \fItimeout\fP %u +.\" The time in jiffies of the process's next timeout. +.\" timeout was removed sometime around 2.1/2.2 +.TP +(20) \fInum_threads\fP \ %ld +Number of threads in this process (since Linux 2.6). +Before Linux 2.6, this field was hard coded to 0 as a placeholder +for an earlier removed field. +.TP +(21) \fIitrealvalue\fP \ %ld +The time in jiffies before the next +.B SIGALRM +is sent to the process due to an interval timer. +Since Linux 2.6.17, this field is no longer maintained, +and is hard coded as 0. +.TP +(22) \fIstarttime\fP \ %llu +The time the process started after system boot. +Before Linux 2.6, this value was expressed in jiffies. +Since Linux 2.6, the value is expressed in clock ticks (divide by +.IR sysconf(_SC_CLK_TCK) ). +.IP +The format for this field was %lu before Linux 2.6. +.TP +(23) \fIvsize\fP \ %lu +Virtual memory size in bytes. +.TP +(24) \fIrss\fP \ %ld +Resident Set Size: number of pages the process has in real memory. +This is just the pages which +count toward text, data, or stack space. +This does not include pages +which have not been demand-loaded in, or which are swapped out. +This value is inaccurate; see +.IR /proc/ pid /statm +below. +.TP +(25) \fIrsslim\fP \ %lu +Current soft limit in bytes on the rss of the process; +see the description of +.B RLIMIT_RSS +in +.BR getrlimit (2). +.TP +(26) \fIstartcode\fP \ %lu \ [PT] +The address above which program text can run. +.TP +(27) \fIendcode\fP \ %lu \ [PT] +The address below which program text can run. +.TP +(28) \fIstartstack\fP \ %lu \ [PT] +The address of the start (i.e., bottom) of the stack. +.TP +(29) \fIkstkesp\fP \ %lu \ [PT] +The current value of ESP (stack pointer), as found in the +kernel stack page for the process. +.TP +(30) \fIkstkeip\fP \ %lu \ [PT] +The current EIP (instruction pointer). +.TP +(31) \fIsignal\fP \ %lu +The bitmap of pending signals, displayed as a decimal number. +Obsolete, because it does not provide information on real-time signals; use +.IR /proc/ pid /status +instead. +.TP +(32) \fIblocked\fP \ %lu +The bitmap of blocked signals, displayed as a decimal number. +Obsolete, because it does not provide information on real-time signals; use +.IR /proc/ pid /status +instead. +.TP +(33) \fIsigignore\fP \ %lu +The bitmap of ignored signals, displayed as a decimal number. +Obsolete, because it does not provide information on real-time signals; use +.IR /proc/ pid /status +instead. +.TP +(34) \fIsigcatch\fP \ %lu +The bitmap of caught signals, displayed as a decimal number. +Obsolete, because it does not provide information on real-time signals; use +.IR /proc/ pid /status +instead. +.TP +(35) \fIwchan\fP \ %lu \ [PT] +This is the "channel" in which the process is waiting. +It is the address of a location in the kernel where the process is sleeping. +The corresponding symbolic name can be found in +.IR /proc/ pid /wchan . +.TP +(36) \fInswap\fP \ %lu +.\" nswap was added in Linux 2.0 +Number of pages swapped (not maintained). +.TP +(37) \fIcnswap\fP \ %lu +.\" cnswap was added in Linux 2.0 +Cumulative \fInswap\fP for child processes (not maintained). +.TP +(38) \fIexit_signal\fP \ %d \ (since Linux 2.1.22) +Signal to be sent to parent when we die. +.TP +(39) \fIprocessor\fP \ %d \ (since Linux 2.2.8) +CPU number last executed on. +.TP +(40) \fIrt_priority\fP \ %u \ (since Linux 2.5.19) +Real-time scheduling priority, a number in the range 1 to 99 for +processes scheduled under a real-time policy, +or 0, for non-real-time processes (see +.BR sched_setscheduler (2)). +.TP +(41) \fIpolicy\fP \ %u \ (since Linux 2.5.19) +Scheduling policy (see +.BR sched_setscheduler (2)). +Decode using the SCHED_* constants in +.IR linux/sched.h . +.IP +The format for this field was %lu before Linux 2.6.22. +.TP +(42) \fIdelayacct_blkio_ticks\fP \ %llu \ (since Linux 2.6.18) +Aggregated block I/O delays, measured in clock ticks (centiseconds). +.TP +(43) \fIguest_time\fP \ %lu \ (since Linux 2.6.24) +Guest time of the process (time spent running a virtual CPU +for a guest operating system), measured in clock ticks (divide by +.IR sysconf(_SC_CLK_TCK) ). +.TP +(44) \fIcguest_time\fP \ %ld \ (since Linux 2.6.24) +Guest time of the process's children, measured in clock ticks (divide by +.IR sysconf(_SC_CLK_TCK) ). +.TP +(45) \fIstart_data\fP \ %lu \ (since Linux 3.3) \ [PT] +.\" commit b3f7f573a20081910e34e99cbc91831f4f02f1ff +Address above which program initialized and +uninitialized (BSS) data are placed. +.TP +(46) \fIend_data\fP \ %lu \ (since Linux 3.3) \ [PT] +.\" commit b3f7f573a20081910e34e99cbc91831f4f02f1ff +Address below which program initialized and +uninitialized (BSS) data are placed. +.TP +(47) \fIstart_brk\fP \ %lu \ (since Linux 3.3) \ [PT] +.\" commit b3f7f573a20081910e34e99cbc91831f4f02f1ff +Address above which program heap can be expanded with +.BR brk (2). +.TP +(48) \fIarg_start\fP \ %lu \ (since Linux 3.5) \ [PT] +.\" commit 5b172087f99189416d5f47fd7ab5e6fb762a9ba3 +Address above which program command-line arguments +.RI ( argv ) +are placed. +.TP +(49) \fIarg_end\fP \ %lu \ (since Linux 3.5) \ [PT] +.\" commit 5b172087f99189416d5f47fd7ab5e6fb762a9ba3 +Address below program command-line arguments +.RI ( argv ) +are placed. +.TP +(50) \fIenv_start\fP \ %lu \ (since Linux 3.5) \ [PT] +.\" commit 5b172087f99189416d5f47fd7ab5e6fb762a9ba3 +Address above which program environment is placed. +.TP +(51) \fIenv_end\fP \ %lu \ (since Linux 3.5) \ [PT] +.\" commit 5b172087f99189416d5f47fd7ab5e6fb762a9ba3 +Address below which program environment is placed. +.TP +(52) \fIexit_code\fP \ %d \ (since Linux 3.5) \ [PT] +.\" commit 5b172087f99189416d5f47fd7ab5e6fb762a9ba3 +The thread's exit status in the form reported by +.BR waitpid (2). +.RE +.SH SEE ALSO +.BR proc (5), +.BR proc_pid_status (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_pid_statm.5 b/upstream/opensuse-tumbleweed/man5/proc_pid_statm.5 new file mode 100644 index 00000000..5aeb72cf --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_pid_statm.5 @@ -0,0 +1,46 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_pid_statm 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/pid/statm \- memory usage information +.SH DESCRIPTION +.TP +.IR /proc/ pid /statm +Provides information about memory usage, measured in pages. +The columns are: +.IP +.in +4n +.EX +size (1) total program size + (same as VmSize in \fI/proc/\fPpid\fI/status\fP) +resident (2) resident set size + (inaccurate; same as VmRSS in \fI/proc/\fPpid\fI/status\fP) +shared (3) number of resident shared pages + (i.e., backed by a file) + (inaccurate; same as RssFile+RssShmem in + \fI/proc/\fPpid\fI/status\fP) +text (4) text (code) +.\" (not including libs; broken, includes data segment) +lib (5) library (unused since Linux 2.6; always 0) +data (6) data + stack +.\" (including libs; broken, includes library text) +dt (7) dirty pages (unused since Linux 2.6; always 0) +.EE +.in +.IP +.\" See SPLIT_RSS_COUNTING in the kernel. +.\" Inaccuracy is bounded by TASK_RSS_EVENTS_THRESH. +Some of these values are inaccurate because +of a kernel-internal scalability optimization. +If accurate values are required, use +.IR /proc/ pid /smaps +or +.IR /proc/ pid /smaps_rollup +instead, which are much slower but provide accurate, detailed information. +.SH SEE ALSO +.BR proc (5), +.BR proc_pid_status (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_pid_status.5 b/upstream/opensuse-tumbleweed/man5/proc_pid_status.5 new file mode 100644 index 00000000..d9688a25 --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_pid_status.5 @@ -0,0 +1,384 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_pid_status 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/pid/status \- memory usage and status information +.SH DESCRIPTION +.TP +.IR /proc/ pid /status +Provides much of the information in +.IR /proc/ pid /stat +and +.IR /proc/ pid /statm +in a format that's easier for humans to parse. +Here's an example: +.IP +.in +4n +.EX +.RB "$" " cat /proc/$$/status" +Name: bash +Umask: 0022 +State: S (sleeping) +Tgid: 17248 +Ngid: 0 +Pid: 17248 +PPid: 17200 +TracerPid: 0 +Uid: 1000 1000 1000 1000 +Gid: 100 100 100 100 +FDSize: 256 +Groups: 16 33 100 +NStgid: 17248 +NSpid: 17248 +NSpgid: 17248 +NSsid: 17200 +VmPeak: 131168 kB +VmSize: 131168 kB +VmLck: 0 kB +VmPin: 0 kB +VmHWM: 13484 kB +VmRSS: 13484 kB +RssAnon: 10264 kB +RssFile: 3220 kB +RssShmem: 0 kB +VmData: 10332 kB +VmStk: 136 kB +VmExe: 992 kB +VmLib: 2104 kB +VmPTE: 76 kB +VmPMD: 12 kB +VmSwap: 0 kB +HugetlbPages: 0 kB # 4.4 +CoreDumping: 0 # 4.15 +Threads: 1 +SigQ: 0/3067 +SigPnd: 0000000000000000 +ShdPnd: 0000000000000000 +SigBlk: 0000000000010000 +SigIgn: 0000000000384004 +SigCgt: 000000004b813efb +CapInh: 0000000000000000 +CapPrm: 0000000000000000 +CapEff: 0000000000000000 +CapBnd: ffffffffffffffff +CapAmb: 0000000000000000 +NoNewPrivs: 0 +Seccomp: 0 +Seccomp_filters: 0 +Speculation_Store_Bypass: vulnerable +Cpus_allowed: 00000001 +Cpus_allowed_list: 0 +Mems_allowed: 1 +Mems_allowed_list: 0 +voluntary_ctxt_switches: 150 +nonvoluntary_ctxt_switches: 545 +.EE +.in +.IP +The fields are as follows: +.RS +.TP +.I Name +Command run by this process. +Strings longer than +.B TASK_COMM_LEN +(16) characters (including the terminating null byte) are silently truncated. +.TP +.I Umask +Process umask, expressed in octal with a leading zero; see +.BR umask (2). +(Since Linux 4.7.) +.TP +.I State +Current state of the process. +One of +"R (running)", +"S (sleeping)", +"D (disk sleep)", +"T (stopped)", +"t (tracing stop)", +"Z (zombie)", +or +"X (dead)". +.TP +.I Tgid +Thread group ID (i.e., Process ID). +.TP +.I Ngid +NUMA group ID (0 if none; since Linux 3.13). +.TP +.I Pid +Thread ID (see +.BR gettid (2)). +.TP +.I PPid +PID of parent process. +.TP +.I TracerPid +PID of process tracing this process (0 if not being traced). +.TP +.I Uid +.TQ +.I Gid +Real, effective, saved set, and filesystem UIDs (GIDs). +.TP +.I FDSize +Number of file descriptor slots currently allocated. +.TP +.I Groups +Supplementary group list. +.TP +.I NStgid +Thread group ID (i.e., PID) in each of the PID namespaces of which +.I pid +is a member. +The leftmost entry shows the value with respect to the PID namespace +of the process that mounted this procfs (or the root namespace +if mounted by the kernel), +followed by the value in successively nested inner namespaces. +.\" commit e4bc33245124db69b74a6d853ac76c2976f472d5 +(Since Linux 4.1.) +.TP +.I NSpid +Thread ID in each of the PID namespaces of which +.I pid +is a member. +The fields are ordered as for +.IR NStgid . +(Since Linux 4.1.) +.TP +.I NSpgid +Process group ID in each of the PID namespaces of which +.I pid +is a member. +The fields are ordered as for +.IR NStgid . +(Since Linux 4.1.) +.TP +.I NSsid +descendant namespace session ID hierarchy +Session ID in each of the PID namespaces of which +.I pid +is a member. +The fields are ordered as for +.IR NStgid . +(Since Linux 4.1.) +.TP +.I VmPeak +Peak virtual memory size. +.TP +.I VmSize +Virtual memory size. +.TP +.I VmLck +Locked memory size (see +.BR mlock (2)). +.TP +.I VmPin +Pinned memory size +.\" commit bc3e53f682d93df677dbd5006a404722b3adfe18 +(since Linux 3.2). +These are pages that can't be moved because something needs to +directly access physical memory. +.TP +.I VmHWM +Peak resident set size ("high water mark"). +This value is inaccurate; see +.IR /proc/ pid /statm +above. +.TP +.I VmRSS +Resident set size. +Note that the value here is the sum of +.IR RssAnon , +.IR RssFile , +and +.IR RssShmem . +This value is inaccurate; see +.IR /proc/ pid /statm +above. +.TP +.I RssAnon +Size of resident anonymous memory. +.\" commit bf9683d6990589390b5178dafe8fd06808869293 +(since Linux 4.5). +This value is inaccurate; see +.IR /proc/ pid /statm +above. +.TP +.I RssFile +Size of resident file mappings. +.\" commit bf9683d6990589390b5178dafe8fd06808869293 +(since Linux 4.5). +This value is inaccurate; see +.IR /proc/ pid /statm +above. +.TP +.I RssShmem +Size of resident shared memory (includes System V shared memory, +mappings from +.BR tmpfs (5), +and shared anonymous mappings). +.\" commit bf9683d6990589390b5178dafe8fd06808869293 +(since Linux 4.5). +.TP +.I VmData +.TQ +.I VmStk +.TQ +.I VmExe +Size of data, stack, and text segments. +This value is inaccurate; see +.IR /proc/ pid /statm +above. +.TP +.I VmLib +Shared library code size. +.TP +.I VmPTE +Page table entries size (since Linux 2.6.10). +.TP +.I VmPMD +.\" commit dc6c9a35b66b520cf67e05d8ca60ebecad3b0479 +Size of second-level page tables (added in Linux 4.0; removed in Linux 4.15). +.TP +.I VmSwap +.\" commit b084d4353ff99d824d3bc5a5c2c22c70b1fba722 +Swapped-out virtual memory size by anonymous private pages; +shmem swap usage is not included (since Linux 2.6.34). +This value is inaccurate; see +.IR /proc/ pid /statm +above. +.TP +.I HugetlbPages +Size of hugetlb memory portions +.\" commit 5d317b2b6536592a9b51fe65faed43d65ca9158e +(since Linux 4.4). +.TP +.I CoreDumping +Contains the value 1 if the process is currently dumping core, +and 0 if it is not +.\" commit c643401218be0f4ab3522e0c0a63016596d6e9ca +(since Linux 4.15). +This information can be used by a monitoring process to avoid killing +a process that is currently dumping core, +which could result in a corrupted core dump file. +.TP +.I Threads +Number of threads in process containing this thread. +.TP +.I SigQ +This field contains two slash-separated numbers that relate to +queued signals for the real user ID of this process. +The first of these is the number of currently queued +signals for this real user ID, and the second is the +resource limit on the number of queued signals for this process +(see the description of +.B RLIMIT_SIGPENDING +in +.BR getrlimit (2)). +.TP +.I SigPnd +.TQ +.I ShdPnd +Mask (expressed in hexadecimal) +of signals pending for thread and for process as a whole (see +.BR pthreads (7) +and +.BR signal (7)). +.TP +.I SigBlk +.TQ +.I SigIgn +.TQ +.I SigCgt +Masks (expressed in hexadecimal) +indicating signals being blocked, ignored, and caught (see +.BR signal (7)). +.TP +.I CapInh +.TQ +.I CapPrm +.TQ +.I CapEff +Masks (expressed in hexadecimal) +of capabilities enabled in inheritable, permitted, and effective sets +(see +.BR capabilities (7)). +.TP +.I CapBnd +Capability bounding set, expressed in hexadecimal +(since Linux 2.6.26, see +.BR capabilities (7)). +.TP +.I CapAmb +Ambient capability set, expressed in hexadecimal +(since Linux 4.3, see +.BR capabilities (7)). +.TP +.I NoNewPrivs +.\" commit af884cd4a5ae62fcf5e321fecf0ec1014730353d +Value of the +.I no_new_privs +bit +(since Linux 4.10, see +.BR prctl (2)). +.TP +.I Seccomp +.\" commit 2f4b3bf6b2318cfaa177ec5a802f4d8d6afbd816 +Seccomp mode of the process +(since Linux 3.8, see +.BR seccomp (2)). +0 means +.BR SECCOMP_MODE_DISABLED ; +1 means +.BR SECCOMP_MODE_STRICT ; +2 means +.BR SECCOMP_MODE_FILTER . +This field is provided only if the kernel was built with the +.B CONFIG_SECCOMP +kernel configuration option enabled. +.TP +.I Seccomp_filters +.\" commit c818c03b661cd769e035e41673d5543ba2ebda64 +Number of seccomp filters attached to the process +(since Linux 5.9, see +.BR seccomp (2)). +.TP +.I Speculation_Store_Bypass +.\" commit fae1fa0fc6cca8beee3ab8ed71d54f9a78fa3f64 +Speculation flaw mitigation state +(since Linux 4.17, see +.BR prctl (2)). +.TP +.I Cpus_allowed +Hexadecimal mask of CPUs on which this process may run +(since Linux 2.6.24, see +.BR cpuset (7)). +.TP +.I Cpus_allowed_list +Same as previous, but in "list format" +(since Linux 2.6.26, see +.BR cpuset (7)). +.TP +.I Mems_allowed +Mask of memory nodes allowed to this process +(since Linux 2.6.24, see +.BR cpuset (7)). +.TP +.I Mems_allowed_list +Same as previous, but in "list format" +(since Linux 2.6.26, see +.BR cpuset (7)). +.TP +.I voluntary_ctxt_switches +.TQ +.I nonvoluntary_ctxt_switches +Number of voluntary and involuntary context switches (since Linux 2.6.23). +.RE +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_pid_syscall.5 b/upstream/opensuse-tumbleweed/man5/proc_pid_syscall.5 new file mode 100644 index 00000000..21a464fa --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_pid_syscall.5 @@ -0,0 +1,33 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_pid_syscall 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/pid/syscall \- currently executed system call +.SH DESCRIPTION +.TP +.IR /proc/ pid /syscall " (since Linux 2.6.27)" +.\" commit ebcb67341fee34061430f3367f2e507e52ee051b +This file exposes the system call number and argument registers for the +system call currently being executed by the process, +followed by the values of the stack pointer and program counter registers. +The values of all six argument registers are exposed, +although most system calls use fewer registers. +.IP +If the process is blocked, but not in a system call, +then the file displays \-1 in place of the system call number, +followed by just the values of the stack pointer and program counter. +If process is not blocked, then the file contains just the string "running". +.IP +This file is present only if the kernel was configured with +.BR CONFIG_HAVE_ARCH_TRACEHOOK . +.IP +Permission to access this file is governed by a ptrace access mode +.B PTRACE_MODE_ATTACH_FSCREDS +check; see +.BR ptrace (2). +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_pid_task.5 b/upstream/opensuse-tumbleweed/man5/proc_pid_task.5 new file mode 100644 index 00000000..0a508769 --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_pid_task.5 @@ -0,0 +1,97 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_pid_task 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/pid/task/, /proc/tid/, /proc/thread\-self/ \- thread information +.SH DESCRIPTION +.TP +.IR /proc/ pid /task/ " (since Linux 2.6.0)" +.\" Precisely: Linux 2.6.0-test6 +This is a directory that contains one subdirectory +for each thread in the process. +The name of each subdirectory is the numerical thread ID +.RI ( tid ) +of the thread (see +.BR gettid (2)). +.IP +Within each of these subdirectories, there is a set of +files with the same names and contents as under the +.IR /proc/ pid +directories. +For attributes that are shared by all threads, the contents for +each of the files under the +.IR task/ tid +subdirectories will be the same as in the corresponding +file in the parent +.IR /proc/ pid +directory +(e.g., in a multithreaded process, all of the +.IR task/ tid /cwd +files will have the same value as the +.IR /proc/ pid /cwd +file in the parent directory, since all of the threads in a process +share a working directory). +For attributes that are distinct for each thread, +the corresponding files under +.IR task/ tid +may have different values (e.g., various fields in each of the +.IR task/ tid /status +files may be different for each thread), +.\" in particular: "children" :/ +or they might not exist in +.IR /proc/ pid +at all. +.IP +.\" The following was still true as at kernel 2.6.13 +In a multithreaded process, the contents of the +.IR /proc/ pid /task +directory are not available if the main thread has already terminated +(typically by calling +.BR pthread_exit (3)). +.TP +.IR /proc/ tid / +There is a numerical subdirectory for each running thread +that is not a thread group leader +(i.e., a thread whose thread ID is not the same as its process ID); +the subdirectory is named by the thread ID. +Each one of these subdirectories contains files and subdirectories +exposing information about the thread with the thread ID +.IR tid . +The contents of these directories are the same as the corresponding +.IR /proc/ pid /task/ tid +directories. +.IP +The +.IR /proc/ tid +subdirectories are +.I not +visible when iterating through +.I /proc +with +.BR getdents (2) +(and thus are +.I not +visible when one uses +.BR ls (1) +to view the contents of +.IR /proc ). +However, the pathnames of these directories are visible to +(i.e., usable as arguments in) +system calls that operate on pathnames. +.TP +.IR /proc/thread\-self/ " (since Linux 3.17)" +.\" commit 0097875bd41528922fb3bb5f348c53f17e00e2fd +This directory refers to the thread accessing the +.I /proc +filesystem, +and is identical to the +.IR /proc/self/task/ tid +directory named by the process thread ID +.RI ( tid ) +of the same thread. +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_pid_timers.5 b/upstream/opensuse-tumbleweed/man5/proc_pid_timers.5 new file mode 100644 index 00000000..fe996e29 --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_pid_timers.5 @@ -0,0 +1,82 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_pid_timers 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/pid/timers \- POSIX timers +.SH DESCRIPTION +.TP +.IR /proc/ pid /timers " (since Linux 3.10)" +.\" commit 5ed67f05f66c41e39880a6d61358438a25f9fee5 +.\" commit 48f6a7a511ef8823fdff39afee0320092d43a8a0 +A list of the POSIX timers for this process. +Each timer is listed with a line that starts with the string "ID:". +For example: +.IP +.in +4n +.EX +ID: 1 +signal: 60/00007fff86e452a8 +notify: signal/pid.2634 +ClockID: 0 +ID: 0 +signal: 60/00007fff86e452a8 +notify: signal/pid.2634 +ClockID: 1 +.EE +.in +.IP +The lines shown for each timer have the following meanings: +.RS +.TP +.I ID +The ID for this timer. +This is not the same as the timer ID returned by +.BR timer_create (2); +rather, it is the same kernel-internal ID that is available via the +.I si_timerid +field of the +.I siginfo_t +structure (see +.BR sigaction (2)). +.TP +.I signal +This is the signal number that this timer uses to deliver notifications +followed by a slash, and then the +.I sigev_value +value supplied to the signal handler. +Valid only for timers that notify via a signal. +.TP +.I notify +The part before the slash specifies the mechanism +that this timer uses to deliver notifications, +and is one of "thread", "signal", or "none". +Immediately following the slash is either the string "tid" for timers +with +.B SIGEV_THREAD_ID +notification, or "pid" for timers that notify by other mechanisms. +Following the "." is the PID of the process +(or the kernel thread ID of the thread) that will be delivered +a signal if the timer delivers notifications via a signal. +.TP +.I ClockID +This field identifies the clock that the timer uses for measuring time. +For most clocks, this is a number that matches one of the user-space +.B CLOCK_* +constants exposed via +.IR <time.h> . +.B CLOCK_PROCESS_CPUTIME_ID +timers display with a value of \-6 +in this field. +.B CLOCK_THREAD_CPUTIME_ID +timers display with a value of \-2 +in this field. +.RE +.IP +This file is available only when the kernel was configured with +.BR CONFIG_CHECKPOINT_RESTORE . +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_pid_timerslack_ns.5 b/upstream/opensuse-tumbleweed/man5/proc_pid_timerslack_ns.5 new file mode 100644 index 00000000..89df9f5a --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_pid_timerslack_ns.5 @@ -0,0 +1,41 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_pid_timerslack_ns 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/pid/timerslack_ns \- timer slack in nanoseconds +.SH DESCRIPTION +.TP +.IR /proc/ pid /timerslack_ns " (since Linux 4.6)" +.\" commit da8b44d5a9f8bf26da637b7336508ca534d6b319 +.\" commit 5de23d435e88996b1efe0e2cebe242074ce67c9e +This file exposes the process's "current" timer slack value, +expressed in nanoseconds. +The file is writable, +allowing the process's timer slack value to be changed. +Writing 0 to this file resets the "current" timer slack to the +"default" timer slack value. +For further details, see the discussion of +.B PR_SET_TIMERSLACK +in +.BR prctl (2). +.IP +Initially, +permission to access this file was governed by a ptrace access mode +.B PTRACE_MODE_ATTACH_FSCREDS +check (see +.BR ptrace (2)). +However, this was subsequently deemed too strict a requirement +(and had the side effect that requiring a process to have the +.B CAP_SYS_PTRACE +capability would also allow it to view and change any process's memory). +Therefore, since Linux 4.9, +.\" commit 7abbaf94049914f074306d960b0f968ffe52e59f +only the (weaker) +.B CAP_SYS_NICE +capability is required to access this file. +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_pid_uid_map.5 b/upstream/opensuse-tumbleweed/man5/proc_pid_uid_map.5 new file mode 100644 index 00000000..eecbf6a0 --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_pid_uid_map.5 @@ -0,0 +1,20 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_pid_uid_map 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/pid/gid_map, /proc/pid/uid_map \- user and group ID mappings +.SH DESCRIPTION +.TP +.IR /proc/ pid /gid_map " (since Linux 3.5)" +See +.BR user_namespaces (7). +.TP +.IR /proc/ pid /uid_map " (since Linux 3.5)" +See +.BR user_namespaces (7). +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_pid_wchan.5 b/upstream/opensuse-tumbleweed/man5/proc_pid_wchan.5 new file mode 100644 index 00000000..7b331b20 --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_pid_wchan.5 @@ -0,0 +1,21 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_pid_wchan 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/pid/wchan \- wait channel +.SH DESCRIPTION +.TP +.IR /proc/ pid /wchan " (since Linux 2.6.0)" +The symbolic name corresponding to the location +in the kernel where the process is sleeping. +.IP +Permission to access this file is governed by a ptrace access mode +.B PTRACE_MODE_READ_FSCREDS +check; see +.BR ptrace (2). +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_profile.5 b/upstream/opensuse-tumbleweed/man5/proc_profile.5 new file mode 100644 index 00000000..44adb24a --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_profile.5 @@ -0,0 +1,24 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_profile 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/profile \- kernel profiling +.SH DESCRIPTION +.TP +.IR /proc/profile " (since Linux 2.4)" +This file is present only if the kernel was booted with the +.I profile=1 +command-line option. +It exposes kernel profiling information in a binary format for use by +.BR readprofile (1). +Writing (e.g., an empty string) to this file resets the profiling counters; +on some architectures, +writing a binary integer "profiling multiplier" of size +.I sizeof(int) +sets the profiling interrupt frequency. +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_scsi.5 b/upstream/opensuse-tumbleweed/man5/proc_scsi.5 new file mode 100644 index 00000000..947c412d --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_scsi.5 @@ -0,0 +1,66 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) , Michael Neuffer <neuffer@mail.uni-mainz.de> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_scsi 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/scsi/ \- SCSI +.SH DESCRIPTION +.TP +.I /proc/scsi/ +A directory with the +.I scsi +mid-level pseudo-file and various SCSI low-level +driver directories, +which contain a file for each SCSI host in this system, all of +which give the status of some part of the SCSI IO subsystem. +These files contain ASCII structures and are, therefore, readable with +.BR cat (1). +.IP +You can also write to some of the files to reconfigure the subsystem or +switch certain features on or off. +.TP +.I /proc/scsi/scsi +This is a listing of all SCSI devices known to the kernel. +The listing is similar to the one seen during bootup. +scsi currently supports only the \fIadd\-single\-device\fP command which +allows root to add a hotplugged device to the list of known devices. +.IP +The command +.IP +.in +4n +.EX +echo \[aq]scsi add\-single\-device 1 0 5 0\[aq] > /proc/scsi/scsi +.EE +.in +.IP +will cause +host scsi1 to scan on SCSI channel 0 for a device on ID 5 LUN 0. +If there +is already a device known on this address or the address is invalid, an +error will be returned. +.TP +.IR /proc/scsi/ drivername / +\fIdrivername\fP can currently be NCR53c7xx, aha152x, aha1542, aha1740, +aic7xxx, buslogic, eata_dma, eata_pio, fdomain, in2000, pas16, qlogic, +scsi_debug, seagate, t128, u15\-24f, ultrastore, or wd7000. +These directories show up for all drivers that registered at least one +SCSI HBA. +Every directory contains one file per registered host. +Every host-file is named after the number the host was assigned during +initialization. +.IP +Reading these files will usually show driver and host configuration, +statistics, and so on. +.IP +Writing to these files allows different things on different hosts. +For example, with the \fIlatency\fP and \fInolatency\fP commands, +root can switch on and off command latency measurement code in the +eata_dma driver. +With the \fIlockup\fP and \fIunlock\fP commands, +root can control bus lockups simulated by the scsi_debug driver. +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_slabinfo.5 b/upstream/opensuse-tumbleweed/man5/proc_slabinfo.5 new file mode 100644 index 00000000..38b785d5 --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_slabinfo.5 @@ -0,0 +1,18 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_slabinfo 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/slabinfo \- kernel caches +.SH DESCRIPTION +.TP +.I /proc/slabinfo +Information about kernel caches. +See +.BR slabinfo (5) +for details. +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_stat.5 b/upstream/opensuse-tumbleweed/man5/proc_stat.5 new file mode 100644 index 00000000..3fe4c6fe --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_stat.5 @@ -0,0 +1,140 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_stat 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/stat \- kernel system statistics +.SH DESCRIPTION +.TP +.I /proc/stat +kernel/system statistics. +Varies with architecture. +Common +entries include: +.RS +.TP +.I cpu 10132153 290696 3084719 46828483 16683 0 25195 0 175628 0 +.TQ +.I cpu0 1393280 32966 572056 13343292 6130 0 17875 0 23933 0 +The amount of time, measured in units of +USER_HZ (1/100ths of a second on most architectures, use +.I sysconf(_SC_CLK_TCK) +to obtain the right value), +.\" 1024 on Alpha and ia64 +that the system ("cpu" line) or the specific CPU ("cpu\fIN\fR" line) +spent in various states: +.RS +.TP +.I user +(1) Time spent in user mode. +.TP +.I nice +(2) Time spent in user mode with low priority (nice). +.TP +.I system +(3) Time spent in system mode. +.TP +.I idle +(4) Time spent in the idle task. +.\" FIXME . Actually, the following info about the /proc/stat 'cpu' field +.\" does not seem to be quite right (at least in Linux 2.6.12 or Linux 3.6): +.\" the idle time in /proc/uptime does not quite match this value +This value should be USER_HZ times the +second entry in the +.I /proc/uptime +pseudo-file. +.TP +.IR iowait " (since Linux 2.5.41)" +(5) Time waiting for I/O to complete. +This value is not reliable, for the following reasons: +.\" See kernel commit 9c240d757658a3ae9968dd309e674c61f07c7f48 +.RS +.IP \[bu] 3 +The CPU will not wait for I/O to complete; +iowait is the time that a task is waiting for I/O to complete. +When a CPU goes into idle state for outstanding task I/O, +another task will be scheduled on this CPU. +.IP \[bu] +On a multi-core CPU, +the task waiting for I/O to complete is not running on any CPU, +so the iowait of each CPU is difficult to calculate. +.IP \[bu] +The value in this field may +.I decrease +in certain conditions. +.RE +.TP +.IR irq " (since Linux 2.6.0)" +.\" Precisely: Linux 2.6.0-test4 +(6) Time servicing interrupts. +.TP +.IR softirq " (since Linux 2.6.0)" +.\" Precisely: Linux 2.6.0-test4 +(7) Time servicing softirqs. +.TP +.IR steal " (since Linux 2.6.11)" +(8) Stolen time, which is the time spent in other operating systems when +running in a virtualized environment +.TP +.IR guest " (since Linux 2.6.24)" +(9) Time spent running a virtual CPU for guest +operating systems under the control of the Linux kernel. +.\" See Changelog entry for 5e84cfde51cf303d368fcb48f22059f37b3872de +.TP +.IR guest_nice " (since Linux 2.6.33)" +.\" commit ce0e7b28fb75cb003cfc8d0238613aaf1c55e797 +(10) Time spent running a niced guest (virtual CPU for guest +operating systems under the control of the Linux kernel). +.RE +.TP +\fIpage 5741 1808\fP +The number of pages the system paged in and the number that were paged +out (from disk). +.TP +\fIswap 1 0\fP +The number of swap pages that have been brought in and out. +.TP +.\" FIXME . The following is not the full picture for the 'intr' of +.\" /proc/stat on 2.6: +\fIintr 1462898\fP +This line shows counts of interrupts serviced since boot time, +for each of the possible system interrupts. +The first column is the total of all interrupts serviced +including unnumbered architecture specific interrupts; +each subsequent column is the total for that particular numbered interrupt. +Unnumbered interrupts are not shown, only summed into the total. +.TP +\fIdisk_io: (2,0):(31,30,5764,1,2) (3,0):\fP... +(major,disk_idx):(noinfo, read_io_ops, blks_read, write_io_ops, blks_written) +.br +(Linux 2.4 only) +.TP +\fIctxt 115315\fP +The number of context switches that the system underwent. +.TP +\fIbtime 769041601\fP +boot time, in seconds since the Epoch, 1970-01-01 00:00:00 +0000 (UTC). +.TP +\fIprocesses 86031\fP +Number of forks since boot. +.TP +\fIprocs_running 6\fP +Number of processes in runnable state. +(Linux 2.5.45 onward.) +.TP +\fIprocs_blocked 2\fP +Number of processes blocked waiting for I/O to complete. +(Linux 2.5.45 onward.) +.TP +.I softirq 229245889 94 60001584 13619 5175704 2471304 28 51212741 59130143 0 51240672 +.\" commit d3d64df21d3d0de675a0d3ffa7c10514f3644b30 +This line shows the number of softirq for all CPUs. +The first column is the total of all softirqs and +each subsequent column is the total for particular softirq. +(Linux 2.6.31 onward.) +.RE +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_swaps.5 b/upstream/opensuse-tumbleweed/man5/proc_swaps.5 new file mode 100644 index 00000000..356943c0 --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_swaps.5 @@ -0,0 +1,17 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_swaps 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/swaps \- swap areas +.SH DESCRIPTION +.TP +.I /proc/swaps +Swap areas in use. +See also +.BR swapon (8). +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_sys.5 b/upstream/opensuse-tumbleweed/man5/proc_sys.5 new file mode 100644 index 00000000..fc5713a8 --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_sys.5 @@ -0,0 +1,31 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) , Andries Brouwer <aeb@cwi.nl> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_sys 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/sys/ \- system information, and sysctl pseudo-filesystem +.SH DESCRIPTION +.TP +.I /proc/sys/ +This directory (present since Linux 1.3.57) contains a number of files +and subdirectories corresponding to kernel variables. +These variables can be read and in some cases modified using +the \fI/proc\fP filesystem, and the (deprecated) +.BR sysctl (2) +system call. +.IP +String values may be terminated by either \[aq]\e0\[aq] or \[aq]\en\[aq]. +.IP +Integer and long values may be written either in decimal or in +hexadecimal notation (e.g., 0x3FFF). +When writing multiple integer or long values, these may be separated +by any of the following whitespace characters: +\[aq]\ \[aq], \[aq]\et\[aq], or \[aq]\en\[aq]. +Using other separators leads to the error +.BR EINVAL . +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_sys_abi.5 b/upstream/opensuse-tumbleweed/man5/proc_sys_abi.5 new file mode 100644 index 00000000..5969ac51 --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_sys_abi.5 @@ -0,0 +1,24 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) , Andries Brouwer <aeb@cwi.nl> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_sys_abi 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/sys/abi/ \- application binary information +.SH DESCRIPTION +.TP +.IR /proc/sys/abi/ " (since Linux 2.4.10)" +This directory may contain files with application binary information. +.\" On some systems, it is not present. +See the Linux kernel source file +.I Documentation/sysctl/abi.rst +(or +.I Documentation/sysctl/abi.txt +before Linux 5.3) +for more information. +.SH SEE ALSO +.BR proc (5), +.BR proc_sys (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_sys_debug.5 b/upstream/opensuse-tumbleweed/man5/proc_sys_debug.5 new file mode 100644 index 00000000..0facf71d --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_sys_debug.5 @@ -0,0 +1,17 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) , Andries Brouwer <aeb@cwi.nl> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_sys_debug 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/sys/debug/ \- debug +.SH DESCRIPTION +.TP +.I /proc/sys/debug/ +This directory may be empty. +.SH SEE ALSO +.BR proc (5), +.BR proc_sys (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_sys_dev.5 b/upstream/opensuse-tumbleweed/man5/proc_sys_dev.5 new file mode 100644 index 00000000..7ff1b58f --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_sys_dev.5 @@ -0,0 +1,20 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) , Andries Brouwer <aeb@cwi.nl> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_sys_dev 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/sys/dev/ \- device-specific information +.SH DESCRIPTION +.TP +.I /proc/sys/dev/ +This directory contains device-specific information (e.g., +.IR dev/cdrom/info ). +On +some systems, it may be empty. +.SH SEE ALSO +.BR proc (5), +.BR proc_sys (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_sys_fs.5 b/upstream/opensuse-tumbleweed/man5/proc_sys_fs.5 new file mode 100644 index 00000000..2ffdeb42 --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_sys_fs.5 @@ -0,0 +1,471 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) , Andries Brouwer <aeb@cwi.nl> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_sys_fs 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/sys/fs/ \- kernel variables related to filesystems +.SH DESCRIPTION +.TP +.I /proc/sys/fs/ +This directory contains the files and subdirectories for kernel variables +related to filesystems. +.TP +.IR /proc/sys/fs/aio\-max\-nr " and " /proc/sys/fs/aio\-nr " (since Linux 2.6.4)" +.I aio\-nr +is the running total of the number of events specified by +.BR io_setup (2) +calls for all currently active AIO contexts. +If +.I aio\-nr +reaches +.IR aio\-max\-nr , +then +.BR io_setup (2) +will fail with the error +.BR EAGAIN . +Raising +.I aio\-max\-nr +does not result in the preallocation or resizing +of any kernel data structures. +.TP +.I /proc/sys/fs/binfmt_misc +Documentation for files in this directory can be found +in the Linux kernel source in the file +.I Documentation/admin\-guide/binfmt\-misc.rst +(or in +.I Documentation/binfmt_misc.txt +on older kernels). +.TP +.IR /proc/sys/fs/dentry\-state " (since Linux 2.2)" +This file contains information about the status of the +directory cache (dcache). +The file contains six numbers, +.IR nr_dentry , +.IR nr_unused , +.I age_limit +(age in seconds), +.I want_pages +(pages requested by system) and two dummy values. +.RS +.IP \[bu] 3 +.I nr_dentry +is the number of allocated dentries (dcache entries). +This field is unused in Linux 2.2. +.IP \[bu] +.I nr_unused +is the number of unused dentries. +.IP \[bu] +.I age_limit +.\" looks like this is unused in Linux 2.2 to Linux 2.6 +is the age in seconds after which dcache entries +can be reclaimed when memory is short. +.IP \[bu] +.I want_pages +.\" looks like this is unused in Linux 2.2 to Linux 2.6 +is nonzero when the kernel has called shrink_dcache_pages() and the +dcache isn't pruned yet. +.RE +.TP +.I /proc/sys/fs/dir\-notify\-enable +This file can be used to disable or enable the +.I dnotify +interface described in +.BR fcntl (2) +on a system-wide basis. +A value of 0 in this file disables the interface, +and a value of 1 enables it. +.TP +.I /proc/sys/fs/dquot\-max +This file shows the maximum number of cached disk quota entries. +On some (2.4) systems, it is not present. +If the number of free cached disk quota entries is very low and +you have some awesome number of simultaneous system users, +you might want to raise the limit. +.TP +.I /proc/sys/fs/dquot\-nr +This file shows the number of allocated disk quota +entries and the number of free disk quota entries. +.TP +.IR /proc/sys/fs/epoll/ " (since Linux 2.6.28)" +This directory contains the file +.IR max_user_watches , +which can be used to limit the amount of kernel memory consumed by the +.I epoll +interface. +For further details, see +.BR epoll (7). +.TP +.I /proc/sys/fs/file\-max +This file defines +a system-wide limit on the number of open files for all processes. +System calls that fail when encountering this limit fail with the error +.BR ENFILE . +(See also +.BR setrlimit (2), +which can be used by a process to set the per-process limit, +.BR RLIMIT_NOFILE , +on the number of files it may open.) +If you get lots +of error messages in the kernel log about running out of file handles +(open file descriptions) +(look for "VFS: file\-max limit <number> reached"), +try increasing this value: +.IP +.in +4n +.EX +echo 100000 > /proc/sys/fs/file\-max +.EE +.in +.IP +Privileged processes +.RB ( CAP_SYS_ADMIN ) +can override the +.I file\-max +limit. +.TP +.I /proc/sys/fs/file\-nr +This (read-only) file contains three numbers: +the number of allocated file handles +(i.e., the number of open file descriptions; see +.BR open (2)); +the number of free file handles; +and the maximum number of file handles (i.e., the same value as +.IR /proc/sys/fs/file\-max ). +If the number of allocated file handles is close to the +maximum, you should consider increasing the maximum. +Before Linux 2.6, +the kernel allocated file handles dynamically, +but it didn't free them again. +Instead the free file handles were kept in a list for reallocation; +the "free file handles" value indicates the size of that list. +A large number of free file handles indicates that there was +a past peak in the usage of open file handles. +Since Linux 2.6, the kernel does deallocate freed file handles, +and the "free file handles" value is always zero. +.TP +.IR /proc/sys/fs/inode\-max " (only present until Linux 2.2)" +This file contains the maximum number of in-memory inodes. +This value should be 3\[en]4 times larger +than the value in +.IR file\-max , +since \fIstdin\fP, \fIstdout\fP +and network sockets also need an inode to handle them. +When you regularly run out of inodes, you need to increase this value. +.IP +Starting with Linux 2.4, +there is no longer a static limit on the number of inodes, +and this file is removed. +.TP +.I /proc/sys/fs/inode\-nr +This file contains the first two values from +.IR inode\-state . +.TP +.I /proc/sys/fs/inode\-state +This file +contains seven numbers: +.IR nr_inodes , +.IR nr_free_inodes , +.IR preshrink , +and four dummy values (always zero). +.IP +.I nr_inodes +is the number of inodes the system has allocated. +.\" This can be slightly more than +.\" .I inode\-max +.\" because Linux allocates them one page full at a time. +.I nr_free_inodes +represents the number of free inodes. +.IP +.I preshrink +is nonzero when the +.I nr_inodes +> +.I inode\-max +and the system needs to prune the inode list instead of allocating more; +since Linux 2.4, this field is a dummy value (always zero). +.TP +.IR /proc/sys/fs/inotify/ " (since Linux 2.6.13)" +This directory contains files +.IR max_queued_events ", " max_user_instances ", and " max_user_watches , +that can be used to limit the amount of kernel memory consumed by the +.I inotify +interface. +For further details, see +.BR inotify (7). +.TP +.I /proc/sys/fs/lease\-break\-time +This file specifies the grace period that the kernel grants to a process +holding a file lease +.RB ( fcntl (2)) +after it has sent a signal to that process notifying it +that another process is waiting to open the file. +If the lease holder does not remove or downgrade the lease within +this grace period, the kernel forcibly breaks the lease. +.TP +.I /proc/sys/fs/leases\-enable +This file can be used to enable or disable file leases +.RB ( fcntl (2)) +on a system-wide basis. +If this file contains the value 0, leases are disabled. +A nonzero value enables leases. +.TP +.IR /proc/sys/fs/mount\-max " (since Linux 4.9)" +.\" commit d29216842a85c7970c536108e093963f02714498 +The value in this file specifies the maximum number of mounts that may exist +in a mount namespace. +The default value in this file is 100,000. +.TP +.IR /proc/sys/fs/mqueue/ " (since Linux 2.6.6)" +This directory contains files +.IR msg_max ", " msgsize_max ", and " queues_max , +controlling the resources used by POSIX message queues. +See +.BR mq_overview (7) +for details. +.TP +.IR /proc/sys/fs/nr_open " (since Linux 2.6.25)" +.\" commit 9cfe015aa424b3c003baba3841a60dd9b5ad319b +This file imposes a ceiling on the value to which the +.B RLIMIT_NOFILE +resource limit can be raised (see +.BR getrlimit (2)). +This ceiling is enforced for both unprivileged and privileged process. +The default value in this file is 1048576. +(Before Linux 2.6.25, the ceiling for +.B RLIMIT_NOFILE +was hard-coded to the same value.) +.TP +.IR /proc/sys/fs/overflowgid " and " /proc/sys/fs/overflowuid +These files +allow you to change the value of the fixed UID and GID. +The default is 65534. +Some filesystems support only 16-bit UIDs and GIDs, although in Linux +UIDs and GIDs are 32 bits. +When one of these filesystems is mounted +with writes enabled, any UID or GID that would exceed 65535 is translated +to the overflow value before being written to disk. +.TP +.IR /proc/sys/fs/pipe\-max\-size " (since Linux 2.6.35)" +See +.BR pipe (7). +.TP +.IR /proc/sys/fs/pipe\-user\-pages\-hard " (since Linux 4.5)" +See +.BR pipe (7). +.TP +.IR /proc/sys/fs/pipe\-user\-pages\-soft " (since Linux 4.5)" +See +.BR pipe (7). +.TP +.IR /proc/sys/fs/protected_fifos " (since Linux 4.19)" +The value in this file is/can be set to one of the following: +.RS +.TP 4 +0 +Writing to FIFOs is unrestricted. +.TP +1 +Don't allow +.B O_CREAT +.BR open (2) +on FIFOs that the caller doesn't own in world-writable sticky directories, +unless the FIFO is owned by the owner of the directory. +.TP +2 +As for the value 1, +but the restriction also applies to group-writable sticky directories. +.RE +.IP +The intent of the above protections is to avoid unintentional writes to an +attacker-controlled FIFO when a program expected to create a regular file. +.TP +.IR /proc/sys/fs/protected_hardlinks " (since Linux 3.6)" +.\" commit 800179c9b8a1e796e441674776d11cd4c05d61d7 +When the value in this file is 0, +no restrictions are placed on the creation of hard links +(i.e., this is the historical behavior before Linux 3.6). +When the value in this file is 1, +a hard link can be created to a target file +only if one of the following conditions is true: +.RS +.IP \[bu] 3 +The calling process has the +.B CAP_FOWNER +capability in its user namespace +and the file UID has a mapping in the namespace. +.IP \[bu] +The filesystem UID of the process creating the link matches +the owner (UID) of the target file +(as described in +.BR credentials (7), +a process's filesystem UID is normally the same as its effective UID). +.IP \[bu] +All of the following conditions are true: +.RS 4 +.IP \[bu] 3 +the target is a regular file; +.IP \[bu] +the target file does not have its set-user-ID mode bit enabled; +.IP \[bu] +the target file does not have both its set-group-ID and +group-executable mode bits enabled; and +.IP \[bu] +the caller has permission to read and write the target file +(either via the file's permissions mask or because it has +suitable capabilities). +.RE +.RE +.IP +The default value in this file is 0. +Setting the value to 1 +prevents a longstanding class of security issues caused by +hard-link-based time-of-check, time-of-use races, +most commonly seen in world-writable directories such as +.IR /tmp . +The common method of exploiting this flaw +is to cross privilege boundaries when following a given hard link +(i.e., a root process follows a hard link created by another user). +Additionally, on systems without separated partitions, +this stops unauthorized users from "pinning" vulnerable set-user-ID and +set-group-ID files against being upgraded by +the administrator, or linking to special files. +.TP +.IR /proc/sys/fs/protected_regular " (since Linux 4.19)" +The value in this file is/can be set to one of the following: +.RS +.TP 4 +0 +Writing to regular files is unrestricted. +.TP +1 +Don't allow +.B O_CREAT +.BR open (2) +on regular files that the caller doesn't own in +world-writable sticky directories, +unless the regular file is owned by the owner of the directory. +.TP +2 +As for the value 1, +but the restriction also applies to group-writable sticky directories. +.RE +.IP +The intent of the above protections is similar to +.IR protected_fifos , +but allows an application to +avoid writes to an attacker-controlled regular file, +where the application expected to create one. +.TP +.IR /proc/sys/fs/protected_symlinks " (since Linux 3.6)" +.\" commit 800179c9b8a1e796e441674776d11cd4c05d61d7 +When the value in this file is 0, +no restrictions are placed on following symbolic links +(i.e., this is the historical behavior before Linux 3.6). +When the value in this file is 1, symbolic links are followed only +in the following circumstances: +.RS +.IP \[bu] 3 +the filesystem UID of the process following the link matches +the owner (UID) of the symbolic link +(as described in +.BR credentials (7), +a process's filesystem UID is normally the same as its effective UID); +.IP \[bu] +the link is not in a sticky world-writable directory; or +.IP \[bu] +the symbolic link and its parent directory have the same owner (UID) +.RE +.IP +A system call that fails to follow a symbolic link +because of the above restrictions returns the error +.B EACCES +in +.IR errno . +.IP +The default value in this file is 0. +Setting the value to 1 avoids a longstanding class of security issues +based on time-of-check, time-of-use races when accessing symbolic links. +.TP +.IR /proc/sys/fs/suid_dumpable " (since Linux 2.6.13)" +.\" The following is based on text from Documentation/sysctl/kernel.txt +The value in this file is assigned to a process's "dumpable" flag +in the circumstances described in +.BR prctl (2). +In effect, +the value in this file determines whether core dump files are +produced for set-user-ID or otherwise protected/tainted binaries. +The "dumpable" setting also affects the ownership of files in a process's +.IR /proc/ pid +directory, as described above. +.IP +Three different integer values can be specified: +.RS +.TP +\fI0\ (default)\fP +.\" In kernel source: SUID_DUMP_DISABLE +This provides the traditional (pre-Linux 2.6.13) behavior. +A core dump will not be produced for a process which has +changed credentials (by calling +.BR seteuid (2), +.BR setgid (2), +or similar, or by executing a set-user-ID or set-group-ID program) +or whose binary does not have read permission enabled. +.TP +\fI1\ ("debug")\fP +.\" In kernel source: SUID_DUMP_USER +All processes dump core when possible. +(Reasons why a process might nevertheless not dump core are described in +.BR core (5).) +The core dump is owned by the filesystem user ID of the dumping process +and no security is applied. +This is intended for system debugging situations only: +this mode is insecure because it allows unprivileged users to +examine the memory contents of privileged processes. +.TP +\fI2\ ("suidsafe")\fP +.\" In kernel source: SUID_DUMP_ROOT +Any binary which normally would not be dumped (see "0" above) +is dumped readable by root only. +This allows the user to remove the core dump file but not to read it. +For security reasons core dumps in this mode will not overwrite one +another or other files. +This mode is appropriate when administrators are +attempting to debug problems in a normal environment. +.IP +Additionally, since Linux 3.6, +.\" 9520628e8ceb69fa9a4aee6b57f22675d9e1b709 +.I /proc/sys/kernel/core_pattern +must either be an absolute pathname +or a pipe command, as detailed in +.BR core (5). +Warnings will be written to the kernel log if +.I core_pattern +does not follow these rules, and no core dump will be produced. +.\" 54b501992dd2a839e94e76aa392c392b55080ce8 +.RE +.IP +For details of the effect of a process's "dumpable" setting +on ptrace access mode checking, see +.BR ptrace (2). +.TP +.I /proc/sys/fs/super\-max +This file +controls the maximum number of superblocks, and +thus the maximum number of mounted filesystems the kernel +can have. +You need increase only +.I super\-max +if you need to mount more filesystems than the current value in +.I super\-max +allows you to. +.TP +.I /proc/sys/fs/super\-nr +This file +contains the number of filesystems currently mounted. +.SH SEE ALSO +.BR proc (5), +.BR proc_sys (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_sys_kernel.5 b/upstream/opensuse-tumbleweed/man5/proc_sys_kernel.5 new file mode 100644 index 00000000..a01964da --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_sys_kernel.5 @@ -0,0 +1,691 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) , Andries Brouwer <aeb@cwi.nl> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_sys_kernel 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/sys/kernel/ \- control a range of kernel parameters +.SH DESCRIPTION +.TP +.I /proc/sys/kernel/ +This directory contains files controlling a range of kernel parameters, +as described below. +.TP +.I /proc/sys/kernel/acct +This file +contains three numbers: +.IR highwater , +.IR lowwater , +and +.IR frequency . +If BSD-style process accounting is enabled, these values control +its behavior. +If free space on filesystem where the log lives goes below +.I lowwater +percent, accounting suspends. +If free space gets above +.I highwater +percent, accounting resumes. +.I frequency +determines +how often the kernel checks the amount of free space (value is in +seconds). +Default values are 4, 2, and 30. +That is, suspend accounting if 2% or less space is free; resume it +if 4% or more space is free; consider information about amount of free space +valid for 30 seconds. +.TP +.IR /proc/sys/kernel/auto_msgmni " (Linux 2.6.27 to Linux 3.18)" +.\" commit 9eefe520c814f6f62c5d36a2ddcd3fb99dfdb30e (introduces feature) +.\" commit 0050ee059f7fc86b1df2527aaa14ed5dc72f9973 (rendered redundant) +From Linux 2.6.27 to Linux 3.18, +this file was used to control recomputing of the value in +.I /proc/sys/kernel/msgmni +upon the addition or removal of memory or upon IPC namespace creation/removal. +Echoing "1" into this file enabled +.I msgmni +automatic recomputing (and triggered a recomputation of +.I msgmni +based on the current amount of available memory and number of IPC namespaces). +Echoing "0" disabled automatic recomputing. +(Automatic recomputing was also disabled if a value was explicitly assigned to +.IR /proc/sys/kernel/msgmni .) +The default value in +.I auto_msgmni +was 1. +.IP +Since Linux 3.19, the content of this file has no effect (because +.I msgmni +.\" FIXME Must document the 3.19 'msgmni' changes. +defaults to near the maximum value possible), +and reads from this file always return the value "0". +.TP +.IR /proc/sys/kernel/cap_last_cap " (since Linux 3.2)" +See +.BR capabilities (7). +.TP +.IR /proc/sys/kernel/cap\-bound " (from Linux 2.2 to Linux 2.6.24)" +This file holds the value of the kernel +.I "capability bounding set" +(expressed as a signed decimal number). +This set is ANDed against the capabilities permitted to a process +during +.BR execve (2). +Starting with Linux 2.6.25, +the system-wide capability bounding set disappeared, +and was replaced by a per-thread bounding set; see +.BR capabilities (7). +.TP +.I /proc/sys/kernel/core_pattern +See +.BR core (5). +.TP +.I /proc/sys/kernel/core_pipe_limit +See +.BR core (5). +.TP +.I /proc/sys/kernel/core_uses_pid +See +.BR core (5). +.TP +.I /proc/sys/kernel/ctrl\-alt\-del +This file +controls the handling of Ctrl-Alt-Del from the keyboard. +When the value in this file is 0, Ctrl-Alt-Del is trapped and +sent to the +.BR init (1) +program to handle a graceful restart. +When the value is greater than zero, Linux's reaction to a Vulcan +Nerve Pinch (tm) will be an immediate reboot, without even +syncing its dirty buffers. +Note: when a program (like dosemu) has the keyboard in "raw" +mode, the Ctrl-Alt-Del is intercepted by the program before it +ever reaches the kernel tty layer, and it's up to the program +to decide what to do with it. +.TP +.IR /proc/sys/kernel/dmesg_restrict " (since Linux 2.6.37)" +The value in this file determines who can see kernel syslog contents. +A value of 0 in this file imposes no restrictions. +If the value is 1, only privileged users can read the kernel syslog. +(See +.BR syslog (2) +for more details.) +Since Linux 3.4, +.\" commit 620f6e8e855d6d447688a5f67a4e176944a084e8 +only users with the +.B CAP_SYS_ADMIN +capability may change the value in this file. +.TP +.IR /proc/sys/kernel/domainname " and " /proc/sys/kernel/hostname +can be used to set the NIS/YP domainname and the +hostname of your box in exactly the same way as the commands +.BR domainname (1) +and +.BR hostname (1), +that is: +.IP +.in +4n +.EX +.RB "#" " echo \[aq]darkstar\[aq] > /proc/sys/kernel/hostname" +.RB "#" " echo \[aq]mydomain\[aq] > /proc/sys/kernel/domainname" +.EE +.in +.IP +has the same effect as +.IP +.in +4n +.EX +.RB "#" " hostname \[aq]darkstar\[aq]" +.RB "#" " domainname \[aq]mydomain\[aq]" +.EE +.in +.IP +Note, however, that the classic darkstar.frop.org has the +hostname "darkstar" and DNS (Internet Domain Name Server) +domainname "frop.org", not to be confused with the NIS (Network +Information Service) or YP (Yellow Pages) domainname. +These two +domain names are in general different. +For a detailed discussion +see the +.BR hostname (1) +man page. +.TP +.I /proc/sys/kernel/hotplug +This file +contains the pathname for the hotplug policy agent. +The default value in this file is +.IR /sbin/hotplug . +.TP +.\" Removed in commit 87f504e5c78b910b0c1d6ffb89bc95e492322c84 (tglx/history.git) +.IR /proc/sys/kernel/htab\-reclaim " (before Linux 2.4.9.2)" +(PowerPC only) If this file is set to a nonzero value, +the PowerPC htab +.\" removed in commit 1b483a6a7b2998e9c98ad985d7494b9b725bd228, before Linux 2.6.28 +(see kernel file +.IR Documentation/powerpc/ppc_htab.txt ) +is pruned +each time the system hits the idle loop. +.TP +.I /proc/sys/kernel/keys/ +This directory contains various files that define parameters and limits +for the key-management facility. +These files are described in +.BR keyrings (7). +.TP +.IR /proc/sys/kernel/kptr_restrict " (since Linux 2.6.38)" +.\" 455cd5ab305c90ffc422dd2e0fb634730942b257 +The value in this file determines whether kernel addresses are exposed via +.I /proc +files and other interfaces. +A value of 0 in this file imposes no restrictions. +If the value is 1, kernel pointers printed using the +.I %pK +format specifier will be replaced with zeros unless the user has the +.B CAP_SYSLOG +capability. +If the value is 2, kernel pointers printed using the +.I %pK +format specifier will be replaced with zeros regardless +of the user's capabilities. +The initial default value for this file was 1, +but the default was changed +.\" commit 411f05f123cbd7f8aa1edcae86970755a6e2a9d9 +to 0 in Linux 2.6.39. +Since Linux 3.4, +.\" commit 620f6e8e855d6d447688a5f67a4e176944a084e8 +only users with the +.B CAP_SYS_ADMIN +capability can change the value in this file. +.TP +.I /proc/sys/kernel/l2cr +(PowerPC only) This file +contains a flag that controls the L2 cache of G3 processor +boards. +If 0, the cache is disabled. +Enabled if nonzero. +.TP +.I /proc/sys/kernel/modprobe +This file contains the pathname for the kernel module loader. +The default value is +.IR /sbin/modprobe . +The file is present only if the kernel is built with the +.B CONFIG_MODULES +.RB ( CONFIG_KMOD +in Linux 2.6.26 and earlier) +option enabled. +It is described by the Linux kernel source file +.I Documentation/kmod.txt +(present only in Linux 2.4 and earlier). +.TP +.IR /proc/sys/kernel/modules_disabled " (since Linux 2.6.31)" +.\" 3d43321b7015387cfebbe26436d0e9d299162ea1 +.\" From Documentation/sysctl/kernel.txt +A toggle value indicating if modules are allowed to be loaded +in an otherwise modular kernel. +This toggle defaults to off (0), but can be set true (1). +Once true, modules can be neither loaded nor unloaded, +and the toggle cannot be set back to false. +The file is present only if the kernel is built with the +.B CONFIG_MODULES +option enabled. +.TP +.IR /proc/sys/kernel/msgmax " (since Linux 2.2)" +This file defines +a system-wide limit specifying the maximum number of bytes in +a single message written on a System V message queue. +.TP +.IR /proc/sys/kernel/msgmni " (since Linux 2.4)" +This file defines the system-wide limit on the number of +message queue identifiers. +See also +.IR /proc/sys/kernel/auto_msgmni . +.TP +.IR /proc/sys/kernel/msgmnb " (since Linux 2.2)" +This file defines a system-wide parameter used to initialize the +.I msg_qbytes +setting for subsequently created message queues. +The +.I msg_qbytes +setting specifies the maximum number of bytes that may be written to the +message queue. +.TP +.IR /proc/sys/kernel/ngroups_max " (since Linux 2.6.4)" +This is a read-only file that displays the upper limit on the +number of a process's group memberships. +.TP +.IR /proc/sys/kernel/ns_last_pid " (since Linux 3.3)" +See +.BR pid_namespaces (7). +.TP +.IR /proc/sys/kernel/ostype " and " /proc/sys/kernel/osrelease +These files +give substrings of +.IR /proc/version . +.TP +.IR /proc/sys/kernel/overflowgid " and " /proc/sys/kernel/overflowuid +These files duplicate the files +.I /proc/sys/fs/overflowgid +and +.IR /proc/sys/fs/overflowuid . +.TP +.I /proc/sys/kernel/panic +This file gives read/write access to the kernel variable +.IR panic_timeout . +If this is zero, the kernel will loop on a panic; if nonzero, +it indicates that the kernel should autoreboot after this number +of seconds. +When you use the +software watchdog device driver, the recommended setting is 60. +.TP +.IR /proc/sys/kernel/panic_on_oops " (since Linux 2.5.68)" +This file controls the kernel's behavior when an oops +or BUG is encountered. +If this file contains 0, then the system +tries to continue operation. +If it contains 1, then the system +delays a few seconds (to give klogd time to record the oops output) +and then panics. +If the +.I /proc/sys/kernel/panic +file is also nonzero, then the machine will be rebooted. +.TP +.IR /proc/sys/kernel/pid_max " (since Linux 2.5.34)" +This file specifies the value at which PIDs wrap around +(i.e., the value in this file is one greater than the maximum PID). +PIDs greater than this value are not allocated; +thus, the value in this file also acts as a system-wide limit +on the total number of processes and threads. +The default value for this file, 32768, +results in the same range of PIDs as on earlier kernels. +On 32-bit platforms, 32768 is the maximum value for +.IR pid_max . +On 64-bit systems, +.I pid_max +can be set to any value up to 2\[ha]22 +.RB ( PID_MAX_LIMIT , +approximately 4 million). +.\" Prior to Linux 2.6.10, pid_max could also be raised above 32768 on 32-bit +.\" platforms, but this broke /proc/[pid] +.\" See http://marc.theaimsgroup.com/?l=linux-kernel&m=109513010926152&w=2 +.TP +.IR /proc/sys/kernel/powersave\-nap " (PowerPC only)" +This file contains a flag. +If set, Linux-PPC will use the "nap" mode of +powersaving, +otherwise the "doze" mode will be used. +.TP +.I /proc/sys/kernel/printk +See +.BR syslog (2). +.TP +.IR /proc/sys/kernel/pty " (since Linux 2.6.4)" +This directory contains two files relating to the number of UNIX 98 +pseudoterminals (see +.BR pts (4)) +on the system. +.TP +.I /proc/sys/kernel/pty/max +This file defines the maximum number of pseudoterminals. +.\" FIXME Document /proc/sys/kernel/pty/reserve +.\" New in Linux 3.3 +.\" commit e9aba5158a80098447ff207a452a3418ae7ee386 +.TP +.I /proc/sys/kernel/pty/nr +This read-only file +indicates how many pseudoterminals are currently in use. +.TP +.I /proc/sys/kernel/random/ +This directory +contains various parameters controlling the operation of the file +.IR /dev/random . +See +.BR random (4) +for further information. +.TP +.IR /proc/sys/kernel/random/uuid " (since Linux 2.4)" +Each read from this read-only file returns a randomly generated 128-bit UUID, +as a string in the standard UUID format. +.TP +.IR /proc/sys/kernel/randomize_va_space " (since Linux 2.6.12)" +.\" Some further details can be found in Documentation/sysctl/kernel.txt +Select the address space layout randomization (ASLR) policy for the system +(on architectures that support ASLR). +Three values are supported for this file: +.RS +.TP +.B 0 +Turn ASLR off. +This is the default for architectures that don't support ASLR, +and when the kernel is booted with the +.I norandmaps +parameter. +.TP +.B 1 +Make the addresses of +.BR mmap (2) +allocations, the stack, and the VDSO page randomized. +Among other things, this means that shared libraries will be +loaded at randomized addresses. +The text segment of PIE-linked binaries will also be loaded +at a randomized address. +This value is the default if the kernel was configured with +.BR CONFIG_COMPAT_BRK . +.TP +.B 2 +(Since Linux 2.6.25) +.\" commit c1d171a002942ea2d93b4fbd0c9583c56fce0772 +Also support heap randomization. +This value is the default if the kernel was not configured with +.BR CONFIG_COMPAT_BRK . +.RE +.TP +.I /proc/sys/kernel/real\-root\-dev +This file is documented in the Linux kernel source file +.I Documentation/admin\-guide/initrd.rst +.\" commit 9d85025b0418163fae079c9ba8f8445212de8568 +(or +.I Documentation/initrd.txt +before Linux 4.10). +.TP +.IR /proc/sys/kernel/reboot\-cmd " (Sparc only)" +This file seems to be a way to give an argument to the SPARC +ROM/Flash boot loader. +Maybe to tell it what to do after +rebooting? +.TP +.I /proc/sys/kernel/rtsig\-max +(Up to and including Linux 2.6.7; see +.BR setrlimit (2)) +This file can be used to tune the maximum number +of POSIX real-time (queued) signals that can be outstanding +in the system. +.TP +.I /proc/sys/kernel/rtsig\-nr +(Up to and including Linux 2.6.7.) +This file shows the number of POSIX real-time signals currently queued. +.TP +.IR /proc/ pid /sched_autogroup_enabled " (since Linux 2.6.38)" +.\" commit 5091faa449ee0b7d73bc296a93bca9540fc51d0a +See +.BR sched (7). +.TP +.IR /proc/sys/kernel/sched_child_runs_first " (since Linux 2.6.23)" +If this file contains the value zero, then, after a +.BR fork (2), +the parent is first scheduled on the CPU. +If the file contains a nonzero value, +then the child is scheduled first on the CPU. +(Of course, on a multiprocessor system, +the parent and the child might both immediately be scheduled on a CPU.) +.TP +.IR /proc/sys/kernel/sched_rr_timeslice_ms " (since Linux 3.9)" +See +.BR sched_rr_get_interval (2). +.TP +.IR /proc/sys/kernel/sched_rt_period_us " (since Linux 2.6.25)" +See +.BR sched (7). +.TP +.IR /proc/sys/kernel/sched_rt_runtime_us " (since Linux 2.6.25)" +See +.BR sched (7). +.TP +.IR /proc/sys/kernel/seccomp/ " (since Linux 4.14)" +.\" commit 8e5f1ad116df6b0de65eac458d5e7c318d1c05af +This directory provides additional seccomp information and +configuration. +See +.BR seccomp (2) +for further details. +.TP +.IR /proc/sys/kernel/sem " (since Linux 2.4)" +This file contains 4 numbers defining limits for System V IPC semaphores. +These fields are, in order: +.RS +.TP +SEMMSL +The maximum semaphores per semaphore set. +.TP +SEMMNS +A system-wide limit on the number of semaphores in all semaphore sets. +.TP +SEMOPM +The maximum number of operations that may be specified in a +.BR semop (2) +call. +.TP +SEMMNI +A system-wide limit on the maximum number of semaphore identifiers. +.RE +.TP +.I /proc/sys/kernel/sg\-big\-buff +This file +shows the size of the generic SCSI device (sg) buffer. +You can't tune it just yet, but you could change it at +compile time by editing +.I include/scsi/sg.h +and changing +the value of +.BR SG_BIG_BUFF . +However, there shouldn't be any reason to change this value. +.TP +.IR /proc/sys/kernel/shm_rmid_forced " (since Linux 3.1)" +.\" commit b34a6b1da371ed8af1221459a18c67970f7e3d53 +.\" See also Documentation/sysctl/kernel.txt +If this file is set to 1, all System V shared memory segments will +be marked for destruction as soon as the number of attached processes +falls to zero; +in other words, it is no longer possible to create shared memory segments +that exist independently of any attached process. +.IP +The effect is as though a +.BR shmctl (2) +.B IPC_RMID +is performed on all existing segments as well as all segments +created in the future (until this file is reset to 0). +Note that existing segments that are attached to no process will be +immediately destroyed when this file is set to 1. +Setting this option will also destroy segments that were created, +but never attached, +upon termination of the process that created the segment with +.BR shmget (2). +.IP +Setting this file to 1 provides a way of ensuring that +all System V shared memory segments are counted against the +resource usage and resource limits (see the description of +.B RLIMIT_AS +in +.BR getrlimit (2)) +of at least one process. +.IP +Because setting this file to 1 produces behavior that is nonstandard +and could also break existing applications, +the default value in this file is 0. +Set this file to 1 only if you have a good understanding +of the semantics of the applications using +System V shared memory on your system. +.TP +.IR /proc/sys/kernel/shmall " (since Linux 2.2)" +This file +contains the system-wide limit on the total number of pages of +System V shared memory. +.TP +.IR /proc/sys/kernel/shmmax " (since Linux 2.2)" +This file +can be used to query and set the run-time limit +on the maximum (System V IPC) shared memory segment size that can be +created. +Shared memory segments up to 1 GB are now supported in the +kernel. +This value defaults to +.BR SHMMAX . +.TP +.IR /proc/sys/kernel/shmmni " (since Linux 2.4)" +This file +specifies the system-wide maximum number of System V shared memory +segments that can be created. +.TP +.IR /proc/sys/kernel/sysctl_writes_strict " (since Linux 3.16)" +.\" commit f88083005ab319abba5d0b2e4e997558245493c8 +.\" commit 2ca9bb456ada8bcbdc8f77f8fc78207653bbaa92 +.\" commit f4aacea2f5d1a5f7e3154e967d70cf3f711bcd61 +.\" commit 24fe831c17ab8149413874f2fd4e5c8a41fcd294 +The value in this file determines how the file offset affects +the behavior of updating entries in files under +.IR /proc/sys . +The file has three possible values: +.RS +.TP 4 +\-1 +This provides legacy handling, with no printk warnings. +Each +.BR write (2) +must fully contain the value to be written, +and multiple writes on the same file descriptor +will overwrite the entire value, regardless of the file position. +.TP +0 +(default) This provides the same behavior as for \-1, +but printk warnings are written for processes that +perform writes when the file offset is not 0. +.TP +1 +Respect the file offset when writing strings into +.I /proc/sys +files. +Multiple writes will +.I append +to the value buffer. +Anything written beyond the maximum length +of the value buffer will be ignored. +Writes to numeric +.I /proc/sys +entries must always be at file offset 0 and the value must be +fully contained in the buffer provided to +.BR write (2). +.\" FIXME . +.\" With /proc/sys/kernel/sysctl_writes_strict==1, writes at an +.\" offset other than 0 do not generate an error. Instead, the +.\" write() succeeds, but the file is left unmodified. +.\" This is surprising. The behavior may change in the future. +.\" See thread.gmane.org/gmane.linux.man/9197 +.\" From: Michael Kerrisk (man-pages <mtk.manpages@...> +.\" Subject: sysctl_writes_strict documentation + an oddity? +.\" Newsgroups: gmane.linux.man, gmane.linux.kernel +.\" Date: 2015-05-09 08:54:11 GMT +.RE +.TP +.I /proc/sys/kernel/sysrq +This file controls the functions allowed to be invoked by the SysRq key. +By default, +the file contains 1 meaning that every possible SysRq request is allowed +(in older kernel versions, SysRq was disabled by default, +and you were required to specifically enable it at run-time, +but this is not the case any more). +Possible values in this file are: +.RS +.TP 5 +0 +Disable sysrq completely +.TP +1 +Enable all functions of sysrq +.TP +> 1 +Bit mask of allowed sysrq functions, as follows: +.PD 0 +.RS +.TP 5 +\ \ 2 +Enable control of console logging level +.TP +\ \ 4 +Enable control of keyboard (SAK, unraw) +.TP +\ \ 8 +Enable debugging dumps of processes etc. +.TP +\ 16 +Enable sync command +.TP +\ 32 +Enable remount read-only +.TP +\ 64 +Enable signaling of processes (term, kill, oom-kill) +.TP +128 +Allow reboot/poweroff +.TP +256 +Allow nicing of all real-time tasks +.RE +.PD +.RE +.IP +This file is present only if the +.B CONFIG_MAGIC_SYSRQ +kernel configuration option is enabled. +For further details see the Linux kernel source file +.I Documentation/admin\-guide/sysrq.rst +.\" commit 9d85025b0418163fae079c9ba8f8445212de8568 +(or +.I Documentation/sysrq.txt +before Linux 4.10). +.TP +.I /proc/sys/kernel/version +This file contains a string such as: +.IP +.in +4n +.EX +#5 Wed Feb 25 21:49:24 MET 1998 +.EE +.in +.IP +The "#5" means that +this is the fifth kernel built from this source base and the +date following it indicates the time the kernel was built. +.TP +.IR /proc/sys/kernel/threads\-max " (since Linux 2.3.11)" +.\" The following is based on Documentation/sysctl/kernel.txt +This file specifies the system-wide limit on the number of +threads (tasks) that can be created on the system. +.IP +Since Linux 4.1, +.\" commit 230633d109e35b0a24277498e773edeb79b4a331 +the value that can be written to +.I threads\-max +is bounded. +The minimum value that can be written is 20. +The maximum value that can be written is given by the +constant +.B FUTEX_TID_MASK +(0x3fffffff). +If a value outside of this range is written to +.IR threads\-max , +the error +.B EINVAL +occurs. +.IP +The value written is checked against the available RAM pages. +If the thread structures would occupy too much (more than 1/8th) +of the available RAM pages, +.I threads\-max +is reduced accordingly. +.TP +.IR /proc/sys/kernel/yama/ptrace_scope " (since Linux 3.5)" +See +.BR ptrace (2). +.TP +.IR /proc/sys/kernel/zero\-paged " (PowerPC only)" +This file +contains a flag. +When enabled (nonzero), Linux-PPC will pre-zero pages in +the idle loop, possibly speeding up get_free_pages. +.SH SEE ALSO +.BR proc (5), +.BR proc_sys (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_sys_net.5 b/upstream/opensuse-tumbleweed/man5/proc_sys_net.5 new file mode 100644 index 00000000..1c3d247a --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_sys_net.5 @@ -0,0 +1,34 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) , Andries Brouwer <aeb@cwi.nl> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_sys_net 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/sys/net/ \- networking +.SH DESCRIPTION +.TP +.I /proc/sys/net/ +This directory contains networking stuff. +Explanations for some of the files under this directory can be found in +.BR tcp (7) +and +.BR ip (7). +.TP +.I /proc/sys/net/core/bpf_jit_enable +See +.BR bpf (2). +.TP +.I /proc/sys/net/core/somaxconn +This file defines a ceiling value for the +.I backlog +argument of +.BR listen (2); +see the +.BR listen (2) +manual page for details. +.SH SEE ALSO +.BR proc (5), +.BR proc_net (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_sys_proc.5 b/upstream/opensuse-tumbleweed/man5/proc_sys_proc.5 new file mode 100644 index 00000000..ced2dcbe --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_sys_proc.5 @@ -0,0 +1,17 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) , Andries Brouwer <aeb@cwi.nl> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_sys_proc 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/sys/proc/ \- ??? +.SH DESCRIPTION +.TP +.I /proc/sys/proc/ +This directory may be empty. +.SH SEE ALSO +.BR proc (5), +.BR proc_sys (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_sys_sunrpc.5 b/upstream/opensuse-tumbleweed/man5/proc_sys_sunrpc.5 new file mode 100644 index 00000000..8fc96476 --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_sys_sunrpc.5 @@ -0,0 +1,19 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) , Andries Brouwer <aeb@cwi.nl> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_sys_sunrpc 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/sys/sunrpc/ \- Sun remote procedure call for NFS +.SH DESCRIPTION +.TP +.I /proc/sys/sunrpc/ +This directory supports Sun remote procedure call for network filesystem +(NFS). +On some systems, it is not present. +.SH SEE ALSO +.BR proc (5), +.BR proc_sys (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_sys_user.5 b/upstream/opensuse-tumbleweed/man5/proc_sys_user.5 new file mode 100644 index 00000000..82cf4a9a --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_sys_user.5 @@ -0,0 +1,18 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) , Andries Brouwer <aeb@cwi.nl> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_sys_user 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/sys/user/ \- limits on the number of namespaces of various types +.SH DESCRIPTION +.TP +.IR /proc/sys/user/ " (since Linux 4.9)" +See +.BR namespaces (7). +.SH SEE ALSO +.BR proc (5), +.BR proc_sys (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_sys_vm.5 b/upstream/opensuse-tumbleweed/man5/proc_sys_vm.5 new file mode 100644 index 00000000..39f8598a --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_sys_vm.5 @@ -0,0 +1,420 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) , Andries Brouwer <aeb@cwi.nl> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_sys_vm 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/sys/vm/ \- virtual memory subsystem +.SH DESCRIPTION +.TP +.I /proc/sys/vm/ +This directory contains files for memory management tuning, buffer, and +cache management. +.TP +.IR /proc/sys/vm/admin_reserve_kbytes " (since Linux 3.10)" +.\" commit 4eeab4f5580d11bffedc697684b91b0bca0d5009 +This file defines the amount of free memory (in KiB) on the system that +should be reserved for users with the capability +.BR CAP_SYS_ADMIN . +.IP +The default value in this file is the minimum of [3% of free pages, 8MiB] +expressed as KiB. +The default is intended to provide enough for the superuser +to log in and kill a process, if necessary, +under the default overcommit 'guess' mode (i.e., 0 in +.IR /proc/sys/vm/overcommit_memory ). +.IP +Systems running in "overcommit never" mode (i.e., 2 in +.IR /proc/sys/vm/overcommit_memory ) +should increase the value in this file to account +for the full virtual memory size of the programs used to recover (e.g., +.BR login (1) +.BR ssh (1), +and +.BR top (1)) +Otherwise, the superuser may not be able to log in to recover the system. +For example, on x86-64 a suitable value is 131072 (128MiB reserved). +.IP +Changing the value in this file takes effect whenever +an application requests memory. +.TP +.IR /proc/sys/vm/compact_memory " (since Linux 2.6.35)" +When 1 is written to this file, all zones are compacted such that free +memory is available in contiguous blocks where possible. +The effect of this action can be seen by examining +.IR /proc/buddyinfo . +.IP +Present only if the kernel was configured with +.BR CONFIG_COMPACTION . +.TP +.IR /proc/sys/vm/drop_caches " (since Linux 2.6.16)" +Writing to this file causes the kernel to drop clean caches, dentries, and +inodes from memory, causing that memory to become free. +This can be useful for memory management testing and +performing reproducible filesystem benchmarks. +Because writing to this file causes the benefits of caching to be lost, +it can degrade overall system performance. +.IP +To free pagecache, use: +.IP +.in +4n +.EX +echo 1 > /proc/sys/vm/drop_caches +.EE +.in +.IP +To free dentries and inodes, use: +.IP +.in +4n +.EX +echo 2 > /proc/sys/vm/drop_caches +.EE +.in +.IP +To free pagecache, dentries, and inodes, use: +.IP +.in +4n +.EX +echo 3 > /proc/sys/vm/drop_caches +.EE +.in +.IP +Because writing to this file is a nondestructive operation and dirty objects +are not freeable, the +user should run +.BR sync (1) +first. +.TP +.IR /proc/sys/vm/sysctl_hugetlb_shm_group " (since Linux 2.6.7)" +This writable file contains a group ID that is allowed +to allocate memory using huge pages. +If a process has a filesystem group ID or any supplementary group ID that +matches this group ID, +then it can make huge-page allocations without holding the +.B CAP_IPC_LOCK +capability; see +.BR memfd_create (2), +.BR mmap (2), +and +.BR shmget (2). +.TP +.IR /proc/sys/vm/legacy_va_layout " (since Linux 2.6.9)" +.\" The following is from Documentation/filesystems/proc.txt +If nonzero, this disables the new 32-bit memory-mapping layout; +the kernel will use the legacy (2.4) layout for all processes. +.TP +.IR /proc/sys/vm/memory_failure_early_kill " (since Linux 2.6.32)" +.\" The following is based on the text in Documentation/sysctl/vm.txt +Control how to kill processes when an uncorrected memory error +(typically a 2-bit error in a memory module) +that cannot be handled by the kernel +is detected in the background by hardware. +In some cases (like the page still having a valid copy on disk), +the kernel will handle the failure +transparently without affecting any applications. +But if there is no other up-to-date copy of the data, +it will kill processes to prevent any data corruptions from propagating. +.IP +The file has one of the following values: +.RS +.TP +.B 1 +Kill all processes that have the corrupted-and-not-reloadable page mapped +as soon as the corruption is detected. +Note that this is not supported for a few types of pages, +such as kernel internally +allocated data or the swap cache, but works for the majority of user pages. +.TP +.B 0 +Unmap the corrupted page from all processes and kill a process +only if it tries to access the page. +.RE +.IP +The kill is performed using a +.B SIGBUS +signal with +.I si_code +set to +.BR BUS_MCEERR_AO . +Processes can handle this if they want to; see +.BR sigaction (2) +for more details. +.IP +This feature is active only on architectures/platforms with advanced machine +check handling and depends on the hardware capabilities. +.IP +Applications can override the +.I memory_failure_early_kill +setting individually with the +.BR prctl (2) +.B PR_MCE_KILL +operation. +.IP +Present only if the kernel was configured with +.BR CONFIG_MEMORY_FAILURE . +.TP +.IR /proc/sys/vm/memory_failure_recovery " (since Linux 2.6.32)" +.\" The following is based on the text in Documentation/sysctl/vm.txt +Enable memory failure recovery (when supported by the platform). +.RS +.TP +.B 1 +Attempt recovery. +.TP +.B 0 +Always panic on a memory failure. +.RE +.IP +Present only if the kernel was configured with +.BR CONFIG_MEMORY_FAILURE . +.TP +.IR /proc/sys/vm/oom_dump_tasks " (since Linux 2.6.25)" +.\" The following is from Documentation/sysctl/vm.txt +Enables a system-wide task dump (excluding kernel threads) to be +produced when the kernel performs an OOM-killing. +The dump includes the following information +for each task (thread, process): +thread ID, real user ID, thread group ID (process ID), +virtual memory size, resident set size, +the CPU that the task is scheduled on, +oom_adj score (see the description of +.IR /proc/ pid /oom_adj ), +and command name. +This is helpful to determine why the OOM-killer was invoked +and to identify the rogue task that caused it. +.IP +If this contains the value zero, this information is suppressed. +On very large systems with thousands of tasks, +it may not be feasible to dump the memory state information for each one. +Such systems should not be forced to incur a performance penalty in +OOM situations when the information may not be desired. +.IP +If this is set to nonzero, this information is shown whenever the +OOM-killer actually kills a memory-hogging task. +.IP +The default value is 0. +.TP +.IR /proc/sys/vm/oom_kill_allocating_task " (since Linux 2.6.24)" +.\" The following is from Documentation/sysctl/vm.txt +This enables or disables killing the OOM-triggering task in +out-of-memory situations. +.IP +If this is set to zero, the OOM-killer will scan through the entire +tasklist and select a task based on heuristics to kill. +This normally selects a rogue memory-hogging task that +frees up a large amount of memory when killed. +.IP +If this is set to nonzero, the OOM-killer simply kills the task that +triggered the out-of-memory condition. +This avoids a possibly expensive tasklist scan. +.IP +If +.I /proc/sys/vm/panic_on_oom +is nonzero, it takes precedence over whatever value is used in +.IR /proc/sys/vm/oom_kill_allocating_task . +.IP +The default value is 0. +.TP +.IR /proc/sys/vm/overcommit_kbytes " (since Linux 3.14)" +.\" commit 49f0ce5f92321cdcf741e35f385669a421013cb7 +This writable file provides an alternative to +.I /proc/sys/vm/overcommit_ratio +for controlling the +.I CommitLimit +when +.I /proc/sys/vm/overcommit_memory +has the value 2. +It allows the amount of memory overcommitting to be specified as +an absolute value (in kB), +rather than as a percentage, as is done with +.IR overcommit_ratio . +This allows for finer-grained control of +.I CommitLimit +on systems with extremely large memory sizes. +.IP +Only one of +.I overcommit_kbytes +or +.I overcommit_ratio +can have an effect: +if +.I overcommit_kbytes +has a nonzero value, then it is used to calculate +.IR CommitLimit , +otherwise +.I overcommit_ratio +is used. +Writing a value to either of these files causes the +value in the other file to be set to zero. +.TP +.I /proc/sys/vm/overcommit_memory +This file contains the kernel virtual memory accounting mode. +Values are: +.RS +.IP +0: heuristic overcommit (this is the default) +.br +1: always overcommit, never check +.br +2: always check, never overcommit +.RE +.IP +In mode 0, calls of +.BR mmap (2) +with +.B MAP_NORESERVE +are not checked, and the default check is very weak, +leading to the risk of getting a process "OOM-killed". +.IP +In mode 1, the kernel pretends there is always enough memory, +until memory actually runs out. +One use case for this mode is scientific computing applications +that employ large sparse arrays. +Before Linux 2.6.0, any nonzero value implies mode 1. +.IP +In mode 2 (available since Linux 2.6), the total virtual address space +that can be allocated +.RI ( CommitLimit +in +.IR /proc/meminfo ) +is calculated as +.IP +.in +4n +.EX +CommitLimit = (total_RAM \- total_huge_TLB) * + overcommit_ratio / 100 + total_swap +.EE +.in +.IP +where: +.RS +.IP \[bu] 3 +.I total_RAM +is the total amount of RAM on the system; +.IP \[bu] +.I total_huge_TLB +is the amount of memory set aside for huge pages; +.IP \[bu] +.I overcommit_ratio +is the value in +.IR /proc/sys/vm/overcommit_ratio ; +and +.IP \[bu] +.I total_swap +is the amount of swap space. +.RE +.IP +For example, on a system with 16 GB of physical RAM, 16 GB +of swap, no space dedicated to huge pages, and an +.I overcommit_ratio +of 50, this formula yields a +.I CommitLimit +of 24 GB. +.IP +Since Linux 3.14, if the value in +.I /proc/sys/vm/overcommit_kbytes +is nonzero, then +.I CommitLimit +is instead calculated as: +.IP +.in +4n +.EX +CommitLimit = overcommit_kbytes + total_swap +.EE +.in +.IP +See also the description of +.I /proc/sys/vm/admin_reserve_kbytes +and +.IR /proc/sys/vm/user_reserve_kbytes . +.TP +.IR /proc/sys/vm/overcommit_ratio " (since Linux 2.6.0)" +This writable file defines a percentage by which memory +can be overcommitted. +The default value in the file is 50. +See the description of +.IR /proc/sys/vm/overcommit_memory . +.TP +.IR /proc/sys/vm/panic_on_oom " (since Linux 2.6.18)" +.\" The following is adapted from Documentation/sysctl/vm.txt +This enables or disables a kernel panic in +an out-of-memory situation. +.IP +If this file is set to the value 0, +the kernel's OOM-killer will kill some rogue process. +Usually, the OOM-killer is able to kill a rogue process and the +system will survive. +.IP +If this file is set to the value 1, +then the kernel normally panics when out-of-memory happens. +However, if a process limits allocations to certain nodes +using memory policies +.RB ( mbind (2) +.BR MPOL_BIND ) +or cpusets +.RB ( cpuset (7)) +and those nodes reach memory exhaustion status, +one process may be killed by the OOM-killer. +No panic occurs in this case: +because other nodes' memory may be free, +this means the system as a whole may not have reached +an out-of-memory situation yet. +.IP +If this file is set to the value 2, +the kernel always panics when an out-of-memory condition occurs. +.IP +The default value is 0. +1 and 2 are for failover of clustering. +Select either according to your policy of failover. +.TP +.I /proc/sys/vm/swappiness +.\" The following is from Documentation/sysctl/vm.txt +The value in this file controls how aggressively the kernel will swap +memory pages. +Higher values increase aggressiveness, lower values +decrease aggressiveness. +The default value is 60. +.TP +.IR /proc/sys/vm/user_reserve_kbytes " (since Linux 3.10)" +.\" commit c9b1d0981fcce3d9976d7b7a56e4e0503bc610dd +Specifies an amount of memory (in KiB) to reserve for user processes. +This is intended to prevent a user from starting a single memory hogging +process, such that they cannot recover (kill the hog). +The value in this file has an effect only when +.I /proc/sys/vm/overcommit_memory +is set to 2 ("overcommit never" mode). +In this case, the system reserves an amount of memory that is the minimum +of [3% of current process size, +.IR user_reserve_kbytes ]. +.IP +The default value in this file is the minimum of [3% of free pages, 128MiB] +expressed as KiB. +.IP +If the value in this file is set to zero, +then a user will be allowed to allocate all free memory with a single process +(minus the amount reserved by +.IR /proc/sys/vm/admin_reserve_kbytes ). +Any subsequent attempts to execute a command will result in +"fork: Cannot allocate memory". +.IP +Changing the value in this file takes effect whenever +an application requests memory. +.TP +.IR /proc/sys/vm/unprivileged_userfaultfd " (since Linux 5.2)" +.\" cefdca0a86be517bc390fc4541e3674b8e7803b0 +This (writable) file exposes a flag that controls whether +unprivileged processes are allowed to employ +.BR userfaultfd (2). +If this file has the value 1, then unprivileged processes may use +.BR userfaultfd (2). +If this file has the value 0, then only processes that have the +.B CAP_SYS_PTRACE +capability may employ +.BR userfaultfd (2). +The default value in this file is 1. +.SH SEE ALSO +.BR proc (5), +.BR proc_sys (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_sysrq-trigger.5 b/upstream/opensuse-tumbleweed/man5/proc_sysrq-trigger.5 new file mode 100644 index 00000000..2d42047c --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_sysrq-trigger.5 @@ -0,0 +1,25 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_sysrq-trigger 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/sysrq\-trigger \- SysRq function +.SH DESCRIPTION +.TP +.IR /proc/sysrq\-trigger " (since Linux 2.4.21)" +Writing a character to this file triggers the same SysRq function as +typing ALT-SysRq-<character> (see the description of +.IR /proc/sys/kernel/sysrq ). +This file is normally writable only by +.IR root . +For further details see the Linux kernel source file +.I Documentation/admin\-guide/sysrq.rst +.\" commit 9d85025b0418163fae079c9ba8f8445212de8568 +(or +.I Documentation/sysrq.txt +before Linux 4.10). +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_sysvipc.5 b/upstream/opensuse-tumbleweed/man5/proc_sysvipc.5 new file mode 100644 index 00000000..567388d2 --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_sysvipc.5 @@ -0,0 +1,25 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_sysvipc 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/sysvipc/ \- System V IPC +.SH DESCRIPTION +.TP +.I /proc/sysvipc/ +Subdirectory containing the pseudo-files +.IR msg ", " sem " and " shm "." +These files list the System V Interprocess Communication (IPC) objects +(respectively: message queues, semaphores, and shared memory) +that currently exist on the system, +providing similar information to that available via +.BR ipcs (1). +These files have headers and are formatted (one IPC object per line) +for easy understanding. +.BR sysvipc (7) +provides further background on the information shown by these files. +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_tid_children.5 b/upstream/opensuse-tumbleweed/man5/proc_tid_children.5 new file mode 100644 index 00000000..0b407745 --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_tid_children.5 @@ -0,0 +1,37 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_tid_children 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/tid/children \- child tasks +.SH DESCRIPTION +.TP +.IR /proc/ tid /children " (since Linux 3.5)" +.\" commit 818411616baf46ceba0cff6f05af3a9b294734f7 +A space-separated list of child tasks of this task. +Each child task is represented by its TID. +.IP +.\" see comments in get_children_pid() in fs/proc/array.c +This option is intended for use by the checkpoint-restore (CRIU) system, +and reliably provides a list of children only if all of the child processes +are stopped or frozen. +It does not work properly if children of the target task exit while +the file is being read! +Exiting children may cause non-exiting children to be omitted from the list. +This makes this interface even more unreliable than classic PID-based +approaches if the inspected task and its children aren't frozen, +and most code should probably not use this interface. +.IP +Until Linux 4.2, the presence of this file was governed by the +.B CONFIG_CHECKPOINT_RESTORE +kernel configuration option. +Since Linux 4.2, +.\" commit 2e13ba54a2682eea24918b87ad3edf70c2cf085b +it is governed by the +.B CONFIG_PROC_CHILDREN +option. +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_timer_list.5 b/upstream/opensuse-tumbleweed/man5/proc_timer_list.5 new file mode 100644 index 00000000..88723916 --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_timer_list.5 @@ -0,0 +1,18 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_timer_list 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/timer_list \- pending timers +.SH DESCRIPTION +.TP +.IR /proc/timer_list " (since Linux 2.6.21)" +.\" commit 289f480af87e45f7a6de6ba9b4c061c2e259fe98 +This read-only file exposes a list of all currently pending +(high-resolution) timers, +all clock-event sources, and their parameters in a human-readable form. +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_timer_stats.5 b/upstream/opensuse-tumbleweed/man5/proc_timer_stats.5 new file mode 100644 index 00000000..beb034ae --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_timer_stats.5 @@ -0,0 +1,117 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_timer_stats 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/timer_stats \- timer statistics +.SH DESCRIPTION +.TP +.IR /proc/timer_stats " (from Linux 2.6.21 until Linux 4.10)" +.\" commit 82f67cd9fca8c8762c15ba7ed0d5747588c1e221 +.\" Date: Fri Feb 16 01:28:13 2007 -0800 +.\" Text largely derived from Documentation/timers/timer_stats.txt +.\" removed in commit dfb4357da6ddbdf57d583ba64361c9d792b0e0b1 +.\" Date: Wed Feb 8 11:26:59 2017 -0800 +This is a debugging facility to make timer (ab)use in a Linux +system visible to kernel and user-space developers. +It can be used by kernel and user-space developers to verify that +their code does not make undue use of timers. +The goal is to avoid unnecessary wakeups, +thereby optimizing power consumption. +.IP +If enabled in the kernel +.RB ( CONFIG_TIMER_STATS ), +but not used, +it has almost zero run-time overhead and a relatively small +data-structure overhead. +Even if collection is enabled at run time, overhead is low: +all the locking is per-CPU and lookup is hashed. +.IP +The +.I /proc/timer_stats +file is used both to control sampling facility and to read out the +sampled information. +.IP +The +.I timer_stats +functionality is inactive on bootup. +A sampling period can be started using the following command: +.IP +.in +4n +.EX +# echo 1 > /proc/timer_stats +.EE +.in +.IP +The following command stops a sampling period: +.IP +.in +4n +.EX +# echo 0 > /proc/timer_stats +.EE +.in +.IP +The statistics can be retrieved by: +.IP +.in +4n +.EX +$ cat /proc/timer_stats +.EE +.in +.IP +While sampling is enabled, each readout from +.I /proc/timer_stats +will see +newly updated statistics. +Once sampling is disabled, the sampled information +is kept until a new sample period is started. +This allows multiple readouts. +.IP +Sample output from +.IR /proc/timer_stats : +.IP +.in +4n +.EX +.RB $ " cat /proc/timer_stats" +Timer Stats Version: v0.3 +Sample period: 1.764 s +Collection: active + 255, 0 swapper/3 hrtimer_start_range_ns (tick_sched_timer) + 71, 0 swapper/1 hrtimer_start_range_ns (tick_sched_timer) + 58, 0 swapper/0 hrtimer_start_range_ns (tick_sched_timer) + 4, 1694 gnome\-shell mod_delayed_work_on (delayed_work_timer_fn) + 17, 7 rcu_sched rcu_gp_kthread (process_timeout) +\&... + 1, 4911 kworker/u16:0 mod_delayed_work_on (delayed_work_timer_fn) + 1D, 2522 kworker/0:0 queue_delayed_work_on (delayed_work_timer_fn) +1029 total events, 583.333 events/sec +.EE +.in +.IP +The output columns are: +.RS +.IP [1] 5 +a count of the number of events, +optionally (since Linux 2.6.23) followed by the letter \[aq]D\[aq] +.\" commit c5c061b8f9726bc2c25e19dec227933a13d1e6b7 deferrable timers +if this is a deferrable timer; +.IP [2] +the PID of the process that initialized the timer; +.IP [3] +the name of the process that initialized the timer; +.IP [4] +the function where the timer was initialized; and +(in parentheses) +the callback function that is associated with the timer. +.RE +.IP +During the Linux 4.11 development cycle, +this file was removed because of security concerns, +as it exposes information across namespaces. +Furthermore, it is possible to obtain +the same information via in-kernel tracing facilities such as ftrace. +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_tty.5 b/upstream/opensuse-tumbleweed/man5/proc_tty.5 new file mode 100644 index 00000000..ac9523db --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_tty.5 @@ -0,0 +1,16 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_tty 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/tty/ \- tty +.SH DESCRIPTION +.TP +.I /proc/tty/ +Subdirectory containing the pseudo-files and subdirectories for +tty drivers and line disciplines. +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_uptime.5 b/upstream/opensuse-tumbleweed/man5/proc_uptime.5 new file mode 100644 index 00000000..6d223dbf --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_uptime.5 @@ -0,0 +1,17 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_uptime 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/uptime \- system uptime +.SH DESCRIPTION +.TP +.I /proc/uptime +This file contains two numbers (values in seconds): the uptime of the +system (including time spent in suspend) and the amount of time spent +in the idle process. +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_version.5 b/upstream/opensuse-tumbleweed/man5/proc_version.5 new file mode 100644 index 00000000..969fc32e --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_version.5 @@ -0,0 +1,27 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_version 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/version \- kernel version +.SH DESCRIPTION +.TP +.I /proc/version +This string identifies the kernel version that is currently running. +It includes the contents of +.IR /proc/sys/kernel/ostype , +.IR /proc/sys/kernel/osrelease , +and +.IR /proc/sys/kernel/version . +For example: +.IP +.in +4n +.EX +Linux version 1.0.9 (quinlan@phaze) #1 Sat May 14 01:51:54 EDT 1994 +.EE +.in +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_vmstat.5 b/upstream/opensuse-tumbleweed/man5/proc_vmstat.5 new file mode 100644 index 00000000..71c71c51 --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_vmstat.5 @@ -0,0 +1,702 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_vmstat 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/vmstat \- virtual memory statistics +.SH DESCRIPTION +.TP +.IR /proc/vmstat " (since Linux 2.6.0)" +This file displays various virtual memory statistics. +Each line of this file contains a single name-value pair, +delimited by white space. +Some lines are present only if the kernel was configured with +suitable options. +(In some cases, the options required for particular files have changed +across kernel versions, so they are not listed here. +Details can be found by consulting the kernel source code.) +The following fields may be present: +.\" FIXME We need explanations for each of the following fields... +.RS +.TP +.IR nr_free_pages " (since Linux 2.6.31)" +.\" commit d23ad42324cc4378132e51f2fc5c9ba6cbe75182 +.TP +.IR nr_alloc_batch " (since Linux 3.12)" +.\" commit 81c0a2bb515fd4daae8cab64352877480792b515 +.TP +.IR nr_inactive_anon " (since Linux 2.6.28)" +.\" commit 4f98a2fee8acdb4ac84545df98cccecfd130f8db +.TP +.IR nr_active_anon " (since Linux 2.6.28)" +.\" commit 4f98a2fee8acdb4ac84545df98cccecfd130f8db +.TP +.IR nr_inactive_file " (since Linux 2.6.28)" +.\" commit 4f98a2fee8acdb4ac84545df98cccecfd130f8db +.TP +.IR nr_active_file " (since Linux 2.6.28)" +.\" commit 4f98a2fee8acdb4ac84545df98cccecfd130f8db +.TP +.IR nr_unevictable " (since Linux 2.6.28)" +.\" commit 7b854121eb3e5ba0241882ff939e2c485228c9c5 +.TP +.IR nr_mlock " (since Linux 2.6.28)" +.\" commit 5344b7e648980cc2ca613ec03a56a8222ff48820 +.TP +.IR nr_anon_pages " (since Linux 2.6.18)" +.\" commit f3dbd34460ff54962d3e3244b6bcb7f5295356e6 +.TP +.IR nr_mapped " (since Linux 2.6.0)" +.TP +.IR nr_file_pages " (since Linux 2.6.18)" +.\" commit 347ce434d57da80fd5809c0c836f206a50999c26 +.TP +.IR nr_dirty " (since Linux 2.6.0)" +.TP +.IR nr_writeback " (since Linux 2.6.0)" +.TP +.IR nr_slab_reclaimable " (since Linux 2.6.19)" +.\" commit 972d1a7b140569084439a81265a0f15b74e924e0 +.\" Linux 2.6.0 had nr_slab +.TP +.IR nr_slab_unreclaimable " (since Linux 2.6.19)" +.\" commit 972d1a7b140569084439a81265a0f15b74e924e0 +.TP +.IR nr_page_table_pages " (since Linux 2.6.0)" +.TP +.IR nr_kernel_stack " (since Linux 2.6.32)" +.\" commit c6a7f5728a1db45d30df55a01adc130b4ab0327c +Amount of memory allocated to kernel stacks. +.TP +.IR nr_unstable " (since Linux 2.6.0)" +.TP +.IR nr_bounce " (since Linux 2.6.12)" +.\" commit edfbe2b0038723e5699ab22695ccd62b5542a5c1 +.TP +.IR nr_vmscan_write " (since Linux 2.6.19)" +.\" commit e129b5c23c2b471d47f1c5d2b8b193fc2034af43 +.TP +.IR nr_vmscan_immediate_reclaim " (since Linux 3.2)" +.\" commit 49ea7eb65e7c5060807fb9312b1ad4c3eab82e2c +.TP +.IR nr_writeback_temp " (since Linux 2.6.26)" +.\" commit fc3ba692a4d19019387c5acaea63131f9eab05dd +.TP +.IR nr_isolated_anon " (since Linux 2.6.32)" +.\" commit a731286de62294b63d8ceb3c5914ac52cc17e690 +.TP +.IR nr_isolated_file " (since Linux 2.6.32)" +.\" commit a731286de62294b63d8ceb3c5914ac52cc17e690 +.TP +.IR nr_shmem " (since Linux 2.6.32)" +.\" commit 4b02108ac1b3354a22b0d83c684797692efdc395 +Pages used by shmem and +.BR tmpfs (5). +.TP +.IR nr_dirtied " (since Linux 2.6.37)" +.\" commit ea941f0e2a8c02ae876cd73deb4e1557248f258c +.TP +.IR nr_written " (since Linux 2.6.37)" +.\" commit ea941f0e2a8c02ae876cd73deb4e1557248f258c +.TP +.IR nr_pages_scanned " (since Linux 3.17)" +.\" commit 0d5d823ab4e608ec7b52ac4410de4cb74bbe0edd +.TP +.IR numa_hit " (since Linux 2.6.18)" +.\" commit ca889e6c45e0b112cb2ca9d35afc66297519b5d5 +.\" Present only if the kernel was configured with +.\" .BR CONFIG_NUMA . +.TP +.IR numa_miss " (since Linux 2.6.18)" +.\" commit ca889e6c45e0b112cb2ca9d35afc66297519b5d5 +.\" Present only if the kernel was configured with +.\" .BR CONFIG_NUMA . +.TP +.IR numa_foreign " (since Linux 2.6.18)" +.\" commit ca889e6c45e0b112cb2ca9d35afc66297519b5d5 +.\" Present only if the kernel was configured with +.\" .BR CONFIG_NUMA . +.TP +.IR numa_interleave " (since Linux 2.6.18)" +.\" commit ca889e6c45e0b112cb2ca9d35afc66297519b5d5 +.\" Present only if the kernel was configured with +.\" .BR CONFIG_NUMA . +.TP +.IR numa_local " (since Linux 2.6.18)" +.\" commit ca889e6c45e0b112cb2ca9d35afc66297519b5d5 +.\" Present only if the kernel was configured with +.\" .BR CONFIG_NUMA . +.TP +.IR numa_other " (since Linux 2.6.18)" +.\" commit ca889e6c45e0b112cb2ca9d35afc66297519b5d5 +.\" Present only if the kernel was configured with +.\" .BR CONFIG_NUMA . +.TP +.IR workingset_refault " (since Linux 3.15)" +.\" commit a528910e12ec7ee203095eb1711468a66b9b60b0 +.\" Present only if the kernel was configured with +.\" .BR CONFIG_VM_EVENT_COUNTERS . +.TP +.IR workingset_activate " (since Linux 3.15)" +.\" commit a528910e12ec7ee203095eb1711468a66b9b60b0 +.\" Present only if the kernel was configured with +.\" .BR CONFIG_VM_EVENT_COUNTERS . +.TP +.IR workingset_nodereclaim " (since Linux 3.15)" +.\" commit 449dd6984d0e47643c04c807f609dd56d48d5bcc +.\" Present only if the kernel was configured with +.\" .BR CONFIG_VM_EVENT_COUNTERS . +.TP +.IR nr_anon_transparent_hugepages " (since Linux 2.6.38)" +.\" Present only if the kernel was configured with +.\" .BR CONFIG_VM_EVENT_COUNTERS . +.TP +.IR nr_free_cma " (since Linux 3.7)" +.\" commit d1ce749a0db12202b711d1aba1d29e823034648d +Number of free CMA (Contiguous Memory Allocator) pages. +.\" Present only if the kernel was configured with +.\" .BR CONFIG_VM_EVENT_COUNTERS . +.TP +.IR nr_dirty_threshold " (since Linux 2.6.37)" +.\" commit 79da826aee6a10902ef411bc65864bd02102fa83 +.\" Present only if the kernel was configured with +.\" .BR CONFIG_VM_EVENT_COUNTERS . +.TP +.IR nr_dirty_background_threshold " (since Linux 2.6.37)" +.\" commit 79da826aee6a10902ef411bc65864bd02102fa83 +.\" Present only if the kernel was configured with +.\" .BR CONFIG_VM_EVENT_COUNTERS . +.TP +.IR pgpgin " (since Linux 2.6.0)" +.\" Present only if the kernel was configured with +.\" .BR CONFIG_VM_EVENT_COUNTERS . +.TP +.IR pgpgout " (since Linux 2.6.0)" +.\" Present only if the kernel was configured with +.\" .BR CONFIG_VM_EVENT_COUNTERS . +.TP +.IR pswpin " (since Linux 2.6.0)" +.\" Present only if the kernel was configured with +.\" .BR CONFIG_VM_EVENT_COUNTERS . +.TP +.IR pswpout " (since Linux 2.6.0)" +.\" Present only if the kernel was configured with +.\" .BR CONFIG_VM_EVENT_COUNTERS . +.TP +.IR pgalloc_dma " (since Linux 2.6.5)" +.\" Linux 2.6.0 had pgalloc +.\" Present only if the kernel was configured with +.\" .BR CONFIG_VM_EVENT_COUNTERS . +.TP +.IR pgalloc_dma32 " (since Linux 2.6.16)" +.\" commit 9328b8faae922e52073785ed6c1eaa8565648a0e +.\" Present only if the kernel was configured with +.\" .BR CONFIG_VM_EVENT_COUNTERS . +.TP +.IR pgalloc_normal " (since Linux 2.6.5)" +.\" Present only if the kernel was configured with +.\" .BR CONFIG_VM_EVENT_COUNTERS . +.TP +.IR pgalloc_high " (since Linux 2.6.5)" +.\" Present only if the kernel was configured with +.\" .BR CONFIG_VM_EVENT_COUNTERS +.\" and +.\" .BR CONFIG_HIGHMEM . +.TP +.IR pgalloc_movable " (since Linux 2.6.23)" +.\" commit 2a1e274acf0b1c192face19a4be7c12d4503eaaf +.\" Present only if the kernel was configured with +.\" .BR CONFIG_VM_EVENT_COUNTERS . +.TP +.IR pgfree " (since Linux 2.6.0)" +.\" Present only if the kernel was configured with +.\" .BR CONFIG_VM_EVENT_COUNTERS . +.TP +.IR pgactivate " (since Linux 2.6.0)" +.\" Present only if the kernel was configured with +.\" .BR CONFIG_VM_EVENT_COUNTERS . +.TP +.IR pgdeactivate " (since Linux 2.6.0)" +.\" Present only if the kernel was configured with +.\" .BR CONFIG_VM_EVENT_COUNTERS . +.TP +.IR pgfault " (since Linux 2.6.0)" +.\" Present only if the kernel was configured with +.\" .BR CONFIG_VM_EVENT_COUNTERS . +.TP +.IR pgmajfault " (since Linux 2.6.0)" +.\" Present only if the kernel was configured with +.\" .BR CONFIG_VM_EVENT_COUNTERS . +.TP +.IR pgrefill_dma " (since Linux 2.6.5)" +.\" Linux 2.6.0 had pgrefill +.\" Present only if the kernel was configured with +.\" .BR CONFIG_VM_EVENT_COUNTERS . +.TP +.IR pgrefill_dma32 " (since Linux 2.6.16)" +.\" commit 9328b8faae922e52073785ed6c1eaa8565648a0e +.\" Present only if the kernel was configured with +.\" .BR CONFIG_VM_EVENT_COUNTERS . +.TP +.IR pgrefill_normal " (since Linux 2.6.5)" +.\" Present only if the kernel was configured with +.\" .BR CONFIG_VM_EVENT_COUNTERS . +.TP +.IR pgrefill_high " (since Linux 2.6.5)" +.\" Present only if the kernel was configured with +.\" .BR CONFIG_VM_EVENT_COUNTERS +.\" and +.\" .BR CONFIG_HIGHMEM . +.TP +.IR pgrefill_movable " (since Linux 2.6.23)" +.\" commit 2a1e274acf0b1c192face19a4be7c12d4503eaaf +.\" Present only if the kernel was configured with +.\" .BR CONFIG_VM_EVENT_COUNTERS . +.\" Formerly there were +.\" pgsteal_high +.\" pgsteal_normal +.\" pgsteal_dma32 +.\" pgsteal_dma +.\" These were split out into pgsteal_kswapd* and pgsteal_direct* +.\" in commit 904249aa68010c8e223263c922fcbb840a3f42e4 +.TP +.IR pgsteal_kswapd_dma " (since Linux 3.4)" +.\" commit 904249aa68010c8e223263c922fcbb840a3f42e4 +.\" Linux 2.6.0 had pgsteal +.\" Present only if the kernel was configured with +.\" .\" .BR CONFIG_VM_EVENT_COUNTERS . +.TP +.IR pgsteal_kswapd_dma32 " (since Linux 3.4)" +.\" commit 904249aa68010c8e223263c922fcbb840a3f42e4 +.\" commit 9328b8faae922e52073785ed6c1eaa8565648a0e +.\" Present only if the kernel was configured with +.\" .BR CONFIG_VM_EVENT_COUNTERS . +.TP +.IR pgsteal_kswapd_normal " (since Linux 3.4)" +.\" commit 904249aa68010c8e223263c922fcbb840a3f42e4 +.\" Present only if the kernel was configured with +.\" .BR CONFIG_VM_EVENT_COUNTERS . +.TP +.IR pgsteal_kswapd_high " (since Linux 3.4)" +.\" commit 904249aa68010c8e223263c922fcbb840a3f42e4 +.\" Present only if the kernel was configured with +.\" .BR CONFIG_VM_EVENT_COUNTERS +.\" and +.\" .BR CONFIG_HIGHMEM . +.TP +.IR pgsteal_kswapd_movable " (since Linux 3.4)" +.\" commit 904249aa68010c8e223263c922fcbb840a3f42e4 +.\" Present only if the kernel was configured with +.\" .BR CONFIG_VM_EVENT_COUNTERS . +.TP +.I pgsteal_direct_dma +.\" Present only if the kernel was configured with +.\" .BR CONFIG_VM_EVENT_COUNTERS . +.TP +.IR pgsteal_direct_dma32 " (since Linux 3.4)" +.\" commit 904249aa68010c8e223263c922fcbb840a3f42e4 +.\" Present only if the kernel was configured with +.\" .BR CONFIG_VM_EVENT_COUNTERS . +.TP +.IR pgsteal_direct_normal " (since Linux 3.4)" +.\" commit 904249aa68010c8e223263c922fcbb840a3f42e4 +.\" Present only if the kernel was configured with +.\" .BR CONFIG_VM_EVENT_COUNTERS . +.TP +.IR pgsteal_direct_high " (since Linux 3.4)" +.\" commit 904249aa68010c8e223263c922fcbb840a3f42e4 +.\" Present only if the kernel was configured with +.\" .BR CONFIG_VM_EVENT_COUNTERS +.\" and +.\" .BR CONFIG_HIGHMEM . +.TP +.IR pgsteal_direct_movable " (since Linux 2.6.23)" +.\" commit 2a1e274acf0b1c192face19a4be7c12d4503eaaf +.\" Present only if the kernel was configured with +.\" .BR CONFIG_VM_EVENT_COUNTERS . +.TP +.I pgscan_kswapd_dma +.\" Linux 2.6.0 had pgscan +.\" Present only if the kernel was configured with +.\" .BR CONFIG_VM_EVENT_COUNTERS . +.TP +.IR pgscan_kswapd_dma32 " (since Linux 2.6.16)" +.\" commit 9328b8faae922e52073785ed6c1eaa8565648a0e +.\" Present only if the kernel was configured with +.\" .BR CONFIG_VM_EVENT_COUNTERS . +.TP +.IR pgscan_kswapd_normal " (since Linux 2.6.5)" +.\" Present only if the kernel was configured with +.\" .BR CONFIG_VM_EVENT_COUNTERS . +.TP +.I pgscan_kswapd_high +.\" Present only if the kernel was configured with +.\" .BR CONFIG_VM_EVENT_COUNTERS +.\" and +.\" .BR CONFIG_HIGHMEM . +.TP +.IR pgscan_kswapd_movable " (since Linux 2.6.23)" +.\" commit 2a1e274acf0b1c192face19a4be7c12d4503eaaf +.\" Present only if the kernel was configured with +.\" .BR CONFIG_VM_EVENT_COUNTERS . +.TP +.I pgscan_direct_dma +.\" Present only if the kernel was configured with +.\" .BR CONFIG_VM_EVENT_COUNTERS . +.TP +.IR pgscan_direct_dma32 " (since Linux 2.6.16)" +.\" commit 9328b8faae922e52073785ed6c1eaa8565648a0e +.\" Present only if the kernel was configured with +.\" .BR CONFIG_VM_EVENT_COUNTERS . +.TP +.I pgscan_direct_normal +.\" Present only if the kernel was configured with +.\" .BR CONFIG_VM_EVENT_COUNTERS . +.TP +.I pgscan_direct_high +.\" Present only if the kernel was configured with +.\" .BR CONFIG_VM_EVENT_COUNTERS +.\" and +.\" .BR CONFIG_HIGHMEM . +.TP +.IR pgscan_direct_movable " (since Linux 2.6.23)" +.\" commit 2a1e274acf0b1c192face19a4be7c12d4503eaaf +.\" Present only if the kernel was configured with +.\" .BR CONFIG_VM_EVENT_COUNTERS . +.TP +.IR pgscan_direct_throttle " (since Linux 3.6)" +.\" commit 68243e76ee343d63c6cf76978588a885951e2818 +.\" Present only if the kernel was configured with +.\" .BR CONFIG_VM_EVENT_COUNTERS . +.TP +.IR zone_reclaim_failed " (since linux 2.6.31)" +.\" commit 24cf72518c79cdcda486ed26074ff8151291cf65 +.\" Present only if the kernel was configured with +.\" .BR CONFIG_VM_EVENT_COUNTERS +.\" and +.\" .BR CONFIG_NUMA . +.TP +.IR pginodesteal " (since linux 2.6.0)" +.\" Present only if the kernel was configured with +.\" .BR CONFIG_VM_EVENT_COUNTERS . +.TP +.IR slabs_scanned " (since linux 2.6.5)" +.\" Present only if the kernel was configured with +.\" .BR CONFIG_VM_EVENT_COUNTERS . +.TP +.IR kswapd_inodesteal " (since linux 2.6.0)" +.\" Present only if the kernel was configured with +.\" .BR CONFIG_VM_EVENT_COUNTERS . +.TP +.IR kswapd_low_wmark_hit_quickly " (since Linux 2.6.33)" +.\" commit bb3ab596832b920c703d1aea1ce76d69c0f71fb7 +.\" Present only if the kernel was configured with +.\" .BR CONFIG_VM_EVENT_COUNTERS . +.TP +.IR kswapd_high_wmark_hit_quickly " (since Linux 2.6.33)" +.\" commit bb3ab596832b920c703d1aea1ce76d69c0f71fb7 +.\" Present only if the kernel was configured with +.\" .BR CONFIG_VM_EVENT_COUNTERS . +.TP +.IR pageoutrun " (since Linux 2.6.0)" +.\" Present only if the kernel was configured with +.\" .BR CONFIG_VM_EVENT_COUNTERS . +.TP +.IR allocstall " (since Linux 2.6.0)" +.\" Present only if the kernel was configured with +.\" .BR CONFIG_VM_EVENT_COUNTERS . +.TP +.IR pgrotated " (since Linux 2.6.0)" +.\" Present only if the kernel was configured with +.\" .BR CONFIG_VM_EVENT_COUNTERS . +.TP +.IR drop_pagecache " (since Linux 3.15)" +.\" commit 5509a5d27b971a90b940e148ca9ca53312e4fa7a +.\" Present only if the kernel was configured with +.\" .BR CONFIG_VM_EVENT_COUNTERS . +.TP +.IR drop_slab " (since Linux 3.15)" +.\" commit 5509a5d27b971a90b940e148ca9ca53312e4fa7a +.\" Present only if the kernel was configured with +.\" .BR CONFIG_VM_EVENT_COUNTERS . +.TP +.IR numa_pte_updates " (since Linux 3.8)" +.\" commit 03c5a6e16322c997bf8f264851bfa3f532ad515f +.\" Present only if the kernel was configured with +.\" .BR CONFIG_VM_EVENT_COUNTERS +.\" and +.\" .BR CONFIG_NUMA_BALANCING . +.TP +.IR numa_huge_pte_updates " (since Linux 3.13)" +.\" commit 72403b4a0fbdf433c1fe0127e49864658f6f6468 +.\" Present only if the kernel was configured with +.\" .BR CONFIG_VM_EVENT_COUNTERS +.\" and +.\" .BR CONFIG_NUMA_BALANCING . +.TP +.IR numa_hint_faults " (since Linux 3.8)" +.\" commit 03c5a6e16322c997bf8f264851bfa3f532ad515f +.\" Present only if the kernel was configured with +.\" .BR CONFIG_VM_EVENT_COUNTERS +.\" and +.\" .BR CONFIG_NUMA_BALANCING . +.TP +.IR numa_hint_faults_local " (since Linux 3.8)" +.\" commit 03c5a6e16322c997bf8f264851bfa3f532ad515f +.\" Present only if the kernel was configured with +.\" .BR CONFIG_VM_EVENT_COUNTERS +.\" and +.\" .BR CONFIG_NUMA_BALANCING . +.TP +.IR numa_pages_migrated " (since Linux 3.8)" +.\" commit 03c5a6e16322c997bf8f264851bfa3f532ad515f +.\" Present only if the kernel was configured with +.\" .BR CONFIG_VM_EVENT_COUNTERS +.\" and +.\" .BR CONFIG_NUMA_BALANCING +.\" and +.\" .BR CONFIG_NUMA_BALANCING . +.TP +.IR pgmigrate_success " (since Linux 3.8)" +.\" commit 5647bc293ab15f66a7b1cda850c5e9d162a6c7c2 +.\" Present only if the kernel was configured with +.\" .BR CONFIG_VM_EVENT_COUNTERS +.\" and +.\" .BR CONFIG_MIGRATION . +.TP +.IR pgmigrate_fail " (since Linux 3.8)" +.\" commit 5647bc293ab15f66a7b1cda850c5e9d162a6c7c2 +.\" Present only if the kernel was configured with +.\" .BR CONFIG_VM_EVENT_COUNTERS +.\" and +.\" .BR CONFIG_MIGRATION . +.TP +.IR compact_migrate_scanned " (since Linux 3.8)" +.\" commit 397487db696cae0b026a474a5cd66f4e372995e6 +.\" Linux 3.8 dropped compact_blocks_moved, compact_pages_moved, and +.\" compact_pagemigrate_failed +.\" Present only if the kernel was configured with +.\" .BR CONFIG_VM_EVENT_COUNTERS +.\" and +.\" .BR CONFIG_COMPACTION . +.TP +.IR compact_free_scanned " (since Linux 3.8)" +.\" commit 397487db696cae0b026a474a5cd66f4e372995e6 +.\" Present only if the kernel was configured with +.\" .BR CONFIG_VM_EVENT_COUNTERS +.\" and +.\" .BR CONFIG_COMPACTION . +.TP +.IR compact_isolated " (since Linux 3.8)" +.\" commit 397487db696cae0b026a474a5cd66f4e372995e6 +.\" Present only if the kernel was configured with +.\" .BR CONFIG_VM_EVENT_COUNTERS +.\" and +.\" .BR CONFIG_COMPACTION . +.TP +.IR compact_stall " (since Linux 2.6.35)" +.\" commit 56de7263fcf3eb10c8dcdf8d59a9cec831795f3f +See the kernel source file +.IR Documentation/admin\-guide/mm/transhuge.rst . +.\" Present only if the kernel was configured with +.\" .BR CONFIG_VM_EVENT_COUNTERS +.\" and +.\" .BR CONFIG_COMPACTION . +.TP +.IR compact_fail " (since Linux 2.6.35)" +.\" commit 56de7263fcf3eb10c8dcdf8d59a9cec831795f3f +See the kernel source file +.IR Documentation/admin\-guide/mm/transhuge.rst . +.\" Present only if the kernel was configured with +.\" .BR CONFIG_VM_EVENT_COUNTERS +.\" and +.\" .BR CONFIG_COMPACTION . +.TP +.IR compact_success " (since Linux 2.6.35)" +.\" commit 56de7263fcf3eb10c8dcdf8d59a9cec831795f3f +See the kernel source file +.IR Documentation/admin\-guide/mm/transhuge.rst . +.\" Present only if the kernel was configured with +.\" .BR CONFIG_VM_EVENT_COUNTERS +.\" and +.\" .BR CONFIG_COMPACTION . +.TP +.IR htlb_buddy_alloc_success " (since Linux 2.6.26)" +.\" commit 3b1163006332302117b1b2acf226d4014ff46525 +.\" Present only if the kernel was configured with +.\" .BR CONFIG_VM_EVENT_COUNTERS +.\" and +.\" .BR CONFIG_HUGETLB_PAGE . +.TP +.IR htlb_buddy_alloc_fail " (since Linux 2.6.26)" +.\" commit 3b1163006332302117b1b2acf226d4014ff46525 +.\" Present only if the kernel was configured with +.\" .BR CONFIG_VM_EVENT_COUNTERS +.\" and +.\" .BR CONFIG_HUGETLB_PAGE . +.TP +.IR unevictable_pgs_culled " (since Linux 2.6.28)" +.\" commit bbfd28eee9fbd73e780b19beb3dc562befbb94fa +.\" Present only if the kernel was configured with +.\" .BR CONFIG_VM_EVENT_COUNTERS . +.TP +.IR unevictable_pgs_scanned " (since Linux 2.6.28)" +.\" commit bbfd28eee9fbd73e780b19beb3dc562befbb94fa +.\" Present only if the kernel was configured with +.\" .BR CONFIG_VM_EVENT_COUNTERS . +.TP +.IR unevictable_pgs_rescued " (since Linux 2.6.28)" +.\" commit bbfd28eee9fbd73e780b19beb3dc562befbb94fa +.\" Present only if the kernel was configured with +.\" .BR CONFIG_VM_EVENT_COUNTERS . +.TP +.IR unevictable_pgs_mlocked " (since Linux 2.6.28)" +.\" commit 5344b7e648980cc2ca613ec03a56a8222ff48820 +.\" Present only if the kernel was configured with +.\" .BR CONFIG_VM_EVENT_COUNTERS . +.TP +.IR unevictable_pgs_munlocked " (since Linux 2.6.28)" +.\" commit 5344b7e648980cc2ca613ec03a56a8222ff48820 +.\" Present only if the kernel was configured with +.\" .BR CONFIG_VM_EVENT_COUNTERS . +.TP +.IR unevictable_pgs_cleared " (since Linux 2.6.28)" +.\" commit 5344b7e648980cc2ca613ec03a56a8222ff48820 +.\" Present only if the kernel was configured with +.\" .BR CONFIG_VM_EVENT_COUNTERS . +.TP +.IR unevictable_pgs_stranded " (since Linux 2.6.28)" +.\" commit 5344b7e648980cc2ca613ec03a56a8222ff48820 +.\" Present only if the kernel was configured with +.\" .BR CONFIG_VM_EVENT_COUNTERS . +.\" Linux 3.7 removed unevictable_pgs_mlockfreed +.TP +.IR thp_fault_alloc " (since Linux 2.6.39)" +.\" commit 81ab4201fb7d91d6b0cd9ad5b4b16776e4bed145 +See the kernel source file +.IR Documentation/admin\-guide/mm/transhuge.rst . +.\" Present only if the kernel was configured with +.\" .BR CONFIG_VM_EVENT_COUNTERS +.\" and +.\" .BR CONFIG_TRANSPARENT_HUGEPAGE . +.TP +.IR thp_fault_fallback " (since Linux 2.6.39)" +.\" commit 81ab4201fb7d91d6b0cd9ad5b4b16776e4bed145 +See the kernel source file +.IR Documentation/admin\-guide/mm/transhuge.rst . +.\" Present only if the kernel was configured with +.\" .BR CONFIG_VM_EVENT_COUNTERS +.\" and +.\" .BR CONFIG_TRANSPARENT_HUGEPAGE . +.TP +.IR thp_collapse_alloc " (since Linux 2.6.39)" +.\" commit 81ab4201fb7d91d6b0cd9ad5b4b16776e4bed145 +See the kernel source file +.IR Documentation/admin\-guide/mm/transhuge.rst . +.\" Present only if the kernel was configured with +.\" .BR CONFIG_VM_EVENT_COUNTERS +.\" and +.\" .BR CONFIG_TRANSPARENT_HUGEPAGE . +.TP +.IR thp_collapse_alloc_failed " (since Linux 2.6.39)" +.\" commit 81ab4201fb7d91d6b0cd9ad5b4b16776e4bed145 +See the kernel source file +.IR Documentation/admin\-guide/mm/transhuge.rst . +.\" Present only if the kernel was configured with +.\" .BR CONFIG_VM_EVENT_COUNTERS +.\" and +.\" .BR CONFIG_TRANSPARENT_HUGEPAGE . +.TP +.IR thp_split " (since Linux 2.6.39)" +.\" commit 81ab4201fb7d91d6b0cd9ad5b4b16776e4bed145 +See the kernel source file +.IR Documentation/admin\-guide/mm/transhuge.rst . +.\" Present only if the kernel was configured with +.\" .BR CONFIG_VM_EVENT_COUNTERS +.\" and +.\" .BR CONFIG_TRANSPARENT_HUGEPAGE . +.TP +.IR thp_zero_page_alloc " (since Linux 3.8)" +.\" commit d8a8e1f0da3d29d7268b3300c96a059d63901b76 +See the kernel source file +.IR Documentation/admin\-guide/mm/transhuge.rst . +.\" Present only if the kernel was configured with +.\" .BR CONFIG_VM_EVENT_COUNTERS +.\" and +.\" .BR CONFIG_TRANSPARENT_HUGEPAGE . +.TP +.IR thp_zero_page_alloc_failed " (since Linux 3.8)" +.\" commit d8a8e1f0da3d29d7268b3300c96a059d63901b76 +See the kernel source file +.IR Documentation/admin\-guide/mm/transhuge.rst . +.\" Present only if the kernel was configured with +.\" .BR CONFIG_VM_EVENT_COUNTERS +.\" and +.\" .BR CONFIG_TRANSPARENT_HUGEPAGE . +.TP +.IR balloon_inflate " (since Linux 3.18)" +.\" commit 09316c09dde33aae14f34489d9e3d243ec0d5938 +.\" Present only if the kernel was configured with +.\" .BR CONFIG_VM_EVENT_COUNTERS +.\" and +.\" .BR CONFIG_MEMORY_BALLOON . +.TP +.IR balloon_deflate " (since Linux 3.18)" +.\" commit 09316c09dde33aae14f34489d9e3d243ec0d5938 +.\" Present only if the kernel was configured with +.\" .BR CONFIG_VM_EVENT_COUNTERS +.\" and +.\" .BR CONFIG_MEMORY_BALLOON . +.TP +.IR balloon_migrate " (since Linux 3.18)" +.\" commit 09316c09dde33aae14f34489d9e3d243ec0d5938 +.\" Present only if the kernel was configured with +.\" .BR CONFIG_VM_EVENT_COUNTERS , +.\" .BR CONFIG_MEMORY_BALLOON , +.\" and +.\" .BR CONFIG_BALLOON_COMPACTION . +.TP +.IR nr_tlb_remote_flush " (since Linux 3.12)" +.\" commit 9824cf9753ecbe8f5b47aa9b2f218207defea211 +.\" Present only if the kernel was configured with +.\" .BR CONFIG_DEBUG_TLBFLUSH +.\" and +.\" .BR CONFIG_SMP . +.TP +.IR nr_tlb_remote_flush_received " (since Linux 3.12)" +.\" commit 9824cf9753ecbe8f5b47aa9b2f218207defea211 +.\" Present only if the kernel was configured with +.\" .BR CONFIG_DEBUG_TLBFLUSH +.\" and +.\" .BR CONFIG_SMP . +.TP +.IR nr_tlb_local_flush_all " (since Linux 3.12)" +.\" commit 9824cf9753ecbe8f5b47aa9b2f218207defea211 +.\" Present only if the kernel was configured with +.\" .BR CONFIG_DEBUG_TLBFLUSH . +.TP +.IR nr_tlb_local_flush_one " (since Linux 3.12)" +.\" commit 9824cf9753ecbe8f5b47aa9b2f218207defea211 +.\" Present only if the kernel was configured with +.\" .BR CONFIG_DEBUG_TLBFLUSH . +.TP +.IR vmacache_find_calls " (since Linux 3.16)" +.\" commit 4f115147ff802267d0aa41e361c5aa5bd933d896 +.\" Present only if the kernel was configured with +.\" .BR CONFIG_DEBUG_VM_VMACACHE . +.TP +.IR vmacache_find_hits " (since Linux 3.16)" +.\" commit 4f115147ff802267d0aa41e361c5aa5bd933d896 +.\" Present only if the kernel was configured with +.\" .BR CONFIG_DEBUG_VM_VMACACHE . +.TP +.IR vmacache_full_flushes " (since Linux 3.19)" +.\" commit f5f302e21257ebb0c074bbafc37606c26d28cc3d +.\" Present only if the kernel was configured with +.\" .BR CONFIG_DEBUG_VM_VMACACHE . +.RE +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/proc_zoneinfo.5 b/upstream/opensuse-tumbleweed/man5/proc_zoneinfo.5 new file mode 100644 index 00000000..86fe3801 --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/proc_zoneinfo.5 @@ -0,0 +1,17 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_zoneinfo 5 2024-05-02 "Linux man-pages (unreleased)" +.SH NAME +/proc/zoneinfo \- memory zones +.SH DESCRIPTION +.TP +.IR /proc/zoneinfo " (since Linux 2.6.13)" +This file displays information about memory zones. +This is useful for analyzing virtual memory behavior. +.\" FIXME more should be said about /proc/zoneinfo +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/opensuse-tumbleweed/man5/protocols.5 b/upstream/opensuse-tumbleweed/man5/protocols.5 index 7939407a..41630c5e 100644 --- a/upstream/opensuse-tumbleweed/man5/protocols.5 +++ b/upstream/opensuse-tumbleweed/man5/protocols.5 @@ -7,7 +7,7 @@ .\" 2002-09-22 Seth W. Klein <sk@sethwklein.net> .\" * protocol numbers are now assigned by the IANA .\" -.TH protocols 5 2022-10-30 "Linux man-pages 6.05.01" +.TH protocols 5 2024-05-02 "Linux man-pages (unreleased)" .SH NAME protocols \- protocols definition file .SH DESCRIPTION @@ -18,24 +18,24 @@ consulted instead of using the numbers in the ARPA include files, or, even worse, just guessing them. These numbers will occur in the protocol field of any IP header. -.PP +.P Keep this file untouched since changes would result in incorrect IP packages. Protocol numbers and names are specified by the IANA (Internet Assigned Numbers Authority). .\" .. by the DDN Network Information Center. -.PP +.P Each line is of the following format: -.PP +.P .RS -.I protocol number aliases ... +.I protocol number aliases .\|.\|. .RE -.PP +.P where the fields are delimited by spaces or tabs. Empty lines are ignored. If a line contains a hash mark (#), the hash mark and the part of the line following it are ignored. -.PP +.P The field descriptions are: .TP .I protocol @@ -52,7 +52,7 @@ header. .TP .I aliases optional aliases for the protocol. -.PP +.P This file might be distributed over a network using a network-wide naming service like Yellow Pages/NIS or BIND/Hesiod. .SH FILES @@ -61,6 +61,6 @@ naming service like Yellow Pages/NIS or BIND/Hesiod. The protocols definition file. .SH SEE ALSO .BR getprotoent (3) -.PP +.P .UR http://www.iana.org\:/assignments\:/protocol\-numbers .UE diff --git a/upstream/opensuse-tumbleweed/man5/repart.d.5 b/upstream/opensuse-tumbleweed/man5/repart.d.5 deleted file mode 100644 index fea09352..00000000 --- a/upstream/opensuse-tumbleweed/man5/repart.d.5 +++ /dev/null @@ -1,1013 +0,0 @@ -'\" t -.TH "REPART\&.D" "5" "" "systemd 254" "repart.d" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- -.SH "NAME" -repart.d \- Partition Definition Files for Automatic Boot\-Time Repartitioning -.SH "SYNOPSIS" -.PP -.nf -/etc/repart\&.d/*\&.conf -/run/repart\&.d/*\&.conf -/usr/lib/repart\&.d/*\&.conf - -.fi -.SH "DESCRIPTION" -.PP -repart\&.d/*\&.conf -files describe basic properties of partitions of block devices of the local system\&. They may be used to declare types, names and sizes of partitions that shall exist\&. The -\fBsystemd-repart\fR(8) -service reads these files and attempts to add new partitions currently missing and enlarge existing partitions according to these definitions\&. Operation is generally incremental, i\&.e\&. when applied, what exists already is left intact, and partitions are never shrunk, moved or deleted\&. -.PP -These definition files are useful for implementing operating system images that are prepared and delivered with minimally sized images (for example lacking any state or swap partitions), and which on first boot automatically take possession of any remaining disk space following a few basic rules\&. -.PP -Currently, support for partition definition files is only implemented for GPT partition tables\&. -.PP -Partition files are generally matched against any partitions already existing on disk in a simple algorithm: the partition files are sorted by their filename (ignoring the directory prefix), and then compared in order against existing partitions matching the same partition type UUID\&. Specifically, the first existing partition with a specific partition type UUID is assigned the first definition file with the same partition type UUID, and the second existing partition with a specific type UUID the second partition file with the same type UUID, and so on\&. Any left\-over partition files that have no matching existing partition are assumed to define new partition that shall be created\&. Such partitions are appended to the end of the partition table, in the order defined by their names utilizing the first partition slot greater than the highest slot number currently in use\&. Any existing partitions that have no matching partition file are left as they are\&. -.PP -Note that these definitions may only be used to create and initialize new partitions or to grow existing ones\&. In the latter case it will not grow the contained files systems however; separate mechanisms, such as -\fBsystemd-growfs\fR(8) -may be used to grow the file systems inside of these partitions\&. Partitions may also be marked for automatic growing via the -\fIGrowFileSystem=\fR -setting, in which case the file system is grown on first mount by tools that respect this flag\&. See below for details\&. -.SH "[PARTITION] SECTION OPTIONS" -.PP -\fIType=\fR -.RS 4 -The GPT partition type UUID to match\&. This may be a GPT partition type UUID such as -\fB4f68bce3\-e8cd\-4db1\-96e7\-fbcaf984b709\fR, or an identifier\&. Architecture specific partition types can use one of these architecture identifiers: -\fBalpha\fR, -\fBarc\fR, -\fBarm\fR -(32\-bit), -\fBarm64\fR -(64\-bit, aka aarch64), -\fBia64\fR, -\fBloongarch64\fR, -\fBmips\-le\fR, -\fBmips64\-le\fR, -\fBparisc\fR, -\fBppc\fR, -\fBppc64\fR, -\fBppc64\-le\fR, -\fBriscv32\fR, -\fBriscv64\fR, -\fBs390\fR, -\fBs390x\fR, -\fBtilegx\fR, -\fBx86\fR -(32\-bit, aka i386) and -\fBx86\-64\fR -(64\-bit, aka amd64)\&. The supported identifiers are: -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&1.\ \&GPT partition type identifiers -.TS -allbox tab(:); -lB lB. -T{ -Identifier -T}:T{ -Explanation -T} -.T& -l l -l l -l l -l l -l l -l l -l l -l l -l l -l l -l l -l l -l l -l l -l l -l l -l l -l l -l l -l l -l l -l l -l l -l l -l l -l l. -T{ -\fBesp\fR -T}:T{ -EFI System Partition -T} -T{ -\fBxbootldr\fR -T}:T{ -Extended Boot Loader Partition -T} -T{ -\fBswap\fR -T}:T{ -Swap partition -T} -T{ -\fBhome\fR -T}:T{ -Home (/home/) partition -T} -T{ -\fBsrv\fR -T}:T{ -Server data (/srv/) partition -T} -T{ -\fBvar\fR -T}:T{ -Variable data (/var/) partition -T} -T{ -\fBtmp\fR -T}:T{ -Temporary data (/var/tmp/) partition -T} -T{ -\fBlinux\-generic\fR -T}:T{ -Generic Linux file system partition -T} -T{ -\fBroot\fR -T}:T{ -Root file system partition type appropriate for the local architecture (an alias for an architecture root file system partition type listed below, e\&.g\&. \fBroot\-x86\-64\fR) -T} -T{ -\fBroot\-verity\fR -T}:T{ -Verity data for the root file system partition for the local architecture -T} -T{ -\fBroot\-verity\-sig\fR -T}:T{ -Verity signature data for the root file system partition for the local architecture -T} -T{ -\fBroot\-secondary\fR -T}:T{ -Root file system partition of the secondary architecture of the local architecture (usually the matching 32\-bit architecture for the local 64\-bit architecture) -T} -T{ -\fBroot\-secondary\-verity\fR -T}:T{ -Verity data for the root file system partition of the secondary architecture -T} -T{ -\fBroot\-secondary\-verity\-sig\fR -T}:T{ -Verity signature data for the root file system partition of the secondary architecture -T} -T{ -\fBroot\-{arch}\fR -T}:T{ -Root file system partition of the given architecture (such as \fBroot\-x86\-64\fR or \fBroot\-riscv64\fR) -T} -T{ -\fBroot\-{arch}\-verity\fR -T}:T{ -Verity data for the root file system partition of the given architecture -T} -T{ -\fBroot\-{arch}\-verity\-sig\fR -T}:T{ -Verity signature data for the root file system partition of the given architecture -T} -T{ -\fBusr\fR -T}:T{ -/usr/ file system partition type appropriate for the local architecture (an alias for an architecture /usr/ file system partition type listed below, e\&.g\&. \fBusr\-x86\-64\fR) -T} -T{ -\fBusr\-verity\fR -T}:T{ -Verity data for the /usr/ file system partition for the local architecture -T} -T{ -\fBusr\-verity\-sig\fR -T}:T{ -Verity signature data for the /usr/ file system partition for the local architecture -T} -T{ -\fBusr\-secondary\fR -T}:T{ -/usr/ file system partition of the secondary architecture of the local architecture (usually the matching 32\-bit architecture for the local 64\-bit architecture) -T} -T{ -\fBusr\-secondary\-verity\fR -T}:T{ -Verity data for the /usr/ file system partition of the secondary architecture -T} -T{ -\fBusr\-secondary\-verity\-sig\fR -T}:T{ -Verity signature data for the /usr/ file system partition of the secondary architecture -T} -T{ -\fBusr\-{arch}\fR -T}:T{ -/usr/ file system partition of the given architecture -T} -T{ -\fBusr\-{arch}\-verity\fR -T}:T{ -Verity data for the /usr/ file system partition of the given architecture -T} -T{ -\fBusr\-{arch}\-verity\-sig\fR -T}:T{ -Verity signature data for the /usr/ file system partition of the given architecture -T} -.TE -.sp 1 -This setting defaults to -\fBlinux\-generic\fR\&. -.sp -Most of the partition type UUIDs listed above are defined in the -\m[blue]\fBDiscoverable Partitions Specification\fR\m[]\&\s-2\u[1]\d\s+2\&. -.RE -.PP -\fILabel=\fR -.RS 4 -The textual label to assign to the partition if none is assigned yet\&. Note that this setting is not used for matching\&. It is also not used when a label is already set for an existing partition\&. It is thus only used when a partition is newly created or when an existing one had a no label set (that is: an empty label)\&. If not specified a label derived from the partition type is automatically used\&. Simple specifier expansion is supported, see below\&. -.RE -.PP -\fIUUID=\fR -.RS 4 -The UUID to assign to the partition if none is assigned yet\&. Note that this setting is not used for matching\&. It is also not used when a UUID is already set for an existing partition\&. It is thus only used when a partition is newly created or when an existing one had a all\-zero UUID set\&. If set to -"null", the UUID is set to all zeroes\&. If not specified a UUID derived from the partition type is automatically used\&. -.RE -.PP -\fIPriority=\fR -.RS 4 -A numeric priority to assign to this partition, in the range \-2147483648\&...2147483647, with smaller values indicating higher priority, and higher values indicating smaller priority\&. This priority is used in case the configured size constraints on the defined partitions do not permit fitting all partitions onto the available disk space\&. If the partitions do not fit, the highest numeric partition priority of all defined partitions is determined, and all defined partitions with this priority are removed from the list of new partitions to create (which may be multiple, if the same priority is used for multiple partitions)\&. The fitting algorithm is then tried again\&. If the partitions still do not fit, the now highest numeric partition priority is determined, and the matching partitions removed too, and so on\&. Partitions of a priority of 0 or lower are never removed\&. If all partitions with a priority above 0 are removed and the partitions still do not fit on the device the operation fails\&. Note that this priority has no effect on ordering partitions, for that use the alphabetical order of the filenames of the partition definition files\&. Defaults to 0\&. -.RE -.PP -\fIWeight=\fR -.RS 4 -A numeric weight to assign to this partition in the range 0\&...1000000\&. Available disk space is assigned the defined partitions according to their relative weights (subject to the size constraints configured with -\fISizeMinBytes=\fR, -\fISizeMaxBytes=\fR), so that a partition with weight 2000 gets double the space as one with weight 1000, and a partition with weight 333 a third of that\&. Defaults to 1000\&. -.sp -The -\fIWeight=\fR -setting is used to distribute available disk space in an "elastic" fashion, based on the disk size and existing partitions\&. If a partition shall have a fixed size use both -\fISizeMinBytes=\fR -and -\fISizeMaxBytes=\fR -with the same value in order to fixate the size to one value, in which case the weight has no effect\&. -.RE -.PP -\fIPaddingWeight=\fR -.RS 4 -Similar to -\fIWeight=\fR, but sets a weight for the free space after the partition (the "padding")\&. When distributing available space the weights of all partitions and all defined padding is summed, and then each partition and padding gets the fraction defined by its weight\&. Defaults to 0, i\&.e\&. by default no padding is applied\&. -.sp -Padding is useful if empty space shall be left for later additions or a safety margin at the end of the device or between partitions\&. -.RE -.PP -\fISizeMinBytes=\fR, \fISizeMaxBytes=\fR -.RS 4 -Specifies minimum and maximum size constraints in bytes\&. Takes the usual K, M, G, T, \&... suffixes (to the base of 1024)\&. If -\fISizeMinBytes=\fR -is specified the partition is created at or grown to at least the specified size\&. If -\fISizeMaxBytes=\fR -is specified the partition is created at or grown to at most the specified size\&. The precise size is determined through the weight value configured with -\fIWeight=\fR, see above\&. When -\fISizeMinBytes=\fR -is set equal to -\fISizeMaxBytes=\fR -the configured weight has no effect as the partition is explicitly sized to the specified fixed value\&. Note that partitions are never created smaller than 4096 bytes, and since partitions are never shrunk the previous size of the partition (in case the partition already exists) is also enforced as lower bound for the new size\&. The values should be specified as multiples of 4096 bytes, and are rounded upwards (in case of -\fISizeMinBytes=\fR) or downwards (in case of -\fISizeMaxBytes=\fR) otherwise\&. If the backing device does not provide enough space to fulfill the constraints placing the partition will fail\&. For partitions that shall be created, depending on the setting of -\fIPriority=\fR -(see above) the partition might be dropped and the placing algorithm restarted\&. By default a minimum size constraint of 10M and no maximum size constraint is set\&. -.RE -.PP -\fIPaddingMinBytes=\fR, \fIPaddingMaxBytes=\fR -.RS 4 -Specifies minimum and maximum size constraints in bytes for the free space after the partition (the "padding")\&. Semantics are similar to -\fISizeMinBytes=\fR -and -\fISizeMaxBytes=\fR, except that unlike partition sizes free space can be shrunk and can be as small as zero\&. By default no size constraints on padding are set, so that only -\fIPaddingWeight=\fR -determines the size of the padding applied\&. -.RE -.PP -\fICopyBlocks=\fR -.RS 4 -Takes a path to a regular file, block device node or directory, or the special value -"auto"\&. If specified and the partition is newly created, the data from the specified path is written to the newly created partition, on the block level\&. If a directory is specified, the backing block device of the file system the directory is on is determined, and the data read directly from that\&. This option is useful to efficiently replicate existing file systems onto new partitions on the block level \(em for example to build a simple OS installer or an OS image builder\&. -.sp -If the special value -"auto" -is specified, the source to copy from is automatically picked up from the running system (or the image specified with -\fB\-\-image=\fR -\(em if used)\&. A partition that matches both the configured partition type (as declared with -\fIType=\fR -described above), and the currently mounted directory appropriate for that partition type is determined\&. For example, if the partition type is set to -"root" -the partition backing the root directory (/) is used as source to copy from \(em if its partition type is set to -"root" -as well\&. If the declared type is -"usr" -the partition backing -/usr/ -is used as source to copy blocks from \(em if its partition type is set to -"usr" -too\&. The logic is capable of automatically tracking down the backing partitions for encrypted and Verity\-enabled volumes\&. -"CopyBlocks=auto" -is useful for implementing "self\-replicating" systems, i\&.e\&. systems that are their own installer\&. -.sp -The file specified here must have a size that is a multiple of the basic block size 512 and not be empty\&. If this option is used, the size allocation algorithm is slightly altered: the partition is created as least as big as required to fit the data in, i\&.e\&. the data size is an additional minimum size value taken into consideration for the allocation algorithm, similar to and in addition to the -\fISizeMin=\fR -value configured above\&. -.sp -This option has no effect if the partition it is declared for already exists, i\&.e\&. existing data is never overwritten\&. Note that the data is copied in before the partition table is updated, i\&.e\&. before the partition actually is persistently created\&. This provides robustness: it is guaranteed that the partition either doesn\*(Aqt exist or exists fully populated; it is not possible that the partition exists but is not or only partially populated\&. -.sp -This option cannot be combined with -\fIFormat=\fR -or -\fICopyFiles=\fR\&. -.RE -.PP -\fIFormat=\fR -.RS 4 -Takes a file system name, such as -"ext4", -"btrfs", -"xfs", -"vfat", -"erofs", -"squashfs" -or the special value -"swap"\&. If specified and the partition is newly created it is formatted with the specified file system (or as swap device)\&. The file system UUID and label are automatically derived from the partition UUID and label\&. If this option is used, the size allocation algorithm is slightly altered: the partition is created as least as big as required for the minimal file system of the specified type (or 4KiB if the minimal size is not known)\&. -.sp -This option has no effect if the partition already exists\&. -.sp -Similarly to the behaviour of -\fICopyBlocks=\fR, the file system is formatted before the partition is created, ensuring that the partition only ever exists with a fully initialized file system\&. -.sp -This option cannot be combined with -\fICopyBlocks=\fR\&. -.RE -.PP -\fICopyFiles=\fR -.RS 4 -Takes a pair of colon separated absolute file system paths\&. The first path refers to a source file or directory on the host, the second path refers to a target in the file system of the newly created partition and formatted file system\&. This setting may be used to copy files or directories from the host into the file system that is created due to the -\fIFormat=\fR -option\&. If -\fICopyFiles=\fR -is used without -\fIFormat=\fR -specified explicitly, -"Format=" -with a suitable default is implied (currently -"vfat" -for -"ESP" -and -"XBOOTLDR" -partitions, and -"ext4" -otherwise, but this may change in the future)\&. This option may be used multiple times to copy multiple files or directories from host into the newly formatted file system\&. The colon and second path may be omitted in which case the source path is also used as the target path (relative to the root of the newly created file system)\&. If the source path refers to a directory it is copied recursively\&. -.sp -This option has no effect if the partition already exists: it cannot be used to copy additional files into an existing partition, it may only be used to populate a file system created anew\&. -.sp -The copy operation is executed before the file system is registered in the partition table, thus ensuring that a file system populated this way only ever exists fully initialized\&. -.sp -Note that -\fICopyFiles=\fR -will skip copying files that aren\*(Aqt supported by the target filesystem (e\&.g symlinks, fifos, sockets and devices on vfat)\&. When an unsupported file type is encountered, -\fBsystemd\-repart\fR -will skip copying this file and write a log message about it\&. -.sp -Note that -\fBsystemd\-repart\fR -does not change the UIDs/GIDs of any copied files and directories\&. When running -\fBsystemd\-repart\fR -as an unprivileged user to build an image of files and directories owned by the same user, you can run -\fBsystemd\-repart\fR -in a user namespace with the current user mapped to the root user to make sure the files and directories in the image are owned by the root user\&. -.sp -Note that when populating XFS filesystems with -\fBsystemd\-repart\fR -and loop devices are not available, populating XFS filesystems with files containing spaces, tabs or newlines might fail on old versions of -\fBmkfs.xfs\fR(8) -due to limitations of its protofile format\&. -.sp -Note that when populating XFS filesystems with -\fBsystemd\-repart\fR -and loop devices are not available, extended attributes will not be copied into generated XFS filesystems due to limitations -\fBmkfs.xfs\fR(8)\*(Aqs protofile format\&. -.sp -This option cannot be combined with -\fICopyBlocks=\fR\&. -.sp -When -\fBsystemd-repart\fR(8) -is invoked with the -\fB\-\-image=\fR -or -\fB\-\-root=\fR -command line switches the source paths specified are taken relative to the specified root directory or disk image root\&. -.RE -.PP -\fIExcludeFiles=\fR, \fIExcludeFilesTarget=\fR -.RS 4 -Takes an absolute file system path referring to a source file or directory on the host\&. This setting may be used to exclude files or directories from the host from being copied into the file system when -\fICopyFiles=\fR -is used\&. This option may be used multiple times to exclude multiple files or directories from host from being copied into the newly formatted file system\&. -.sp -If the path is a directory and ends with -"/", only the directory\*(Aqs contents are excluded but not the directory itself\&. If the path is a directory and does not end with -"/", both the directory and its contents are excluded\&. -.sp -\fIExcludeFilesTarget=\fR -is like -\fIExcludeFiles=\fR -except that instead of excluding the path on the host from being copied into the partition, we exclude any files and directories from being copied into the given path in the partition\&. -.sp -When -\fBsystemd-repart\fR(8) -is invoked with the -\fB\-\-image=\fR -or -\fB\-\-root=\fR -command line switches the paths specified are taken relative to the specified root directory or disk image root\&. -.RE -.PP -\fIMakeDirectories=\fR -.RS 4 -Takes one or more absolute paths, separated by whitespace, each declaring a directory to create within the new file system\&. Behaviour is similar to -\fICopyFiles=\fR, but instead of copying in a set of files this just creates the specified directories with the default mode of 0755 owned by the root user and group, plus all their parent directories (with the same ownership and access mode)\&. To configure directories with different ownership or access mode, use -\fICopyFiles=\fR -and specify a source tree to copy containing appropriately owned/configured directories\&. This option may be used more than once to create multiple directories\&. When -\fICopyFiles=\fR -and -\fIMakeDirectories=\fR -are used together the former is applied first\&. If a directory listed already exists no operation is executed (in particular, the ownership/access mode of the directories is left as is)\&. -.sp -The primary use case for this option is to create a minimal set of directories that may be mounted over by other partitions contained in the same disk image\&. For example, a disk image where the root file system is formatted at first boot might want to automatically pre\-create -/usr/ -in it this way, so that the -"usr" -partition may over\-mount it\&. -.sp -Consider using -\fBsystemd-tmpfiles\fR(8) -with its -\fB\-\-image=\fR -option to pre\-create other, more complex directory hierarchies (as well as other inodes) with fine\-grained control of ownership, access modes and other file attributes\&. -.RE -.PP -\fIEncrypt=\fR -.RS 4 -Takes one of -"off", -"key\-file", -"tpm2" -and -"key\-file+tpm2" -(alternatively, also accepts a boolean value, which is mapped to -"off" -when false, and -"key\-file" -when true)\&. Defaults to -"off"\&. If not -"off" -the partition will be formatted with a LUKS2 superblock, before the blocks configured with -\fICopyBlocks=\fR -are copied in or the file system configured with -\fIFormat=\fR -is created\&. -.sp -The LUKS2 UUID is automatically derived from the partition UUID in a stable fashion\&. If -"key\-file" -or -"key\-file+tpm2" -is used, a key is added to the LUKS2 superblock, configurable with the -\fB\-\-key\-file=\fR -option to -\fBsystemd\-repart\fR\&. If -"tpm2" -or -"key\-file+tpm2" -is used, a key is added to the LUKS2 superblock that is enrolled to the local TPM2 chip, as configured with the -\fB\-\-tpm2\-device=\fR -and -\fB\-\-tpm2\-pcrs=\fR -options to -\fBsystemd\-repart\fR\&. -.sp -When used this slightly alters the size allocation logic as the implicit, minimal size limits of -\fIFormat=\fR -and -\fICopyBlocks=\fR -are increased by the space necessary for the LUKS2 superblock (see above)\&. -.sp -This option has no effect if the partition already exists\&. -.RE -.PP -\fIVerity=\fR -.RS 4 -Takes one of -"off", -"data", -"hash" -or -"signature"\&. Defaults to -"off"\&. If set to -"off" -or -"data", the partition is populated with content as specified by -\fICopyBlocks=\fR -or -\fICopyFiles=\fR\&. If set to -"hash", the partition will be populated with verity hashes from the matching verity data partition\&. If set to -"signature", the partition will be populated with a JSON object containing a signature of the verity root hash of the matching verity hash partition\&. -.sp -A matching verity partition is a partition with the same verity match key (as configured with -\fIVerityMatchKey=\fR)\&. -.sp -If not explicitly configured, the data partition\*(Aqs UUID will be set to the first 128 bits of the verity root hash\&. Similarly, if not configured, the hash partition\*(Aqs UUID will be set to the final 128 bits of the verity root hash\&. The verity root hash itself will be included in the output of -\fBsystemd\-repart\fR\&. -.sp -This option has no effect if the partition already exists\&. -.sp -Usage of this option in combination with -\fIEncrypt=\fR -is not supported\&. -.sp -For each unique -\fIVerityMatchKey=\fR -value, a single verity data partition ("Verity=data") and a single verity hash partition ("Verity=hash") must be defined\&. -.RE -.PP -\fIVerityMatchKey=\fR -.RS 4 -Takes a short, user\-chosen identifier string\&. This setting is used to find sibling verity partitions for the current verity partition\&. See the description for -\fIVerity=\fR\&. -.RE -.PP -\fIFactoryReset=\fR -.RS 4 -Takes a boolean argument\&. If specified the partition is marked for removal during a factory reset operation\&. This functionality is useful to implement schemes where images can be reset into their original state by removing partitions and creating them anew\&. Defaults to off\&. -.RE -.PP -\fIFlags=\fR -.RS 4 -Configures the 64\-bit GPT partition flags field to set for the partition when creating it\&. This option has no effect if the partition already exists\&. If not specified the flags values is set to all zeroes, except for the three bits that can also be configured via -\fINoAuto=\fR, -\fIReadOnly=\fR -and -\fIGrowFileSystem=\fR; see below for details on the defaults for these three flags\&. Specify the flags value in hexadecimal (by prefixing it with -"0x"), binary (prefix -"0b") or decimal (no prefix)\&. -.RE -.PP -\fINoAuto=\fR, \fIReadOnly=\fR, \fIGrowFileSystem=\fR -.RS 4 -Configures the No\-Auto, Read\-Only and Grow\-File\-System partition flags (bit 63, 60 and 59) of the partition table entry, as defined by the -\m[blue]\fBDiscoverable Partitions Specification\fR\m[]\&\s-2\u[1]\d\s+2\&. Only available for partition types supported by the specification\&. This option is a friendly way to set bits 63, 60 and 59 of the partition flags value without setting any of the other bits, and may be set via -\fIFlags=\fR -too, see above\&. -.sp -If -\fIFlags=\fR -is used in conjunction with one or more of -\fINoAuto=\fR/\fIReadOnly=\fR/\fIGrowFileSystem=\fR -the latter control the value of the relevant flags, i\&.e\&. the high\-level settings -\fINoAuto=\fR/\fIReadOnly=\fR/\fIGrowFileSystem=\fR -override the relevant bits of the low\-level setting -\fIFlags=\fR\&. -.sp -Note that the three flags affect only automatic partition mounting, as implemented by -\fBsystemd-gpt-auto-generator\fR(8) -or the -\fB\-\-image=\fR -option of various commands (such as -\fBsystemd-nspawn\fR(1))\&. It has no effect on explicit mounts, such as those done via -\fBmount\fR(8) -or -\fBfstab\fR(5)\&. -.sp -If both bit 50 and 59 are set for a partition (i\&.e\&. the partition is marked both read\-only and marked for file system growing) the latter is typically without effect: the read\-only flag takes precedence in most tools reading these flags, and since growing the file system involves writing to the partition it is consequently ignored\&. -.sp -\fINoAuto=\fR -defaults to off\&. -\fIReadOnly=\fR -defaults to on for Verity partition types, and off for all others\&. -\fIGrowFileSystem=\fR -defaults to on for all partition types that support it, except if the partition is marked read\-only (and thus effectively, defaults to off for Verity partitions)\&. -.RE -.PP -\fISplitName=\fR -.RS 4 -Configures the suffix to append to split artifacts when the -\fB\-\-split\fR -option of -\fBsystemd-repart\fR(8) -is used\&. Simple specifier expansion is supported, see below\&. Defaults to -"%t"\&. To disable split artifact generation for a partition, set -\fISplitName=\fR -to -"\-"\&. -.RE -.PP -\fIMinimize=\fR -.RS 4 -Takes one of -"off", -"best", and -"guess" -(alternatively, also accepts a boolean value, which is mapped to -"off" -when false, and -"best" -when true)\&. Defaults to -"off"\&. If set to -"best", the partition will have the minimal size required to store the sources configured with -\fICopyFiles=\fR\&. -"best" -is currently only supported for read\-only filesystems\&. If set to -"guess", the partition is created at least as big as required to store the sources configured with -\fICopyFiles=\fR\&. Note that unless the filesystem is a read\-only filesystem, -\fBsystemd\-repart\fR -will have to populate the filesystem twice to guess the minimal required size, so enabling this option might slow down repart when populating large partitions\&. -.RE -.SH "SPECIFIERS" -.PP -Specifiers may be used in the -\fILabel=\fR, -\fICopyBlocks=\fR, -\fICopyFiles=\fR, -\fIMakeDirectories=\fR, -\fISplitName=\fR -settings\&. The following expansions are understood: -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&2.\ \&Specifiers available -.TS -allbox tab(:); -lB lB lB. -T{ -Specifier -T}:T{ -Meaning -T}:T{ -Details -T} -.T& -l l l -l l l -l l l -l l l -l l l -l l l -l l l -l l l -l l l -l l l -l l l -l l l -l l l -l l l -l l l. -T{ -"%a" -T}:T{ -Architecture -T}:T{ -A short string identifying the architecture of the local system\&. A string such as \fBx86\fR, \fBx86\-64\fR or \fBarm64\fR\&. See the architectures defined for \fIConditionArchitecture=\fR in \fBsystemd.unit\fR(5) for a full list\&. -T} -T{ -"%A" -T}:T{ -Operating system image version -T}:T{ -The operating system image version identifier of the running system, as read from the \fIIMAGE_VERSION=\fR field of /etc/os\-release\&. If not set, resolves to an empty string\&. See \fBos-release\fR(5) for more information\&. -T} -T{ -"%b" -T}:T{ -Boot ID -T}:T{ -The boot ID of the running system, formatted as string\&. See \fBrandom\fR(4) for more information\&. -T} -T{ -"%B" -T}:T{ -Operating system build ID -T}:T{ -The operating system build identifier of the running system, as read from the \fIBUILD_ID=\fR field of /etc/os\-release\&. If not set, resolves to an empty string\&. See \fBos-release\fR(5) for more information\&. -T} -T{ -"%H" -T}:T{ -Host name -T}:T{ -The hostname of the running system\&. -T} -T{ -"%l" -T}:T{ -Short host name -T}:T{ -The hostname of the running system, truncated at the first dot to remove any domain component\&. -T} -T{ -"%m" -T}:T{ -Machine ID -T}:T{ -The machine ID of the running system, formatted as string\&. See \fBmachine-id\fR(5) for more information\&. -T} -T{ -"%M" -T}:T{ -Operating system image identifier -T}:T{ -The operating system image identifier of the running system, as read from the \fIIMAGE_ID=\fR field of /etc/os\-release\&. If not set, resolves to an empty string\&. See \fBos-release\fR(5) for more information\&. -T} -T{ -"%o" -T}:T{ -Operating system ID -T}:T{ -The operating system identifier of the running system, as read from the \fIID=\fR field of /etc/os\-release\&. See \fBos-release\fR(5) for more information\&. -T} -T{ -"%v" -T}:T{ -Kernel release -T}:T{ -Identical to \fBuname \-r\fR output\&. -T} -T{ -"%w" -T}:T{ -Operating system version ID -T}:T{ -The operating system version identifier of the running system, as read from the \fIVERSION_ID=\fR field of /etc/os\-release\&. If not set, resolves to an empty string\&. See \fBos-release\fR(5) for more information\&. -T} -T{ -"%W" -T}:T{ -Operating system variant ID -T}:T{ -The operating system variant identifier of the running system, as read from the \fIVARIANT_ID=\fR field of /etc/os\-release\&. If not set, resolves to an empty string\&. See \fBos-release\fR(5) for more information\&. -T} -T{ -"%T" -T}:T{ -Directory for temporary files -T}:T{ -This is either /tmp or the path "$TMPDIR", "$TEMP" or "$TMP" are set to\&. (Note that the directory may be specified without a trailing slash\&.) -T} -T{ -"%V" -T}:T{ -Directory for larger and persistent temporary files -T}:T{ -This is either /var/tmp or the path "$TMPDIR", "$TEMP" or "$TMP" are set to\&. (Note that the directory may be specified without a trailing slash\&.) -T} -T{ -"%%" -T}:T{ -Single percent sign -T}:T{ -Use "%%" in place of "%" to specify a single percent sign\&. -T} -.TE -.sp 1 -.PP -Additionally, for the -\fISplitName=\fR -setting, the following specifiers are also understood: -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&3.\ \&Specifiers available -.TS -allbox tab(:); -lB lB lB. -T{ -Specifier -T}:T{ -Meaning -T}:T{ -Details -T} -.T& -l l l -l l l -l l l -l l l. -T{ -"%T" -T}:T{ -Partition Type UUID -T}:T{ -The partition type UUID, as configured with \fIType=\fR -T} -T{ -"%t" -T}:T{ -Partition Type Identifier -T}:T{ -The partition type identifier corresponding to the partition type UUID -T} -T{ -"%U" -T}:T{ -Partition UUID -T}:T{ -The partition UUID, as configured with \fIUUID=\fR -T} -T{ -"%n" -T}:T{ -Partition Number -T}:T{ -The partition number assigned to the partition -T} -.TE -.sp 1 -.SH "EXAMPLES" -.PP -\fBExample\ \&1.\ \&Grow the root partition to the full disk size at first boot\fR -.PP -With the following file the root partition is automatically grown to the full disk if possible during boot\&. -.PP -.if n \{\ -.RS 4 -.\} -.nf -# /usr/lib/repart\&.d/50\-root\&.conf -[Partition] -Type=root -.fi -.if n \{\ -.RE -.\} - -.PP -\fBExample\ \&2.\ \&Create a swap and home partition automatically on boot, if missing\fR -.PP -The home partition gets all available disk space while the swap partition gets 1G at most and 64M at least\&. We set a priority > 0 on the swap partition to ensure the swap partition is not used if not enough space is available\&. For every three bytes assigned to the home partition the swap partition gets assigned one\&. -.PP -.if n \{\ -.RS 4 -.\} -.nf -# /usr/lib/repart\&.d/60\-home\&.conf -[Partition] -Type=home -.fi -.if n \{\ -.RE -.\} -.PP -.if n \{\ -.RS 4 -.\} -.nf -# /usr/lib/repart\&.d/70\-swap\&.conf -[Partition] -Type=swap -SizeMinBytes=64M -SizeMaxBytes=1G -Priority=1 -Weight=333 -.fi -.if n \{\ -.RE -.\} - -.PP -\fBExample\ \&3.\ \&Create B partitions in an A/B Verity setup, if missing\fR -.PP -Let\*(Aqs say the vendor intends to update OS images in an A/B setup, i\&.e\&. with two root partitions (and two matching Verity partitions) that shall be used alternatingly during upgrades\&. To minimize image sizes the original image is shipped only with one root and one Verity partition (the "A" set), and the second root and Verity partitions (the "B" set) shall be created on first boot on the free space on the medium\&. -.PP -.if n \{\ -.RS 4 -.\} -.nf -# /usr/lib/repart\&.d/50\-root\&.conf -[Partition] -Type=root -SizeMinBytes=512M -SizeMaxBytes=512M -.fi -.if n \{\ -.RE -.\} -.PP -.if n \{\ -.RS 4 -.\} -.nf -# /usr/lib/repart\&.d/60\-root\-verity\&.conf -[Partition] -Type=root\-verity -SizeMinBytes=64M -SizeMaxBytes=64M -.fi -.if n \{\ -.RE -.\} -.PP -The definitions above cover the "A" set of root partition (of a fixed 512M size) and Verity partition for the root partition (of a fixed 64M size)\&. Let\*(Aqs use symlinks to create the "B" set of partitions, since after all they shall have the same properties and sizes as the "A" set\&. -.PP -.if n \{\ -.RS 4 -.\} -.nf -# ln \-s 50\-root\&.conf /usr/lib/repart\&.d/70\-root\-b\&.conf -# ln \-s 60\-root\-verity\&.conf /usr/lib/repart\&.d/80\-root\-verity\-b\&.conf -.fi -.if n \{\ -.RE -.\} - -.PP -\fBExample\ \&4.\ \&Create a data and verity partition from a OS tree\fR -.PP -Assuming we have an OS tree at /var/tmp/os\-tree that we want to package in a root partition together with a matching verity partition, we can do so as follows: -.PP -.if n \{\ -.RS 4 -.\} -.nf -# 50\-root\&.conf -[Partition] -Type=root -CopyFiles=/var/tmp/os\-tree -Verity=data -VerityMatchKey=root -.fi -.if n \{\ -.RE -.\} -.PP -.if n \{\ -.RS 4 -.\} -.nf -# 60\-root\-verity\&.conf -[Partition] -Type=root\-verity -Verity=hash -VerityMatchKey=root -.fi -.if n \{\ -.RE -.\} - -.SH "SEE ALSO" -.PP -\fBsystemd\fR(1), -\fBsystemd-repart\fR(8), -\fBsfdisk\fR(8), -\fBsystemd-cryptenroll\fR(1) -.SH "NOTES" -.IP " 1." 4 -Discoverable Partitions Specification -.RS 4 -\%https://uapi-group.org/specifications/specs/discoverable_partitions_specification -.RE diff --git a/upstream/opensuse-tumbleweed/man5/repertoiremap.5 b/upstream/opensuse-tumbleweed/man5/repertoiremap.5 index bf1238d7..d785c8d9 100644 --- a/upstream/opensuse-tumbleweed/man5/repertoiremap.5 +++ b/upstream/opensuse-tumbleweed/man5/repertoiremap.5 @@ -1,6 +1,6 @@ .\" SPDX-License-Identifier: GPL-2.0-or-later .\" -.TH repertoiremap 5 2022-10-30 "Linux man-pages 6.05.01" +.TH repertoiremap 5 2024-05-02 "Linux man-pages (unreleased)" .SH NAME repertoiremap \- map symbolic character names to Unicode code points .SH DESCRIPTION @@ -23,18 +23,18 @@ is followed by a character that should be used as the escape character for the rest of the file to mark characters that should be interpreted in a special way. It defaults to the backslash (\e). -.PP +.P The mapping section starts with the keyword .I CHARIDS in the first column. -.PP +.P The mapping lines have the following form: .TP .I <symbolic-name> <code-point> comment This defines exactly one mapping, .I comment being optional. -.PP +.P The mapping section ends with the string .IR "END CHARIDS" . .SH FILES @@ -47,7 +47,7 @@ POSIX.2. Repertoire maps are deprecated in favor of Unicode code points. .SH EXAMPLES A mnemonic for the Euro sign can be defined as follows: -.PP +.P .nf <Eu> <U20AC> EURO SIGN .fi diff --git a/upstream/opensuse-tumbleweed/man5/resolv.conf.5 b/upstream/opensuse-tumbleweed/man5/resolv.conf.5 index 1ea918d2..0f726a97 100644 --- a/upstream/opensuse-tumbleweed/man5/resolv.conf.5 +++ b/upstream/opensuse-tumbleweed/man5/resolv.conf.5 @@ -20,7 +20,7 @@ .\" .\" Added ndots remark by Bernhard R. Link - debian bug #182886 .\" -.TH resolv.conf 5 2023-05-05 "Linux man-pages 6.05.01" +.TH resolv.conf 5 2024-05-02 "Linux man-pages (unreleased)" .UC 4 .SH NAME resolv.conf \- resolver configuration file @@ -41,11 +41,11 @@ The configuration file is considered a trusted source of DNS information; see the .B trust-ad option below for details. -.PP +.P If this file does not exist, only the name server on the local machine will be queried, and the search list contains the local domain name determined from the hostname. -.PP +.P The different configuration options are: .TP \fBnameserver\fP Name server IP address @@ -140,7 +140,7 @@ The syntax is .RS .IP \fBoptions\fP \fIoption\fP \fI...\fP -.PP +.P where \fIoption\fP is one of the following: .TP \fBdebug\fP @@ -373,22 +373,22 @@ In glibc 2.30 and earlier, the AD is not set automatically in queries, and is passed through unchanged to applications in responses. .RE -.PP +.P The \fIsearch\fP keyword of a system's \fIresolv.conf\fP file can be overridden on a per-process basis by setting the environment variable .B LOCALDOMAIN to a space-separated list of search domains. -.PP +.P The \fIoptions\fP keyword of a system's \fIresolv.conf\fP file can be amended on a per-process basis by setting the environment variable .B RES_OPTIONS to a space-separated list of resolver options as explained above under \fBoptions\fP. -.PP +.P The keyword and value must appear on a single line, and the keyword (e.g., \fBnameserver\fP) must start the line. The value follows the keyword, separated by white space. -.PP +.P Lines that contain a semicolon (;) or hash character (#) in the first column are treated as comments. .SH FILES @@ -402,5 +402,5 @@ in the first column are treated as comments. .BR nsswitch.conf (5), .BR hostname (7), .BR named (8) -.PP +.P Name Server Operations Guide for BIND diff --git a/upstream/opensuse-tumbleweed/man5/resolved.conf.5 b/upstream/opensuse-tumbleweed/man5/resolved.conf.5 index c98e4082..6c9bfff3 100644 --- a/upstream/opensuse-tumbleweed/man5/resolved.conf.5 +++ b/upstream/opensuse-tumbleweed/man5/resolved.conf.5 @@ -1,5 +1,5 @@ '\" t -.TH "RESOLVED\&.CONF" "5" "" "systemd 254" "resolved.conf" +.TH "RESOLVED\&.CONF" "5" "" "systemd 255" "resolved.conf" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -83,6 +83,8 @@ for IPv6\&. DNS requests are sent to one of the listed DNS servers in parallel t or set at runtime by external applications\&. For compatibility reasons, if this setting is not specified, the DNS servers listed in /etc/resolv\&.conf are used instead, if that file exists and any servers are configured in it\&. This setting defaults to the empty list\&. +.sp +Added in version 213\&. .RE .PP \fIFallbackDNS=\fR @@ -95,6 +97,8 @@ take precedence over this setting, as do any servers set via \fIDNS=\fR above or /etc/resolv\&.conf\&. This setting is hence only used if no other DNS server information is known\&. If this option is not given, a compiled\-in list of DNS servers is used instead\&. +.sp +Added in version 216\&. .RE .PP \fIDomains=\fR @@ -132,6 +136,14 @@ to indicate the DNS root domain that is the implied suffix of all DNS domains) t See "Protocols and Routing" in \fBsystemd-resolved.service\fR(8) for details of how search and route\-only domains are used\&. +.sp +Note that configuring the MulticastDNS domain +"local" +as search or routing domain has the effect of routing lookups for this domain to classic unicast DNS\&. This may be used to provide compatibility with legacy installations that use this domain in a unicast DNS context, against the IANA assignment of this domain to pure MulticastDNS purposes\&. Search and routing domains are a unicast DNS concept, they +\fIcannot\fR +be used to resolve single\-label lookups via MulticastDNS\&. +.sp +Added in version 229\&. .RE .PP \fILLMNR=\fR @@ -141,6 +153,8 @@ Takes a boolean argument or "resolve", only resolution support is enabled, but responding is disabled\&. Note that \fBsystemd-networkd.service\fR(8) also maintains per\-link LLMNR settings\&. LLMNR will be enabled on a link only if the per\-link and the global setting is on\&. +.sp +Added in version 216\&. .RE .PP \fIMulticastDNS=\fR @@ -150,6 +164,8 @@ Takes a boolean argument or "resolve", only resolution support is enabled, but responding is disabled\&. Note that \fBsystemd-networkd.service\fR(8) also maintains per\-link Multicast DNS settings\&. Multicast DNS will be enabled on a link only if the per\-link and the global setting is on\&. +.sp +Added in version 234\&. .RE .PP \fIDNSSEC=\fR @@ -196,6 +212,8 @@ mode is selected, it is attempted to detect site\-private DNS zones using top\-l .sp Defaults to "no"\&. +.sp +Added in version 229\&. .RE .PP \fIDNSOverTLS=\fR @@ -229,6 +247,8 @@ setting is in effect\&. For per\-link DNS servers the per\-link setting is in ef .sp Defaults to "no"\&. +.sp +Added in version 239\&. .RE .PP \fICache=\fR @@ -243,6 +263,8 @@ as argument\&. If Note that caching is turned off by default for host\-local DNS servers\&. See \fICacheFromLocalhost=\fR for details\&. +.sp +Added in version 231\&. .RE .PP \fICacheFromLocalhost=\fR @@ -250,6 +272,8 @@ for details\&. Takes a boolean as argument\&. If "no" (the default), and response cames from host\-local IP address (such as 127\&.0\&.0\&.1 or ::1), the result wouldn\*(Aqt be cached in order to avoid potential duplicate local caching\&. +.sp +Added in version 248\&. .RE .PP \fIDNSStubListener=\fR @@ -267,6 +291,8 @@ and The DNS stub resolver on 127\&.0\&.0\&.53 provides the full feature set of the local resolver, which includes offering LLMNR/MulticastDNS resolution\&. The DNS stub resolver on 127\&.0\&.0\&.54 provides a more limited resolver, that operates in "proxy" mode only, i\&.e\&. it will pass most DNS messages relatively unmodified to the current upstream DNS servers and back, but not try to process the messages locally, and hence does not validate DNSSEC, or offer up LLMNR/MulticastDNS\&. (It will translate to DNS\-over\-TLS communication if needed however\&.) .sp Note that the DNS stub listener is turned off implicitly when its listening address and port are already in use\&. +.sp +Added in version 232\&. .RE .PP \fIDNSStubListenerExtra=\fR @@ -299,6 +325,7 @@ DNSStubListenerExtra=udp:[2001:db8:0:f102::13]:9953 .RE .\} .sp +Added in version 247\&. .RE .PP \fIReadEtcHosts=\fR @@ -309,6 +336,8 @@ Takes a boolean argument\&. If \fBsystemd\-resolved\fR will read /etc/hosts, and try to resolve hosts or address by using the entries in the file before sending query to DNS servers\&. +.sp +Added in version 240\&. .RE .PP \fIResolveUnicastSingleLabel=\fR @@ -323,15 +352,22 @@ above), or using other mechanisms, in particular via LLMNR or from This option is provided for compatibility with configurations where \fIpublic DNS servers are not used\fR\&. Forwarding single\-label names to servers not under your control is not standard\-conformant, see \m[blue]\fBIAB Statement\fR\m[]\&\s-2\u[3]\d\s+2, and may create a privacy and security risk\&. +.sp +Added in version 246\&. .RE .PP StaleRetentionSec=\fISECONDS\fR .RS 4 Takes a duration value, which determines the length of time DNS resource records can be retained in the cache beyond their Time To Live (TTL)\&. This allows these records to be returned as stale records\&. By default, this value is set to zero, meaning that DNS resource records are not stored in the cache after their TTL expires\&. .sp -This is useful when a DNS server failure occurs or becomes unreachable\&. In such cases, systemd\-resolved continues to use the stale records to answer DNS queries, particularly when no valid response can be obtained from the upstream DNS servers\&. However, this doesn\*(Aqt apply to NXDOMAIN responses, as those are still perfectly valid responses\&. This feature enhances resilience against DNS infrastructure failures and outages\&. +This is useful when a DNS server failure occurs or becomes unreachable\&. In such cases, +\fBsystemd-resolved\fR(8) +continues to use the stale records to answer DNS queries, particularly when no valid response can be obtained from the upstream DNS servers\&. However, this doesn\*(Aqt apply to NXDOMAIN responses, as those are still perfectly valid responses\&. This feature enhances resilience against DNS infrastructure failures and outages\&. +.sp +\fBsystemd\-resolved\fR +always attempts to reach the upstream DNS servers first, before providing the client application with any stale data\&. If this feature is enabled, cache will not be flushed when changing servers\&. .sp -systemd\-resolved always attempts to reach the upstream DNS servers first, before providing the client application with any stale data\&. If this feature is enabled, cache will not be flushed when changing servers\&. +Added in version 254\&. .RE .SH "SEE ALSO" .PP diff --git a/upstream/opensuse-tumbleweed/man5/rpc.5 b/upstream/opensuse-tumbleweed/man5/rpc.5 index 4f1fe2c8..e96c39fd 100644 --- a/upstream/opensuse-tumbleweed/man5/rpc.5 +++ b/upstream/opensuse-tumbleweed/man5/rpc.5 @@ -5,7 +5,7 @@ .\" %%%LICENSE_END .\" .\" @(#)rpc.5 2.2 88/08/03 4.0 RPCSRC; from 1.4 87/11/27 SMI; -.TH rpc 5 2023-02-05 "Linux man-pages 6.05.01" +.TH rpc 5 2024-05-02 "Linux man-pages (unreleased)" .SH NAME rpc \- RPC program number data base .SH SYNOPSIS @@ -18,7 +18,7 @@ The file contains user readable names that can be used in place of RPC program numbers. Each line has the following information: -.PP +.P .PD 0 .IP \[bu] 3 name of server for the RPC program @@ -27,17 +27,17 @@ RPC program number .IP \[bu] aliases .PD -.PP +.P Items are separated by any number of blanks and/or tab characters. A \[aq]#\[aq] indicates the beginning of a comment; characters from the \[aq]#\[aq] to the end of the line are not interpreted by routines which search the file. -.PP +.P Here is an example of the .I /etc/rpc file from the Sun RPC Source distribution. -.PP +.P .in +4n .EX # diff --git a/upstream/opensuse-tumbleweed/man5/sane-airscan.5 b/upstream/opensuse-tumbleweed/man5/sane-airscan.5 new file mode 100644 index 00000000..d60ae0a9 --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/sane-airscan.5 @@ -0,0 +1,154 @@ +.\" generated with Ronn-NG/v0.9.1 +.\" http://github.com/apjanke/ronn-ng/tree/0.9.1 +.TH "SANE\-AIRSCAN" "5" "May 2022" "" "AirScan (eSCL) and WSD SANE backend" +.SH "NAME" +\fBsane\-airscan\fR \- SANE backend for AirScan (eSCL) and WSD scanners and MFP +.SH "DESCRIPTION" +The \fBsane\-airscan\fR is the universal backend for "driverless" document scanning\. Currently it supports two protocols: +.IP "" 4 +.nf +1\. eSCL, also known as AirScan or AirPrint scan +2\. WSD, also known as WS\-Scan +.fi +.IP "" 0 +.SH "CONFIGURATION" +The sane\-airscan loads its configuration files from the following places: +.IP "" 4 +.nf +1\. /etc/sane\.d/airscan\.conf +2\. /etc/sane\.d/airscan\.d/* +.fi +.IP "" 0 +.P +The configuration file syntax is very similar to the \.INI file syntax\. It consist of sections, each section contains some variables\. Comments are started from # or ; characters and continies until end of line +.IP "" 4 +.nf +# This is a comment +[section 1] +variable 1 = value 1 ; and another comment +variable 2 = value 2 +.fi +.IP "" 0 +.P +Leading and trailing spaces of variable name and value are striped\. If you want to preserve them, put name or value into quotes ("like this")\. +.SH "CONFIGURATION OF DEVICES" +If scanner and computer are connected to the same LAN segment, everything expected to "just work" out of box, without any need of manual configuration\. +.P +However, in some cases manual configuration can be useful\. For example: +.IP "" 4 +.nf +1\. If computer and scanner are connected via IP router +2\. There are a lot of devices on a corporate network, but + only few of them are interesting +3\. Automatic discovery works unreliable +.fi +.IP "" 0 +.P +To manually configure a device, add the following section to the configuration file: +.IP "" 4 +.nf +[devices] +"Kyocera eSCL" = http://192\.168\.1\.102:9095/eSCL, eSCL +"Kyocera WSD" = http://192\.168\.1\.102:5358/WSDScanner, WSD +"Device I do not want to see" = disable +.fi +.IP "" 0 +.P +The \fB[devices]\fR section contains all manually configured devices, one line per device, and each line contains a device name on a left side of equation and device URL on a rights side, followed by protocol (eSCL or WSD)\. If protocol is omitted, eSCL is assumed\. You may also disable particular device by using the \fBdisable\fR keyword instead of URL\. +.P +In addition, you can manually configure a device by directly passing its URL in a device name without adding it to the configuration file\. This takes the format \fBprotocol:Device Name:URL\fR\. The examples above could be written as \fBescl:Kyocera eSCL:http://192\.168\.1\.102:9095/eSCL\fR and \fBwsd:Kyocera WSD:http://192\.168\.1\.102:5358/WSDScanner\fR\. +.P +To figure out URLs of available devices, the simplest way is to run the supplied \fBairscan\-discover(1)\fR tool on a computer connected with scanner to the same LAN segment\. On success, this program will dump to its standard output a list of discovered devices in a format suitable for inclusion into the configuration file\. +.P +If running \fBairscan\-discover(1)\fR on the same LAN segment as a scanner is not possible, you will have to follow a hard way\. Your administrator must know device IP address, consult your device manual for the eSCL port, and the URL path component most likely is the "/eSCL", though on some devices it may differ\. Discovering WSD URLs doing this way is much harder, because it is very difficult to guess TCP port and URL path, that in a case of eSCL\. +.P +For eSCL devices, the URL can also use the unix:// scheme, such as unix://scanner\.sock/eSCL\. The "host" from the URL is a file name that will be searched for in the directory specified by socket_dir (see below)\. When connecting to the scanner, all traffic will be sent to the specified UNIX socket instead of a TCP connection\. +.SH "CONFIGURATION OPTIONS" +Miscellaneous options all goes to the \fB[options]\fR section\. Currently the following options are supported: +.IP "" 4 +.nf +[options] +; If there are a lot of scanners around and you are only +; interested in few of them, disable auto discovery and +; configure scanners manually\. +discovery = enable | disable + +; Choose what SANE apps will show in a list of devices: +; scanner network name (the default) or hardware model name\. +model = network | hardware + +; If device supports both eSCL and WSD protocol, sane\-airscan +; may either choose the "best" protocol automatically, or +; expose all variants for user, allowing manual protocol selection\. +; The default is "auto"\. +protocol = auto | manual + +; Discovery of WSD devices may be "fast" or "full"\. The "fast" +; mode works as fast as DNS\-SD discovery, but in some cases +; may be unreliable\. The "full" mode is slow and reliable\. +; It is also possible to disable automatic discovery +; of WSD devices\. The default is "fast"\. +ws\-discovery = fast | full | off + +; Scanners that use the unix:// schema in their URL can only specify a +; socket name (not a full path)\. The name will be searched for in the +; directory specified here\. The default is /var/run\. +socket_dir = /path/to/directory +.fi +.IP "" 0 +.SH "BLACKLISTING DEVICES" +This feature can be useful, if you are on a very big network and have a lot of devices around you, while interesting only in a few of them\. +.IP "" 4 +.nf +[blacklist] +model = "Xerox*" ; blacklist by model name +name = "HP*" ; blacklist by network name +ip = 192\.168\.0\.1 ; blacklist by address +ip = 192\.168\.0\.0/24 ; blacklist the whole subnet +.fi +.IP "" 0 +.P +Network names come from DNS\-SD, WS\-Discovery doesn\'t provide this information\. For filtering by network name to work, Avahi must be enabled and device must be discoverable via DNS\-SD (not necessarily as a scanner, it\'s enough if WSD scanner is discoverable as a printer via DNS\-SD)\. +.P +Blacklisting only affects automatic discovery, and doesn\'t affect manually configured devices\. +.SH "DEBUGGING" +sane\-airscan provides very good instrumentation for troubleshooting without physical access to the problemmatic device\. +.P +Debugging facilities can be controlled using the \fB[debug]\fR section of the configuration file: +.IP "" 4 +.nf +[debug] +; Enable or disable console logging +enable = false | true + +; Enable protocol trace and configure output directory +; for trace files\. Like in shell, to specify path relative to +; the home directory, start it with tilda character, followed +; by slash, i\.e\., "~/airscan/trace"\. The directory will +; be created automatically\. +trace = path + +; Hex dump all traffic to the trace file (very verbose!) +hexdump = false | true +.fi +.IP "" 0 +.SH "FILES" +.TP +\fB/etc/sane\.d/airscan\.conf\fR, \fB/etc/sane\.d/airscan\.d/*\fR +The backend configuration files +.TP +\fB/usr/LIBDIR/sane/libsane\-airscan\.so\fR +The shared library implementing this backend +.SH "ENVIRONMENT" +.TP +\fBSANE_DEBUG_AIRSCAN\fR +This variable if set to \fBtrue\fR or non\-zero numerical value, enables debug messages, that are printed to stdout +.TP +\fBSANE_CONFIG_DIR\fR +This variable alters the search path for configuration files\. This is a colon\-separated list of directories\. These directories are searched for the airscan\.conf configuration file and for the airscan\.d subdirectory, before the standard path (/etc/sane\.d) is searched\. +.SH "BUGS AND SUPPORT" +If you have found a bug, please file a GitHub issue on a GitHub project page: \fBhttps://github\.com/alexpevzner/sane\-airscan\fR +.SH "SEE ALSO" +\fBsane(7), scanimage(1), xsane(1), airscan\-discover(1)\fR +.SH "AUTHOR" +Alexander Pevzner <pzz@apevzner\.com> diff --git a/upstream/opensuse-tumbleweed/man5/sane-apple.5 b/upstream/opensuse-tumbleweed/man5/sane-apple.5 index a78579df..123bbee9 100644 --- a/upstream/opensuse-tumbleweed/man5/sane-apple.5 +++ b/upstream/opensuse-tumbleweed/man5/sane-apple.5 @@ -84,7 +84,7 @@ support dynamic loading). .SH ENVIRONMENT .TP .B SANE_CONFIG_DIR -This environment variable is list of directories where SANE looks +This environment variable is a list of directories where SANE looks for the configuration file. On *NIX systems, directory names are separated by a colon (`:'), under OS/2 by a semi-colon (`;'). If SANE_CONFIG_DIR is not set, SANE defaults to @@ -177,7 +177,6 @@ bugs. We know we have a GUI bug when a parameter is not showing up when it should (active) or vice versa. Finding out which parameters are active across various Apple modes and models from the documentation -.I ftp://ftpdev.info.apple.com/devworld/Technical_Documentation/Peripherals_Documentation/ is an interesting exercise. I may have missed some dependencies. For example of the threshold parameter the Apple Scanners Programming Guide says nothing. I had to assume it is valid only in LineArt mode. @@ -238,7 +237,8 @@ looks like, goto to .I apple.h and #define the .B NEUTRALIZE_BACKEND -macro. You can select the scanner model through the APPLE_MODEL_SELECT +macro. You can select the scanner model through the +.B APPLE_MODEL_SELECT macro. Available options are .BR APPLESCANNER , .BR ONESCANNER , @@ -246,7 +246,9 @@ and .BR COLORONESCANNER . .PP If you encounter a SCSI bus error or trimmed and/or displaced images please -set the environment variable SANE_DEBUG_SANEI_SCSI to 255 before sending me +set the environment variable +.B SANE_DEBUG_SANEI_SCSI +to 255 before sending me the report. .SH TODO @@ -257,12 +259,12 @@ Make a non blocking backend. Properly support .BR sane_set_io_mode () and -.BR sane_get_select_fd () +.BR sane_get_select_fd (). .TP .B Scan Make scanning possible for all models in all supported modes. .PP -Add other missing functionality +Add other missing functionality. .SH "SEE ALSO" .BR sane (7), @@ -274,4 +276,4 @@ The backend was written not entirely from scratch by Milon Firikis. It is mostly based on the .BR sane\-mustek (5) -backend from David Mosberger and Andreas Czechanowski +backend from David Mosberger and Andreas Czechanowski. diff --git a/upstream/opensuse-tumbleweed/man5/sane-artec_eplus48u.5 b/upstream/opensuse-tumbleweed/man5/sane-artec_eplus48u.5 index 7df45067..be6c290e 100644 --- a/upstream/opensuse-tumbleweed/man5/sane-artec_eplus48u.5 +++ b/upstream/opensuse-tumbleweed/man5/sane-artec_eplus48u.5 @@ -50,7 +50,9 @@ find the firmware file under .SH CONFIGURATION The contents of the .I artec_eplus48u.conf -file is a list of usb lines containing vendor and product ids that correspond +file is a list of +.I usb +lines containing vendor and product ids that correspond to USB scanners. The file can also contain option lines. Empty lines and lines starting with a hash mark (#) are ignored. The scanners are autodetected by @@ -59,7 +61,9 @@ statements which are already included into .I artec_eplus48u.conf . "vendor_id" and "product_id" are hexadecimal numbers that identify the scanner. .PP -Every usb section can have additional options. +Every +.I usb +section can have additional options. .TP .B artecFirmwareFile /usr/share/sane/artec_eplus48u/Artec48.usb The path to the firmware file. This option is required. diff --git a/upstream/opensuse-tumbleweed/man5/sane-bh.5 b/upstream/opensuse-tumbleweed/man5/sane-bh.5 index 129c6a40..81d23a3d 100644 --- a/upstream/opensuse-tumbleweed/man5/sane-bh.5 +++ b/upstream/opensuse-tumbleweed/man5/sane-bh.5 @@ -89,7 +89,7 @@ compression is disabled and the image is delivered in a frame. .TP .B \-\-mode lineart|halftone [lineart] -Selects the scan mode (e.g., lineart,monochrome, or color). +Selects the scan mode (e.g., lineart, monochrome, or color). .TP .B \-\-resolution 200|240|300dpi [200] Sets the resolution of the scanned image. Each scanner model supports @@ -148,7 +148,8 @@ Bottom-right y position of scan area. .B \-\-source Automatic Document Feeder|Manual Feed Tray [Automatic Document Feeder] Selects the scan source (such as a document feeder). This option is provided to allow multiple image scans with -.BR xsane (1); it has no other purpose. +.BR xsane (1); +it has no other purpose. .TP .B \-\-batch[=(yes|no)] [no] Enable/disable batch mode scanning. Batch mode allows scanning at maximum throughput @@ -171,7 +172,7 @@ Sets the timeout in seconds for semi-automatic feeder. The value 0 specifies the hardware default value which varies based on the scanner model. .TP .B \-\-check\-adf[=(yes|no)] [no] -Check ADF Status prior to starting scan using the OBJECT POSITION command. +Check ADF status prior to starting scan using the OBJECT POSITION command. Note that this feature requires RSC firmware level 1.5 or higher and dip switch 4 must be in the on position. NOTE: This option has not been tested extensively and may produce undesirable results. @@ -381,7 +382,7 @@ with a hash mark (#) are ignored. .SH OPTIONS The following options can be specified in the .I bh.conf -file. +file: .TP .B disable\-optional\-frames This option prevents the backend from sending any optional frames. This @@ -544,7 +545,9 @@ prior to initiating the last scan command. Currently, there is no mechanism available for the frontend to pass this knowledge to the backend. If batch mode is enabled and the .B \-\-end\-count -terminates a scanadf session, +terminates a +.BR scanadf (1) +session, an extra page will be pulled through the scanner, but is neither read nor delivered to the frontend. The issue can be avoided by specifying .B \-\-batch=no @@ -556,7 +559,7 @@ with revision 1.2 or higher that is faster and more reliable than the standard Bar/Patch code decoder. This is not currently supported. .SH BUGS -This is a new backend; detailed bug reports are welcome -- and expected ;) +Detailed bug reports are welcome -- and expected ;) .PP If you have found something that you think is a bug, please attempt to recreate it with the diff --git a/upstream/opensuse-tumbleweed/man5/sane-coolscan2.5 b/upstream/opensuse-tumbleweed/man5/sane-coolscan2.5 index bec35913..6cbe0e1c 100644 --- a/upstream/opensuse-tumbleweed/man5/sane-coolscan2.5 +++ b/upstream/opensuse-tumbleweed/man5/sane-coolscan2.5 @@ -123,9 +123,9 @@ Eject the film strip or mounted slide when using the slide loader. .TP .B \-\-reset Reset scanner. The scanner will perform the same action as when power is -turned on: it will eject the film strip (with the SF\-200 bulk feeder) +turned on: it will eject the slide (with the SF\-200 bulk feeder) and calibrate itself. Use this whenever the scanner refuses to load -a film strip properly, as a result of +a slide properly, as a result of which .B \-\-eject does not work. diff --git a/upstream/opensuse-tumbleweed/man5/sane-coolscan3.5 b/upstream/opensuse-tumbleweed/man5/sane-coolscan3.5 index 24b0dc5b..0b329dcc 100644 --- a/upstream/opensuse-tumbleweed/man5/sane-coolscan3.5 +++ b/upstream/opensuse-tumbleweed/man5/sane-coolscan3.5 @@ -82,7 +82,9 @@ unit is mm). If set to "yes", the scanner will read the infrared channel, thus allowing defect removal in software. The infrared image is read during a second scan, with no options altered. The backend must not be restarted between the scans. -If you use scanimage, perform a batch scan with +If you use +.BR scanimage (1), +perform a batch scan with .B \-\-batch\-count=2 to obtain the IR information. .TP @@ -120,9 +122,9 @@ Eject the film strip or mounted slide when using the slide loader. .TP .B \-\-reset Reset scanner. The scanner will perform the same action as when power is -turned on: it will eject the film strip (with the SF\-200 bulk loader) +turned on: it will eject the slide (with the SF\-200 bulk loader) and calibrate itself. Use this -whenever the scanner refuses to load a film strip properly, as a result of +whenever the scanner refuses to load a slide properly, as a result of which .B \-\-eject does not work. diff --git a/upstream/opensuse-tumbleweed/man5/sane-dmc.5 b/upstream/opensuse-tumbleweed/man5/sane-dmc.5 index 92ed2f1a..1c3e198a 100644 --- a/upstream/opensuse-tumbleweed/man5/sane-dmc.5 +++ b/upstream/opensuse-tumbleweed/man5/sane-dmc.5 @@ -49,7 +49,9 @@ This image is a 1599-by-1200 pixel full-color image constructed by filtering and interpolating the "raw" image. The filtering and interpolation is done in software, so this mode is very slow. Also, this mode places restrictions on how the image is read which means that the "preview" mode -of xscanimage does not work in Super Resolution mode. +of +.BR xscanimage (1) +does not work in Super Resolution mode. .RB ( xcam (1) and the non-preview modes of .BR scanimage (1) @@ -146,8 +148,8 @@ like. .BR sane\-scsi (5) .SH AUTHOR -David F. Skoll +Dianne Skoll <dianne@skoll.ca> .PP The backend is derived from .BR sane\-hp (5) -by David Mosberger +by David Mosberger. diff --git a/upstream/opensuse-tumbleweed/man5/sane-epjitsu.5 b/upstream/opensuse-tumbleweed/man5/sane-epjitsu.5 index 7eb345bd..7b462166 100644 --- a/upstream/opensuse-tumbleweed/man5/sane-epjitsu.5 +++ b/upstream/opensuse-tumbleweed/man5/sane-epjitsu.5 @@ -2,7 +2,7 @@ .IX sane\-epjitsu .SH NAME -sane\-epjitsu \- SANE backend for Epson-based Fujitsu USB scanners. +sane\-epjitsu \- SANE backend for Epson-based Fujitsu USB scanners .SH DESCRIPTION The @@ -35,12 +35,12 @@ Selects the source for the scan. Options may include "Flatbed", "ADF Front", "AD Selects the mode for the scan. Options may include "Lineart", "Gray", "Color". .RE .PP -.B resolution, y\-resolution +.BR resolution , " y\-resolution" .RS Controls scan resolution. Setting .B \-\-resolution also sets -.B \-\-y\-resolution, +.BR \-\-y\-resolution , though this behavior is overridden by some frontends. .RE .PP diff --git a/upstream/opensuse-tumbleweed/man5/sane-epson.5 b/upstream/opensuse-tumbleweed/man5/sane-epson.5 index 44ecf875..61fa35c5 100644 --- a/upstream/opensuse-tumbleweed/man5/sane-epson.5 +++ b/upstream/opensuse-tumbleweed/man5/sane-epson.5 @@ -5,12 +5,12 @@ sane\-epson \- SANE backend for EPSON scanners .SH DESCRIPTION The .B sane\-epson -library implements a SANE Scanner Access Now Easy) backend that +library implements a SANE (Scanner Access Now Easy) backend that provides access to Epson flatbed scanners. Some functions of this backend should be considered .B beta-quality software! Most functions have been stable for a long time, but of -course new development can not and often times will not function properly from +course new development can not and often will not function properly from the very first day. Please report any strange behavior to the maintainer of the backend. .PP @@ -255,8 +255,9 @@ The parallel interface can be configured in two ways: An integer value starting at the beginning of a line will be interpreted as the IO address of the parallel port. To make it clearer that a configured IO address is a parallel port the port address can be preceded by the string "PIO". The PIO connection does not -use a special device file in the /dev directory. The IO address can be specified -in hex mode (prefixed with "0x"). +use a special device file in the +.I /dev +directory. The IO address can be specified in hex mode (prefixed with "0x"). .TP .I USB A device file that is preceded by the string "USB" is treated as a scanner diff --git a/upstream/opensuse-tumbleweed/man5/sane-epson2.5 b/upstream/opensuse-tumbleweed/man5/sane-epson2.5 index 854ec02f..883652f4 100644 --- a/upstream/opensuse-tumbleweed/man5/sane-epson2.5 +++ b/upstream/opensuse-tumbleweed/man5/sane-epson2.5 @@ -266,7 +266,7 @@ will ignore this option. The .B \-\-bay -option selects which bay to scan +option selects which bay to scan. The .B \-\-eject diff --git a/upstream/opensuse-tumbleweed/man5/sane-fujitsu.5 b/upstream/opensuse-tumbleweed/man5/sane-fujitsu.5 index 34864cb6..3885cde2 100644 --- a/upstream/opensuse-tumbleweed/man5/sane-fujitsu.5 +++ b/upstream/opensuse-tumbleweed/man5/sane-fujitsu.5 @@ -1,16 +1,16 @@ -.TH sane\-fujitsu 5 "15 Nov 2022" "" "SANE Scanner Access Now Easy" +.TH sane\-fujitsu 5 "24 Mar 2023" "" "SANE Scanner Access Now Easy" .IX sane\-fujitsu .SH NAME -sane\-fujitsu \- SANE backend for Fujitsu flatbed and ADF scanners +sane\-fujitsu \- SANE backend for Fujitsu and Ricoh fi series scanners .SH DESCRIPTION The .B sane\-fujitsu library implements a SANE (Scanner Access Now Easy) backend which provides -access to most Fujitsu flatbed and ADF scanners. +access to most Fujitsu flatbed and ADF scanners, and the subsequent Ricoh models. -This document describes backend version 139, which initially shipped with SANE 1.1.2. +This document describes backend version 140. .SH SUPPORTED HARDWARE This version supports every known model which speaks the Fujitsu SCSI and @@ -20,14 +20,14 @@ supported. Please see the list at .I http://www.sane\-project.org/sane\-supported\-devices.html for details. -This backend may support other Fujitsu scanners. The best +This backend may support other Fujitsu or newer Ricoh scanners. The best way to determine level of support is to test the scanner directly, or to collect a trace of the windows driver in action. Please contact the author for help or with test results. .SH UNSUPPORTED HARDWARE The following scanners are known NOT to work with this backend, -either because they have a non\-Fujitsu chipset, or an unsupported +either because they have an unsupported chipset, or an unsupported interface type. Some of these scanners may be supported by another backend. .PP @@ -152,7 +152,7 @@ specify one. Probably should not be used with the other "scsi" line above. .RS Requests backend to search all usb buses in the system for a device which uses that vendor and product id. The device will then be queried -to determine if it is a Fujitsu scanner. +to determine if it is a supported scanner. .RE .PP "usb /dev/usb/scanner0" (or other device file) diff --git a/upstream/opensuse-tumbleweed/man5/sane-genesys.5 b/upstream/opensuse-tumbleweed/man5/sane-genesys.5 index 72ef8de0..72a82d41 100644 --- a/upstream/opensuse-tumbleweed/man5/sane-genesys.5 +++ b/upstream/opensuse-tumbleweed/man5/sane-genesys.5 @@ -48,7 +48,8 @@ GL841, GL843, GL847 or GL124 chipset, you can try to add it to the backend. .SH "CALIBRATION" To give correct image quality, sheet fed scanners need to be calibrated using the calibration sheet sold with the scanner. To do calibration, you must insert this target -in the feeder then start calibration either by passing the \-\-calibrate option to scanimage +in the feeder then start calibration either by passing the \-\-calibrate option to +.BR scanimage (1) or by clicking on the available 'calibrate' button in the 'advanced options' in a graphical frontend. The result of the calibration is stored in a file in the home directory of the user doing it. If you plug the scanner in another machine or use it with another account, calibration @@ -100,7 +101,7 @@ Disable use of a software adaptive algorithm to generate lineart and rely on har .TP .B \-\-color-filter None|Red|Green|Blue When using gray or lineart this option selects the used color. Using a color filter -will give a monochrome scan. CIS based scanners can to true gray when no filter (None value) is +will give a monochrome scan. CIS based scanners can do true gray when no filter (None value) is selected. .TP @@ -123,7 +124,7 @@ users. .B \-\-expiration\-time Specify the time (in minutes) a cached calibration is considered valid. If older than the given value, a new calibration is done. A value of -1 means no expiration and cached value are kept forever unless cleared by -userwith the calibration clear option. A value of 0 means cache is disabled. +user with the calibration clear option. A value of 0 means cache is disabled. .PP Additionally, several 'software' options are exposed by the backend. These @@ -248,9 +249,7 @@ Syscan/Ambir DocketPORT 467/485/487/665/685 Xerox Travel Scanner 100, Onetouch 2400 .RE .TP -cncsolutions -.RI ( http://www.cncsolutions.com.br ) -sponsored and supported the work on the Panasonic KV-SS080. +cncsolutions sponsored and supported the work on the Panasonic KV-SS080. .br .TP Brian Paavo from Benthic Science Limited for donating a Canoscan LiDE 700F. @@ -298,7 +297,8 @@ due to the way image sensors are built. .PP This backend will be much slower if not using libusb\-1.0. So be sure that sane\-backends is built with the -.B \-\-enable-libusb_1_0 option. +.B \-\-enable-libusb_1_0 +option. .SH "BUGS" For the LiDE 200, the scanned data at 4800 dpi is obtained "as is" from sensor. diff --git a/upstream/opensuse-tumbleweed/man5/sane-hp.5 b/upstream/opensuse-tumbleweed/man5/sane-hp.5 index e8f725d5..4ae4ac4f 100644 --- a/upstream/opensuse-tumbleweed/man5/sane-hp.5 +++ b/upstream/opensuse-tumbleweed/man5/sane-hp.5 @@ -45,19 +45,18 @@ and .IR http://penguin-breeder.org/kernel/download/ . .PP -Support for models 5200C/62X0C/63X0C connected to the USB require -the kernel scanner driver or libusb. See +Support for models 5200C/62X0C/63X0C connected to USB requires +libusb. See .BR sane\-usb (5) for more details. .PP The .B sane\-hp backend no longer supports OfficeJet multi-function peripherals. -For these devices use the external "hpoj" backend in version 0.90 and later of -the "HP OfficeJet Linux driver", available at -.br -.IR http://hpoj.sourceforge.net -. +For these devices use the external "hplip" packages available at: +.IR https://developers.hp.com/hp\-linux\-imaging\-and\-printing/ . +For information about the previous hpoj driver, see: +.IR http://hpoj.sourceforge.net/ . .PP Because Hewlett-Packard does no longer produce scanners that support SCL (beside the OfficeJets), the above list of supported scanners is @@ -70,7 +69,7 @@ You can also watch the sane\-devel mailing list at .IR http://www.sane\-project.org/mailing\-lists.html . .PP More details about the hp backend can be found on its homepage -.IR http://www.kirchgessner.net/sane.html . +.IR http://web.archive.org/web/20070206115546/http://www.kirchgessner.net/sane.html . .PP .SH "DEVICE NAMES" This backend expects device names of the form: @@ -220,8 +219,9 @@ levels reduce verbosity. .TP .B SANE_HOME_HP Only used for OS/2 and along with use of HP PhotoSmart PhotoScanner. -Must be set to the directory where the directory .sane is located. -Is used to save and read the calibration file. +Must be set to the directory where the directory +.I .sane +is located. Is used to save and read the calibration file. .TP .B SANE_HP_KEEPOPEN_SCSI .TP diff --git a/upstream/opensuse-tumbleweed/man5/sane-lexmark_x2600.5 b/upstream/opensuse-tumbleweed/man5/sane-lexmark_x2600.5 new file mode 100644 index 00000000..bf9cb76f --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/sane-lexmark_x2600.5 @@ -0,0 +1,62 @@ +.TH "sane\-lexmark_x2600" "5" "23 Dec 2023" "" "SANE Scanner Access Now Easy" +.IX sane\-lexmark_x2600 +.SH "NAME" +sane\-lexmark_x2600 \- SANE backend for Lexmark X2600 Series scanners +.SH "DESCRIPTION" +The +.B sane\-lexmark +library implements a SANE (Scanner Access Now Easy) backend that +provides access to the scanner part of Lexmark X2600 AIOs. +.PP +The scanners that should work with this backend are: +.PP +.RS +.ft CR +.nf + Vendor Model status +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- \-\-\-\-\-\-\-\-\-\-\- + Lexmark X2670 good +.fi +.ft R +.RE + +The options the backend supports can either be selected through +command line options to programs like +.BR scanimage (1) +or through GUI elements in +.BR xscanimage (1) +, +.BR xsane (1). +or +.BR simple-scan (1). +.br +If you notice any strange behavior, please report to the backend +maintainer or to the SANE mailing list. + +.SH "FILES" +.TP +.I /usr/lib64/sane/libsane\-lexmark_x2600.a +The static library implementing this backend. +.TP +.I /usr/lib64/sane/libsane\-lexmark_x2600.so +The shared library implementing this backend (present on systems that +support dynamic loading). + +.SH "ENVIRONMENT" +.TP +.B SANE_DEBUG_LEXMARK_X2600 +If the library was compiled with debug support enabled, this +environment variable controls the debug level for this backend. E.g., +a value of 255 requests all debug output to be printed. Smaller levels +reduce verbosity. + +.SH "AUTHOR" +.TP +The backend was originally written by Benoit Juin. +.RI < benoit.juin@gmail.com > + +.SH "CREDITS" +.TP +Many thanks go to: +@skelband aka Ralph Little who help me to dive in the sane-backencode and +reviewed the sources. diff --git a/upstream/opensuse-tumbleweed/man5/sane-matsushita.5 b/upstream/opensuse-tumbleweed/man5/sane-matsushita.5 index 29855e9a..e0321c08 100644 --- a/upstream/opensuse-tumbleweed/man5/sane-matsushita.5 +++ b/upstream/opensuse-tumbleweed/man5/sane-matsushita.5 @@ -27,14 +27,14 @@ backend: .ft R .RE .PP -(*) WARNING: None of the advanced options of these scanners are available (ie no color, no high resolution, no automatic cropping). Basically, the driver does no more than what it does for the KV-SS25. I don't have access to such scanners, and thus cannot add these options. +(*) WARNING: None of the advanced options of these scanners are available (i.e. no color, no high resolution, no automatic cropping). Basically, the driver does no more than what it does for the KV-SS25. I don't have access to such scanners, and thus cannot add these options. Other Panasonic high speed scanners may or may not work with that backend. -Valid command line options and their syntax can be listed by using +Valid command line options and their syntax can be listed by using: .RS .PP -scanimage \-\-help \-d matsushita +.I scanimage \-\-help \-d matsushita .RE .TP @@ -58,13 +58,13 @@ selects the number of pages to scan (one or until the tray is empty). .TP .B \-\-paper\-size A4|...|Legal|Letter [A4] -options selects the area to scan. It adjust the +selects the area to scan. It adjusts the .B \-l \-t \-x \-y options accordingly. It does not need to be the real size of the paper. .TP .B \-l \-t \-x \-y -control the scan area: \-l sets the top left x coordinate, \-t the top +controls the scan area: \-l sets the top left x coordinate, \-t the top left y coordinate, \-x selects the width and \-y the height of the scan area. All parameters are specified in millimeters. It is possible to use the option @@ -85,28 +85,28 @@ controls the contrast of the acquired image. Some models do not support that opt automatically sets brightness, contrast, white level, gamma, noise reduction and image emphasis. These options are not available when automatic\-threshold is in use. .TP .B \-\-halftone\-pattern -option sets the tonal gradation for the halftone mode. Pattern downloading is not implemented by the backend. +sets the tonal gradation for the halftone mode. Pattern downloading is not implemented by the backend. .TP .B \-\-autoseparation provides automatic separation of text and images. .TP .B \-\-white\-level -option indicate the source of the white base. +indicates the source of the white base. .TP .B \-\-noise\-reduction reduces the isolated dot noise. This option is not supported by all scanners. .TP .B \-\-image\-emphasis -option sets the image emphasis. Some selection are not available on all scanners. +sets the image emphasis. Some selection are not available on all scanners. .TP .B \-\-gamma -options set the gamma curve. It is only valid for Gray modes, and is not available on all scanners. Gamma downloading is not implemented by the backend. +sets the gamma curve. It is only valid for Gray modes, and is not available on all scanners. Gamma downloading is not implemented by the backend. .SH CONFIGURATION FILE The configuration file .I /etc/sane.d/matsushita.conf -supports the device name to use (eg +supports the device name to use (e.g. .IR /dev/scanner ) and the SCSI option to auto-detect the scanners supported. diff --git a/upstream/opensuse-tumbleweed/man5/sane-microtek.5 b/upstream/opensuse-tumbleweed/man5/sane-microtek.5 index 4f56f018..ad6ab8f3 100644 --- a/upstream/opensuse-tumbleweed/man5/sane-microtek.5 +++ b/upstream/opensuse-tumbleweed/man5/sane-microtek.5 @@ -104,7 +104,7 @@ ignored. A sample configuration file is shown below: The configuration file may also contain the special tokens .I norealcal or -.I noprecal. +.IR noprecal . .I norealcal will disable the use of magic, undocumented scanner calibration commands which are known to work on the E6, but may not work with other models. diff --git a/upstream/opensuse-tumbleweed/man5/sane-microtek2.5 b/upstream/opensuse-tumbleweed/man5/sane-microtek2.5 index d02bd615..3395cf68 100644 --- a/upstream/opensuse-tumbleweed/man5/sane-microtek2.5 +++ b/upstream/opensuse-tumbleweed/man5/sane-microtek2.5 @@ -7,9 +7,7 @@ The library implements a SANE (Scanner Access Now Easy) backend that provides access to Microtek scanners with a SCSI-2 command set. This backend can be considered alpha to beta. Some scanner models are reported -to work well, others not. New development versions of this backend can be -obtained from -.IR http://karstenfestag.gmxhome.de . +to work well, others not. .PP There exists a different backend for Microtek scanners with SCSI-1 command set. @@ -17,7 +15,7 @@ Refer to .BR sane\-microtek (5) for details. .PP -And there is work in progress for the ScanMaker 3600. +And there is partial progress for the ScanMaker 3600. See .IR http://sourceforge.net/projects/sm3600 . .PP @@ -155,7 +153,9 @@ The configuration file may also contain options. Global options that are valid for all devices are placed above the device names. Device-specific options are placed under the device name. Note that, except for option dump <n> and -option strip-height <n>, the entry in the microtek2.conf file only enables +option strip-height <n>, the entry in the +.I microtek2.conf +file only enables the corresponding option for being showed in the frontend. There, in the frontend, you can switch the options on and off. Currently the following options are supported: diff --git a/upstream/opensuse-tumbleweed/man5/sane-mustek.5 b/upstream/opensuse-tumbleweed/man5/sane-mustek.5 index 9857dc35..e2b1af7c 100644 --- a/upstream/opensuse-tumbleweed/man5/sane-mustek.5 +++ b/upstream/opensuse-tumbleweed/man5/sane-mustek.5 @@ -181,7 +181,9 @@ is 128. Because of double buffering the buffer actually sent to the scanner is half the size of this value. Try to increase this value to achieve higher scan speeds. Note that some ScanExpress scanners don't like buffer sizes above 64 kb (buffersize = 128). If your sg driver can't set SCSI buffer sizes at -runtime you may have to change that value, too. See sane\-scsi(5) for details. +runtime you may have to change that value, too. See +.BR sane\-scsi (5) +for details. .PP Option .B blocksize @@ -312,7 +314,7 @@ I/O ports. Thus, either make frontends such as .BR scanimage (1) and .BR xscanimage (1) -setuid root (generally not recommended for safety reasons) or, alternatively, +setuid root (generally not recommended for security reasons) or, alternatively, access this backend through the network daemon .BR saned (8). .PP diff --git a/upstream/opensuse-tumbleweed/man5/sane-mustek_usb.5 b/upstream/opensuse-tumbleweed/man5/sane-mustek_usb.5 index 45a3f70d..690bd9bc 100644 --- a/upstream/opensuse-tumbleweed/man5/sane-mustek_usb.5 +++ b/upstream/opensuse-tumbleweed/man5/sane-mustek_usb.5 @@ -86,7 +86,7 @@ Instead of using the device name, the scanner can be autodetected by statements which are already included into .IR mustek_usb.conf . This is only supported with Linux 2.4.8 and higher and all systems that -support libsub. "vendor_id" and "product_id" are hexadecimal numbers that +support libusb. "vendor_id" and "product_id" are hexadecimal numbers that identify the scanner. If this doesn't work, a device name and the option specifying the scanner type must be placed in .I mustek_usb.conf diff --git a/upstream/opensuse-tumbleweed/man5/sane-net.5 b/upstream/opensuse-tumbleweed/man5/sane-net.5 index f3782449..fd7c5623 100644 --- a/upstream/opensuse-tumbleweed/man5/sane-net.5 +++ b/upstream/opensuse-tumbleweed/man5/sane-net.5 @@ -93,10 +93,8 @@ are contacted in addition to the hosts listed above. For this backend to function properly, it is also necessary to define the .B sane\-port service in -.IR /etc/services . -The -.B sane -service should be defined using a line of the following form: +.I /etc/services +using a line of the following form: .PP .RS sane\-port 6566/tcp # SANE network scanner daemon diff --git a/upstream/opensuse-tumbleweed/man5/sane-p5.5 b/upstream/opensuse-tumbleweed/man5/sane-p5.5 index bf2418ce..7907c510 100644 --- a/upstream/opensuse-tumbleweed/man5/sane-p5.5 +++ b/upstream/opensuse-tumbleweed/man5/sane-p5.5 @@ -28,7 +28,7 @@ This backend expects device names of the form: .RE .PP Where -\fBvalue\fR is : +\fBvalue\fR is: .RS .TP @@ -151,7 +151,9 @@ your .IR /etc/sane.d/dll.conf . If your scanner isn't detected, make sure you've defined the right port address, or the correct device -in your p5.conf. +in your +.I p5.conf +file. .TP .I the name of your scanner/vendor also a worthy information. Please also include the optical resolution and lamp type of your diff --git a/upstream/opensuse-tumbleweed/man5/sane-pixma.5 b/upstream/opensuse-tumbleweed/man5/sane-pixma.5 index 1271832e..e73dd704 100644 --- a/upstream/opensuse-tumbleweed/man5/sane-pixma.5 +++ b/upstream/opensuse-tumbleweed/man5/sane-pixma.5 @@ -19,9 +19,9 @@ Currently, the following models work with this backend: .RS PIXMA E410, E510, E4500 .br -PIXMA G600, G2000, G2010, G2100, G4000, G4511 +PIXMA G600, G2000, G2010, G2030, G2070, G2100, G3030, G3070, G4000, G4070, G4511 .br -PIXMA GX6000, GX7000 +PIXMA GX1000, GX2000, GX3000, GX4000, GX6000, GX6500, GX7000 .br PIXMA MG2100, MG2200, MG2400, MG2500, MG2900, MG3000, MG3100 .br @@ -55,13 +55,15 @@ PIXMA MX410, MX420, MX470, MX510, MX520, MX530, MX700, MX720 .br PIXMA MX850, MX860, MX870, MX882, MX885, MX890, MX920, MX7600 .br +PIXMA TC-20M, TC-5200M +.br PIXMA TR4500, TR4600, TR4700 .br PIXMA TS2400, TS2600, TS3100, TS3300, TS3450, TS3451, TS3452 .br PIXMA TS3500, TS5000, TS5100, TS5350i, TS5400, TS6100, TS6200 .br -PIXMA TS7530, TS7450i ,TS8000, TS8530, TS8200 +PIXMA TS7530, TS7450i ,TS8000, TS8200, TS8530, TS8630, TS8630 .br PIXUS MP10 .br @@ -123,25 +125,27 @@ PIXMA MX320, MX390, MX430, MX450, MX490, MX710 .br PIXMA G3000, G3010, G4010, G6000, G6080, G7000, GM4000, GM4080 .br -PIXMA TR7500, TR7530, TR7600, TR8500, TR8530, TR8580, TR8600 +PIXMA TR7500, TR7530, TR7600, TR7800, TR8500, TR8530, TR8580 TR8600 .br PIXMA TR8630, TR9530 .br PIXMA TS3400, TS5100, TS6000, TS6130, TS6180, TS6230, TS6280, TS6300 .br -PIXMA TS6330, TS6330, TS6380, TS6400, TS7330, TS7400, TS7430, TS8100 +PIXMA TS6330, TS6330, TS6380, TS6400, TS6630, TS6730, TS7330, TS7400, +.br +PIXMA TS7430, TS7600i, TS7700, TS7700A, TS7700i, TS8100, TS8130 .br -PIXMA TS8130, TS8180, TS8230, TS8280, TS8300, TS8330, TS8380, TS9000 +PIXMA TS8180, TS8230, TS8280, TS8300, TS8330, TS8380, TS8700, TS9000 .br PIXMA TS9100, TS9180, TS9500, TS9580 .br -PIXUS MP5, XK50, XK60, XK70, XK80, XK90, XK100, XK500 +PIXUS MP5, XK50, XK60, XK70, XK80, XK90, XK100, XK110, XK120, XK500 .br imageCLASS MF720, MF810/820, MF5630, MF5650, MF5750, MF8170c .br imageCLASS MPC190, D550 .br -i-SENSYS MF110, MF220, MF260, MF410, MF420, MF510, MF520, MF740 +i-SENSYS MF110, MF220, MF260, MF410, MF420, MF510, MF520, MF740, MF750 .br i-SENSYS MF5880dn, MF5900, MF6680dn, MF8500C .br @@ -167,7 +171,7 @@ The backend supports: .br * a custom gamma table, .br -* Automatic Document Feeder, Simplex and Duplex. +* Automatic Document Feeder, Simplex and Duplex, .br * Transparency Unit, 24 or 48 bits depth. Infrared channel on certain models. .RE @@ -183,7 +187,7 @@ where aaaa is the scanners model and bbbb is the hostname or ip-adress. Example: pixma:MF4800_192.168.1.45 is a MF4800 Series multi-function peripheral. .PP This backend, based on cloning original Canon drivers protocols, is in -a production stage. Designed has been carried out without any applicable +a production stage. Design has been carried out without any applicable manufacturer documentation, probably never available. However, we have tested it as well as we could, but it may not work in all situations. You will find an up-to-date status at the project homepage. (See below). @@ -235,8 +239,8 @@ backward compatibility reasons. .TP .I button\-1 button\-2 (read only) These options will return the value of the respective buttons. -value 0 means that the button was not pressed, 1 is returned when the button -was pressed. Some scanners with more than two buttons send the button number +Value 0 means that the button was not pressed, 1 is returned when the button +was pressed. Some scanners, with more than two buttons, send the button number as target. .TP .I original @@ -293,7 +297,7 @@ only scanners that cannot be auto-detected because they are on a different subnet shall be listed here. If you do not use Linux and your OS does not allow enumeration of interfaces (i.e. it does not support the .BR getifaddrs () -qfunction) you also may need +function) you also may need to add your scanner here as well. .PP Scanners shall be listed in the configuration file as follows: @@ -302,48 +306,56 @@ Scanners shall be listed in the configuration file as follows: .I <method>://<host>[:port][/timeout=<value>] .RE .PP -where method indicates the protocol used (bjnp is used for inkjet multi-functionals -and mfnp is used for laser multi-functionals). -.PP -host is the hostname or IP address of the scanner, e.g. bjnp://10.0.1.4 -for IPv4, bjnp://[2001:888:118e:18e2:21e:8fff:fe36:b64a] for a literal -IPv6-address or bjnp://myscanner.mydomain.org for a hostname. -.PP -The port number is optional and in normally implied by the method. +.TP +.B method +indicates the protocol used. +.I bjnp +is used for inkjet multi-functionals and +.I mfnp +is used for laser multi-functionals). +.TP +.B host +is the hostname or IP address of the scanner, e.g. +.I bjnp://10.0.1.4 +for IPv4, +.I bjnp://[2001:888:118e:18e2:21e:8fff:fe36:b64a] +for a literal IPv6-address or +.I bjnp://myscanner.mydomain.org +for a hostname. +.TP +.B port +is optional and is normally implied by the method. Port 8610 is the standard port for mfnp, 8612 for bjnp. +.TP +.B timeout +scanner-specific timeout value for the network protocol. The value is in ms. .PP -A scanner specific timeout value for the network protocol can be set using the -bjnp-timeout parameter. The value is in ms. -.PP -Define scanners each on a new line. +Define each scanner each on a separate line. .PP -More globally applicable timeouts can be set using the bjnp-timeout parameter as follows: +More globally-applicable timeouts can be set using the bjnp-timeout parameter as follows: .PP .RS .I bjnp-timeout=<value> .RE .PP A timeout defined using bjnp-timeout will apply to the following scanner definitions -in the file. If required the bjnp-timeout setting +in the file. If required, the bjnp-timeout setting can be defined multiple times, where each setting will apply only to the scanners that -follow the setting. The last setting is used for the auto discovered scanners. +follow the setting. The last setting is used for auto-discovered scanners. If not explicitly set, the default 1000ms setting will apply. .PP Setting timeouts should only be required in exceptional cases. .PP .RE .PP -If so desired networking can be disabled as follows: +If so desired, networking can be disabled as follows: .RS -.IP - -If the first non-commented line contains -.B networking=no -all networking will be disabled. -This will cause all further statements in the configuration file to be ignored. -.IP - -A line that contains -.B auto_detection=no -will cause auto-detection to be skipped. Explicitly defined network scanners will still be probed. +.IP \fInetworking=no\FR +If the first non-commented line contains this entry all networking will be disabled. +All further statements in the configuration file will be ignored. +.IP \fIauto_detection=no\fR +This line will cause auto-detection to be skipped. +Explicitly defined network scanners will still be probed. .SH USB SUPPORT USB scanners will be auto-detected and require no configuration. .SH NETWORKING SUPPORT @@ -446,7 +458,7 @@ the verbosity and includes the information printed at the lower levels. .RE .TP .B PIXMA_EXPERIMENT -Setting to a non-zero value will enable the support for experimental models. +Setting to a non-zero value will enable experimental support for further models. You should also set SANE_DEBUG_PIXMA to 11. .TP .B SANE_CONFIG_DIR diff --git a/upstream/opensuse-tumbleweed/man5/sane-plustek.5 b/upstream/opensuse-tumbleweed/man5/sane-plustek.5 index bd783ed9..fa49fc09 100644 --- a/upstream/opensuse-tumbleweed/man5/sane-plustek.5 +++ b/upstream/opensuse-tumbleweed/man5/sane-plustek.5 @@ -411,7 +411,9 @@ means autocalibration. .RE .PP -See the plustek.conf file for examples. +See the +.I plustek.conf +file for examples. .PP .B Note: .br @@ -475,7 +477,7 @@ export SANE_DEBUG_PLUSTEK=10 .BR sane\-usb (5), .BR sane\-u12 (5), .BR sane\-gt68xx (5), -.BR sane-\mustek_pp (5), +.BR sane\-mustek_pp (5), .BR sane\-find\-scanner (1), .BR scanimage (1) .br @@ -486,24 +488,20 @@ Please send any information and bug-reports to: .br .B SANE Mailing List .PP -Additional info and hints can be obtained from our -.br -Mailing-List archive at: -.br -.I http://www.sane\-project.org/mailing\-lists.html +Additional info and hints can be obtained from our mailing-List archive at: +.IR http://www.sane\-project.org/mailing\-lists.html . .PP To obtain debug messages from the backend, please set the environment-variable .B SANE_DEBUG_PLUSTEK -before calling your favorite scan-frontend (i.e. -.BR scanimage (1)), i.e.: - -.br +before calling your favorite SANE frontend (e.g. +.BR scanimage (1)): +.PP .I export SANE_DEBUG_PLUSTEK=20 ; scanimage .PP -The value controls the verbosity of the backend. Please note, that -values greater than 24 force the backend to output raw data files, -which could be rather large. The ending of these files is ".raw". +The value controls the verbosity of the output. Please note that +values greater than 24 force the backend to output raw data files +which could be rather large. The suffix of these files is ".raw". For problem reports it should be enough the set the verbosity to 13. diff --git a/upstream/opensuse-tumbleweed/man5/sane-plustek_pp.5 b/upstream/opensuse-tumbleweed/man5/sane-plustek_pp.5 index e236a0db..f53e5ea2 100644 --- a/upstream/opensuse-tumbleweed/man5/sane-plustek_pp.5 +++ b/upstream/opensuse-tumbleweed/man5/sane-plustek_pp.5 @@ -291,21 +291,18 @@ Please send any information and bug-reports to: .br .B SANE Mailing List .PP -Additional info and hints can be obtained from our -.br -Mailing-List archive at: -.br -.I http://www.sane\-project.org/mailing\-lists.html +Additional info and hints can be obtained from our mailing-List archive at: +.IR http://www.sane\-project.org/mailing\-lists.html . .PP To obtain debug messages from the backend, please set the environment-variable .B SANE_DEBUG_PLUSTEK_PP -before calling your favorite scan-frontend (i.e. -.BR xscanimage (1)), i.e.: -.br +before calling your favorite SANE frontend (e.g. +.BR xscanimage (1)): +.PP .I export SANE_DEBUG_PLUSTEK_PP=20 ; xscanimage .PP -The value controls the verbosity of the backend. +The value controls the verbosity of the output. .PP .SH "KNOWN BUGS & RESTRICTIONS" diff --git a/upstream/opensuse-tumbleweed/man5/sane-scsi.5 b/upstream/opensuse-tumbleweed/man5/sane-scsi.5 index 01f00f7d..87894ae1 100644 --- a/upstream/opensuse-tumbleweed/man5/sane-scsi.5 +++ b/upstream/opensuse-tumbleweed/man5/sane-scsi.5 @@ -44,7 +44,7 @@ is the SCSI vendor string, .I MODEL is the SCSI model string, .I TYPE -is type SCSI device type string, +is the SCSI device type string, .I BUS is the SCSI bus number (named "host" in .IR /proc/scsi/scsi ), @@ -195,7 +195,7 @@ maximum buffer size can be changed at program run time, and there is no restrict version 2.2.7 on. If the new SG driver is available some backends (e.g. .BR sane\-umax (5), -.BR sane\-mustek (5) , +.BR sane\-mustek (5), .BR sane\-sharp (5)) automatically request larger SCSI buffers. If a backend does not automatically request a larger SCSI buffer, set @@ -204,9 +204,9 @@ the environment variable to the desired buffer size in bytes. It is not recommended to use more than 1 MB, because for large values the probability increases that the SG driver cannot allocate the necessary buffer(s). For ISA cards, even -1 MB might be a too large value. For a detailed discussion of memory -issues of the SG driver, see -.I http://www.torque.net/sg. +1 MB might be a too large value. +For a detailed discussion of the Linux SG SCSI driver see: +.IR https://tldp.org/HOWTO/SCSI-Generic-HOWTO . .PP For Linux kernels before version 2.2.7 the size of the buffer is only 32KB. This works, but for many cheaper scanners this causes scanning to be slower by @@ -299,7 +299,7 @@ of the form ``restart (ncr dead ?)'' in your .I /var/log/messages file or on the system console, it's an indication that the timeout is too short. In this case, find the line ``if (np->latetime>10)'' in file -.I ncr53c8xx. +.I ncr53c8xx.c (normally in directory .IR /usr/src/linux/drivers/scsi ) and change the constant 10 to, say, 60 (one minute). @@ -329,7 +329,7 @@ and with target-id 0 would be called .IR /dev/sg0a , and the device with target-id 1 on that same bus would be called -.IR /dev/sg0b, +.IR /dev/sg0b , and so on. .SH ENVIRONMENT diff --git a/upstream/opensuse-tumbleweed/man5/sane-sharp.5 b/upstream/opensuse-tumbleweed/man5/sane-sharp.5 index ef9f5659..9a10ae1d 100644 --- a/upstream/opensuse-tumbleweed/man5/sane-sharp.5 +++ b/upstream/opensuse-tumbleweed/man5/sane-sharp.5 @@ -98,7 +98,7 @@ default selection. .TP .B \-\-custom\-gamma -Custom Gamma This option determines whether a builtin or a custom +Custom Gamma. This option determines whether a builtin or a custom gamma table is used. Possible settings are: .I yes (enables custom gamma tables) or @@ -197,7 +197,7 @@ This option is only available in scan mode .TP .B \-\-threshold-red -Sets the threshold for the red component of a pixel in +Sets the threshold for the red component of a pixel in lineart color scan mode. Possible values are 1..255. The default value is 128. This option is only available in scan mode color @@ -205,7 +205,7 @@ This option is only available in scan mode color .TP .B \-\-threshold-green -Sets the threshold for the green component of a pixel in +Sets the threshold for the green component of a pixel in lineart color scan mode. Possible values are 1..255. The default value is 128. This option is only available in scan mode color @@ -213,7 +213,7 @@ This option is only available in scan mode color .TP .B \-\-threshold-blue -Sets the threshold for the blue component of a pixel in +Sets the threshold for the blue component of a pixel in lineart color scan mode. Possible values are 1..255. The default value is 128. This option is only available in scan mode color @@ -321,11 +321,11 @@ stops. Stops of the carriage can be caused by the following reasons: .PP .RS -\- too much "traffic" on the SCSI bus +\- too much "traffic" on the SCSI bus, .br \- slow responses by the backend to the scanner, .br -\- a program which processes the data acquired by the backend too slow. +\- a program which processes the data acquired by the backend is too slow. .PP .RE Too much "traffic" on the SCSI bus: This happens for example, if hard disks @@ -409,12 +409,12 @@ backend. At present, the scanner must power off and on to stop this annoying behaviour. .RE -2. Threshold level does not work (only JX-610) +2. Threshold level does not work (only JX\-610) .PP -3. The maximum resolution is limited to 600 dpi(JX-610 supported -to 1200 dpi) resp. 400 dpi (JX-250) +3. The maximum resolution is limited to 600 dpi (JX\-610 supported +to 1200 dpi) resp. 400 dpi (JX\-250) .PP -4. If the JX250 is used with an ADF, the following situation can occur: After +4. If the JX\-250 is used with an ADF, the following situation can occur: After several scans, the scanner moves, after loading a new sheet of paper, the carriage to the idle position, and then back to the position used for ADF scans. This happens for @@ -436,8 +436,8 @@ tested. Kazuya Fukuda, Abel Deuring .SH CREDITS -The Sharp backend is based on the Canon backend written by Helmut Koeberle +The Sharp backend is based on the Canon backend written by Helmut Koeberle. .PP Parts of this man page are a plain copy of .BR sane\-mustek (5) -by David Mosberger-Tang, Andreas Czechanowski and Andreas Bolsch +by David Mosberger-Tang, Andreas Czechanowski and Andreas Bolsch. diff --git a/upstream/opensuse-tumbleweed/man5/sane-stv680.5 b/upstream/opensuse-tumbleweed/man5/sane-stv680.5 index 060db32f..42f57492 100644 --- a/upstream/opensuse-tumbleweed/man5/sane-stv680.5 +++ b/upstream/opensuse-tumbleweed/man5/sane-stv680.5 @@ -82,7 +82,7 @@ scanimage \-\-help \-d stv680 .TP .B \-\-mode -selects the basic mode of operation of the webcams valid choices. +selects the basic mode of operation of the webcam's valid choices. The read resolution mode is 8 bits, output resolution is 24 bits. Selects the resolution for a scan. @@ -113,7 +113,7 @@ value loaded into the scanner. Scale \-32 .. 0 .. +32 in steps of 1. .TP .B \-\-white\-level\-g \-32..+32 Selects what green radiance level should be -considered "white", when scanning some sheets by changing the calibration i +considered "white", when scanning some sheets by changing the calibration value loaded into the scanner. Scale \-32 .. 0 .. +32 in steps of 1. .TP diff --git a/upstream/opensuse-tumbleweed/man5/sane-teco2.5 b/upstream/opensuse-tumbleweed/man5/sane-teco2.5 index 5574f097..2b503859 100644 --- a/upstream/opensuse-tumbleweed/man5/sane-teco2.5 +++ b/upstream/opensuse-tumbleweed/man5/sane-teco2.5 @@ -94,7 +94,7 @@ For a restricted set of resolutions are available. .B Note: -All values with ydpi > 300 (300 x 600) or 600 (600 x 1200) result in +All values with vertical resolution in dpi > 300 (300 x 600) or 600 (600 x 1200) result in a wrong proportion for the scan. The proportion can be adjusted with the following .BR convert (1) diff --git a/upstream/opensuse-tumbleweed/man5/sane-test.5 b/upstream/opensuse-tumbleweed/man5/sane-test.5 index c78f346d..69e81f45 100644 --- a/upstream/opensuse-tumbleweed/man5/sane-test.5 +++ b/upstream/opensuse-tumbleweed/man5/sane-test.5 @@ -235,7 +235,7 @@ constraint. Minimum is 4, maximum 192, and quant is 2. .PP Option .B int\-constraint\-array\-constraint\-word\-list -(6/7) is an int test option with unit percent and using an array a word list +(6/7) is an int test option with unit percent and using an array or word list constraint. .PP Option @@ -258,7 +258,7 @@ set. Minimum is \-42.17, maximum 32767.9999, and quant is 2.0. .PP Option .B fixed\-constraint\-word\-list -(3/3) is a Fixed test option with no unit and constraint word list set. +(3/3) is a fixed test option with no unit and constraint word list set. .PP .SH STRING TEST OPTIONS diff --git a/upstream/opensuse-tumbleweed/man5/sane-u12.5 b/upstream/opensuse-tumbleweed/man5/sane-u12.5 index c10ff948..e7ff397f 100644 --- a/upstream/opensuse-tumbleweed/man5/sane-u12.5 +++ b/upstream/opensuse-tumbleweed/man5/sane-u12.5 @@ -167,20 +167,15 @@ Please send any information and bug-reports to: .br .B SANE Mailing List .PP -Additional info and hints can be obtained from our -.br -Mailing-List archive at: -.br -.I http://www.sane\-project.org/mailing\-lists.html +Additional info and hints can be obtained from our mailing-List archive at: +.IR http://www.sane\-project.org/mailing\-lists.html . .PP To obtain debug messages from the backend, please set the environment-variable .B SANE_DEBUG_U12 -before calling your favorite scan-frontend (i.e. -.BR xscanimage (1)), -i.e.: - -.br +before calling your favorite SANE frontend (e.g. +.BR xscanimage (1)): +.PP .I export SANE_DEBUG_U12=20 ; xscanimage .PP The value controls the verbosity of the backend. diff --git a/upstream/opensuse-tumbleweed/man5/sane-umax_pp.5 b/upstream/opensuse-tumbleweed/man5/sane-umax_pp.5 index c49d4199..958ff362 100644 --- a/upstream/opensuse-tumbleweed/man5/sane-umax_pp.5 +++ b/upstream/opensuse-tumbleweed/man5/sane-umax_pp.5 @@ -55,15 +55,15 @@ if you have a kernel with ppdev support. .PP Note that if you don't use the ppdev character device, the backend needs to run as root. To allow user access to the scanner -run the backend through the network interface (See +run the backend through the network interface (see .BR saned (8) and .BR sane\-net (5)). A more relaxed solution (security wise) is to add suid bit to the frontend -(See +(see .BR chmod (1)). -The backend drop root privileges as soon as it can, right after gaining direct -access to IO ports, which lessen risks when being root. +The backend drops root privileges as soon as it can, right after gaining direct +access to I/O ports, which lessen risks of being root. .SH "DEVICE NAMES" This backend expects device names of the form: @@ -73,7 +73,7 @@ This backend expects device names of the form: .RE .PP Where -\fBvalue\fR is : +\fBvalue\fR is: .RS .TP @@ -102,8 +102,8 @@ have to use .TP 0x378 does direct hardware access on the given -address. Usual values are 0x378, 0x278, 0x3BC -In this case, you have to run the scanner as +address. Usual values are 0x378, 0x278, 0x3BC. +In this case, you have to run the backend as root (*BSD and Linux), or with 'IOPL=yes' on OS/2 .PP @@ -166,8 +166,7 @@ user provided values. .PP Options -.B red\-offset -, +.BR red\-offset , .B green\-offset and .B blue\-offset diff --git a/upstream/opensuse-tumbleweed/man5/sane-usb.5 b/upstream/opensuse-tumbleweed/man5/sane-usb.5 index 61d30ef4..1a713576 100644 --- a/upstream/opensuse-tumbleweed/man5/sane-usb.5 +++ b/upstream/opensuse-tumbleweed/man5/sane-usb.5 @@ -54,7 +54,9 @@ scanner under Linux) or disable the driver when compiling a new kernel. For Linux, your kernel needs support for the USB filesystem (usbfs). For kernels older than 2.4.19, replace "usbfs" with "usbdevfs" because the name has changed. This filesystem must be mounted. That's done automatically at boot -time, if /etc/fstab contains a line like this: +time, if +.I /etc/fstab +contains a line like this: .PP .RS none /proc/bus/usb usbfs defaults 0 0 @@ -97,7 +99,9 @@ For the .BR BSDs , the device files used by libusb are named .IR /dev/ugen* . -Use chmod to apply appropriate permissions. +Use +.BR chmod (1) +to apply appropriate permissions. .SH "SANE ISSUES" .PP @@ -174,6 +178,15 @@ setting the environment variable to 1. This may work around issues which happen with particular kernel versions. Example: .I export SANE_USB_WORKAROUND=1. +.TP +.B SANE_XEROX_USB_HALT_WORKAROUND +If your old (pre-2010) Xerox / Samsung / HP scanner is detected +only once and subsequent usage requires replugging the cable, try +setting the environment variable +.B SANE_XEROX_USB_HALT_WORKAROUND +to 1. This may work around issues which happen with particular USB +controllers. Example: +.I export SANE_XEROX_USB_HALT_WORKAROUND=1. .SH "SEE ALSO" .BR sane (7), diff --git a/upstream/opensuse-tumbleweed/man5/scr_dump.5 b/upstream/opensuse-tumbleweed/man5/scr_dump.5 index 85004ac4..64de4c60 100644 --- a/upstream/opensuse-tumbleweed/man5/scr_dump.5 +++ b/upstream/opensuse-tumbleweed/man5/scr_dump.5 @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2018-2021,2023 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 2017 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -27,8 +27,8 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: scr_dump.5,v 1.42 2023/12/30 22:06:36 tom Exp $ -.TH scr_dump 5 2023-12-30 "ncurses 6.4" "File formats" +.\" $Id: scr_dump.5,v 1.46 2024/03/23 20:42:29 tom Exp $ +.TH scr_dump 5 2024-03-23 "ncurses 6.5" "File formats" .ie \n(.g \{\ .ds `` \(lq .ds '' \(rq @@ -236,12 +236,12 @@ As noted above, Solaris .I curses has no magic number corresponding to SVr4 -.I curses. +.IR curses . This is odd, since Solaris was the first operating system to meet the SVr4 guidelines. Solaris furthermore supplies two versions of -.I curses. +.IR curses . .bP The default .I curses @@ -253,7 +253,7 @@ library (which we term .I \%xcurses), available in -.I /usr/xpg4, +.IR /usr/xpg4 , uses a textual format with no magic number. .IP According to its copyright notice, diff --git a/upstream/opensuse-tumbleweed/man5/securetty.5 b/upstream/opensuse-tumbleweed/man5/securetty.5 index a32db97d..1bd0dab9 100644 --- a/upstream/opensuse-tumbleweed/man5/securetty.5 +++ b/upstream/opensuse-tumbleweed/man5/securetty.5 @@ -4,7 +4,7 @@ .\" SPDX-License-Identifier: GPL-2.0-or-later .\" .\" Modified Sun Jul 25 11:06:27 1993 by Rik Faith (faith@cs.unc.edu) -.TH securetty 5 2022-10-30 "Linux man-pages 6.05.01" +.TH securetty 5 2024-05-02 "Linux man-pages (unreleased)" .SH NAME securetty \- list of terminals on which root is allowed to login .SH DESCRIPTION @@ -15,7 +15,7 @@ contains the names of terminals .IR /dev/ ) which are considered secure for the transmission of certain authentication tokens. -.PP +.P It is used by (some versions of) .BR login (1) to restrict the terminals @@ -23,7 +23,7 @@ on which root is allowed to login. See .BR login.defs (5) if you use the shadow suite. -.PP +.P On PAM enabled systems, it is used for the same purpose by .BR pam_securetty (8) to restrict the terminals on which empty passwords are accepted. diff --git a/upstream/opensuse-tumbleweed/man5/services.5 b/upstream/opensuse-tumbleweed/man5/services.5 index 5003f615..0d8f6c88 100644 --- a/upstream/opensuse-tumbleweed/man5/services.5 +++ b/upstream/opensuse-tumbleweed/man5/services.5 @@ -11,7 +11,7 @@ .\" Thu Jan 11 12:14:41 1996 Austin Donnelly <and1000@cam.ac.uk> .\" * Merged two services(5) manpages .\" -.TH services 5 2022-10-30 "Linux man-pages 6.05.01" +.TH services 5 2024-05-02 "Linux man-pages (unreleased)" .SH NAME services \- Internet network services list .SH DESCRIPTION @@ -29,13 +29,13 @@ The C library routines and .BR endservent (3) support querying this file from programs. -.PP +.P Port numbers are assigned by the IANA (Internet Assigned Numbers Authority), and their current policy is to assign both TCP and UDP protocols when assigning a port number. Therefore, most entries will have two entries, even for TCP-only services. -.PP +.P Port numbers below 1024 (so-called "low numbered" ports) can be bound to only by root (see .BR bind (2), @@ -47,7 +47,7 @@ that the service running on the port is the standard implementation, and not a rogue service run by a user of the machine. Well-known port numbers specified by the IANA are normally located in this root-only space. -.PP +.P The presence of an entry for a service in the .B services file does not necessarily mean that the service is currently running @@ -62,7 +62,7 @@ and so won't appear in .BR inetd.conf (5). In particular, news (NNTP) and mail (SMTP) servers are often initialized from the system boot scripts. -.PP +.P The location of the .B services file is defined by @@ -71,7 +71,7 @@ in .IR <netdb.h> "." This is usually set to .IR /etc/services "." -.PP +.P Each line describes one service, and is of the form: .IP \f2service-name\ \ \ port\f3/\f2protocol\ \ \ \f1[\f2aliases ...\f1] @@ -103,13 +103,13 @@ is an optional space or tab separated list of other names for this service. Again, the names are case sensitive. -.PP +.P Either spaces or tabs may be used to separate the fields. -.PP +.P Comments are started by the hash sign (#) and continue until the end of the line. Blank lines are skipped. -.PP +.P The .I service-name should begin in the first column of the file, since leading spaces are @@ -120,7 +120,7 @@ However, a conservative choice of characters should be used to minimize compatibility problems. For example, a\-z, 0\-9, and hyphen (\-) would seem a sensible choice. -.PP +.P Lines not matching this format should not be present in the file. (Currently, they are silently skipped by @@ -129,7 +129,7 @@ file. and .BR getservbyport (3). However, this behavior should not be relied on.) -.PP +.P .\" The following is not true as at glibc 2.8 (a line with a comma is .\" ignored by getservent()); it's not clear if/when it was ever true. .\" As a backward compatibility feature, the slash (/) between the @@ -142,11 +142,11 @@ However, this behavior should not be relied on.) .\" This file might be distributed over a network using a network-wide naming service like Yellow Pages/NIS or BIND/Hesiod. -.PP +.P A sample .B services file might look like this: -.PP +.P .in +4n .EX netstat 15/tcp @@ -195,5 +195,5 @@ Definition of .BR inetd.conf (5), .BR protocols (5), .BR inetd (8) -.PP +.P Assigned Numbers RFC, most recently RFC\ 1700, (AKA STD0002). diff --git a/upstream/opensuse-tumbleweed/man5/shells.5 b/upstream/opensuse-tumbleweed/man5/shells.5 index fcbbd22e..965b2a03 100644 --- a/upstream/opensuse-tumbleweed/man5/shells.5 +++ b/upstream/opensuse-tumbleweed/man5/shells.5 @@ -6,7 +6,7 @@ .\" Modified Sat Jul 24 17:11:07 1993 by Rik Faith (faith@cs.unc.edu) .\" Modified Sun Nov 21 10:49:38 1993 by Michael Haardt .\" Modified Sun Feb 26 15:09:15 1995 by Rik Faith (faith@cs.unc.edu) -.TH shells 5 2022-10-30 "Linux man-pages 6.05.01" +.TH shells 5 2024-05-02 "Linux man-pages (unreleased)" .SH NAME shells \- pathnames of valid login shells .SH DESCRIPTION @@ -15,7 +15,7 @@ is a text file which contains the full pathnames of valid login shells. This file is consulted by .BR chsh (1) and available to be queried by other programs. -.PP +.P Be aware that there are programs which consult this file to find out if a user is a normal user; for example, @@ -26,7 +26,7 @@ disallow access to users with shells not included in this file. .SH EXAMPLES .I /etc/shells may contain the following paths: -.PP +.P .in +4n .EX .I /bin/sh diff --git a/upstream/opensuse-tumbleweed/man5/slabinfo.5 b/upstream/opensuse-tumbleweed/man5/slabinfo.5 index e27ff80f..0d5160ff 100644 --- a/upstream/opensuse-tumbleweed/man5/slabinfo.5 +++ b/upstream/opensuse-tumbleweed/man5/slabinfo.5 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH slabinfo 5 2023-02-05 "Linux man-pages 6.05.01" +.TH slabinfo 5 2024-05-02 "Linux man-pages (unreleased)" .SH NAME slabinfo \- kernel slab allocator statistics .SH SYNOPSIS @@ -19,7 +19,7 @@ The file gives statistics on these caches. The following (edited) output shows an example of the contents of this file: -.PP +.P .EX $ \fBsudo cat /proc/slabinfo\fP slabinfo \- version: 2.1 @@ -29,13 +29,13 @@ sighand_cache 355 405 2112 15 8 : tunables 0 0 0 : slabdata 27 27 0 kmalloc\-8192 96 96 8192 4 8 : tunables 0 0 0 : slabdata 24 24 0 \&... .EE -.PP +.P The first line of output includes a version number, which allows an application that is reading the file to handle changes in the file format. (See VERSIONS, below.) The next line lists the names of the columns in the remaining lines. -.PP +.P Each of the remaining lines displays information about a specified cache. Following the cache name, the output shown in each line shows three components for each cache: @@ -45,7 +45,7 @@ statistics tunables .IP \[bu] slabdata -.PP +.P The statistics are as follows: .TP .I active_objs @@ -63,7 +63,7 @@ The number of objects stored in each slab. .TP .I pagesperslab The number of pages allocated for each slab. -.PP +.P The .I tunables entries in each line show tunable parameters for the corresponding cache. @@ -74,13 +74,13 @@ When using the older SLAB allocator, the tunables for a particular cache can be set by writing lines of the following form to .IR /proc/slabinfo : -.PP +.P .in +4n .EX # \fBecho \[aq]name limit batchcount sharedfactor\[aq] > /proc/slabinfo\fP .EE .in -.PP +.P Here, .I name is the cache name, and @@ -100,7 +100,7 @@ and should be nonnegative. If any of the specified values is invalid, the cache settings are left unchanged. -.PP +.P The .I tunables entries in each line contain the following fields: @@ -121,7 +121,7 @@ when refilling the available object list. .I sharedfactor [To be documented] .\" -.PP +.P The .I slabdata entries in each line contain the following fields: @@ -134,12 +134,12 @@ The total number of slabs. .TP .I sharedavail [To be documented] -.PP +.P Note that because of object alignment and slab cache overhead, objects are not normally packed tightly into pages. Pages with even one in-use object are considered in-use and cannot be freed. -.PP +.P Kernels configured with .B CONFIG_DEBUG_SLAB will also have additional statistics fields in each line, @@ -206,14 +206,14 @@ Only root can read and (if the kernel was configured with write the .I /proc/slabinfo file. -.PP +.P The total amount of memory allocated to the SLAB/SLUB cache is shown in the .I Slab field of .IR /proc/meminfo . .SH SEE ALSO .BR slabtop (1) -.PP +.P The kernel source file .I Documentation/vm/slub.txt and diff --git a/upstream/opensuse-tumbleweed/man5/sshd_config.5 b/upstream/opensuse-tumbleweed/man5/sshd_config.5 index 9e921488..b5df80a7 100644 --- a/upstream/opensuse-tumbleweed/man5/sshd_config.5 +++ b/upstream/opensuse-tumbleweed/man5/sshd_config.5 @@ -381,17 +381,14 @@ If the argument is then no banner is displayed. By default, no banner is displayed. .It Cm CASignatureAlgorithms +The default is handled system-wide by +.Xr crypto-policies 7 . +Information about defaults, how to modify the defaults and how to customize +existing policies with sub-policies are present in manual page +.Xr update-crypto-policies 8 . +.Pp Specifies which algorithms are allowed for signing of certificates by certificate authorities (CAs). -The default is: -.Bd -literal -offset indent -ssh-ed25519,ecdsa-sha2-nistp256, -ecdsa-sha2-nistp384,ecdsa-sha2-nistp521, -sk-ssh-ed25519@openssh.com, -sk-ecdsa-sha2-nistp256@openssh.com, -rsa-sha2-512,rsa-sha2-256 -.Ed -.Pp If the specified list begins with a .Sq + character, then the specified algorithms will be appended to the default set @@ -527,20 +524,26 @@ The default is indicating not to .Xr chroot 2 . .It Cm Ciphers +The default is handled system-wide by +.Xr crypto-policies 7 . +Information about defaults, how to modify the defaults and how to customize +existing policies with sub-policies are present in manual page +.Xr update-crypto-policies 8 . +.Pp Specifies the ciphers allowed. Multiple ciphers must be comma-separated. If the specified list begins with a .Sq + -character, then the specified ciphers will be appended to the default set -instead of replacing them. +character, then the specified ciphers will be appended to the built-in +openssh default set instead of replacing them. If the specified list begins with a .Sq - character, then the specified ciphers (including wildcards) will be removed -from the default set instead of replacing them. +from the built-in openssh default set instead of replacing them. If the specified list begins with a .Sq ^ character, then the specified ciphers will be placed at the head of the -default set. +built-in openssh default set. .Pp The supported ciphers are: .Pp @@ -567,13 +570,6 @@ aes256-gcm@openssh.com chacha20-poly1305@openssh.com .El .Pp -The default is: -.Bd -literal -offset indent -chacha20-poly1305@openssh.com, -aes128-ctr,aes192-ctr,aes256-ctr, -aes128-gcm@openssh.com,aes256-gcm@openssh.com -.Ed -.Pp The list of available ciphers may also be obtained using .Qq ssh -Q cipher . .It Cm ClientAliveCountMax @@ -764,52 +760,45 @@ For this to work .Cm GSSAPIKeyExchange needs to be enabled in the server and also used by the client. .It Cm GSSAPIKexAlgorithms +The default is handled system-wide by +.Xr crypto-policies 7 . +Information about defaults, how to modify the defaults and how to customize +existing policies with sub-policies are present in manual page +.Xr update-crypto-policies 8 . +.Pp The list of key exchange algorithms that are accepted by GSSAPI key exchange. Possible values are .Bd -literal -offset 3n -gss-gex-sha1-, -gss-group1-sha1-, -gss-group14-sha1-, -gss-group14-sha256-, -gss-group16-sha512-, -gss-nistp256-sha256-, +gss-gex-sha1- +gss-group1-sha1- +gss-group14-sha1- +gss-group14-sha256- +gss-group16-sha512- +gss-nistp256-sha256- gss-curve25519-sha256- .Ed -.Pp -The default is -.Dq gss-gex-sha1-,gss-group14-sha1- . This option only applies to protocol version 2 connections using GSSAPI. .It Cm HostbasedAcceptedAlgorithms +The default is handled system-wide by +.Xr crypto-policies 7 . +Information about defaults, how to modify the defaults and how to customize +existing policies with sub-policies are present in manual page +.Xr update-crypto-policies 8 . +.Pp Specifies the signature algorithms that will be accepted for hostbased authentication as a list of comma-separated patterns. Alternately if the specified list begins with a .Sq + character, then the specified signature algorithms will be appended to -the default set instead of replacing them. +the built-in openssh set instead of replacing them. If the specified list begins with a .Sq - character, then the specified signature algorithms (including wildcards) -will be removed from the default set instead of replacing them. +will be removed from the built-in openssh set instead of replacing them. If the specified list begins with a .Sq ^ character, then the specified signature algorithms will be placed at -the head of the default set. -The default for this option is: -.Bd -literal -offset 3n -ssh-ed25519-cert-v01@openssh.com, -ecdsa-sha2-nistp256-cert-v01@openssh.com, -ecdsa-sha2-nistp384-cert-v01@openssh.com, -ecdsa-sha2-nistp521-cert-v01@openssh.com, -sk-ssh-ed25519-cert-v01@openssh.com, -sk-ecdsa-sha2-nistp256-cert-v01@openssh.com, -rsa-sha2-512-cert-v01@openssh.com, -rsa-sha2-256-cert-v01@openssh.com, -ssh-ed25519, -ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521, -sk-ssh-ed25519@openssh.com, -sk-ecdsa-sha2-nistp256@openssh.com, -rsa-sha2-512,rsa-sha2-256 -.Ed +the head of the built-in openssh default set. .Pp The list of available signature algorithms may also be obtained using .Qq ssh -Q HostbasedAcceptedAlgorithms . @@ -876,25 +865,15 @@ is specified, the location of the socket will be read from the .Ev SSH_AUTH_SOCK environment variable. .It Cm HostKeyAlgorithms +The default is handled system-wide by +.Xr crypto-policies 7 . +Information about defaults, how to modify the defaults and how to customize +existing policies with sub-policies are present in manual page +.Xr update-crypto-policies 8 . +.Pp Specifies the host key signature algorithms that the server offers. The default for this option is: -.Bd -literal -offset 3n -ssh-ed25519-cert-v01@openssh.com, -ecdsa-sha2-nistp256-cert-v01@openssh.com, -ecdsa-sha2-nistp384-cert-v01@openssh.com, -ecdsa-sha2-nistp521-cert-v01@openssh.com, -sk-ssh-ed25519-cert-v01@openssh.com, -sk-ecdsa-sha2-nistp256-cert-v01@openssh.com, -rsa-sha2-512-cert-v01@openssh.com, -rsa-sha2-256-cert-v01@openssh.com, -ssh-ed25519, -ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521, -sk-ssh-ed25519@openssh.com, -sk-ecdsa-sha2-nistp256@openssh.com, -rsa-sha2-512,rsa-sha2-256 -.Ed -.Pp The list of available signature algorithms may also be obtained using .Qq ssh -Q HostKeyAlgorithms . .It Cm IgnoreRhosts @@ -1027,20 +1006,26 @@ file on logout. The default is .Cm yes . .It Cm KexAlgorithms +The default is handled system-wide by +.Xr crypto-policies 7 . +Information about defaults, how to modify the defaults and how to customize +existing policies with sub-policies are present in manual page +.Xr update-crypto-policies 8 . +.Pp Specifies the available KEX (Key Exchange) algorithms. Multiple algorithms must be comma-separated. Alternately if the specified list begins with a .Sq + -character, then the specified algorithms will be appended to the default set -instead of replacing them. +character, then the specified methods will be appended to the built-in +openssh default set instead of replacing them. If the specified list begins with a .Sq - character, then the specified algorithms (including wildcards) will be removed -from the default set instead of replacing them. +from the built-in openssh default set instead of replacing them. If the specified list begins with a .Sq ^ character, then the specified algorithms will be placed at the head of the -default set. +built-in openssh default set. The supported algorithms are: .Pp .Bl -item -compact -offset indent @@ -1072,16 +1057,6 @@ ecdh-sha2-nistp521 sntrup761x25519-sha512@openssh.com .El .Pp -The default is: -.Bd -literal -offset indent -sntrup761x25519-sha512@openssh.com, -curve25519-sha256,curve25519-sha256@libssh.org, -ecdh-sha2-nistp256,ecdh-sha2-nistp384,ecdh-sha2-nistp521, -diffie-hellman-group-exchange-sha256, -diffie-hellman-group16-sha512,diffie-hellman-group18-sha512, -diffie-hellman-group14-sha256,diffie-hellman-group14-sha1 -.Ed -.Pp The list of available key exchange algorithms may also be obtained using .Qq ssh -Q KexAlgorithms . .It Cm ListenAddress @@ -1167,21 +1142,27 @@ function, and all code in the file. This option is intended for debugging and no overrides are enabled by default. .It Cm MACs +The default is handled system-wide by +.Xr crypto-policies 7 . +Information about defaults, how to modify the defaults and how to customize +existing policies with sub-policies are present in manual page +.Xr update-crypto-policies 8 . +.Pp Specifies the available MAC (message authentication code) algorithms. The MAC algorithm is used for data integrity protection. Multiple algorithms must be comma-separated. If the specified list begins with a .Sq + -character, then the specified algorithms will be appended to the default set -instead of replacing them. +character, then the specified algorithms will be appended to the built-in +openssh default set instead of replacing them. If the specified list begins with a .Sq - character, then the specified algorithms (including wildcards) will be removed -from the default set instead of replacing them. +from the built-in openssh default set instead of replacing them. If the specified list begins with a .Sq ^ character, then the specified algorithms will be placed at the head of the -default set. +built-in openssh default set. .Pp The algorithms that contain .Qq -etm @@ -1224,15 +1205,6 @@ umac-64-etm@openssh.com umac-128-etm@openssh.com .El .Pp -The default is: -.Bd -literal -offset indent -umac-64-etm@openssh.com,umac-128-etm@openssh.com, -hmac-sha2-256-etm@openssh.com,hmac-sha2-512-etm@openssh.com, -hmac-sha1-etm@openssh.com, -umac-64@openssh.com,umac-128@openssh.com, -hmac-sha2-256,hmac-sha2-512,hmac-sha1 -.Ed -.Pp The list of available MAC algorithms may also be obtained using .Qq ssh -Q mac . .It Cm Match @@ -1614,36 +1586,26 @@ or equivalent.) The default is .Cm yes . .It Cm PubkeyAcceptedAlgorithms +The default is handled system-wide by +.Xr crypto-policies 7 . +Information about defaults, how to modify the defaults and how to customize +existing policies with sub-policies are present in manual page +.Xr update-crypto-policies 8 . +.Pp Specifies the signature algorithms that will be accepted for public key authentication as a list of comma-separated patterns. Alternately if the specified list begins with a .Sq + -character, then the specified algorithms will be appended to the default set -instead of replacing them. +character, then the specified algorithms will be appended to the built-in +openssh default set instead of replacing them. If the specified list begins with a .Sq - character, then the specified algorithms (including wildcards) will be removed -from the default set instead of replacing them. +from the built-in openssh default set instead of replacing them. If the specified list begins with a .Sq ^ character, then the specified algorithms will be placed at the head of the -default set. -The default for this option is: -.Bd -literal -offset 3n -ssh-ed25519-cert-v01@openssh.com, -ecdsa-sha2-nistp256-cert-v01@openssh.com, -ecdsa-sha2-nistp384-cert-v01@openssh.com, -ecdsa-sha2-nistp521-cert-v01@openssh.com, -sk-ssh-ed25519-cert-v01@openssh.com, -sk-ecdsa-sha2-nistp256-cert-v01@openssh.com, -rsa-sha2-512-cert-v01@openssh.com, -rsa-sha2-256-cert-v01@openssh.com, -ssh-ed25519, -ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521, -sk-ssh-ed25519@openssh.com, -sk-ecdsa-sha2-nistp256@openssh.com, -rsa-sha2-512,rsa-sha2-256 -.Ed +built-in openssh default set. .Pp The list of available signature algorithms may also be obtained using .Qq ssh -Q PubkeyAcceptedAlgorithms . @@ -2122,7 +2084,9 @@ This file should be writable by root only, but it is recommended .El .Sh SEE ALSO .Xr sftp-server 8 , -.Xr sshd 8 +.Xr sshd 8 , +.Xr crypto-policies 7 , +.Xr update-crypto-policies 8 .Sh AUTHORS .An -nosplit OpenSSH is a derivative of the original and free diff --git a/upstream/opensuse-tumbleweed/man5/sysctl.d.5 b/upstream/opensuse-tumbleweed/man5/sysctl.d.5 index f29cc182..378b4c78 100644 --- a/upstream/opensuse-tumbleweed/man5/sysctl.d.5 +++ b/upstream/opensuse-tumbleweed/man5/sysctl.d.5 @@ -1,5 +1,5 @@ '\" t -.TH "SYSCTL\&.D" "5" "" "systemd 254" "sysctl.d" +.TH "SYSCTL\&.D" "5" "" "systemd 255" "sysctl.d" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/upstream/opensuse-tumbleweed/man5/sysfs.5 b/upstream/opensuse-tumbleweed/man5/sysfs.5 index 2edd582e..33b03914 100644 --- a/upstream/opensuse-tumbleweed/man5/sysfs.5 +++ b/upstream/opensuse-tumbleweed/man5/sysfs.5 @@ -2,7 +2,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH sysfs 5 2023-03-30 "Linux man-pages 6.05.01" +.TH sysfs 5 2024-05-02 "Linux man-pages (unreleased)" .SH NAME sysfs \- a filesystem for exporting kernel objects .SH DESCRIPTION @@ -19,20 +19,20 @@ The files under .B sysfs provide information about devices, kernel modules, filesystems, and other kernel components. -.PP +.P The .B sysfs filesystem is commonly mounted at .IR /sys . Typically, it is mounted automatically by the system, but it can also be mounted manually using a command such as: -.PP +.P .in +4n .EX mount \-t sysfs sysfs /sys .EE .in -.PP +.P Many of the files in the .B sysfs filesystem are read-only, @@ -261,12 +261,12 @@ of thing that needs to be updated very often. .SH SEE ALSO .BR proc (5), .BR udev (7) -.PP +.P P.\& Mochel. (2005). .IR "The sysfs filesystem" . Proceedings of the 2005 Ottawa Linux Symposium. .\" https://www.kernel.org/pub/linux/kernel/people/mochel/doc/papers/ols-2005/mochel.pdf -.PP +.P The kernel source file .I Documentation/filesystems/sysfs.txt and various other files in diff --git a/upstream/opensuse-tumbleweed/man5/systemd-system.conf.5 b/upstream/opensuse-tumbleweed/man5/systemd-system.conf.5 index 93cb0876..15043f8f 100644 --- a/upstream/opensuse-tumbleweed/man5/systemd-system.conf.5 +++ b/upstream/opensuse-tumbleweed/man5/systemd-system.conf.5 @@ -1,5 +1,5 @@ '\" t -.TH "SYSTEMD\-SYSTEM\&.CONF" "5" "" "systemd 254" "systemd-system.conf" +.TH "SYSTEMD\-SYSTEM\&.CONF" "5" "" "systemd 255" "systemd-system.conf" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -92,6 +92,8 @@ All options are configured in the [Manager] section: Configures various parameters of basic manager operation\&. These options may be overridden by the respective process and kernel command line arguments\&. See \fBsystemd\fR(1) for details\&. +.sp +Added in version 198\&. .RE .PP \fICtrlAltDelBurstAction=\fR @@ -104,6 +106,8 @@ Defines what action will be performed if user presses Ctrl\-Alt\-Delete more tha or disabled with "none"\&. Defaults to "reboot\-force"\&. +.sp +Added in version 232\&. .RE .PP \fICPUAffinity=\fR @@ -112,6 +116,8 @@ Configures the CPU affinity for the service manager as well as the default CPU a \fICPUAffinity=\fR setting in unit files, see \fBsystemd.exec\fR(5)\&. +.sp +Added in version 198\&. .RE .PP \fINUMAPolicy=\fR @@ -120,6 +126,8 @@ Configures the NUMA memory policy for the service manager and the default NUMA m \fINUMAPolicy=\fR setting in unit files, see \fBsystemd.exec\fR(5)\&. +.sp +Added in version 243\&. .RE .PP \fINUMAMask=\fR @@ -131,6 +139,8 @@ and NUMA policies don\*(Aqt require explicit NUMA node mask and value of the option can be empty\&. Similarly to \fINUMAPolicy=\fR, value can be overridden by individual services in unit files, see \fBsystemd.exec\fR(5)\&. +.sp +Added in version 243\&. .RE .PP \fIRuntimeWatchdogSec=\fR, \fIRebootWatchdogSec=\fR, \fIKExecWatchdogSec=\fR @@ -189,6 +199,8 @@ only if is also enabled\&. .sp These settings have no effect if a hardware watchdog is not available\&. +.sp +Added in version 198\&. .RE .PP \fIRuntimeWatchdogPreSec=\fR @@ -207,6 +219,8 @@ defaults to 0 (off)\&. The value set for \fIRuntimeWatchdogPreSec=\fR must be smaller than the timeout value for \fIRuntimeWatchdogSec=\fR\&. This setting has no effect if a hardware watchdog is not available or the hardware watchdog does not support a pre\-timeout and will be ignored by the kernel if the setting is greater than the actual watchdog timeout\&. +.sp +Added in version 251\&. .RE .PP \fIRuntimeWatchdogPreGovernor=\fR @@ -220,12 +234,16 @@ and pretimeout_available_governors sysfs file is empty, the governor might be built as a kernel module and might need to be manually loaded (e\&.g\&. \fIpretimeout_noop\&.ko\fR), or the watchdog device might not support pre\-timeouts\&. +.sp +Added in version 251\&. .RE .PP \fIWatchdogDevice=\fR .RS 4 Configure the hardware watchdog device that the runtime and shutdown watchdog timers will open and use\&. Defaults to /dev/watchdog0\&. This setting has no effect if a hardware watchdog is not available\&. +.sp +Added in version 236\&. .RE .PP \fICapabilityBoundingSet=\fR @@ -236,6 +254,8 @@ for details\&. Takes a whitespace\-separated list of capability names as read by \fBcap_from_name\fR(3)\&. Capabilities listed will be included in the bounding set, all others are removed\&. If the list of capabilities is prefixed with ~, all but the listed capabilities will be included, the effect of the assignment inverted\&. Note that this option also affects the respective capabilities in the effective, permitted and inheritable capability sets\&. The capability bounding set may also be individually configured for units using the \fICapabilityBoundingSet=\fR directive for units, but note that capabilities dropped for PID 1 cannot be regained in individual units, they are lost for good\&. +.sp +Added in version 198\&. .RE .PP \fINoNewPrivileges=\fR @@ -244,6 +264,8 @@ Takes a boolean argument\&. If true, ensures that PID 1 and all its children can \fBexecve\fR(2) (e\&.g\&. via setuid or setgid bits, or filesystem capabilities)\&. Defaults to false\&. General purpose distributions commonly rely on executables with setuid or setgid bits and will thus not function properly with this option enabled\&. Individual units cannot disable this option\&. Also see \m[blue]\fBNo New Privileges Flag\fR\m[]\&\s-2\u[1]\d\s+2\&. +.sp +Added in version 239\&. .RE .PP \fISystemCallArchitectures=\fR @@ -261,6 +283,8 @@ and the special identifier "native"\&. The latter implicitly maps to the native architecture of the system (or more specifically, the architecture the system manager was compiled for)\&. Set this setting to "native" to prohibit execution of any non\-native binaries\&. When a binary executes a system call of an architecture that is not listed in this setting, it will be immediately terminated with the SIGSYS signal\&. +.sp +Added in version 209\&. .RE .PP \fITimerSlackNSec=\fR @@ -271,6 +295,8 @@ setting in service units (for details see \fBsystemd.exec\fR(5))\&. The timer slack controls the accuracy of wake\-ups triggered by system timers\&. See \fBprctl\fR(2) for more information\&. Note that in contrast to most other time span definitions this parameter takes an integer value in nano\-seconds if no unit is specified\&. The usual time units are understood too\&. +.sp +Added in version 198\&. .RE .PP \fIStatusUnitFormat=\fR @@ -293,6 +319,8 @@ See \fBsystemd.unit\fR(5) for details about unit names and \fIDescription=\fR\&. +.sp +Added in version 243\&. .RE .PP \fIDefaultTimerAccuracySec=\fR @@ -306,6 +334,8 @@ for details\&. set in individual units override the global default for the specific unit\&. Defaults to 1min\&. Note that the accuracy of timer units is also affected by the configured timer slack for PID 1, see \fITimerSlackNSec=\fR above\&. +.sp +Added in version 212\&. .RE .PP \fIDefaultTimeoutStartSec=\fR, \fIDefaultTimeoutStopSec=\fR, \fIDefaultTimeoutAbortSec=\fR, \fIDefaultRestartSec=\fR @@ -333,6 +363,8 @@ is not set by default so that all units fall back to \fITimeoutStopSec=\fR\&. \fIDefaultRestartSec=\fR defaults to 100 ms\&. +.sp +Added in version 209\&. .RE .PP \fIDefaultDeviceTimeoutSec=\fR @@ -346,6 +378,8 @@ and (see \fBsystemd.mount\fR(5), \fBcrypttab\fR(5))\&. Defaults to 90 s in the system manager and 90 s in the user manager\&. +.sp +Added in version 252\&. .RE .PP \fIDefaultStartLimitIntervalSec=\fR, \fIDefaultStartLimitBurst=\fR @@ -360,6 +394,8 @@ for details on the per\-service settings\&. defaults to 10s\&. \fIDefaultStartLimitBurst=\fR defaults to 5\&. +.sp +Added in version 209\&. .RE .PP \fIDefaultEnvironment=\fR @@ -387,6 +423,8 @@ Sets three variables "VAR1", "VAR2", "VAR3"\&. +.sp +Added in version 205\&. .RE .PP \fIManagerEnvironment=\fR @@ -397,12 +435,14 @@ Takes the same arguments as for that\&. Note that these variables are merged into the existing environment block\&. In particular, in case of the system manager, this includes variables set by the kernel based on the kernel command line\&. .sp Setting environment variables for the manager process may be useful to modify its behaviour\&. See -\m[blue]\fBENVIRONMENT\fR\m[]\&\s-2\u[2]\d\s+2 +\m[blue]\fBKnown Environment Variables\fR\m[]\&\s-2\u[2]\d\s+2 for a descriptions of some variables understood by \fBsystemd\fR\&. .sp Simple "%"\-specifier expansion is supported, see below for a list of supported specifiers\&. +.sp +Added in version 248\&. .RE .PP \fIDefaultCPUAccounting=\fR, \fIDefaultMemoryAccounting=\fR, \fIDefaultTasksAccounting=\fR, \fIDefaultIOAccounting=\fR, \fIDefaultIPAccounting=\fR @@ -423,6 +463,8 @@ defaults to yes when running on kernel ≥4\&.15, and no on older versions\&. defaults to yes\&. \fIDefaultTasksAccounting=\fR defaults to yes\&. The other settings default to no\&. +.sp +Added in version 211\&. .RE .PP \fIDefaultTasksMax=\fR @@ -441,6 +483,8 @@ and an algorithm of counting in case of more than 32 cores\&. For example, with \fIkernel\&.pid_max=\fR, \fIDefaultTasksMax=\fR defaults to 4915, but might be greater in other systems or smaller in OS containers\&. +.sp +Added in version 228\&. .RE .PP \fIDefaultLimitCPU=\fR, \fIDefaultLimitFSIZE=\fR, \fIDefaultLimitDATA=\fR, \fIDefaultLimitSTACK=\fR, \fIDefaultLimitCORE=\fR, \fIDefaultLimitRSS=\fR, \fIDefaultLimitNOFILE=\fR, \fIDefaultLimitAS=\fR, \fIDefaultLimitNPROC=\fR, \fIDefaultLimitMEMLOCK=\fR, \fIDefaultLimitLOCKS=\fR, \fIDefaultLimitSIGPENDING=\fR, \fIDefaultLimitMSGQUEUE=\fR, \fIDefaultLimitNICE=\fR, \fIDefaultLimitRTPRIO=\fR, \fIDefaultLimitRTTIME=\fR @@ -500,6 +544,8 @@ Note that the service manager internally in PID 1 bumps and \fIRLIMIT_MEMLOCK\fR to higher values, however the limit is reverted to the mentioned defaults for all child processes forked off\&. +.sp +Added in version 198\&. .RE .PP \fIDefaultOOMPolicy=\fR @@ -512,6 +558,8 @@ setting\&. See for details\&. Note that this default is not used for services that have \fIDelegate=\fR turned on\&. +.sp +Added in version 243\&. .RE .PP \fIDefaultOOMScoreAdjust=\fR @@ -521,6 +569,8 @@ Configures the default OOM score adjustments of processes run by the service man setting\&. See \fBsystemd.exec\fR(5) for details\&. Note that this setting has no effect on the OOM score adjustment value of the service manager process itself, it retains the original value set during its invocation\&. +.sp +Added in version 250\&. .RE .PP \fIDefaultSmackProcessLabel=\fR @@ -537,6 +587,8 @@ If the value is "/", only labels specified with \fISmackProcessLabel=\fR are assigned and the compile\-time default is ignored\&. +.sp +Added in version 252\&. .RE .PP \fIReloadLimitIntervalSec=\fR, \fIReloadLimitBurst=\fR @@ -546,6 +598,8 @@ Rate limiting for daemon\-reload requests\&. Default to unset, and any number of takes a value in seconds to configure the rate limit window, and \fIReloadLimitBurst=\fR takes a positive integer to configure the maximum allowed number of reloads within the configured time window\&. +.sp +Added in version 253\&. .RE .PP \fIDefaultMemoryPressureWatch=\fR, \fIDefaultMemoryPressureThresholdSec=\fR @@ -560,6 +614,8 @@ for details\&. Defaults to "auto" and "200ms", respectively\&. This also sets the memory pressure monitoring threshold for the service manager itself\&. +.sp +Added in version 254\&. .RE .SH "SPECIFIERS" .PP @@ -762,6 +818,8 @@ systemd 252 Option \fIDefaultBlockIOAccounting=\fR was deprecated\&. Please switch to the unified cgroup hierarchy\&. +.sp +Added in version 252\&. .RE .SH "SEE ALSO" .PP @@ -778,7 +836,7 @@ No New Privileges Flag \%https://docs.kernel.org/userspace-api/no_new_privs.html .RE .IP " 2." 4 -ENVIRONMENT +Known Environment Variables .RS 4 \%https://systemd.io/ENVIRONMENT .RE diff --git a/upstream/opensuse-tumbleweed/man5/systemd.automount.5 b/upstream/opensuse-tumbleweed/man5/systemd.automount.5 index 9d6a2f5e..b61efb9a 100644 --- a/upstream/opensuse-tumbleweed/man5/systemd.automount.5 +++ b/upstream/opensuse-tumbleweed/man5/systemd.automount.5 @@ -1,5 +1,5 @@ '\" t -.TH "SYSTEMD\&.AUTOMOUNT" "5" "" "systemd 254" "systemd.automount" +.TH "SYSTEMD\&.AUTOMOUNT" "5" "" "systemd 255" "systemd.automount" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -160,6 +160,8 @@ Takes an absolute path of a directory of the automount point\&. If the automount .RS 4 Extra mount options to use when creating the autofs mountpoint\&. This takes a comma\-separated list of options\&. This setting is optional\&. Note that the usual specifier expansion is applied to this setting, literal percent characters should hence be written as "%%"\&. +.sp +Added in version 250\&. .RE .PP \fIDirectoryMode=\fR @@ -170,6 +172,8 @@ Directories of automount points (and any parent directories) are automatically c \fITimeoutIdleSec=\fR .RS 4 Configures an idle timeout\&. Once the mount has been idle for the specified time, systemd will attempt to unmount\&. Takes a unit\-less value in seconds, or a time span value such as "5min 20s"\&. Pass 0 to disable the timeout logic\&. The timeout is disabled by default\&. +.sp +Added in version 220\&. .RE .PP Check diff --git a/upstream/opensuse-tumbleweed/man5/systemd.device.5 b/upstream/opensuse-tumbleweed/man5/systemd.device.5 index 0a10fc79..6d6744c4 100644 --- a/upstream/opensuse-tumbleweed/man5/systemd.device.5 +++ b/upstream/opensuse-tumbleweed/man5/systemd.device.5 @@ -1,5 +1,5 @@ '\" t -.TH "SYSTEMD\&.DEVICE" "5" "" "systemd 254" "systemd.device" +.TH "SYSTEMD\&.DEVICE" "5" "" "systemd 255" "systemd.device" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/upstream/opensuse-tumbleweed/man5/systemd.dnssd.5 b/upstream/opensuse-tumbleweed/man5/systemd.dnssd.5 index c9611687..708d02ca 100644 --- a/upstream/opensuse-tumbleweed/man5/systemd.dnssd.5 +++ b/upstream/opensuse-tumbleweed/man5/systemd.dnssd.5 @@ -1,5 +1,5 @@ '\" t -.TH "SYSTEMD\&.DNSSD" "5" "" "systemd 254" "systemd.dnssd" +.TH "SYSTEMD\&.DNSSD" "5" "" "systemd 255" "systemd.dnssd" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -195,6 +195,7 @@ Use "%%" in place of "%" to specify a single percent sign\&. T} .TE .sp 1 +Added in version 236\&. .RE .PP \fIType=\fR @@ -202,11 +203,15 @@ T} A type of the network service as defined in the section 4\&.1\&.2 of \m[blue]\fBRFC 6763\fR\m[]\&\s-2\u[1]\d\s+2, e\&.g\&. "_http\&._tcp"\&. +.sp +Added in version 236\&. .RE .PP \fIPort=\fR .RS 4 An IP port number of the network service\&. +.sp +Added in version 236\&. .RE .PP \fIPriority=\fR @@ -214,6 +219,8 @@ An IP port number of the network service\&. A priority number set in \fBSRV\fR resource records corresponding to the network service\&. +.sp +Added in version 236\&. .RE .PP \fIWeight=\fR @@ -221,6 +228,8 @@ resource records corresponding to the network service\&. A weight number set in \fBSRV\fR resource records corresponding to the network service\&. +.sp +Added in version 236\&. .RE .PP \fITxtText=\fR @@ -231,6 +240,8 @@ A whitespace\-separated list of arbitrary key/value pairs conveying additional i This option together with \fITxtData=\fR may be specified more than once, in which case multiple TXT resource records will be created for the service\&. If the empty string is assigned to this option, the list is reset and all prior assignments will have no effect\&. +.sp +Added in version 236\&. .RE .PP \fITxtData=\fR @@ -241,6 +252,8 @@ A whitespace\-separated list of arbitrary key/value pairs conveying additional i This option together with \fITxtText=\fR may be specified more than once, in which case multiple TXT resource records will be created for the service\&. If the empty string is assigned to this option, the list is reset and all prior assignments will have no effect\&. +.sp +Added in version 236\&. .RE .SH "EXAMPLES" .PP diff --git a/upstream/opensuse-tumbleweed/man5/systemd.exec.5 b/upstream/opensuse-tumbleweed/man5/systemd.exec.5 index 15e1c509..469948df 100644 --- a/upstream/opensuse-tumbleweed/man5/systemd.exec.5 +++ b/upstream/opensuse-tumbleweed/man5/systemd.exec.5 @@ -1,5 +1,5 @@ '\" t -.TH "SYSTEMD\&.EXEC" "5" "" "systemd 254" "systemd.exec" +.TH "SYSTEMD\&.EXEC" "5" "" "systemd 255" "systemd.exec" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -148,6 +148,8 @@ or \fIPassEnvironment=\fR\&. Assigning an empty string removes previous assignments and setting \fIExecSearchPath=\fR to a value multiple times will append to the previous setting\&. +.sp +Added in version 250\&. .RE .PP \fIWorkingDirectory=\fR @@ -267,6 +269,8 @@ file will be made available for the service (read\-only) as \fBsystemd-soft-reboot.service\fR(8)), in case the service is configured to survive it\&. .sp This option is only available for system services and is not supported for services running in per\-user instances of the service manager\&. +.sp +Added in version 233\&. .RE .PP \fIRootImageOptions=\fR @@ -289,6 +293,8 @@ Valid partition names follow the \fBvar\fR\&. .sp This option is only available for system services and is not supported for services running in per\-user instances of the service manager\&. +.sp +Added in version 247\&. .RE .PP \fIRootEphemeral=\fR @@ -302,11 +308,15 @@ is used and the root directory is a subvolume, the ephemeral copy will be create To make sure making ephemeral copies can be made efficiently, the root directory or root image should be located on the same filesystem as /var/lib/systemd/ephemeral\-trees/\&. When using \fIRootEphemeral=\fR -with root directories, btrfs should be used as the filesystem and the root directory should ideally be a subvolume which +with root directories, +\fBbtrfs\fR(5) +should be used as the filesystem and the root directory should ideally be a subvolume which \fBsystemd\fR can snapshot to make the ephemeral copy\&. For root images, a filesystem with support for reflinks should be used to ensure an efficient ephemeral copy\&. .sp This option is only available for system services and is not supported for services running in per\-user instances of the service manager\&. +.sp +Added in version 254\&. .RE .PP \fIRootHash=\fR @@ -333,6 +343,8 @@ file adjacent to the disk image\&. There\*(Aqs currently no option to configure file system via the unit file directly\&. .sp This option is only available for system services and is not supported for services running in per\-user instances of the service manager\&. +.sp +Added in version 246\&. .RE .PP \fIRootHashSignature=\fR @@ -355,6 +367,8 @@ file adjacent to the disk image\&. There\*(Aqs currently no option to configure via the unit file directly\&. .sp This option is only available for system services and is not supported for services running in per\-user instances of the service manager\&. +.sp +Added in version 246\&. .RE .PP \fIRootVerity=\fR @@ -371,6 +385,8 @@ This option is supported only for disk images that contain a single file system, \m[blue]\fBDiscoverable Partitions Specification\fR\m[]\&\s-2\u[1]\d\s+2\&. .sp This option is only available for system services and is not supported for services running in per\-user instances of the service manager\&. +.sp +Added in version 246\&. .RE .PP \fIRootImagePolicy=\fR, \fIMountImagePolicy=\fR, \fIExtensionImagePolicy=\fR @@ -414,6 +430,8 @@ root=verity+signed+encrypted+unprotected+absent: \e .if n \{\ .RE .\} +.sp +Added in version 254\&. .RE .PP \fIMountAPIVFS=\fR @@ -439,6 +457,8 @@ In order to allow propagating mounts at runtime in a safe manner, on the host will be used to set up new mounts, and /run/host/incoming/ in the private namespace will be used as an intermediate step to store them before being moved to the final mount point\&. +.sp +Added in version 233\&. .RE .PP \fIProtectProc=\fR @@ -482,6 +502,8 @@ If the kernel doesn\*(Aqt support per\-mount point mount options this setting remains without effect, and the unit\*(Aqs processes will be able to access and see other process as if the option was not used\&. .sp This option is only available for system services and is not supported for services running in per\-user instances of the service manager\&. +.sp +Added in version 247\&. .RE .PP \fIProcSubset=\fR @@ -509,6 +531,8 @@ this setting is gracefully disabled if the used kernel does not support the "subset=" mount option of "procfs"\&. +.sp +Added in version 247\&. .RE .PP \fIBindPaths=\fR, \fIBindReadOnlyPaths=\fR @@ -541,6 +565,8 @@ with or \fIProtectHome=tmpfs\fR should be used instead\&. +.sp +Added in version 233\&. .RE .PP \fIMountImages=\fR @@ -599,6 +625,8 @@ below, as it may change the setting of \fIDevicePolicy=\fR\&. .sp This option is only available for system services and is not supported for services running in per\-user instances of the service manager\&. +.sp +Added in version 247\&. .RE .PP \fIExtensionImages=\fR @@ -611,7 +639,9 @@ A read\-only OverlayFS will be set up on top of /usr/ and /opt/ -hierarchies\&. The order in which the images are listed will determine the order in which the overlay is laid down: images specified first to last will result in overlayfs layers bottom to top\&. +hierarchies for sysext images and +/etc/ +hierarchy for confext images\&. The order in which the images are listed will determine the order in which the overlay is laid down: images specified first to last will result in overlayfs layers bottom to top\&. .sp Mount options may be defined as a single comma\-separated list of options, in which case they will be implicitly applied to the root partition on the image, or a series of colon\-separated tuples of partition name and mount options\&. Valid partition names and mount options are the same as for \fIRootImageOptions=\fR @@ -625,8 +655,10 @@ Each mount definition may be prefixed with .sp These settings may be used more than once, each usage appends to the unit\*(Aqs list of image paths\&. If the empty string is assigned, the entire list of mount paths defined prior to this is reset\&. .sp -Each image must carry a +Each sysext image must carry a /usr/lib/extension\-release\&.d/extension\-release\&.IMAGE +file while each confext image must carry a +/etc/extension\-release\&.d/extension\-release\&.IMAGE file, with the appropriate metadata which matches \fIRootImage=\fR/\fIRootDirectory=\fR or the host\&. See: @@ -665,6 +697,8 @@ below, as it may change the setting of \fIDevicePolicy=\fR\&. .sp This option is only available for system services and is not supported for services running in per\-user instances of the service manager\&. +.sp +Added in version 248\&. .RE .PP \fIExtensionDirectories=\fR @@ -677,7 +711,9 @@ A read\-only OverlayFS will be set up on top of /usr/ and /opt/ -hierarchies\&. The order in which the directories are listed will determine the order in which the overlay is laid down: directories specified first to last will result in overlayfs layers bottom to top\&. +hierarchies for sysext images and +/etc/ +hierarchy for confext images\&. The order in which the directories are listed will determine the order in which the overlay is laid down: directories specified first to last will result in overlayfs layers bottom to top\&. .sp Each directory listed in \fIExtensionDirectories=\fR @@ -686,8 +722,10 @@ may be prefixed with .sp These settings may be used more than once, each usage appends to the unit\*(Aqs list of directories paths\&. If the empty string is assigned, the entire list of mount paths defined prior to this is reset\&. .sp -Each directory must contain a +Each sysext directory must contain a /usr/lib/extension\-release\&.d/extension\-release\&.IMAGE +file while each confext directory must carry a +/etc/extension\-release\&.d/extension\-release\&.IMAGE file, with the appropriate metadata which matches \fIRootImage=\fR/\fIRootDirectory=\fR or the host\&. See: @@ -700,6 +738,8 @@ This option is only available for system services, or for services running in pe is implicitly enabled (requires unprivileged user namespaces support to be enabled in the kernel via the "kernel\&.unprivileged_userns_clone=" sysctl)\&. +.sp +Added in version 251\&. .RE .SH "USER/GROUP IDENTITY" .PP @@ -785,6 +825,8 @@ in order to assign a set of writable directories for specific purposes to the se and be careful with \fBAF_UNIX\fR file descriptor passing for directory file descriptors, as this would permit processes to create files or directories owned by the dynamic user/group that are not subject to the lifecycle and access guarantees of the service\&. Note that this option is currently incompatible with D\-Bus policies, thus a service using this option may currently not allocate a D\-Bus service name (note that this does not affect calling into other D\-Bus services)\&. Defaults to off\&. +.sp +Added in version 232\&. .RE .PP \fISupplementaryGroups=\fR @@ -793,6 +835,23 @@ Sets the supplementary Unix groups the processes are executed as\&. This takes a "+"\&. .RE .PP +\fISetLoginEnvironment=\fR +.RS 4 +Takes a boolean parameter that controls whether to set +\fI$HOME\fR, +\fI$LOGNAME\fR, and +\fI$SHELL\fR +environment variables\&. If unset, this is controlled by whether +\fIUser=\fR +is set\&. If true, they will always be set for system services, i\&.e\&. even when the default user +"root" +is used\&. If false, the mentioned variables are not set by systemd, no matter whether +\fIUser=\fR +is used or not\&. This option normally has no effect on user services, since these variables are typically inherited from user manager\*(Aqs own environment anyway\&. +.sp +Added in version 255\&. +.RE +.PP \fIPAMName=\fR .RS 4 Sets the PAM service name to set up a session as\&. If set, the executed process will be registered as a PAM session under the specified service name\&. This is only useful in conjunction with the @@ -899,6 +958,8 @@ to retain the capabilities over the user change\&. \fIAmbientCapabilities=\fR does not affect commands prefixed with "+"\&. +.sp +Added in version 229\&. .RE .SH "SECURITY" .PP @@ -906,26 +967,7 @@ does not affect commands prefixed with .RS 4 Takes a boolean argument\&. If true, ensures that the service process and all its children can never gain new privileges through \fBexecve()\fR -(e\&.g\&. via setuid or setgid bits, or filesystem capabilities)\&. This is the simplest and most effective way to ensure that a process and its children can never elevate privileges again\&. Defaults to false, but certain settings override this and ignore the value of this setting\&. This is the case when -\fIDynamicUser=\fR, -\fILockPersonality=\fR, -\fIMemoryDenyWriteExecute=\fR, -\fIPrivateDevices=\fR, -\fIProtectClock=\fR, -\fIProtectHostname=\fR, -\fIProtectKernelLogs=\fR, -\fIProtectKernelModules=\fR, -\fIProtectKernelTunables=\fR, -\fIRestrictAddressFamilies=\fR, -\fIRestrictNamespaces=\fR, -\fIRestrictRealtime=\fR, -\fIRestrictSUIDSGID=\fR, -\fISystemCallArchitectures=\fR, -\fISystemCallFilter=\fR, or -\fISystemCallLog=\fR -are specified\&. Note that even if this setting is overridden by them, -\fBsystemctl show\fR -shows the original value of this setting\&. In case the service will be run in a new mount namespace anyway and SELinux is disabled, all file systems are mounted with +(e\&.g\&. via setuid or setgid bits, or filesystem capabilities)\&. This is the simplest and most effective way to ensure that a process and its children can never elevate privileges again\&. Defaults to false\&. In case the service will be run in a new mount namespace anyway and SELinux is disabled, all file systems are mounted with \fBMS_NOSUID\fR flag\&. Also see \m[blue]\fBNo New Privileges Flag\fR\m[]\&\s-2\u[4]\d\s+2\&. @@ -934,6 +976,8 @@ Note that this setting only has an effect on the unit\*(Aqs processes themselves \fBat\fR(1), \fBcrontab\fR(1), \fBsystemd-run\fR(1), or arbitrary IPC services\&. +.sp +Added in version 187\&. .RE .PP \fISecureBits=\fR @@ -962,6 +1006,8 @@ may fail if the policy doesn\*(Aqt allow the transition for the non\-overridden "+"\&. See \fBsetexeccon\fR(3) for details\&. +.sp +Added in version 209\&. .RE .PP \fIAppArmorProfile=\fR @@ -969,6 +1015,8 @@ for details\&. Takes a profile name as argument\&. The process executed by the unit will switch to this profile when started\&. Profiles must already be loaded in the kernel, or the unit will fail\&. If prefixed by "\-", all errors will be ignored\&. This setting has no effect if AppArmor is not enabled\&. This setting does not affect commands prefixed with "+"\&. +.sp +Added in version 210\&. .RE .PP \fISmackProcessLabel=\fR @@ -982,6 +1030,8 @@ label, in which case the process will transition to run under that label\&. When The value may be prefixed by "\-", in which case all errors will be ignored\&. An empty value may be specified to unset previous assignments\&. This does not affect commands prefixed with "+"\&. +.sp +Added in version 218\&. .RE .SH "PROCESS PROPERTIES" .PP @@ -1271,6 +1321,8 @@ CoredumpFilter=default private\-dax shared\-dax .if n \{\ .RE .\} + +Added in version 246\&. .RE .PP \fIKeyringMode=\fR @@ -1298,6 +1350,8 @@ to the newly created session keyring\&. Defaults to for services of the system service manager and to \fBinherit\fR for non\-service units and for services of the user service manager\&. +.sp +Added in version 235\&. .RE .PP \fIOOMScoreAdjust=\fR @@ -1350,15 +1404,17 @@ personalities but no others\&. The personality feature is useful when running 32 (32\-bit only) or \fBalpha\fR (64\-bit only)\&. +.sp +Added in version 209\&. .RE .PP \fIIgnoreSIGPIPE=\fR .RS 4 -Takes a boolean argument\&. If true, causes +Takes a boolean argument\&. If true, \fBSIGPIPE\fR -to be ignored in the executed process\&. Defaults to true because +is ignored in the executed process\&. Defaults to true since \fBSIGPIPE\fR -generally is useful only in shell pipelines\&. +is generally only useful in shell pipelines\&. .RE .SH "SCHEDULING" .PP @@ -1418,6 +1474,8 @@ and \fINUMAMask=\fR\&. For more details on each policy please see, \fBset_mempolicy\fR(2)\&. For overall overview of NUMA support in Linux see, \fBnuma\fR(7)\&. +.sp +Added in version 243\&. .RE .PP \fINUMAMask=\fR @@ -1431,6 +1489,8 @@ and policies and for \fBpreferred\fR policy we expect a single NUMA node\&. +.sp +Added in version 243\&. .RE .PP \fIIOSchedulingClass=\fR @@ -1472,6 +1532,12 @@ Also note that some sandboxing functionality is generally not available in user \fIProtectSystem=\fR) are not available, as the underlying kernel functionality is only accessible to privileged processes\&. However, most namespacing settings, that will not work on their own in user services, will work when used in conjunction with \fIPrivateUsers=\fR\fBtrue\fR\&. .PP +Note that the various options that turn directories read\-only (such as +\fIProtectSystem=\fR, +\fIReadOnlyPaths=\fR, \&...) do not affect the ability for programs to connect to and communicate with +\fBAF_UNIX\fR +sockets in these directores\&. These options cannot be used to lock down access to IPC services hence\&. +.PP \fIProtectSystem=\fR .RS 4 Takes a boolean argument or the special values @@ -1496,10 +1562,15 @@ and \fIProtectKernelTunables=\fR, \fIProtectControlGroups=\fR)\&. This setting ensures that any modification of the vendor\-supplied operating system (and optionally its configuration, and local mounts) is prohibited for the service\&. It is recommended to enable this setting for all long\-running services, unless they are involved with system updates or need to modify the operating system in other ways\&. If this option is used, \fIReadWritePaths=\fR -may be used to exclude specific directories from being made read\-only\&. This setting is implied if +may be used to exclude specific directories from being made read\-only\&. Similar, +\fIStateDirectory=\fR, +\fILogsDirectory=\fR, \&... and related directory settings (see below) also exclude the specific directories from the effect of +\fIProtectSystem=\fR\&. This setting is implied if \fIDynamicUser=\fR is set\&. This setting cannot ensure protection in all cases\&. In general it has the same limitations as \fIReadOnlyPaths=\fR, see below\&. Defaults to off\&. +.sp +Added in version 214\&. .RE .PP \fIProtectHome=\fR @@ -1543,6 +1614,8 @@ This option is only available for system services, or for services running in pe is implicitly enabled (requires unprivileged user namespaces support to be enabled in the kernel via the "kernel\&.unprivileged_userns_clone=" sysctl)\&. +.sp +Added in version 214\&. .RE .PP \fIRuntimeDirectory=\fR, \fIStateDirectory=\fR, \fICacheDirectory=\fR, \fILogsDirectory=\fR, \fIConfigurationDirectory=\fR @@ -1774,6 +1847,8 @@ plus /run/baz as symlinks to /run/foo\&. +.sp +Added in version 211\&. .RE .PP \fIRuntimeDirectoryMode=\fR, \fIStateDirectoryMode=\fR, \fICacheDirectoryMode=\fR, \fILogsDirectoryMode=\fR, \fIConfigurationDirectoryMode=\fR @@ -1787,6 +1862,8 @@ Specifies the access mode of the directories specified in \fB0755\fR\&. See "Permissions" in \fBpath_resolution\fR(7) for a discussion of the meaning of permission bits\&. +.sp +Added in version 234\&. .RE .PP \fIRuntimeDirectoryPreserve=\fR @@ -1807,6 +1884,8 @@ is a mount point of "tmpfs", then for system services the directories specified in \fIRuntimeDirectory=\fR are removed when the system is rebooted\&. +.sp +Added in version 235\&. .RE .PP \fITimeoutCleanSec=\fR @@ -1816,6 +1895,8 @@ Configures a timeout on the clean\-up operation requested through \fBsystemctl\fR(1) for details\&. Takes the usual time values and defaults to \fBinfinity\fR, i\&.e\&. by default no timeout is applied\&. If a timeout is configured the clean operation will be aborted forcibly when the timeout is reached, potentially leaving resources on disk\&. +.sp +Added in version 244\&. .RE .PP \fIReadWritePaths=\fR, \fIReadOnlyPaths=\fR, \fIInaccessiblePaths=\fR, \fIExecPaths=\fR, \fINoExecPaths=\fR @@ -1922,6 +2003,8 @@ These options are only available for system services, or for services running in is implicitly enabled (requires unprivileged user namespaces support to be enabled in the kernel via the "kernel\&.unprivileged_userns_clone=" sysctl)\&. +.sp +Added in version 231\&. .RE .PP \fITemporaryFileSystem=\fR @@ -1964,6 +2047,8 @@ This option is only available for system services, or for services running in pe is implicitly enabled (requires unprivileged user namespaces support to be enabled in the kernel via the "kernel\&.unprivileged_userns_clone=" sysctl)\&. +.sp +Added in version 238\&. .RE .PP \fIPrivateTmp=\fR @@ -2044,12 +2129,7 @@ of instead of using \fBMAP_ANON\fR\&. For this setting the same restrictions regarding mount propagation and privileges apply as for \fIReadOnlyPaths=\fR -and related calls, see above\&. If turned on and if running in user mode, or in system mode, but without the -\fBCAP_SYS_ADMIN\fR -capability (e\&.g\&. setting -\fIUser=\fR), -\fINoNewPrivileges=yes\fR -is implied\&. +and related calls, see above\&. .sp Note that the implementation of this setting might be impossible (for example if mount namespaces are not available), and the unit should be written in a way that does not solely rely on this setting for security\&. .sp @@ -2063,6 +2143,8 @@ When access to some but not all devices must be possible, the \fIDeviceAllow=\fR setting might be used instead\&. See \fBsystemd.resource-control\fR(5)\&. +.sp +Added in version 209\&. .RE .PP \fIPrivateNetwork=\fR @@ -2132,6 +2214,8 @@ This option is only available for system services, or for services running in pe is implicitly enabled (requires unprivileged user namespaces support to be enabled in the kernel via the "kernel\&.unprivileged_userns_clone=" sysctl)\&. +.sp +Added in version 242\&. .RE .PP \fIPrivateIPC=\fR @@ -2159,6 +2243,8 @@ This option is only available for system services, or for services running in pe is implicitly enabled (requires unprivileged user namespaces support to be enabled in the kernel via the "kernel\&.unprivileged_userns_clone=" sysctl)\&. +.sp +Added in version 248\&. .RE .PP \fIIPCNamespacePath=\fR @@ -2180,6 +2266,8 @@ This option is only available for system services, or for services running in pe is implicitly enabled (requires unprivileged user namespaces support to be enabled in the kernel via the "kernel\&.unprivileged_userns_clone=" sysctl)\&. +.sp +Added in version 248\&. .RE .PP \fIMemoryKSM=\fR @@ -2189,7 +2277,9 @@ Takes a boolean argument\&. When set, it enables KSM (kernel samepage merging) f in the kernel documentation\&. .sp Note that this functionality might not be available, for example if KSM is disabled in the kernel, or the kernel doesn\*(Aqt support controlling KSM at the process level through -\fBprctl()\fR\&. +\fBprctl\fR(2)\&. +.sp +Added in version 254\&. .RE .PP \fIPrivateUsers=\fR @@ -2221,6 +2311,8 @@ This setting is particularly useful in conjunction with and the unit\*(Aqs own user and group\&. .sp Note that the implementation of this setting might be impossible (for example if user namespaces are not available), and the unit should be written in a way that does not solely rely on this setting for security\&. +.sp +Added in version 232\&. .RE .PP \fIProtectHostname=\fR @@ -2231,19 +2323,13 @@ Note that the implementation of this setting might be impossible (for example if .sp Note that when this option is enabled for a service hostname changes no longer propagate from the system into the service, it is hence not suitable for services that need to take notice of system hostname changes dynamically\&. .sp -If this setting is on, but the unit doesn\*(Aqt have the -\fBCAP_SYS_ADMIN\fR -capability (e\&.g\&. services for which -\fIUser=\fR -is set), -\fINoNewPrivileges=yes\fR -is implied\&. -.sp This option is only available for system services, or for services running in per\-user instances of the service manager in which case \fIPrivateUsers=\fR is implicitly enabled (requires unprivileged user namespaces support to be enabled in the kernel via the "kernel\&.unprivileged_userns_clone=" sysctl)\&. +.sp +Added in version 242\&. .RE .PP \fIProtectClock=\fR @@ -2259,13 +2345,7 @@ is implied\&. Note that the system calls are blocked altogether, the filter does /dev/rtc1, etc\&. are made read\-only to the service\&. See \fBsystemd.resource-control\fR(5) for the details about -\fIDeviceAllow=\fR\&. If this setting is on, but the unit doesn\*(Aqt have the -\fBCAP_SYS_ADMIN\fR -capability (e\&.g\&. services for which -\fIUser=\fR -is set), -\fINoNewPrivileges=yes\fR -is implied\&. +\fIDeviceAllow=\fR\&. .sp It is recommended to turn this on for most services that do not need modify the clock or check its state\&. .sp @@ -2274,6 +2354,8 @@ This option is only available for system services, or for services running in pe is implicitly enabled (requires unprivileged user namespaces support to be enabled in the kernel via the "kernel\&.unprivileged_userns_clone=" sysctl)\&. +.sp +Added in version 245\&. .RE .PP \fIProtectKernelTunables=\fR @@ -2292,13 +2374,7 @@ will be made read\-only to all processes of the unit\&. Usually, tunable kernel \fBsysctl.d\fR(5) mechanism\&. Few services need to write to these at runtime; it is hence recommended to turn this on for most services\&. For this setting the same restrictions regarding mount propagation and privileges apply as for \fIReadOnlyPaths=\fR -and related calls, see above\&. Defaults to off\&. If this setting is on, but the unit doesn\*(Aqt have the -\fBCAP_SYS_ADMIN\fR -capability (e\&.g\&. services for which -\fIUser=\fR -is set), -\fINoNewPrivileges=yes\fR -is implied\&. Note that this option does not prevent indirect changes to kernel tunables effected by IPC calls to other processes\&. However, +and related calls, see above\&. Defaults to off\&. Note that this option does not prevent indirect changes to kernel tunables effected by IPC calls to other processes\&. However, \fIInaccessiblePaths=\fR may be used to make relevant IPC file system objects inaccessible\&. If \fIProtectKernelTunables=\fR @@ -2311,6 +2387,8 @@ This option is only available for system services, or for services running in pe is implicitly enabled (requires unprivileged user namespaces support to be enabled in the kernel via the "kernel\&.unprivileged_userns_clone=" sysctl)\&. +.sp +Added in version 232\&. .RE .PP \fIProtectKernelModules=\fR @@ -2326,19 +2404,15 @@ and related calls, see above\&. Note that limited automatic module loading due t \fBkernel\&.modules_disabled\fR mechanism and /proc/sys/kernel/modules_disabled -documentation\&. If this setting is on, but the unit doesn\*(Aqt have the -\fBCAP_SYS_ADMIN\fR -capability (e\&.g\&. services for which -\fIUser=\fR -is set), -\fINoNewPrivileges=yes\fR -is implied\&. +documentation\&. .sp This option is only available for system services, or for services running in per\-user instances of the service manager in which case \fIPrivateUsers=\fR is implicitly enabled (requires unprivileged user namespaces support to be enabled in the kernel via the "kernel\&.unprivileged_userns_clone=" sysctl)\&. +.sp +Added in version 232\&. .RE .PP \fIProtectKernelLogs=\fR @@ -2352,19 +2426,15 @@ system call (not to be confused with the libc API for userspace logging)\&. The kernel exposes its log buffer to userspace via /dev/kmsg and -/proc/kmsg\&. If enabled, these are made inaccessible to all the processes in the unit\&. If this setting is on, but the unit doesn\*(Aqt have the -\fBCAP_SYS_ADMIN\fR -capability (e\&.g\&. services for which -\fIUser=\fR -is set), -\fINoNewPrivileges=yes\fR -is implied\&. +/proc/kmsg\&. If enabled, these are made inaccessible to all the processes in the unit\&. .sp This option is only available for system services, or for services running in per\-user instances of the service manager in which case \fIPrivateUsers=\fR is implicitly enabled (requires unprivileged user namespaces support to be enabled in the kernel via the "kernel\&.unprivileged_userns_clone=" sysctl)\&. +.sp +Added in version 244\&. .RE .PP \fIProtectControlGroups=\fR @@ -2380,6 +2450,8 @@ is set, is implied\&. .sp This option is only available for system services and is not supported for services running in per\-user instances of the service manager\&. +.sp +Added in version 232\&. .RE .PP \fIRestrictAddressFamilies=\fR @@ -2400,12 +2472,7 @@ system call only\&. Sockets passed into the process by other means (for example, \fBsocketpair()\fR (which creates connected AF_UNIX sockets only) are unaffected\&. Note that this option has no effect on 32\-bit x86, s390, s390x, mips, mips\-le, ppc, ppc\-le, ppc64, ppc64\-le and is ignored (but works correctly on other ABIs, including x86\-64)\&. Note that on systems supporting multiple ABIs (such as x86/x86\-64) it is recommended to turn off alternative ABIs for services, so that they cannot be used to circumvent the restrictions of this option\&. Specifically, it is recommended to combine this option with \fISystemCallArchitectures=native\fR -or similar\&. If running in user mode, or in system mode, but without the -\fBCAP_SYS_ADMIN\fR -capability (e\&.g\&. setting -\fIUser=\fR), -\fINoNewPrivileges=yes\fR -is implied\&. By default, no restrictions apply, all address families are accessible to processes\&. If assigned the empty string, any previous address family restriction changes are undone\&. This setting does not affect commands prefixed with +or similar\&. By default, no restrictions apply, all address families are accessible to processes\&. If assigned the empty string, any previous address family restriction changes are undone\&. This setting does not affect commands prefixed with "+"\&. .sp Use this option to limit exposure of processes to remote access, in particular via exotic and sensitive network protocols, such as @@ -2414,6 +2481,8 @@ Use this option to limit exposure of processes to remote access, in particular v address family should be included in the configured allow list as it is frequently used for local communication, including for \fBsyslog\fR(2) logging\&. +.sp +Added in version 211\&. .RE .PP \fIRestrictFileSystems=\fR @@ -2554,6 +2623,8 @@ Note that this setting might not be supported on some systems (for example if th This option cannot be bypassed by prefixing "+" to the executable path in the service unit, as it applies to the whole control group\&. +.sp +Added in version 250\&. .RE .PP \fIRestrictNamespaces=\fR @@ -2579,12 +2650,7 @@ and \fBsetns\fR(2) system calls, taking the specified flags parameters into account\&. Note that \(em if this option is used \(em in addition to restricting creation and switching of the specified types of namespaces (or all of them, if true) access to the \fBsetns()\fR -system call with a zero flags parameter is prohibited\&. This setting is only supported on x86, x86\-64, mips, mips\-le, mips64, mips64\-le, mips64\-n32, mips64\-le\-n32, ppc64, ppc64\-le, s390 and s390x, and enforces no restrictions on other architectures\&. If running in user mode, or in system mode, but without the -\fBCAP_SYS_ADMIN\fR -capability (e\&.g\&. setting -\fIUser=\fR), -\fINoNewPrivileges=yes\fR -is implied\&. +system call with a zero flags parameter is prohibited\&. This setting is only supported on x86, x86\-64, mips, mips\-le, mips64, mips64\-le, mips64\-n32, mips64\-le\-n32, ppc64, ppc64\-le, s390 and s390x, and enforces no restrictions on other architectures\&. .sp Example: if a unit has the following, .sp @@ -2620,6 +2686,8 @@ RestrictNamespaces=~cgroup net then, only \fBipc\fR is set\&. +.sp +Added in version 233\&. .RE .PP \fILockPersonality=\fR @@ -2628,12 +2696,9 @@ Takes a boolean argument\&. If set, locks down the \fBpersonality\fR(2) system call so that the kernel execution domain may not be changed from the default or the personality selected with \fIPersonality=\fR -directive\&. This may be useful to improve security, because odd personality emulations may be poorly tested and source of vulnerabilities\&. If running in user mode, or in system mode, but without the -\fBCAP_SYS_ADMIN\fR -capability (e\&.g\&. setting -\fIUser=\fR), -\fINoNewPrivileges=yes\fR -is implied\&. +directive\&. This may be useful to improve security, because odd personality emulations may be poorly tested and source of vulnerabilities\&. +.sp +Added in version 235\&. .RE .PP \fIMemoryDenyWriteExecute=\fR @@ -2664,12 +2729,9 @@ set\&. Note that this option is incompatible with programs and libraries that ge \fBshmat()\fR protection is not available on x86\&. Note that on systems supporting multiple ABIs (such as x86/x86\-64) it is recommended to turn off alternative ABIs for services, so that they cannot be used to circumvent the restrictions of this option\&. Specifically, it is recommended to combine this option with \fISystemCallArchitectures=native\fR -or similar\&. If running in user mode, or in system mode, but without the -\fBCAP_SYS_ADMIN\fR -capability (e\&.g\&. setting -\fIUser=\fR), -\fINoNewPrivileges=yes\fR -is implied\&. +or similar\&. +.sp +Added in version 231\&. .RE .PP \fIRestrictRealtime=\fR @@ -2680,25 +2742,19 @@ Takes a boolean argument\&. If set, any attempts to enable realtime scheduling i or \fBSCHED_DEADLINE\fR\&. See \fBsched\fR(7) -for details about these scheduling policies\&. If running in user mode, or in system mode, but without the -\fBCAP_SYS_ADMIN\fR -capability (e\&.g\&. setting -\fIUser=\fR), -\fINoNewPrivileges=yes\fR -is implied\&. Realtime scheduling policies may be used to monopolize CPU time for longer periods of time, and may hence be used to lock up or otherwise trigger Denial\-of\-Service situations on the system\&. It is hence recommended to restrict access to realtime scheduling to the few programs that actually require them\&. Defaults to off\&. +for details about these scheduling policies\&. Realtime scheduling policies may be used to monopolize CPU time for longer periods of time, and may hence be used to lock up or otherwise trigger Denial\-of\-Service situations on the system\&. It is hence recommended to restrict access to realtime scheduling to the few programs that actually require them\&. Defaults to off\&. +.sp +Added in version 231\&. .RE .PP \fIRestrictSUIDSGID=\fR .RS 4 Takes a boolean argument\&. If set, any attempts to set the set\-user\-ID (SUID) or set\-group\-ID (SGID) bits on files or directories will be denied (for details on these bits see -\fBinode\fR(7))\&. If running in user mode, or in system mode, but without the -\fBCAP_SYS_ADMIN\fR -capability (e\&.g\&. setting -\fIUser=\fR), -\fINoNewPrivileges=yes\fR -is implied\&. As the SUID/SGID bits are mechanisms to elevate privileges, and allow users to acquire the identity of other users, it is recommended to restrict creation of SUID/SGID files to the few programs that actually require them\&. Note that this restricts marking of any type of file system object with these bits, including both regular files and directories (where the SGID is a different meaning than for files, see documentation)\&. This option is implied if +\fBinode\fR(7))\&. As the SUID/SGID bits are mechanisms to elevate privileges, and allow users to acquire the identity of other users, it is recommended to restrict creation of SUID/SGID files to the few programs that actually require them\&. Note that this restricts marking of any type of file system object with these bits, including both regular files and directories (where the SGID is a different meaning than for files, see documentation)\&. This option is implied if \fIDynamicUser=\fR is enabled\&. Defaults to off\&. +.sp +Added in version 242\&. .RE .PP \fIRemoveIPC=\fR @@ -2713,6 +2769,8 @@ are used\&. It has no effect on IPC objects owned by the root user\&. Specifical is set\&. .sp This option is only available for system services and is not supported for services running in per\-user instances of the service manager\&. +.sp +Added in version 232\&. .RE .PP \fIPrivateMounts=\fR @@ -2755,6 +2813,8 @@ This option is only available for system services, or for services running in pe is implicitly enabled (requires unprivileged user namespaces support to be enabled in the kernel via the "kernel\&.unprivileged_userns_clone=" sysctl)\&. +.sp +Added in version 239\&. .RE .PP \fIMountFlags=\fR @@ -2817,12 +2877,7 @@ or for a full list)\&. This value will be returned when a deny\-listed system call is triggered, instead of terminating the processes immediately\&. Special setting "kill" can be used to explicitly specify killing\&. This value takes precedence over the one given in -\fISystemCallErrorNumber=\fR, see below\&. If running in user mode, or in system mode, but without the -\fBCAP_SYS_ADMIN\fR -capability (e\&.g\&. setting -\fIUser=\fR), -\fINoNewPrivileges=yes\fR -is implied\&. This feature makes use of the Secure Computing Mode 2 interfaces of the kernel (\*(Aqseccomp filtering\*(Aq) and is useful for enforcing a minimal sandboxing environment\&. Note that the +\fISystemCallErrorNumber=\fR, see below\&. This feature makes use of the Secure Computing Mode 2 interfaces of the kernel (\*(Aqseccomp filtering\*(Aq) and is useful for enforcing a minimal sandboxing environment\&. Note that the \fBexecve()\fR, \fBexit()\fR, \fBexit_group()\fR, @@ -3086,6 +3141,8 @@ It is recommended to combine the file system namespacing related options with \fIInaccessiblePaths=\fR and \fIReadWritePaths=\fR\&. +.sp +Added in version 187\&. .RE .PP \fISystemCallErrorNumber=\fR @@ -3103,6 +3160,8 @@ is triggered, instead of terminating the process immediately\&. See for a full list of error codes\&. When this setting is not used, or when the empty string or the special setting "kill" is assigned, the process will be terminated immediately when the filter is triggered\&. +.sp +Added in version 209\&. .RE .PP \fISystemCallArchitectures=\fR @@ -3116,12 +3175,7 @@ described in \fBmips64\-le\-n32\fR, and the special identifier \fBnative\fR\&. The special identifier \fBnative\fR -implicitly maps to the native architecture of the system (or more precisely: to the architecture the system manager is compiled for)\&. If running in user mode, or in system mode, but without the -\fBCAP_SYS_ADMIN\fR -capability (e\&.g\&. setting -\fIUser=\fR), -\fINoNewPrivileges=yes\fR -is implied\&. By default, this option is set to the empty list, i\&.e\&. no filtering is applied\&. +implicitly maps to the native architecture of the system (or more precisely: to the architecture the system manager is compiled for)\&. By default, this option is set to the empty list, i\&.e\&. no filtering is applied\&. .sp If this setting is used, processes of this unit will only be permitted to call native system calls, and system calls of the specified architectures\&. For the purposes of this option, the x32 architecture is treated as including x86\-64 system calls\&. However, this setting still fulfills its purpose, as explained below, on x32\&. .sp @@ -3134,18 +3188,17 @@ System call architectures may also be restricted system\-wide via the option in the global configuration\&. See \fBsystemd-system.conf\fR(5) for details\&. +.sp +Added in version 209\&. .RE .PP \fISystemCallLog=\fR .RS 4 Takes a space\-separated list of system call names\&. If this setting is used, all system calls executed by the unit processes for the listed ones will be logged\&. If the first character of the list is -"~", the effect is inverted: all system calls except the listed system calls will be logged\&. If running in user mode, or in system mode, but without the -\fBCAP_SYS_ADMIN\fR -capability (e\&.g\&. setting -\fIUser=\fR), -\fINoNewPrivileges=yes\fR -is implied\&. This feature makes use of the Secure Computing Mode 2 interfaces of the kernel (\*(Aqseccomp filtering\*(Aq) and is useful for auditing or setting up a minimal sandboxing environment\&. This option may be specified more than once, in which case the filter masks are merged\&. If the empty string is assigned, the filter is reset, all prior assignments will have no effect\&. This does not affect commands prefixed with +"~", the effect is inverted: all system calls except the listed system calls will be logged\&. This feature makes use of the Secure Computing Mode 2 interfaces of the kernel (\*(Aqseccomp filtering\*(Aq) and is useful for auditing or setting up a minimal sandboxing environment\&. This option may be specified more than once, in which case the filter masks are merged\&. If the empty string is assigned, the filter is reset, all prior assignments will have no effect\&. This does not affect commands prefixed with "+"\&. +.sp +Added in version 247\&. .RE .SH "ENVIRONMENT" .PP @@ -3204,17 +3257,21 @@ separator, or lines starting with ";" or "#" -will be ignored, which may be used for commenting\&. The file must be UTF\-8 encoded\&. Valid characters are +will be ignored, which may be used for commenting\&. The file must be encoded with UTF\-8\&. Valid characters are \m[blue]\fBunicode scalar values\fR\m[]\&\s-2\u[8]\d\s+2 other than -\m[blue]\fBnoncharacters\fR\m[]\&\s-2\u[9]\d\s+2, U+0000 NUL, and U+FEFF -\m[blue]\fBbyte order mark\fR\m[]\&\s-2\u[10]\d\s+2\&. Control codes other than NUL are allowed\&. +\m[blue]\fBunicode noncharacters\fR\m[]\&\s-2\u[9]\d\s+2, +\fBU+0000\fR +\fBNUL\fR, and +\fBU+FEFF\fR +\m[blue]\fBunicode byte order mark\fR\m[]\&\s-2\u[10]\d\s+2\&. Control codes other than +\fBNUL\fR +are allowed\&. .sp In the file, an unquoted value after the "=" is parsed with the same backslash\-escape rules as -\m[blue]\fBunquoted text\fR\m[]\&\s-2\u[11]\d\s+2 -in a POSIX shell, but unlike in a shell, interior whitespace is preserved and quotes after the first non\-whitespace character are preserved\&. Leading and trailing whitespace (space, tab, carriage return) is discarded, but interior whitespace within the line is preserved verbatim\&. A line ending with a backslash will be continued to the following one, with the newline itself discarded\&. A backslash +\m[blue]\fBPOSIX shell unquoted text\fR\m[]\&\s-2\u[11]\d\s+2, but unlike in a shell, interior whitespace is preserved and quotes after the first non\-whitespace character are preserved\&. Leading and trailing whitespace (space, tab, carriage return) is discarded, but interior whitespace within the line is preserved verbatim\&. A line ending with a backslash will be continued to the following one, with the newline itself discarded\&. A backslash "\e" followed by any character other than newline will preserve the following character, so that "\e\e" @@ -3225,15 +3282,13 @@ In the file, a "\*(Aq"\-quoted value after the "=" can span multiple lines and contain any character verbatim other than single quote, like -\m[blue]\fBsingle\-quoted text\fR\m[]\&\s-2\u[12]\d\s+2 -in a POSIX shell\&. No backslash\-escape sequences are recognized\&. Leading and trailing whitespace outside of the single quotes is discarded\&. +\m[blue]\fBPOSIX shell single\-quoted text\fR\m[]\&\s-2\u[12]\d\s+2\&. No backslash\-escape sequences are recognized\&. Leading and trailing whitespace outside of the single quotes is discarded\&. .sp In the file, a """\-quoted value after the "=" can span multiple lines, and the same escape sequences are recognized as in -\m[blue]\fBdouble\-quoted text\fR\m[]\&\s-2\u[13]\d\s+2 -of a POSIX shell\&. Backslash ("\e") followed by any of +\m[blue]\fBPOSIX shell double\-quoted text\fR\m[]\&\s-2\u[13]\d\s+2\&. Backslash ("\e") followed by any of ""\e`$" will preserve that character\&. A backslash followed by newline is a line continuation, and the newline itself is discarded\&. A backslash followed by any other character is ignored; both the backslash and the following character are preserved verbatim\&. Leading and trailing whitespace outside of the double quotes is discarded\&. .sp @@ -3276,6 +3331,8 @@ with the values set for those variables in PID1\&. See \fBenviron\fR(7) for details about environment variables\&. +.sp +Added in version 228\&. .RE .PP \fIUnsetEnvironment=\fR @@ -3298,6 +3355,8 @@ is used)\&. See "Environment Variables in Spawned Processes" below for a description of how those settings combine to form the inherited environment\&. See \fBenviron\fR(7) for general information about environment variables\&. +.sp +Added in version 235\&. .RE .SH "LOGGING AND STANDARD INPUT/OUTPUT" .PP @@ -3585,6 +3644,8 @@ StandardInputData=V2XigLJyZSBubyBzdHJhbmdlcnMgdG8gbG92ZQpZb3Uga25vdyB0aGUgcnVsZX .if n \{\ .RE .\} +.sp +Added in version 236\&. .RE .PP \fILogLevelMax=\fR @@ -3613,6 +3674,8 @@ configured in might prohibit messages of higher log levels to be stored on disk, even though the per\-unit \fILogLevelMax=\fR permitted it to be processed\&. +.sp +Added in version 236\&. .RE .PP \fILogExtraFields=\fR @@ -3623,6 +3686,10 @@ separated by whitespace\&. See \fBsystemd.journal-fields\fR(7) for details on the journal field concept\&. Even though the underlying journal implementation permits binary field values, this setting accepts only valid UTF\-8 values\&. To include space characters in a journal field value, enclose the assignment in double quotes (")\&. The usual specifiers are expanded in all assignments (see below)\&. Note that this setting is not only useful for attaching additional metadata to log records of a unit, but given that all fields and values are indexed may also be used to implement cross\-unit log record matching\&. Assign an empty string to reset the list\&. +.sp +Note that this functionality is currently only available in system services, not in per\-user services\&. +.sp +Added in version 236\&. .RE .PP \fILogRateLimitIntervalSec=\fR, \fILogRateLimitBurst=\fR @@ -3640,12 +3707,13 @@ and \fIRateLimitBurst=\fR configured in \fBjournald.conf\fR(5)\&. Note that this only applies to log messages that are processed by the logging subsystem, i\&.e\&. by -\fBsystemd-journald.service\fR(8) -This means that if you connect a service\*(Aqs stderr directly to a file via +\fBsystemd-journald.service\fR(8)\&. This means that if you connect a service\*(Aqs stderr directly to a file via \fIStandardOutput=file:\&...\fR or a similar setting, the rate limiting will not be applied to messages written that way (but it will be enforced for messages generated via \fBsyslog\fR(3) and similar functions)\&. +.sp +Added in version 240\&. .RE .PP \fILogFilterPatterns=\fR @@ -3677,6 +3745,10 @@ Filtering is based on the unit for which is defined, meaning log messages coming from \fBsystemd\fR(1) about the unit are not taken into account\&. Filtered log messages won\*(Aqt be forwarded to traditional syslog daemons, the kernel log buffer (kmsg), the systemd console, or sent as wall messages to all logged\-in users\&. +.sp +Note that this functionality is currently only available in system services, not in per\-user services\&. +.sp +Added in version 253\&. .RE .PP \fILogNamespace=\fR @@ -3704,6 +3776,8 @@ output, unless the option is used\&. .sp This option is only available for system services and is not supported for services running in per\-user instances of the service manager\&. +.sp +Added in version 245\&. .RE .PP \fISyslogIdentifier=\fR @@ -3831,6 +3905,8 @@ before and after execution\&. Defaults to .RS 4 Configure the size of the TTY specified with \fITTYPath=\fR\&. If unset or set to the empty string, the kernel default is used\&. +.sp +Added in version 250\&. .RE .PP \fITTYVTDisallocate=\fR @@ -3984,6 +4060,8 @@ is requested for a unit For further information see \m[blue]\fBSystem and Service Credentials\fR\m[]\&\s-2\u[18]\d\s+2 documentation\&. +.sp +Added in version 247\&. .RE .PP \fIImportCredential=\fR\fIGLOB\fR @@ -4014,6 +4092,8 @@ and \fILoadCredentialEncrypted=\fR take priority over credentials found by \fIImportCredential=\fR\&. +.sp +Added in version 254\&. .RE .PP \fISetCredential=\fR\fIID\fR:\fIVALUE\fR, \fISetCredentialEncrypted=\fR\fIID\fR:\fIVALUE\fR @@ -4057,6 +4137,8 @@ will act as default if no credentials are found by any of the former\&. In this or \fILoadCredentialEncrypted=\fR is not considered fatal\&. +.sp +Added in version 247\&. .RE .SH "SYSTEM V COMPATIBILITY" .PP @@ -4105,6 +4187,8 @@ entry and finally a \fBUSER_PROCESS\fR entry is generated\&. In this case, the invoked process may be any process that is suitable to be run as session leader\&. Defaults to "init"\&. +.sp +Added in version 225\&. .RE .SH "ENVIRONMENT VARIABLES IN SPAWNED PROCESSES" .PP @@ -4217,13 +4301,10 @@ Colon\-separated list of directories to use when launching executables\&. \fBsystemd\fR uses a fixed value of "/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin" -in the system manager\&. When compiled for systems with "unmerged -/usr/" (/bin -is not a symlink to -/usr/bin), -":/sbin:/bin" -is appended\&. In case of the user manager, a different path may be configured by the distribution\&. It is recommended to not rely on the order of entries, and have only one program with a given name in +in the system manager\&. In case of the user manager, a different path may be configured by the distribution\&. It is recommended to not rely on the order of entries, and have only one program with a given name in \fI$PATH\fR\&. +.sp +Added in version 208\&. .RE .PP \fI$LANG\fR @@ -4234,21 +4315,33 @@ or on the kernel command line (see \fBsystemd\fR(1) and \fBkernel-command-line\fR(7))\&. +.sp +Added in version 208\&. .RE .PP \fI$USER\fR, \fI$LOGNAME\fR, \fI$HOME\fR, \fI$SHELL\fR .RS 4 -User name (twice), home directory, and the login shell\&. The variables are set for the units that have +User name (twice), home directory, and the login shell\&. +\fI$USER\fR +is set unconditionally, while +\fI$HOME\fR, +\fI$LOGNAME\fR, and +\fI$SHELL\fR +are only set for the units that have \fIUser=\fR -set, which includes user -\fBsystemd\fR -instances\&. See +set and +\fISetLoginEnvironment=\fR +unset or set to true\&. For user services, these variables are typically inherited from the user manager itself\&. See \fBpasswd\fR(5)\&. +.sp +Added in version 208\&. .RE .PP \fI$INVOCATION_ID\fR .RS 4 Contains a randomized, unique 128\-bit ID identifying each runtime cycle of the unit, formatted as 32 character hexadecimal string\&. A new ID is assigned each time the unit changes from an inactive state into an activating or active state, and may be used to identify this specific runtime cycle, in particular in data stored offline, such as the journal\&. The same ID is passed to all processes run as part of the unit\&. +.sp +Added in version 232\&. .RE .PP \fI$XDG_RUNTIME_DIR\fR @@ -4261,6 +4354,8 @@ with a PAM stack that includes \fBpam_systemd\fR\&. See below and \fBpam_systemd\fR(8) for more information\&. +.sp +Added in version 208\&. .RE .PP \fI$RUNTIME_DIRECTORY\fR, \fI$STATE_DIRECTORY\fR, \fI$CACHE_DIRECTORY\fR, \fI$LOGS_DIRECTORY\fR, \fI$CONFIGURATION_DIRECTORY\fR @@ -4272,6 +4367,8 @@ Absolute paths to the directories defined with \fILogsDirectory=\fR, and \fIConfigurationDirectory=\fR when those settings are used\&. +.sp +Added in version 244\&. .RE .PP \fI$CREDENTIALS_DIRECTORY\fR @@ -4282,6 +4379,8 @@ An absolute path to the per\-unit directory with credentials configured via or \fIDynamicUser=\fR (and the superuser)\&. +.sp +Added in version 247\&. .RE .PP \fI$MAINPID\fR @@ -4289,6 +4388,8 @@ or The PID of the unit\*(Aqs main process if it is known\&. This is only set for control processes as invoked by \fIExecReload=\fR and similar\&. +.sp +Added in version 209\&. .RE .PP \fI$MANAGERPID\fR @@ -4296,12 +4397,16 @@ and similar\&. The PID of the user \fBsystemd\fR instance, set for processes spawned by it\&. +.sp +Added in version 208\&. .RE .PP \fI$LISTEN_FDS\fR, \fI$LISTEN_PID\fR, \fI$LISTEN_FDNAMES\fR .RS 4 Information about file descriptors passed to a service for socket activation\&. See \fBsd_listen_fds\fR(3)\&. +.sp +Added in version 208\&. .RE .PP \fI$NOTIFY_SOCKET\fR @@ -4310,12 +4415,16 @@ The socket \fBsd_notify()\fR talks to\&. See \fBsd_notify\fR(3)\&. +.sp +Added in version 229\&. .RE .PP \fI$WATCHDOG_PID\fR, \fI$WATCHDOG_USEC\fR .RS 4 Information about watchdog keep\-alive notifications\&. See \fBsd_watchdog_enabled\fR(3)\&. +.sp +Added in version 229\&. .RE .PP \fI$SYSTEMD_EXEC_PID\fR @@ -4327,6 +4436,8 @@ with \fI$LISTEN_PID\fR and \fI$LISTEN_FDS\fR)\&. +.sp +Added in version 248\&. .RE .PP \fI$TERM\fR @@ -4335,6 +4446,8 @@ Terminal type, set only for units connected to a terminal (\fIStandardInput=tty\ \fIStandardOutput=tty\fR, or \fIStandardError=tty\fR)\&. See \fBtermcap\fR(5)\&. +.sp +Added in version 209\&. .RE .PP \fI$LOG_NAMESPACE\fR @@ -4342,6 +4455,8 @@ Terminal type, set only for units connected to a terminal (\fIStandardInput=tty\ Contains the name of the selected logging namespace when the \fILogNamespace=\fR service setting is used\&. +.sp +Added in version 246\&. .RE .PP \fI$JOURNAL_STREAM\fR @@ -4358,6 +4473,8 @@ If both standard output and standard error of the executed processes are connect This environment variable is primarily useful to allow services to optionally upgrade their used log protocol to the native journal protocol (using \fBsd_journal_print\fR(3) and other functions) if their standard output or standard error output is connected to the journal anyway, thus enabling delivery of structured metadata along with logged messages\&. +.sp +Added in version 231\&. .RE .PP \fI$SERVICE_RESULT\fR @@ -4390,6 +4507,8 @@ l l l l l l l l +l l +l l l l. T{ "success" @@ -4427,6 +4546,16 @@ T}:T{ Watchdog keep\-alive ping was enabled for the service, but the deadline was missed\&. T} T{ +"exec\-condition" +T}:T{ +Service did not run because \fIExecCondition=\fR failed\&. +T} +T{ +"oom\-kill" +T}:T{ +A service process was terminated by the Out\-Of\-Memory (OOM) killer\&. +T} +T{ "start\-limit\-hit" T}:T{ A start limit was defined for the unit and it was hit, causing the unit to fail to start\&. See \fBsystemd.unit\fR(5)\*(Aqs \fIStartLimitIntervalSec=\fR and \fIStartLimitBurst=\fR for details\&. @@ -4442,6 +4571,8 @@ This environment variable is useful to monitor failure or successful termination \fIExecStop=\fR and \fIExecStopPost=\fR, it is usually a better choice to place monitoring tools in the latter, as the former is only invoked for services that managed to start up correctly, and the latter covers both services that failed during their start\-up and those which failed during their runtime\&. +.sp +Added in version 232\&. .RE .PP \fI$EXIT_CODE\fR, \fI$EXIT_STATUS\fR @@ -4602,6 +4733,7 @@ Note: the process may be also terminated by a signal not sent by systemd\&. In p T} .TE .sp 1 +Added in version 232\&. .RE .PP \fI$MONITOR_SERVICE_RESULT\fR, \fI$MONITOR_EXIT_CODE\fR, \fI$MONITOR_EXIT_STATUS\fR, \fI$MONITOR_INVOCATION_ID\fR, \fI$MONITOR_UNIT\fR @@ -4638,6 +4770,8 @@ be passed\&. Consider using a template handler unit for that case instead: for non\-templated units, or "OnFailure=\fIhandler\fR@%p\-%i\&.service" for templated units\&. +.sp +Added in version 251\&. .RE .PP \fI$PIDFILE\fR @@ -4647,17 +4781,23 @@ The path to the configured PID file, in case the process is forked off on behalf setting, see \fBsystemd.service\fR(5) for details\&. Service code may use this environment variable to automatically generate a PID file at the location configured in the unit file\&. This field is set to an absolute path in the file system\&. +.sp +Added in version 242\&. .RE .PP \fI$REMOTE_ADDR\fR, \fI$REMOTE_PORT\fR .RS 4 If this is a unit started via per\-connection socket activation (i\&.e\&. via a socket unit with \fIAccept=yes\fR), these environment variables contain the IP address and port number of the remote peer of the socket connection\&. +.sp +Added in version 254\&. .RE .PP \fI$TRIGGER_UNIT\fR, \fI$TRIGGER_PATH\fR, \fI$TRIGGER_TIMER_REALTIME_USEC\fR, \fI$TRIGGER_TIMER_MONOTONIC_USEC\fR .RS 4 If the unit was activated dynamically (e\&.g\&.: a corresponding path unit or timer unit), the unit that triggered it and other type\-dependent information will be passed via these variables\&. Note that this information is provided in a best\-effort way\&. For example, multiple triggers happening one after another will be coalesced and only one will be reported, with no guarantee as to which one it will be\&. Because of this, in most cases this variable will be primarily informational, i\&.e\&. useful for debugging purposes, is lossy, and should not be relied upon to propagate a comprehensive reason for activation\&. +.sp +Added in version 252\&. .RE .PP \fI$MEMORY_PRESSURE_WATCH\fR, \fI$MEMORY_PRESSURE_WRITE\fR @@ -4665,19 +4805,20 @@ If the unit was activated dynamically (e\&.g\&.: a corresponding path unit or ti If memory pressure monitoring is enabled for this service unit, the path to watch and the data to write into it\&. See \m[blue]\fBMemory Pressure Handling\fR\m[]\&\s-2\u[19]\d\s+2 for details about these variables and the service protocol data they convey\&. +.sp +Added in version 254\&. .RE .PP \fI$FDSTORE\fR .RS 4 -If the file descriptor store is enabled for a service (i\&.e\&. +The maximum number of file descriptors that may be stored in the manager for the service\&. This variable is set when the file descriptor store is enabled for the service, i\&.e\&. \fIFileDescriptorStoreMax=\fR -is set to a non\-zero value, see +is set to a non\-zero value (see \fBsystemd.service\fR(5) -for details), this environment variable will be set to the maximum number of permitted entries, as per the setting\&. Applications may check this environment variable before sending file descriptors to the service manager via -\fBsd_pid_notify_with_fds()\fR -(see -\fBsd_notify\fR(3) -for details)\&. +for details)\&. Applications may check this environment variable before sending file descriptors to the service manager via +\fBsd_pid_notify_with_fds\fR(3)\&. +.sp +Added in version 254\&. .RE .PP For system services, when @@ -5478,27 +5619,27 @@ unicode scalar values \%https://www.unicode.org/glossary/#unicode_scalar_value .RE .IP " 9." 4 -noncharacters +unicode noncharacters .RS 4 \%https://www.unicode.org/glossary/#noncharacter .RE .IP "10." 4 -byte order mark +unicode byte order mark .RS 4 \%https://www.unicode.org/glossary/#byte_order_mark .RE .IP "11." 4 -unquoted text +POSIX shell unquoted text .RS 4 \%https://pubs.opengroup.org/onlinepubs/9699919799/utilities/V3_chap02.html#tag_18_02_01 .RE .IP "12." 4 -single-quoted text +POSIX shell single-quoted text .RS 4 \%https://pubs.opengroup.org/onlinepubs/9699919799/utilities/V3_chap02.html#tag_18_02_02 .RE .IP "13." 4 -double-quoted text +POSIX shell double-quoted text .RS 4 \%https://pubs.opengroup.org/onlinepubs/9699919799/utilities/V3_chap02.html#tag_18_02_03 .RE diff --git a/upstream/opensuse-tumbleweed/man5/systemd.kill.5 b/upstream/opensuse-tumbleweed/man5/systemd.kill.5 index b81eab03..f8379e5f 100644 --- a/upstream/opensuse-tumbleweed/man5/systemd.kill.5 +++ b/upstream/opensuse-tumbleweed/man5/systemd.kill.5 @@ -1,5 +1,5 @@ '\" t -.TH "SYSTEMD\&.KILL" "5" "" "systemd 254" "systemd.kill" +.TH "SYSTEMD\&.KILL" "5" "" "systemd 255" "systemd.kill" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -124,6 +124,8 @@ for more information\&. .sp Defaults to \fBcontrol\-group\fR\&. +.sp +Added in version 187\&. .RE .PP \fIKillSignal=\fR @@ -136,6 +138,8 @@ Specifies which signal to use when stopping a service\&. This controls the signa .sp Note that, right after sending the signal specified in this setting, systemd will always send \fBSIGCONT\fR, to ensure that even suspended tasks can be terminated cleanly\&. +.sp +Added in version 187\&. .RE .PP \fIRestartKillSignal=\fR @@ -145,6 +149,8 @@ Specifies which signal to use when restarting a service\&. The same as described above, with the exception that this setting is used in a restart job\&. Not set by default, and the value of \fIKillSignal=\fR is used\&. +.sp +Added in version 244\&. .RE .PP \fISendSIGHUP=\fR @@ -152,7 +158,10 @@ is used\&. Specifies whether to send \fBSIGHUP\fR to remaining processes immediately after sending the signal configured with -\fIKillSignal=\fR\&. This is useful to indicate to shells and shell\-like programs that their connection has been severed\&. Takes a boolean value\&. Defaults to "no"\&. +\fIKillSignal=\fR\&. This is useful to indicate to shells and shell\-like programs that their connection has been severed\&. Takes a boolean value\&. Defaults to +"no"\&. +.sp +Added in version 207\&. .RE .PP \fISendSIGKILL=\fR @@ -166,7 +175,10 @@ of \fBcontrol\-group\fR or \fBmixed\fR -service will not restart if processes from prior services exist within the control group\&. Takes a boolean value\&. Defaults to "yes"\&. +service will not restart if processes from prior services exist within the control group\&. Takes a boolean value\&. Defaults to +"yes"\&. +.sp +Added in version 187\&. .RE .PP \fIFinalKillSignal=\fR @@ -185,6 +197,8 @@ to either or \fBSIGABRT\fR\&. Defaults to \fBSIGKILL\fR\&. +.sp +Added in version 240\&. .RE .PP \fIWatchdogSignal=\fR @@ -192,6 +206,8 @@ or Specifies which signal to use to terminate the service when the watchdog timeout expires (enabled through \fIWatchdogSec=\fR)\&. Defaults to \fBSIGABRT\fR\&. +.sp +Added in version 240\&. .RE .SH "SEE ALSO" .PP diff --git a/upstream/opensuse-tumbleweed/man5/systemd.link.5 b/upstream/opensuse-tumbleweed/man5/systemd.link.5 index 0d460256..359f1911 100644 --- a/upstream/opensuse-tumbleweed/man5/systemd.link.5 +++ b/upstream/opensuse-tumbleweed/man5/systemd.link.5 @@ -1,5 +1,5 @@ '\" t -.TH "SYSTEMD\&.LINK" "5" "" "systemd 254" "systemd.link" +.TH "SYSTEMD\&.LINK" "5" "" "systemd 255" "systemd.link" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -41,7 +41,9 @@ files are read from the files located in the system network directory and /usr/local/lib/systemd/network, the volatile runtime network directory /run/systemd/network, and the local administration network directory -/etc/systemd/network\&. All configuration files are collectively sorted and processed in alphanumeric order, regardless of the directories in which they live\&. However, files with identical filenames replace each other\&. It is recommended that each filename is prefixed with a number (e\&.g\&. +/etc/systemd/network\&. All configuration files are collectively sorted and processed in alphanumeric order, regardless of the directories in which they live\&. However, files with identical filenames replace each other\&. It is recommended that each filename is prefixed with a number smaller than +"70" +(e\&.g\&. 10\-eth0\&.link)\&. Otherwise, the default \&.link files or those generated by @@ -115,6 +117,8 @@ Each field must be one byte\&. E\&.g\&. "12:34:56:78:90:ab" or "AA:BB:CC:DD:EE:FF"\&. +.sp +Added in version 250\&. .RE .PP \fBhyphen\-delimited hexadecimal\fR @@ -123,6 +127,8 @@ Each field must be one byte\&. E\&.g\&. "12\-34\-56\-78\-90\-ab" or "AA\-BB\-CC\-DD\-EE\-FF"\&. +.sp +Added in version 250\&. .RE .PP \fBdot\-delimited hexadecimal\fR @@ -131,6 +137,8 @@ Each field must be two bytes\&. E\&.g\&. "1234\&.5678\&.90ab" or "AABB\&.CCDD\&.EEFF"\&. +.sp +Added in version 250\&. .RE .PP \fBIPv4 address format\fR @@ -139,6 +147,8 @@ E\&.g\&. "127\&.0\&.0\&.1" or "192\&.168\&.0\&.1"\&. +.sp +Added in version 250\&. .RE .PP \fBIPv6 address format\fR @@ -147,9 +157,13 @@ E\&.g\&. "2001:0db8:85a3::8a2e:0370:7334" or "::1"\&. +.sp +Added in version 250\&. .RE .sp The total length of each MAC address must be 4 (for IPv4 tunnel), 6 (for Ethernet), 16 (for IPv6 tunnel), or 20 (for InfiniBand)\&. This option may appear more than once, in which case the lists are merged\&. If the empty string is assigned to this option, the list of hardware addresses defined prior to this is reset\&. Defaults to unset\&. +.sp +Added in version 211\&. .RE .PP \fIPermanentMACAddress=\fR @@ -157,12 +171,16 @@ The total length of each MAC address must be 4 (for IPv4 tunnel), 6 (for Etherne A whitespace\-separated list of hardware\*(Aqs permanent addresses\&. While \fIMACAddress=\fR matches the device\*(Aqs current MAC address, this matches the device\*(Aqs permanent MAC address, which may be different from the current one\&. Use full colon\-, hyphen\- or dot\-delimited hexadecimal, or IPv4 or IPv6 address format\&. This option may appear more than once, in which case the lists are merged\&. If the empty string is assigned to this option, the list of hardware addresses defined prior to this is reset\&. Defaults to unset\&. +.sp +Added in version 245\&. .RE .PP \fIPath=\fR .RS 4 A whitespace\-separated list of shell\-style globs matching the persistent path, as exposed by the udev property \fIID_PATH\fR\&. +.sp +Added in version 211\&. .RE .PP \fIDriver=\fR @@ -172,6 +190,8 @@ A whitespace\-separated list of shell\-style globs matching the driver currently of its parent device, or if that is not set, the driver as exposed by \fBethtool \-i\fR of the device itself\&. If the list is prefixed with a "!", the test is inverted\&. +.sp +Added in version 211\&. .RE .PP \fIType=\fR @@ -187,6 +207,8 @@ attribute, or "ARPHRD_" macros in linux/if_arp\&.h, so this is not comprehensive\&. +.sp +Added in version 211\&. .RE .PP \fIKind=\fR @@ -202,6 +224,8 @@ or "veth"\&. Valid kinds are given by netlink\*(Aqs "IFLA_INFO_KIND" attribute, so this is not comprehensive\&. +.sp +Added in version 251\&. .RE .PP \fIProperty=\fR @@ -222,11 +246,15 @@ Property=ID_MODEL_ID=9999 "ID_VENDOR_FROM_DATABASE=vendor name" "KEY=with \e"quo .\} .sp then, the \&.link file matches only when an interface has all the above three properties\&. +.sp +Added in version 243\&. .RE .PP \fIOriginalName=\fR .RS 4 A whitespace\-separated list of shell\-style globs matching the device name, as exposed by the udev property "INTERFACE"\&. This cannot be used to match on names that have already been changed from userspace\&. Caution is advised when matching on kernel\-assigned names, as they are known to be unstable between reboots\&. +.sp +Added in version 218\&. .RE .PP \fIHost=\fR @@ -236,6 +264,8 @@ Matches against the hostname or machine ID of the host\&. See in \fBsystemd.unit\fR(5) for details\&. When prefixed with an exclamation mark ("!"), the result is negated\&. If an empty string is assigned, the previously assigned value is cleared\&. +.sp +Added in version 211\&. .RE .PP \fIVirtualization=\fR @@ -245,6 +275,8 @@ Checks whether the system is executed in a virtualized environment and optionall in \fBsystemd.unit\fR(5) for details\&. When prefixed with an exclamation mark ("!"), the result is negated\&. If an empty string is assigned, the previously assigned value is cleared\&. +.sp +Added in version 211\&. .RE .PP \fIKernelCommandLine=\fR @@ -254,6 +286,8 @@ Checks whether a specific kernel command line option is set\&. See in \fBsystemd.unit\fR(5) for details\&. When prefixed with an exclamation mark ("!"), the result is negated\&. If an empty string is assigned, the previously assigned value is cleared\&. +.sp +Added in version 211\&. .RE .PP \fIKernelVersion=\fR @@ -264,6 +298,8 @@ Checks whether the kernel version (as reported by in \fBsystemd.unit\fR(5) for details\&. When prefixed with an exclamation mark ("!"), the result is negated\&. If an empty string is assigned, the previously assigned value is cleared\&. +.sp +Added in version 237\&. .RE .PP \fICredential=\fR @@ -273,6 +309,8 @@ systemd\-udevd\&.service service\&. See \m[blue]\fBSystem and Service Credentials\fR\m[]\&\s-2\u[1]\d\s+2 for details\&. When prefixed with an exclamation mark ("!"), the result is negated\&. If an empty string is assigned, the previously assigned value is cleared\&. +.sp +Added in version 252\&. .RE .PP \fIArchitecture=\fR @@ -282,6 +320,8 @@ Checks whether the system is running on a specific architecture\&. See in \fBsystemd.unit\fR(5) for details\&. When prefixed with an exclamation mark ("!"), the result is negated\&. If an empty string is assigned, the previously assigned value is cleared\&. +.sp +Added in version 211\&. .RE .PP \fIFirmware=\fR @@ -291,6 +331,8 @@ Checks whether the system is running on a machine with the specified firmware\&. in \fBsystemd.unit\fR(5) for details\&. When prefixed with an exclamation mark ("!"), the result is negated\&. If an empty string is assigned, the previously assigned value is cleared\&. +.sp +Added in version 249\&. .RE .SH "[LINK] SECTION OPTIONS" .PP @@ -299,6 +341,8 @@ The [Link] section accepts the following keys: \fIDescription=\fR .RS 4 A description of the device\&. +.sp +Added in version 211\&. .RE .PP \fIAlias=\fR @@ -306,6 +350,8 @@ A description of the device\&. The \fIifalias\fR interface property is set to this value\&. +.sp +Added in version 211\&. .RE .PP \fIMACAddressPolicy=\fR @@ -315,6 +361,8 @@ The policy by which the MAC address should be set\&. The available policies are: \fBpersistent\fR .RS 4 If the hardware has a persistent MAC address, as most hardware should, and if it is used by the kernel, nothing is done\&. Otherwise, a new MAC address is generated which is guaranteed to be the same on every boot for the given machine and the given device, but which is otherwise random\&. This feature depends on ID_NET_NAME_* properties to exist for the link\&. On hardware where these properties are not set, the generation of a persistent MAC address will fail\&. +.sp +Added in version 211\&. .RE .PP \fBrandom\fR @@ -324,16 +372,22 @@ If the kernel is using a random MAC address, nothing is done\&. Otherwise, a new and "locally administered" bits set\&. +.sp +Added in version 211\&. .RE .PP \fBnone\fR .RS 4 Keeps the MAC address assigned by the kernel\&. Or use the MAC address specified in \fIMACAddress=\fR\&. +.sp +Added in version 227\&. .RE .sp An empty string assignment is equivalent to setting "none"\&. +.sp +Added in version 211\&. .RE .PP \fIMACAddress=\fR @@ -342,6 +396,8 @@ The interface MAC address to use\&. For this setting to take effect, \fIMACAddressPolicy=\fR must either be unset, empty, or "none"\&. +.sp +Added in version 211\&. .RE .PP \fINamePolicy=\fR @@ -358,12 +414,16 @@ on the kernel command line\&. Each of the policies may fail, and the first succe \fBkernel\fR .RS 4 If the kernel claims that the name it has set for a device is predictable, then no renaming is performed\&. +.sp +Added in version 216\&. .RE .PP \fBdatabase\fR .RS 4 The name is set based on entries in the udev\*(Aqs Hardware Database with the key \fIID_NET_NAME_FROM_DATABASE\fR\&. +.sp +Added in version 211\&. .RE .PP \fBonboard\fR @@ -371,6 +431,8 @@ The name is set based on entries in the udev\*(Aqs Hardware Database with the ke The name is set based on information given by the firmware for on\-board devices, as exported by the udev property \fIID_NET_NAME_ONBOARD\fR\&. See \fBsystemd.net-naming-scheme\fR(7)\&. +.sp +Added in version 211\&. .RE .PP \fBslot\fR @@ -378,6 +440,8 @@ The name is set based on information given by the firmware for on\-board devices The name is set based on information given by the firmware for hot\-plug devices, as exported by the udev property \fIID_NET_NAME_SLOT\fR\&. See \fBsystemd.net-naming-scheme\fR(7)\&. +.sp +Added in version 211\&. .RE .PP \fBpath\fR @@ -385,6 +449,8 @@ The name is set based on information given by the firmware for hot\-plug devices The name is set based on the device\*(Aqs physical location, as exported by the udev property \fIID_NET_NAME_PATH\fR\&. See \fBsystemd.net-naming-scheme\fR(7)\&. +.sp +Added in version 211\&. .RE .PP \fBmac\fR @@ -392,12 +458,18 @@ The name is set based on the device\*(Aqs physical location, as exported by the The name is set based on the device\*(Aqs persistent MAC address, as exported by the udev property \fIID_NET_NAME_MAC\fR\&. See \fBsystemd.net-naming-scheme\fR(7)\&. +.sp +Added in version 211\&. .RE .PP \fBkeep\fR .RS 4 If the device already had a name given by userspace (as part of creation of the device or a rename), keep it\&. +.sp +Added in version 241\&. .RE +.sp +Added in version 211\&. .RE .PP \fIName=\fR @@ -427,6 +499,8 @@ is an allowed character, it\*(Aqs recommended to avoid it when naming interfaces "all" and "default"\&. +.sp +Added in version 211\&. .RE .PP \fIAlternativeNamesPolicy=\fR @@ -437,6 +511,8 @@ A space\-separated list of policies by which the interface\*(Aqs alternative nam "slot", "path", and "mac"\&. If the kernel does not support the alternative names, then this setting will be ignored\&. +.sp +Added in version 245\&. .RE .PP \fIAlternativeName=\fR @@ -446,31 +522,43 @@ The alternative interface name to use\&. This option can be specified multiple t Alternative interface names may be used to identify interfaces in various tools\&. In contrast to the primary name (as configured with \fIName=\fR above) there may be multiple alternative names referring to the same interface\&. Alternative names may have a maximum length of 127 characters, in contrast to the 15 allowed for the primary interface name, but otherwise are subject to the same naming constraints\&. +.sp +Added in version 245\&. .RE .PP \fITransmitQueues=\fR .RS 4 Specifies the device\*(Aqs number of transmit queues\&. An integer in the range 1\&...4096\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 248\&. .RE .PP \fIReceiveQueues=\fR .RS 4 Specifies the device\*(Aqs number of receive queues\&. An integer in the range 1\&...4096\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 248\&. .RE .PP \fITransmitQueueLength=\fR .RS 4 Specifies the transmit queue length of the device in number of packets\&. An unsigned integer in the range 0\&...4294967294\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 248\&. .RE .PP \fIMTUBytes=\fR .RS 4 The maximum transmission unit in bytes to set for the device\&. The usual suffixes K, M, G are supported and are understood to the base of 1024\&. +.sp +Added in version 211\&. .RE .PP \fIBitsPerSecond=\fR .RS 4 The speed to set for the device, the value is rounded down to the nearest Mbps\&. The usual suffixes K, M, G are supported and are understood to the base of 1000\&. +.sp +Added in version 211\&. .RE .PP \fIDuplex=\fR @@ -479,6 +567,8 @@ The duplex mode to set for the device\&. The accepted values are \fBhalf\fR and \fBfull\fR\&. +.sp +Added in version 211\&. .RE .PP \fIAutoNegotiation=\fR @@ -486,6 +576,8 @@ and Takes a boolean\&. If set to yes, automatic negotiation of transmission parameters is enabled\&. Autonegotiation is a procedure by which two connected ethernet devices choose common transmission parameters, such as speed, duplex mode, and flow control\&. When unset, the kernel\*(Aqs default will be used\&. .sp Note that if autonegotiation is enabled, speed and duplex settings are read\-only\&. If autonegotiation is disabled, speed and duplex settings are writable if the driver supports multiple link modes\&. +.sp +Added in version 233\&. .RE .PP \fIWakeOnLan=\fR @@ -497,31 +589,43 @@ which disables Wake\-on\-LAN, or space separated list of the following words: \fBphy\fR .RS 4 Wake on PHY activity\&. +.sp +Added in version 211\&. .RE .PP \fBunicast\fR .RS 4 Wake on unicast messages\&. +.sp +Added in version 235\&. .RE .PP \fBmulticast\fR .RS 4 Wake on multicast messages\&. +.sp +Added in version 235\&. .RE .PP \fBbroadcast\fR .RS 4 Wake on broadcast messages\&. +.sp +Added in version 235\&. .RE .PP \fBarp\fR .RS 4 Wake on ARP\&. +.sp +Added in version 235\&. .RE .PP \fBmagic\fR .RS 4 Wake on receipt of a magic packet\&. +.sp +Added in version 211\&. .RE .PP \fBsecureon\fR @@ -540,9 +644,13 @@ in \fBsystemd.exec\fR(5) for details\&. The password in the credential, must be 6 bytes in hex format with each byte separated by a colon (":") like an Ethernet MAC address, e\&.g\&., "aa:bb:cc:dd:ee:ff"\&. +.sp +Added in version 235\&. .RE .sp Defaults to unset, and the device\*(Aqs default will be used\&. This setting can be specified multiple times\&. If an empty string is assigned, then the all previous assignments are cleared\&. +.sp +Added in version 211\&. .RE .PP \fIWakeOnLanPassword=\fR @@ -554,6 +662,8 @@ stream socket, or the plain password\&. When a path to a regular file is specifi stream socket is specified, a connection is made to it and the password is read from it\&. The password must be 6 bytes in hex format with each byte separated by a colon (":") like an Ethernet MAC address, e\&.g\&., "aa:bb:cc:dd:ee:ff"\&. This implies \fIWakeOnLan=secureon\fR\&. Defaults to unset, and the current value will not be changed\&. +.sp +Added in version 250\&. .RE .PP \fIPort=\fR @@ -563,27 +673,39 @@ The port option is used to select the device port\&. The supported values are: \fBtp\fR .RS 4 An Ethernet interface using Twisted\-Pair cable as the medium\&. +.sp +Added in version 234\&. .RE .PP \fBaui\fR .RS 4 Attachment Unit Interface (AUI)\&. Normally used with hubs\&. +.sp +Added in version 234\&. .RE .PP \fBbnc\fR .RS 4 An Ethernet interface using BNC connectors and co\-axial cable\&. +.sp +Added in version 234\&. .RE .PP \fBmii\fR .RS 4 An Ethernet interface using a Media Independent Interface (MII)\&. +.sp +Added in version 234\&. .RE .PP \fBfibre\fR .RS 4 An Ethernet interface using Optical Fibre as the medium\&. +.sp +Added in version 234\&. .RE +.sp +Added in version 234\&. .RE .PP \fIAdvertise=\fR @@ -1402,71 +1524,99 @@ T} .TE .sp 1 By default this is unset, i\&.e\&. all possible modes will be advertised\&. This option may be specified more than once, in which case all specified speeds and modes are advertised\&. If the empty string is assigned to this option, the list is reset, and all prior assignments have no effect\&. +.sp +Added in version 240\&. .RE .PP \fIReceiveChecksumOffload=\fR .RS 4 Takes a boolean\&. If set to true, hardware offload for checksumming of ingress network packets is enabled\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 245\&. .RE .PP \fITransmitChecksumOffload=\fR .RS 4 Takes a boolean\&. If set to true, hardware offload for checksumming of egress network packets is enabled\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 245\&. .RE .PP \fITCPSegmentationOffload=\fR .RS 4 Takes a boolean\&. If set to true, TCP Segmentation Offload (TSO) is enabled\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 232\&. .RE .PP \fITCP6SegmentationOffload=\fR .RS 4 Takes a boolean\&. If set to true, TCP6 Segmentation Offload (tx\-tcp6\-segmentation) is enabled\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 235\&. .RE .PP \fIGenericSegmentationOffload=\fR .RS 4 Takes a boolean\&. If set to true, Generic Segmentation Offload (GSO) is enabled\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 232\&. .RE .PP \fIGenericReceiveOffload=\fR .RS 4 Takes a boolean\&. If set to true, Generic Receive Offload (GRO) is enabled\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 232\&. .RE .PP \fIGenericReceiveOffloadHardware=\fR .RS 4 Takes a boolean\&. If set to true, hardware accelerated Generic Receive Offload (GRO) is enabled\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 250\&. .RE .PP \fILargeReceiveOffload=\fR .RS 4 Takes a boolean\&. If set to true, Large Receive Offload (LRO) is enabled\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 232\&. .RE .PP \fIReceiveVLANCTAGHardwareAcceleration=\fR .RS 4 Takes a boolean\&. If set to true, receive VLAN CTAG hardware acceleration is enabled\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 250\&. .RE .PP \fITransmitVLANCTAGHardwareAcceleration=\fR .RS 4 Takes a boolean\&. If set to true, transmit VLAN CTAG hardware acceleration is enabled\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 250\&. .RE .PP \fIReceiveVLANCTAGFilter=\fR .RS 4 Takes a boolean\&. If set to true, receive filtering on VLAN CTAGs is enabled\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 250\&. .RE .PP \fITransmitVLANSTAGHardwareAcceleration=\fR .RS 4 Takes a boolean\&. If set to true, transmit VLAN STAG hardware acceleration is enabled\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 250\&. .RE .PP \fINTupleFilter=\fR .RS 4 Takes a boolean\&. If set to true, receive N\-tuple filters and actions are enabled\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 250\&. .RE .PP \fIRxChannels=\fR, \fITxChannels=\fR, \fIOtherChannels=\fR, \fICombinedChannels=\fR @@ -1474,6 +1624,8 @@ Takes a boolean\&. If set to true, receive N\-tuple filters and actions are enab Specifies the number of receive, transmit, other, or combined channels, respectively\&. Takes an unsigned integer in the range 1\&...4294967295 or "max"\&. If set to "max", the advertised maximum value of the hardware will be used\&. When unset, the number will not be changed\&. Defaults to unset\&. +.sp +Added in version 239\&. .RE .PP \fIRxBufferSize=\fR, \fIRxMiniBufferSize=\fR, \fIRxJumboBufferSize=\fR, \fITxBufferSize=\fR @@ -1481,36 +1633,50 @@ Specifies the number of receive, transmit, other, or combined channels, respecti Specifies the maximum number of pending packets in the NIC receive buffer, mini receive buffer, jumbo receive buffer, or transmit buffer, respectively\&. Takes an unsigned integer in the range 1\&...4294967295 or "max"\&. If set to "max", the advertised maximum value of the hardware will be used\&. When unset, the number will not be changed\&. Defaults to unset\&. +.sp +Added in version 244\&. .RE .PP \fIRxFlowControl=\fR .RS 4 Takes a boolean\&. When set, enables receive flow control, also known as the ethernet receive PAUSE message (generate and send ethernet PAUSE frames)\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 246\&. .RE .PP \fITxFlowControl=\fR .RS 4 Takes a boolean\&. When set, enables transmit flow control, also known as the ethernet transmit PAUSE message (respond to received ethernet PAUSE frames)\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 246\&. .RE .PP \fIAutoNegotiationFlowControl=\fR .RS 4 Takes a boolean\&. When set, auto negotiation enables the interface to exchange state advertisements with the connected peer so that the two devices can agree on the ethernet PAUSE configuration\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 246\&. .RE .PP \fIGenericSegmentOffloadMaxBytes=\fR .RS 4 Specifies the maximum size of a Generic Segment Offload (GSO) packet the device should accept\&. The usual suffixes K, M, G are supported and are understood to the base of 1024\&. An unsigned integer in the range 1\&...65536\&. Defaults to unset\&. +.sp +Added in version 248\&. .RE .PP \fIGenericSegmentOffloadMaxSegments=\fR .RS 4 Specifies the maximum number of Generic Segment Offload (GSO) segments the device should accept\&. An unsigned integer in the range 1\&...65535\&. Defaults to unset\&. +.sp +Added in version 248\&. .RE .PP \fIUseAdaptiveRxCoalesce=\fR, \fIUseAdaptiveTxCoalesce=\fR .RS 4 Boolean properties that, when set, enable/disable adaptive Rx/Tx coalescing if the hardware supports it\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 250\&. .RE .PP \fIRxCoalesceSec=\fR, \fIRxCoalesceIrqSec=\fR, \fIRxCoalesceLowSec=\fR, \fIRxCoalesceHighSec=\fR, \fITxCoalesceSec=\fR, \fITxCoalesceIrqSec=\fR, \fITxCoalesceLowSec=\fR, \fITxCoalesceHighSec=\fR @@ -1522,6 +1688,8 @@ properties come into effect when the host is servicing an IRQ\&. The and "High" properties come into effect when the packet rate drops below the low packet rate threshold or exceeds the high packet rate threshold respectively if adaptive Rx/Tx coalescing is enabled\&. When unset, the kernel\*(Aqs defaults will be used\&. +.sp +Added in version 250\&. .RE .PP \fIRxMaxCoalescedFrames=\fR, \fIRxMaxCoalescedIrqFrames=\fR, \fIRxMaxCoalescedLowFrames=\fR, \fIRxMaxCoalescedHighFrames=\fR, \fITxMaxCoalescedFrames=\fR, \fITxMaxCoalescedIrqFrames=\fR, \fITxMaxCoalescedLowFrames=\fR, \fITxMaxCoalescedHighFrames=\fR @@ -1533,21 +1701,29 @@ properties come into effect when the host is servicing an IRQ\&. The and "High" properties come into effect when the packet rate drops below the low packet rate threshold or exceeds the high packet rate threshold respectively if adaptive Rx/Tx coalescing is enabled\&. When unset, the kernel\*(Aqs defaults will be used\&. +.sp +Added in version 250\&. .RE .PP \fICoalescePacketRateLow=\fR, \fICoalescePacketRateHigh=\fR .RS 4 These properties configure the low and high packet rate (expressed in packets per second) threshold respectively and are used to determine when the corresponding coalescing settings for low and high packet rates come into effect if adaptive Rx/Tx coalescing is enabled\&. If unset, the kernel\*(Aqs defaults will be used\&. +.sp +Added in version 250\&. .RE .PP \fICoalescePacketRateSampleIntervalSec=\fR .RS 4 Configures how often to sample the packet rate used for adaptive Rx/Tx coalescing\&. This property cannot be zero\&. This lowest time granularity supported by this property is seconds\&. Partial seconds will be rounded up before being passed to the kernel\&. If unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 250\&. .RE .PP \fIStatisticsBlockCoalesceSec=\fR .RS 4 How long to delay driver in\-memory statistics block updates\&. If the driver does not have an in\-memory statistic block, this property is ignored\&. This property cannot be zero\&. If unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 250\&. .RE .PP \fIMDI=\fR @@ -1564,6 +1740,8 @@ Specifies the medium dependent interface (MDI) mode for the interface\&. A MDI d "straight", the MDI straight through mode will be used\&. When "crossover", the MDI crossover (MDI\-X) mode will be used\&. When "auto", the MDI status is automatically detected\&. Defaults to unset, and the kernel\*(Aqs default will be used\&. +.sp +Added in version 251\&. .RE .PP \fISR\-IOVVirtualFunctions=\fR @@ -1571,6 +1749,8 @@ Specifies the medium dependent interface (MDI) mode for the interface\&. A MDI d Specifies the number of SR\-IOV virtual functions\&. Takes an integer in the range 0\&...2147483647\&. Defaults to unset, and automatically determined from the values specified in the \fIVirtualFunction=\fR settings in the [SR\-IOV] sections\&. +.sp +Added in version 251\&. .RE .SH "[SR\-IOV] SECTION OPTIONS" .PP @@ -1579,16 +1759,22 @@ The [SR\-IOV] section accepts the following keys\&. Specify several [SR\-IOV] se \fIVirtualFunction=\fR .RS 4 Specifies a Virtual Function (VF), lightweight PCIe function designed solely to move data in and out\&. Takes an integer in the range 0\&...2147483646\&. This option is compulsory\&. +.sp +Added in version 251\&. .RE .PP \fIVLANId=\fR .RS 4 Specifies VLAN ID of the virtual function\&. Takes an integer in the range 1\&...4095\&. +.sp +Added in version 251\&. .RE .PP \fIQualityOfService=\fR .RS 4 Specifies quality of service of the virtual function\&. Takes an integer in the range 1\&...4294967294\&. +.sp +Added in version 251\&. .RE .PP \fIVLANProtocol=\fR @@ -1597,21 +1783,29 @@ Specifies VLAN protocol of the virtual function\&. Takes "802\&.1Q" or "802\&.1ad"\&. +.sp +Added in version 251\&. .RE .PP \fIMACSpoofCheck=\fR .RS 4 Takes a boolean\&. Controls the MAC spoof checking\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 251\&. .RE .PP \fIQueryReceiveSideScaling=\fR .RS 4 Takes a boolean\&. Toggle the ability of querying the receive side scaling (RSS) configuration of the virtual function (VF)\&. The VF RSS information like RSS hash key may be considered sensitive on some devices where this information is shared between VF and the physical function (PF)\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 251\&. .RE .PP \fITrust=\fR .RS 4 Takes a boolean\&. Allows one to set trust mode of the virtual function (VF)\&. When set, VF users can set a specific feature which may impact security and/or performance\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 251\&. .RE .PP \fILinkState=\fR @@ -1624,11 +1818,15 @@ means a reflection of the physical function (PF) link state, lets the VF to communicate with other VFs on this host even if the PF link state is down, "no" causes the hardware to drop any packets sent by the VF\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 251\&. .RE .PP \fIMACAddress=\fR .RS 4 Specifies the MAC address for the virtual function\&. +.sp +Added in version 251\&. .RE .SH "EXAMPLES" .PP @@ -1699,7 +1897,7 @@ $ sudo udevadm trigger \-\-verbose \-\-settle \-\-action add /sys/class/net/eth0 .\} .PP You may also need to stop the service that manages the network interface, e\&.g\&. -systemd\-networkd\&.service +\fBsystemd-networkd.service\fR(8) or NetworkManager\&.service before the above operation, and then restart the service after that\&. For more details about diff --git a/upstream/opensuse-tumbleweed/man5/systemd.mount.5 b/upstream/opensuse-tumbleweed/man5/systemd.mount.5 index 5fe050d5..62d7fb91 100644 --- a/upstream/opensuse-tumbleweed/man5/systemd.mount.5 +++ b/upstream/opensuse-tumbleweed/man5/systemd.mount.5 @@ -1,5 +1,5 @@ '\" t -.TH "SYSTEMD\&.MOUNT" "5" "" "systemd 254" "systemd.mount" +.TH "SYSTEMD\&.MOUNT" "5" "" "systemd 255" "systemd.mount" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -277,6 +277,8 @@ for details\&. Note that this option always applies to the created mount unit only regardless whether \fBx\-systemd\&.automount\fR has been specified\&. +.sp +Added in version 220\&. .RE .PP \fBx\-systemd\&.before=\fR, \fBx\-systemd\&.after=\fR @@ -300,6 +302,8 @@ for details\&. Note that these options always apply to the created mount unit only regardless whether \fBx\-systemd\&.automount\fR has been specified\&. +.sp +Added in version 233\&. .RE .PP \fBx\-systemd\&.wanted\-by=\fR, \fBx\-systemd\&.required\-by=\fR @@ -316,6 +320,8 @@ and in \fBsystemd.unit\fR(5) for details\&. +.sp +Added in version 245\&. .RE .PP \fBx\-systemd\&.requires\-mounts\-for=\fR @@ -327,18 +333,27 @@ dependency between the created mount unit and other mount units\&. The argument in \fBsystemd.unit\fR(5) for details\&. +.sp +Added in version 220\&. .RE .PP -\fBx\-systemd\&.device\-bound\fR +\fBx\-systemd\&.device\-bound=\fR .RS 4 -The block device backed file system will be upgraded to +Takes a boolean argument\&. If true or no argument, a \fIBindsTo=\fR -dependency\&. This option is only useful when mounting file systems manually with -\fBmount\fR(8) -as the default dependency in this case is -\fIRequires=\fR\&. This option is already implied by entries in +dependency on the backing device is set\&. If false, the mount unit is not stopped no matter whether the backing device is still present\&. This is useful when the file system is backed by volume managers\&. If not set, and the mount comes from unit fragments, i\&.e\&. generated from /etc/fstab -or by mount units\&. +by +\fBsystemd-fstab-generator\fR(8) +or loaded from a manually configured mount unit, a combination of +\fIRequires=\fR +and +\fIStopPropagatedFrom=\fR +dependencies is set on the backing device\&. If doesn\*(Aqt, only +\fIRequires=\fR +is used\&. +.sp +Added in version 233\&. .RE .PP \fBx\-systemd\&.automount\fR @@ -346,6 +361,8 @@ or by mount units\&. An automount unit will be created for the file system\&. See \fBsystemd.automount\fR(5) for details\&. +.sp +Added in version 215\&. .RE .PP \fBx\-systemd\&.idle\-timeout=\fR @@ -355,6 +372,8 @@ Configures the idle timeout of the automount unit\&. See in \fBsystemd.automount\fR(5) for details\&. +.sp +Added in version 220\&. .RE .PP \fBx\-systemd\&.device\-timeout=\fR @@ -370,6 +389,8 @@ Note that this option can only be used in /etc/fstab, and will be ignored when part of the \fIOptions=\fR setting in a unit file\&. +.sp +Added in version 215\&. .RE .PP \fBx\-systemd\&.mount\-timeout=\fR @@ -389,6 +410,8 @@ setting in a unit file\&. See \fITimeoutSec=\fR below for details\&. +.sp +Added in version 233\&. .RE .PP \fBx\-systemd\&.makefs\fR @@ -407,6 +430,8 @@ See may be used to remove any signatures from a block device to force \fBx\-systemd\&.makefs\fR to reinitialize the device\&. +.sp +Added in version 236\&. .RE .PP \fBx\-systemd\&.growfs\fR @@ -419,6 +444,8 @@ Note that this option can only be used in /etc/fstab, and will be ignored when part of the \fIOptions=\fR setting in a unit file\&. +.sp +Added in version 236\&. .RE .PP \fBx\-systemd\&.pcrfs\fR @@ -436,6 +463,8 @@ setting in a unit file\&. It is also implied for the root and /usr/ partitions discovered by \fBsystemd-gpt-auto-generator\fR(8)\&. +.sp +Added in version 253\&. .RE .PP \fBx\-systemd\&.rw\-only\fR @@ -443,6 +472,8 @@ partitions discovered by If a mount operation fails to mount the file system read\-write, it normally tries mounting the file system read\-only instead\&. This option disables that behaviour, and causes the mount to fail immediately instead\&. This option is translated into the \fIReadWriteOnly=\fR setting in a unit file\&. +.sp +Added in version 246\&. .RE .PP \fB_netdev\fR @@ -459,6 +490,8 @@ local\-fs\&.target\&. They also pull in network\-online\&.target and are ordered after it and network\&.target\&. +.sp +Added in version 235\&. .RE .PP \fBnoauto\fR, \fBauto\fR @@ -478,6 +511,8 @@ Note that if nor \fBnoauto\fR have any effect\&. The matching automount unit will be added as a dependency to the appropriate target\&. +.sp +Added in version 215\&. .RE .PP \fBnofail\fR @@ -487,6 +522,8 @@ With local\-fs\&.target or remote\-fs\&.target\&. Moreover the mount unit is not ordered before these target units\&. This means that the boot will continue without waiting for the mount unit and regardless whether the mount point can be mounted successfully\&. +.sp +Added in version 215\&. .RE .PP \fBx\-initrd\&.mount\fR @@ -495,6 +532,8 @@ An additional filesystem to be mounted in the initrd\&. See initrd\-fs\&.target description in \fBsystemd.special\fR(7)\&. This is both an indicator to the initrd to mount this partition early and an indicator to the host to leave the partition mounted until final shutdown\&. Or in other words, if this flag is set it is assumed the mount shall be active during the entire regular runtime of the system, i\&.e\&. established before the initrd transitions into the host all the way until the host transitions to the final shutdown phase\&. +.sp +Added in version 215\&. .RE .PP If a mount point is configured in both @@ -551,6 +590,8 @@ is relaxed, and unknown mount options are tolerated\&. This corresponds with \fBmount\fR(8)\*(Aqs \fI\-s\fR switch\&. Defaults to off\&. +.sp +Added in version 215\&. .RE .PP \fILazyUnmount=\fR @@ -559,6 +600,8 @@ Takes a boolean argument\&. If true, detach the filesystem from the filesystem h \fBumount\fR(8)\*(Aqs \fI\-l\fR switch\&. Defaults to off\&. +.sp +Added in version 232\&. .RE .PP \fIReadWriteOnly=\fR @@ -567,6 +610,8 @@ Takes a boolean argument\&. If false, a mount point that shall be mounted read\- \fBmount\fR(8)\*(Aqs \fI\-w\fR switch\&. Defaults to off\&. +.sp +Added in version 246\&. .RE .PP \fIForceUnmount=\fR @@ -575,6 +620,8 @@ Takes a boolean argument\&. If true, force an unmount (in case of an unreachable \fBumount\fR(8)\*(Aqs \fI\-f\fR switch\&. Defaults to off\&. +.sp +Added in version 232\&. .RE .PP \fIDirectoryMode=\fR diff --git a/upstream/opensuse-tumbleweed/man5/systemd.netdev.5 b/upstream/opensuse-tumbleweed/man5/systemd.netdev.5 index 556d88ac..4cbedb2f 100644 --- a/upstream/opensuse-tumbleweed/man5/systemd.netdev.5 +++ b/upstream/opensuse-tumbleweed/man5/systemd.netdev.5 @@ -1,5 +1,5 @@ '\" t -.TH "SYSTEMD\&.NETDEV" "5" "" "systemd 254" "systemd.network" +.TH "SYSTEMD\&.NETDEV" "5" "" "systemd 255" "systemd.network" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -42,7 +42,9 @@ and /usr/local/lib/systemd/network, the volatile runtime network directory /run/systemd/network and the local administration network directory -/etc/systemd/network\&. All configuration files are collectively sorted and processed in alphanumeric order, regardless of the directories in which they live\&. However, files with identical filenames replace each other\&. It is recommended that each filename is prefixed with a number (e\&.g\&. +/etc/systemd/network\&. All configuration files are collectively sorted and processed in alphanumeric order, regardless of the directories in which they live\&. However, files with identical filenames replace each other\&. It is recommended that each filename is prefixed with a number smaller than +"70" +(e\&.g\&. 10\-vlan\&.netdev)\&. Otherwise, \&.netdev files generated by @@ -335,6 +337,8 @@ Matches against the hostname or machine ID of the host\&. See in \fBsystemd.unit\fR(5) for details\&. When prefixed with an exclamation mark ("!"), the result is negated\&. If an empty string is assigned, the previously assigned value is cleared\&. +.sp +Added in version 211\&. .RE .PP \fIVirtualization=\fR @@ -344,6 +348,8 @@ Checks whether the system is executed in a virtualized environment and optionall in \fBsystemd.unit\fR(5) for details\&. When prefixed with an exclamation mark ("!"), the result is negated\&. If an empty string is assigned, the previously assigned value is cleared\&. +.sp +Added in version 211\&. .RE .PP \fIKernelCommandLine=\fR @@ -353,6 +359,8 @@ Checks whether a specific kernel command line option is set\&. See in \fBsystemd.unit\fR(5) for details\&. When prefixed with an exclamation mark ("!"), the result is negated\&. If an empty string is assigned, the previously assigned value is cleared\&. +.sp +Added in version 211\&. .RE .PP \fIKernelVersion=\fR @@ -363,6 +371,8 @@ Checks whether the kernel version (as reported by in \fBsystemd.unit\fR(5) for details\&. When prefixed with an exclamation mark ("!"), the result is negated\&. If an empty string is assigned, the previously assigned value is cleared\&. +.sp +Added in version 237\&. .RE .PP \fICredential=\fR @@ -372,6 +382,8 @@ systemd\-udevd\&.service service\&. See \m[blue]\fBSystem and Service Credentials\fR\m[]\&\s-2\u[6]\d\s+2 for details\&. When prefixed with an exclamation mark ("!"), the result is negated\&. If an empty string is assigned, the previously assigned value is cleared\&. +.sp +Added in version 252\&. .RE .PP \fIArchitecture=\fR @@ -381,6 +393,8 @@ Checks whether the system is running on a specific architecture\&. See in \fBsystemd.unit\fR(5) for details\&. When prefixed with an exclamation mark ("!"), the result is negated\&. If an empty string is assigned, the previously assigned value is cleared\&. +.sp +Added in version 211\&. .RE .PP \fIFirmware=\fR @@ -390,6 +404,8 @@ Checks whether the system is running on a machine with the specified firmware\&. in \fBsystemd.unit\fR(5) for details\&. When prefixed with an exclamation mark ("!"), the result is negated\&. If an empty string is assigned, the previously assigned value is cleared\&. +.sp +Added in version 249\&. .RE .SH "[NETDEV] SECTION OPTIONS" .PP @@ -398,11 +414,15 @@ The [NetDev] section accepts the following keys: \fIDescription=\fR .RS 4 A free\-form description of the netdev\&. +.sp +Added in version 215\&. .RE .PP \fIName=\fR .RS 4 The interface name used when creating the netdev\&. This setting is compulsory\&. +.sp +Added in version 211\&. .RE .PP \fIKind=\fR @@ -410,6 +430,8 @@ The interface name used when creating the netdev\&. This setting is compulsory\& The netdev kind\&. This setting is compulsory\&. See the "Supported netdev kinds" section for the valid keys\&. +.sp +Added in version 211\&. .RE .PP \fIMTUBytes=\fR @@ -423,6 +445,8 @@ devices, setting is not currently supported in [NetDev] section\&. Please specify it in [Link] section of corresponding \fBsystemd.network\fR(5) files\&. +.sp +Added in version 215\&. .RE .PP \fIMACAddress=\fR @@ -452,6 +476,8 @@ will assign the persistent MAC address for the device, as 99\-default\&.link has \fIMACAddressPolicy=persistent\fR\&. So, it is also necessary to create a custom \&.link file for the device, if the MAC address assignment is not desired\&. +.sp +Added in version 215\&. .RE .SH "[BRIDGE] SECTION OPTIONS" .PP @@ -461,31 +487,43 @@ The [Bridge] section only applies for netdevs of kind \fIHelloTimeSec=\fR .RS 4 HelloTimeSec specifies the number of seconds between two hello packets sent out by the root bridge and the designated bridges\&. Hello packets are used to communicate information about the topology throughout the entire bridged local area network\&. +.sp +Added in version 227\&. .RE .PP \fIMaxAgeSec=\fR .RS 4 MaxAgeSec specifies the number of seconds of maximum message age\&. If the last seen (received) hello packet is more than this number of seconds old, the bridge in question will start the takeover procedure in attempt to become the Root Bridge itself\&. +.sp +Added in version 227\&. .RE .PP \fIForwardDelaySec=\fR .RS 4 ForwardDelaySec specifies the number of seconds spent in each of the Listening and Learning states before the Forwarding state is entered\&. +.sp +Added in version 227\&. .RE .PP \fIAgeingTimeSec=\fR .RS 4 This specifies the number of seconds a MAC Address will be kept in the forwarding database after having a packet received from this MAC Address\&. +.sp +Added in version 232\&. .RE .PP \fIPriority=\fR .RS 4 The priority of the bridge\&. An integer between 0 and 65535\&. A lower value means higher priority\&. The bridge having the lowest priority will be elected as root bridge\&. +.sp +Added in version 232\&. .RE .PP \fIGroupForwardMask=\fR .RS 4 A 16\-bit bitmask represented as an integer which allows forwarding of link local frames with 802\&.1D reserved addresses (01:80:C2:00:00:0X)\&. A logical AND is performed between the specified bitmask and the exponentiation of 2^X, the lower nibble of the last octet of the MAC address\&. For example, a value of 8 would allow forwarding of frames addressed to 01:80:C2:00:00:03 (802\&.1X PAE)\&. +.sp +Added in version 235\&. .RE .PP \fIDefaultPVID=\fR @@ -493,21 +531,29 @@ A 16\-bit bitmask represented as an integer which allows forwarding of link loca This specifies the default port VLAN ID of a newly attached bridge port\&. Set this to an integer in the range 1\&...4094 or "none" to disable the PVID\&. +.sp +Added in version 232\&. .RE .PP \fIMulticastQuerier=\fR .RS 4 Takes a boolean\&. This setting controls the IFLA_BR_MCAST_QUERIER option in the kernel\&. If enabled, the kernel will send general ICMP queries from a zero source address\&. This feature should allow faster convergence on startup, but it causes some multicast\-aware switches to misbehave and disrupt forwarding of multicast packets\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 230\&. .RE .PP \fIMulticastSnooping=\fR .RS 4 Takes a boolean\&. This setting controls the IFLA_BR_MCAST_SNOOPING option in the kernel\&. If enabled, IGMP snooping monitors the Internet Group Management Protocol (IGMP) traffic between hosts and multicast routers\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 230\&. .RE .PP \fIVLANFiltering=\fR .RS 4 Takes a boolean\&. This setting controls the IFLA_BR_VLAN_FILTERING option in the kernel\&. If enabled, the bridge will be started in VLAN\-filtering mode\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 231\&. .RE .PP \fIVLANProtocol=\fR @@ -516,16 +562,22 @@ Allows setting the protocol used for VLAN filtering\&. Takes \fB802\&.1q\fR or, \fB802\&.1ad\fR, and defaults to unset and kernel\*(Aqs default is used\&. +.sp +Added in version 246\&. .RE .PP \fISTP=\fR .RS 4 Takes a boolean\&. This enables the bridge\*(Aqs Spanning Tree Protocol (STP)\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 232\&. .RE .PP \fIMulticastIGMPVersion=\fR .RS 4 Allows changing bridge\*(Aqs multicast Internet Group Management Protocol (IGMP) version\&. Takes an integer 2 or 3\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 243\&. .RE .SH "[VLAN] SECTION OPTIONS" .PP @@ -535,6 +587,8 @@ The [VLAN] section only applies for netdevs of kind \fIId=\fR .RS 4 The VLAN ID to use\&. An integer in the range 0\&...4094\&. This setting is compulsory\&. +.sp +Added in version 211\&. .RE .PP \fIProtocol=\fR @@ -543,26 +597,36 @@ Allows setting the protocol used for the VLAN interface\&. Takes "802\&.1q" or, "802\&.1ad", and defaults to unset and kernel\*(Aqs default is used\&. +.sp +Added in version 248\&. .RE .PP \fIGVRP=\fR .RS 4 Takes a boolean\&. The Generic VLAN Registration Protocol (GVRP) is a protocol that allows automatic learning of VLANs on a network\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 234\&. .RE .PP \fIMVRP=\fR .RS 4 Takes a boolean\&. Multiple VLAN Registration Protocol (MVRP) formerly known as GARP VLAN Registration Protocol (GVRP) is a standards\-based Layer 2 network protocol, for automatic configuration of VLAN information on switches\&. It was defined in the 802\&.1ak amendment to 802\&.1Q\-2005\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 234\&. .RE .PP \fILooseBinding=\fR .RS 4 Takes a boolean\&. The VLAN loose binding mode, in which only the operational state is passed from the parent to the associated VLANs, but the VLAN device state is not changed\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 234\&. .RE .PP \fIReorderHeader=\fR .RS 4 Takes a boolean\&. When enabled, the VLAN reorder header is used and VLAN interfaces behave like physical interfaces\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 234\&. .RE .PP \fIEgressQOSMaps=\fR, \fIIngressQOSMaps=\fR @@ -573,6 +637,8 @@ Defines a mapping of Linux internal packet priority (\fBSO_PRIORITY\fR) to VLAN "from" must be greater than or equal to "to"\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 248\&. .RE .SH "[MACVLAN] SECTION OPTIONS" .PP @@ -587,16 +653,22 @@ The MACVLAN mode to use\&. The supported options are "bridge", "passthru", and "source"\&. +.sp +Added in version 211\&. .RE .PP \fISourceMACAddress=\fR .RS 4 A whitespace\-separated list of remote hardware addresses allowed on the MACVLAN\&. This option only has an effect in source mode\&. Use full colon\-, hyphen\- or dot\-delimited hexadecimal\&. This option may appear more than once, in which case the lists are merged\&. If the empty string is assigned to this option, the list of hardware addresses defined prior to this is reset\&. Defaults to unset\&. +.sp +Added in version 246\&. .RE .PP \fIBroadcastMulticastQueueLength=\fR .RS 4 Specifies the length of the receive queue for broadcast/multicast packets\&. An unsigned integer in the range 0\&...4294967294\&. Defaults to unset\&. +.sp +Added in version 248\&. .RE .SH "[MACVTAP] SECTION OPTIONS" .PP @@ -614,6 +686,8 @@ The IPVLAN mode to use\&. The supported options are "L2","L3" and "L3S"\&. +.sp +Added in version 219\&. .RE .PP \fIFlags=\fR @@ -622,6 +696,8 @@ The IPVLAN flags to use\&. The supported options are "bridge","private" and "vepa"\&. +.sp +Added in version 237\&. .RE .SH "[IPVTAP] SECTION OPTIONS" .PP @@ -636,11 +712,15 @@ The [VXLAN] section only applies for netdevs of kind \fIVNI=\fR .RS 4 The VXLAN Network Identifier (or VXLAN Segment ID)\&. Takes a number in the range 1\&...16777215\&. +.sp +Added in version 243\&. .RE .PP \fIRemote=\fR .RS 4 Configures destination IP address\&. +.sp +Added in version 233\&. .RE .PP \fILocal=\fR @@ -651,16 +731,22 @@ Configures local IP address\&. It must be an address on the underlying interface "dhcp4", "dhcp6", and "slaac"\&. If one of the special values is specified, an address which matches the corresponding type on the underlying interface will be used\&. Defaults to unset\&. +.sp +Added in version 233\&. .RE .PP \fIGroup=\fR .RS 4 Configures VXLAN multicast group IP address\&. All members of a VXLAN must use the same multicast group address\&. +.sp +Added in version 243\&. .RE .PP \fITOS=\fR .RS 4 The Type Of Service byte value for a vxlan interface\&. +.sp +Added in version 215\&. .RE .PP \fITTL=\fR @@ -670,68 +756,94 @@ A fixed Time To Live N on Virtual eXtensible Local Area Network packets\&. Takes or a number in the range 0\&...255\&. 0 is a special value meaning inherit the inner protocol\*(Aqs TTL value\&. "inherit" means that it will inherit the outer protocol\*(Aqs TTL value\&. +.sp +Added in version 215\&. .RE .PP \fIMacLearning=\fR .RS 4 Takes a boolean\&. When true, enables dynamic MAC learning to discover remote MAC addresses\&. +.sp +Added in version 215\&. .RE .PP \fIFDBAgeingSec=\fR .RS 4 The lifetime of Forwarding Database entry learnt by the kernel, in seconds\&. +.sp +Added in version 218\&. .RE .PP \fIMaximumFDBEntries=\fR .RS 4 Configures maximum number of FDB entries\&. +.sp +Added in version 228\&. .RE .PP \fIReduceARPProxy=\fR .RS 4 -Takes a boolean\&. When true, bridge\-connected VXLAN tunnel endpoint answers ARP requests from the local bridge on behalf of remote Distributed Overlay Virtual Ethernet -\m[blue]\fB(DOVE)\fR\m[]\&\s-2\u[7]\d\s+2 +Takes a boolean\&. When true, bridge\-connected VXLAN tunnel endpoint answers ARP requests from the local bridge on behalf of remote +\m[blue]\fBDistributed Overlay Virtual Ethernet (DOVE)\fR\m[]\&\s-2\u[7]\d\s+2 clients\&. Defaults to false\&. +.sp +Added in version 233\&. .RE .PP \fIL2MissNotification=\fR .RS 4 Takes a boolean\&. When true, enables netlink LLADDR miss notifications\&. +.sp +Added in version 218\&. .RE .PP \fIL3MissNotification=\fR .RS 4 Takes a boolean\&. When true, enables netlink IP address miss notifications\&. +.sp +Added in version 218\&. .RE .PP \fIRouteShortCircuit=\fR .RS 4 Takes a boolean\&. When true, route short circuiting is turned on\&. +.sp +Added in version 218\&. .RE .PP \fIUDPChecksum=\fR .RS 4 Takes a boolean\&. When true, transmitting UDP checksums when doing VXLAN/IPv4 is turned on\&. +.sp +Added in version 220\&. .RE .PP \fIUDP6ZeroChecksumTx=\fR .RS 4 Takes a boolean\&. When true, sending zero checksums in VXLAN/IPv6 is turned on\&. +.sp +Added in version 220\&. .RE .PP \fIUDP6ZeroChecksumRx=\fR .RS 4 Takes a boolean\&. When true, receiving zero checksums in VXLAN/IPv6 is turned on\&. +.sp +Added in version 220\&. .RE .PP \fIRemoteChecksumTx=\fR .RS 4 Takes a boolean\&. When true, remote transmit checksum offload of VXLAN is turned on\&. +.sp +Added in version 232\&. .RE .PP \fIRemoteChecksumRx=\fR .RS 4 Takes a boolean\&. When true, remote receive checksum offload in VXLAN is turned on\&. +.sp +Added in version 232\&. .RE .PP \fIGroupPolicyExtension=\fR @@ -739,6 +851,8 @@ Takes a boolean\&. When true, remote receive checksum offload in VXLAN is turned Takes a boolean\&. When true, it enables Group Policy VXLAN extension security label mechanism across network peers based on VXLAN\&. For details about the Group Policy VXLAN, see the \m[blue]\fBVXLAN Group Policy\fR\m[]\&\s-2\u[8]\d\s+2 document\&. Defaults to false\&. +.sp +Added in version 224\&. .RE .PP \fIGenericProtocolExtension=\fR @@ -746,21 +860,29 @@ document\&. Defaults to false\&. Takes a boolean\&. When true, Generic Protocol Extension extends the existing VXLAN protocol to provide protocol typing, OAM, and versioning capabilities\&. For details about the VXLAN GPE Header, see the \m[blue]\fBGeneric Protocol Extension for VXLAN\fR\m[]\&\s-2\u[9]\d\s+2 document\&. If destination port is not specified and Generic Protocol Extension is set then default port of 4790 is used\&. Defaults to false\&. +.sp +Added in version 243\&. .RE .PP \fIDestinationPort=\fR .RS 4 Configures the default destination UDP port\&. If the destination port is not specified then Linux kernel default will be used\&. Set to 4789 to get the IANA assigned value\&. +.sp +Added in version 229\&. .RE .PP \fIPortRange=\fR .RS 4 Configures the source port range for the VXLAN\&. The kernel assigns the source UDP port based on the flow to help the receiver to do load balancing\&. When this option is not set, the normal range of local UDP ports is used\&. +.sp +Added in version 229\&. .RE .PP \fIFlowLabel=\fR .RS 4 Specifies the flow label to use in outgoing packets\&. The valid range is 0\-1048575\&. +.sp +Added in version 234\&. .RE .PP \fIIPDoNotFragment=\fR @@ -769,6 +891,8 @@ Allows setting the IPv4 Do not Fragment (DF) bit in outgoing packets, or to inhe "inherit"\&. Set to "inherit" if the encapsulated protocol is IPv6\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 243\&. .RE .PP \fIIndependent=\fR @@ -776,6 +900,8 @@ if the encapsulated protocol is IPv6\&. When unset, the kernel\*(Aqs default wil Takes a boolean\&. When true, the vxlan interface is created without any underlying network interface\&. Defaults to false, which means that a \&.network file that requests this VXLAN interface using \fIVXLAN=\fR is required for the VXLAN to be created\&. +.sp +Added in version 247\&. .RE .SH "[GENEVE] SECTION OPTIONS" .PP @@ -785,57 +911,79 @@ The [GENEVE] section only applies for netdevs of kind \fIId=\fR .RS 4 Specifies the Virtual Network Identifier (VNI) to use, a number between 0 and 16777215\&. This field is mandatory\&. +.sp +Added in version 234\&. .RE .PP \fIRemote=\fR .RS 4 Specifies the unicast destination IP address to use in outgoing packets\&. +.sp +Added in version 234\&. .RE .PP \fITOS=\fR .RS 4 Specifies the TOS value to use in outgoing packets\&. Takes a number between 1 and 255\&. +.sp +Added in version 234\&. .RE .PP \fITTL=\fR .RS 4 Accepts the same values as in the [VXLAN] section, except that when unset or set to 0, the kernel\*(Aqs default will be used, meaning that packet TTL will be set from /proc/sys/net/ipv4/ip_default_ttl\&. +.sp +Added in version 234\&. .RE .PP \fIUDPChecksum=\fR .RS 4 Takes a boolean\&. When true, specifies that UDP checksum is calculated for transmitted packets over IPv4\&. +.sp +Added in version 234\&. .RE .PP \fIUDP6ZeroChecksumTx=\fR .RS 4 Takes a boolean\&. When true, skip UDP checksum calculation for transmitted packets over IPv6\&. +.sp +Added in version 234\&. .RE .PP \fIUDP6ZeroChecksumRx=\fR .RS 4 Takes a boolean\&. When true, allows incoming UDP packets over IPv6 with zero checksum field\&. +.sp +Added in version 234\&. .RE .PP \fIDestinationPort=\fR .RS 4 Specifies destination port\&. Defaults to 6081\&. If not set or assigned the empty string, the default port of 6081 is used\&. +.sp +Added in version 234\&. .RE .PP \fIFlowLabel=\fR .RS 4 Specifies the flow label to use in outgoing packets\&. +.sp +Added in version 234\&. .RE .PP \fIIPDoNotFragment=\fR .RS 4 Accepts the same key as in [VXLAN] section\&. +.sp +Added in version 243\&. .RE .PP \fIInheritInnerProtocol=\fR .RS 4 Takes a boolean\&. When true, inner Layer 3 protocol is set as Protocol Type in the GENEVE header instead of Ethernet\&. Defaults to false\&. +.sp +Added in version 254\&. .RE .SH "[BAREUDP] SECTION OPTIONS" .PP @@ -845,6 +993,8 @@ The [BareUDP] section only applies for netdevs of kind \fIDestinationPort=\fR .RS 4 Specifies the destination UDP port (in range 1\&...65535)\&. This is mandatory\&. +.sp +Added in version 247\&. .RE .PP \fIEtherType=\fR @@ -855,6 +1005,8 @@ Specifies the L3 protocol\&. Takes one of "mpls\-uc" or "mpls\-mc"\&. This is mandatory\&. +.sp +Added in version 247\&. .RE .SH "[L2TP] SECTION OPTIONS" .PP @@ -866,6 +1018,8 @@ The [L2TP] section only applies for netdevs of kind Specifies the tunnel identifier\&. Takes an number in the range 1\&...4294967295\&. The value used must match the "PeerTunnelId=" value being used at the peer\&. This setting is compulsory\&. +.sp +Added in version 242\&. .RE .PP \fIPeerTunnelId=\fR @@ -873,11 +1027,15 @@ value being used at the peer\&. This setting is compulsory\&. Specifies the peer tunnel id\&. Takes a number in the range 1\&...4294967295\&. The value used must match the "TunnelId=" value being used at the peer\&. This setting is compulsory\&. +.sp +Added in version 242\&. .RE .PP \fIRemote=\fR .RS 4 Specifies the IP address of the remote peer\&. This setting is compulsory\&. +.sp +Added in version 242\&. .RE .PP \fILocal=\fR @@ -896,6 +1054,8 @@ or "dynamic" is set, then one of the static or dynamic addresses will be used\&. Defaults to "auto"\&. +.sp +Added in version 242\&. .RE .PP \fIEncapsulationType=\fR @@ -904,31 +1064,43 @@ Specifies the encapsulation type of the tunnel\&. Takes one of "udp" or "ip"\&. +.sp +Added in version 242\&. .RE .PP \fIUDPSourcePort=\fR .RS 4 Specifies the UDP source port to be used for the tunnel\&. When UDP encapsulation is selected it\*(Aqs mandatory\&. Ignored when IP encapsulation is selected\&. +.sp +Added in version 242\&. .RE .PP \fIUDPDestinationPort=\fR .RS 4 Specifies destination port\&. When UDP encapsulation is selected it\*(Aqs mandatory\&. Ignored when IP encapsulation is selected\&. +.sp +Added in version 245\&. .RE .PP \fIUDPChecksum=\fR .RS 4 Takes a boolean\&. When true, specifies that UDP checksum is calculated for transmitted packets over IPv4\&. +.sp +Added in version 242\&. .RE .PP \fIUDP6ZeroChecksumTx=\fR .RS 4 Takes a boolean\&. When true, skip UDP checksum calculation for transmitted packets over IPv6\&. +.sp +Added in version 242\&. .RE .PP \fIUDP6ZeroChecksumRx=\fR .RS 4 Takes a boolean\&. When true, allows incoming UDP packets over IPv6 with zero checksum field\&. +.sp +Added in version 242\&. .RE .SH "[L2TPSESSION] SECTION OPTIONS" .PP @@ -938,6 +1110,8 @@ The [L2TPSession] section only applies for netdevs of kind \fIName=\fR .RS 4 Specifies the name of the session\&. This setting is compulsory\&. +.sp +Added in version 242\&. .RE .PP \fISessionId=\fR @@ -945,6 +1119,8 @@ Specifies the name of the session\&. This setting is compulsory\&. Specifies the session identifier\&. Takes an number in the range 1\&...4294967295\&. The value used must match the "SessionId=" value being used at the peer\&. This setting is compulsory\&. +.sp +Added in version 242\&. .RE .PP \fIPeerSessionId=\fR @@ -952,6 +1128,8 @@ value being used at the peer\&. This setting is compulsory\&. Specifies the peer session identifier\&. Takes an number in the range 1\&...4294967295\&. The value used must match the "PeerSessionId=" value being used at the peer\&. This setting is compulsory\&. +.sp +Added in version 242\&. .RE .PP \fILayer2SpecificHeader=\fR @@ -961,6 +1139,8 @@ Specifies layer2specific header type of the session\&. One of or "default"\&. Defaults to "default"\&. +.sp +Added in version 242\&. .RE .SH "[MACSEC] SECTION OPTIONS" .PP @@ -970,11 +1150,15 @@ The [MACsec] section only applies for network devices of kind \fIPort=\fR .RS 4 Specifies the port to be used for the MACsec transmit channel\&. The port is used to make secure channel identifier (SCI)\&. Takes a value between 1 and 65535\&. Defaults to unset\&. +.sp +Added in version 243\&. .RE .PP \fIEncrypt=\fR .RS 4 Takes a boolean\&. When true, enable encryption\&. Defaults to unset\&. +.sp +Added in version 243\&. .RE .SH "[MACSECRECEIVECHANNEL] SECTION OPTIONS" .PP @@ -984,11 +1168,15 @@ The [MACsecReceiveChannel] section only applies for network devices of kind \fIPort=\fR .RS 4 Specifies the port to be used for the MACsec receive channel\&. The port is used to make secure channel identifier (SCI)\&. Takes a value between 1 and 65535\&. This option is compulsory, and is not set by default\&. +.sp +Added in version 243\&. .RE .PP \fIMACAddress=\fR .RS 4 Specifies the MAC address to be used for the MACsec receive channel\&. The MAC address used to make secure channel identifier (SCI)\&. This setting is compulsory, and is not set by default\&. +.sp +Added in version 243\&. .RE .SH "[MACSECTRANSMITASSOCIATION] SECTION OPTIONS" .PP @@ -998,17 +1186,23 @@ The [MACsecTransmitAssociation] section only applies for network devices of kind \fIPacketNumber=\fR .RS 4 Specifies the packet number to be used for replay protection and the construction of the initialization vector (along with the secure channel identifier [SCI])\&. Takes a value between 1\-4,294,967,295\&. Defaults to unset\&. +.sp +Added in version 243\&. .RE .PP \fIKeyId=\fR .RS 4 Specifies the identification for the key\&. Takes a number between 0\-255\&. This option is compulsory, and is not set by default\&. +.sp +Added in version 243\&. .RE .PP \fIKey=\fR .RS 4 Specifies the encryption key used in the transmission channel\&. The same key must be configured on the peer\(cqs matching receive channel\&. This setting is compulsory, and is not set by default\&. Takes a 128\-bit key encoded in a hexadecimal string, for example "dffafc8d7b9a43d5b9a3dfbbf6a30c16"\&. +.sp +Added in version 243\&. .RE .PP \fIKeyFile=\fR @@ -1023,11 +1217,15 @@ with a file mode\&. If the path refers to an \fBAF_UNIX\fR stream socket in the file system a connection is made to it and the key read from it\&. +.sp +Added in version 243\&. .RE .PP \fIActivate=\fR .RS 4 Takes a boolean\&. If enabled, then the security association is activated\&. Defaults to unset\&. +.sp +Added in version 243\&. .RE .PP \fIUseForEncoding=\fR @@ -1035,6 +1233,8 @@ Takes a boolean\&. If enabled, then the security association is activated\&. Def Takes a boolean\&. If enabled, then the security association is used for encoding\&. Only one [MACsecTransmitAssociation] section can enable this option\&. When enabled, \fIActivate=yes\fR is implied\&. Defaults to unset\&. +.sp +Added in version 243\&. .RE .SH "[MACSECRECEIVEASSOCIATION] SECTION OPTIONS" .PP @@ -1044,36 +1244,50 @@ The [MACsecReceiveAssociation] section only applies for network devices of kind \fIPort=\fR .RS 4 Accepts the same key as in [MACsecReceiveChannel] section\&. +.sp +Added in version 243\&. .RE .PP \fIMACAddress=\fR .RS 4 Accepts the same key as in [MACsecReceiveChannel] section\&. +.sp +Added in version 243\&. .RE .PP \fIPacketNumber=\fR .RS 4 Accepts the same key as in [MACsecTransmitAssociation] section\&. +.sp +Added in version 243\&. .RE .PP \fIKeyId=\fR .RS 4 Accepts the same key as in [MACsecTransmitAssociation] section\&. +.sp +Added in version 243\&. .RE .PP \fIKey=\fR .RS 4 Accepts the same key as in [MACsecTransmitAssociation] section\&. +.sp +Added in version 243\&. .RE .PP \fIKeyFile=\fR .RS 4 Accepts the same key as in [MACsecTransmitAssociation] section\&. +.sp +Added in version 243\&. .RE .PP \fIActivate=\fR .RS 4 Accepts the same key as in [MACsecTransmitAssociation] section\&. +.sp +Added in version 243\&. .RE .SH "[TUNNEL] SECTION OPTIONS" .PP @@ -1098,6 +1312,8 @@ or \fIRemote=\fR are ignored\&. This implies \fIIndependent=\fR\&. Defaults to false\&. +.sp +Added in version 251\&. .RE .PP \fILocal=\fR @@ -1112,12 +1328,16 @@ A static local address for tunneled packets\&. It must be an address on another "any" is specified, an address which matches the corresponding type on the underlying interface will be used\&. Defaults to "any"\&. +.sp +Added in version 215\&. .RE .PP \fIRemote=\fR .RS 4 The remote endpoint of the tunnel\&. Takes an IP address or the special value "any"\&. +.sp +Added in version 215\&. .RE .PP \fITOS=\fR @@ -1125,11 +1345,15 @@ The remote endpoint of the tunnel\&. Takes an IP address or the special value The Type Of Service byte value for a tunnel interface\&. For details about the TOS, see the \m[blue]\fBType of Service in the Internet Protocol Suite\fR\m[]\&\s-2\u[10]\d\s+2 document\&. +.sp +Added in version 215\&. .RE .PP \fITTL=\fR .RS 4 A fixed Time To Live N on tunneled packets\&. N is a number in the range 1\&...255\&. 0 is a special value meaning that packets inherit the TTL value\&. The default value for IPv4 tunnels is 0 (inherit)\&. The default value for IPv6 tunnels is 64\&. +.sp +Added in version 215\&. .RE .PP \fIDiscoverPathMTU=\fR @@ -1137,6 +1361,8 @@ A fixed Time To Live N on tunneled packets\&. N is a number in the range 1\&...2 Takes a boolean\&. When true, enables Path MTU Discovery on the tunnel\&. When \fIIgnoreDontFragment=\fR is enabled, defaults to false\&. Otherwise, defaults to true\&. +.sp +Added in version 215\&. .RE .PP \fIIgnoreDontFragment=\fR @@ -1146,6 +1372,8 @@ Takes a boolean\&. When true, enables IPv4 Don\*(Aqt Fragment (DF) suppression o is set to true, \fIDiscoverPathMTU=\fR cannot be set to true\&. Only applicable to GRE, GRETAP, and ERSPAN tunnels\&. +.sp +Added in version 254\&. .RE .PP \fIIPv6FlowLabel=\fR @@ -1154,12 +1382,16 @@ Configures the 20\-bit flow label (see \m[blue]\fBRFC 6437\fR\m[]\&\s-2\u[11]\d\s+2) field in the IPv6 header (see \m[blue]\fBRFC 2460\fR\m[]\&\s-2\u[12]\d\s+2), which is used by a node to label packets of a flow\&. It is only used for IPv6 tunnels\&. A flow label of zero is used to indicate packets that have not been labeled\&. It can be configured to a value in the range 0\&...0xFFFFF, or be set to "inherit", in which case the original flowlabel is used\&. +.sp +Added in version 223\&. .RE .PP \fICopyDSCP=\fR .RS 4 Takes a boolean\&. When true, the Differentiated Service Code Point (DSCP) field will be copied to the inner header from outer header during the decapsulation of an IPv6 tunnel packet\&. DSCP is a field in an IP packet that enables different levels of service to be assigned to network traffic\&. Defaults to "no"\&. +.sp +Added in version 223\&. .RE .PP \fIEncapsulationLimit=\fR @@ -1167,6 +1399,8 @@ Takes a boolean\&. When true, the Differentiated Service Code Point (DSCP) field The Tunnel Encapsulation Limit option specifies how many additional levels of encapsulation are permitted to be prepended to the packet\&. For example, a Tunnel Encapsulation Limit option containing a limit value of zero means that a packet carrying that option may not enter another tunnel before exiting the current tunnel\&. (see \m[blue]\fBRFC 2473\fR\m[]\&\s-2\u[13]\d\s+2)\&. The valid range is 0\&...255 and "none"\&. Defaults to 4\&. +.sp +Added in version 226\&. .RE .PP \fIKey=\fR @@ -1180,6 +1414,8 @@ and is either a number or an IPv4 address\-like dotted quad\&. It is used as mark\-configured SAD/SPD entry as part of the lookup key (both in data and control path) in IP XFRM (framework used to implement IPsec protocol)\&. See \m[blue]\fBip\-xfrm \(em transform configuration\fR\m[]\&\s-2\u[14]\d\s+2 for details\&. It is only used for VTI/VTI6, GRE, GRETAP, and ERSPAN tunnels\&. +.sp +Added in version 231\&. .RE .PP \fIInputKey=\fR @@ -1188,6 +1424,8 @@ The \fIInputKey=\fR parameter specifies the key to use for input\&. The format is same as \fIKey=\fR\&. It is only used for VTI/VTI6, GRE, GRETAP, and ERSPAN tunnels\&. +.sp +Added in version 231\&. .RE .PP \fIOutputKey=\fR @@ -1196,6 +1434,8 @@ The \fIOutputKey=\fR parameter specifies the key to use for output\&. The format is same as \fIKey=\fR\&. It is only used for VTI/VTI6, GRE, GRETAP, and ERSPAN tunnels\&. +.sp +Added in version 231\&. .RE .PP \fIMode=\fR @@ -1209,6 +1449,8 @@ for IPv6 over IPv6, for IPv4 over IPv6 or "any" for either\&. +.sp +Added in version 219\&. .RE .PP \fIIndependent=\fR @@ -1216,6 +1458,8 @@ for either\&. Takes a boolean\&. When false (the default), the tunnel is always created over some network device, and a \&.network file that requests this tunnel using \fITunnel=\fR is required for the tunnel to be created\&. When true, the tunnel is created independently of any network as "tunnel@NONE"\&. +.sp +Added in version 235\&. .RE .PP \fIAssignToLoopback=\fR @@ -1225,6 +1469,8 @@ Takes a boolean\&. If set to "lo" is used as the underlying device of the tunnel interface\&. Defaults to "no"\&. +.sp +Added in version 243\&. .RE .PP \fIAllowLocalRemote=\fR @@ -1232,6 +1478,8 @@ is used as the underlying device of the tunnel interface\&. Defaults to Takes a boolean\&. When true allows tunnel traffic on \fIip6tnl\fR devices where the remote endpoint is a local host address\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 237\&. .RE .PP \fIFooOverUDP=\fR @@ -1240,12 +1488,16 @@ Takes a boolean\&. Specifies whether \fIFooOverUDP=\fR tunnel is to be configured\&. Defaults to false\&. This takes effects only for IPIP, SIT, GRE, and GRETAP tunnels\&. For more detail information see \m[blue]\fBFoo over UDP\fR\m[]\&\s-2\u[15]\d\s+2 +.sp +Added in version 240\&. .RE .PP \fIFOUDestinationPort=\fR .RS 4 This setting specifies the UDP destination port for encapsulation\&. This field is mandatory when \fIFooOverUDP=yes\fR, and is not set by default\&. +.sp +Added in version 240\&. .RE .PP \fIFOUSourcePort=\fR @@ -1253,38 +1505,52 @@ This setting specifies the UDP destination port for encapsulation\&. This field This setting specifies the UDP source port for encapsulation\&. Defaults to \fB0\fR \(em that is, the source port for packets is left to the network stack to decide\&. +.sp +Added in version 240\&. .RE .PP \fIEncapsulation=\fR .RS 4 Accepts the same key as in the [FooOverUDP] section\&. +.sp +Added in version 240\&. .RE .PP \fIIPv6RapidDeploymentPrefix=\fR .RS 4 Reconfigure the tunnel for \m[blue]\fBIPv6 Rapid Deployment\fR\m[]\&\s-2\u[16]\d\s+2, also known as 6rd\&. The value is an ISP\-specific IPv6 prefix with a non\-zero length\&. Only applicable to SIT tunnels\&. +.sp +Added in version 240\&. .RE .PP \fIISATAP=\fR .RS 4 Takes a boolean\&. If set, configures the tunnel as Intra\-Site Automatic Tunnel Addressing Protocol (ISATAP) tunnel\&. Only applicable to SIT tunnels\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 240\&. .RE .PP \fISerializeTunneledPackets=\fR .RS 4 Takes a boolean\&. If set to yes, then packets are serialized\&. Only applies for GRE, GRETAP, and ERSPAN tunnels\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 240\&. .RE .PP \fIERSPANVersion=\fR .RS 4 Specifies the ERSPAN version number\&. Takes 0 for version 0 (a\&.k\&.a\&. type I), 1 for version 1 (a\&.k\&.a\&. type II), or 2 for version 2 (a\&.k\&.a\&. type III)\&. Defaults to 1\&. +.sp +Added in version 252\&. .RE .PP \fIERSPANIndex=\fR .RS 4 Specifies the ERSPAN v1 index field for the interface\&. Takes an integer in the range 0\&...1048575, which is associated with the ERSPAN traffic\*(Aqs source port and direction\&. Only used when \fIERSPANVersion=1\fR\&. Defaults to 0\&. +.sp +Added in version 240\&. .RE .PP \fIERSPANDirection=\fR @@ -1295,12 +1561,16 @@ or "egress"\&. Only used when \fIERSPANVersion=2\fR\&. Defaults to "ingress"\&. +.sp +Added in version 252\&. .RE .PP \fIERSPANHardwareId=\fR .RS 4 Specifies an unique identifier of the ERSPAN v2 engine\&. Takes an integer in the range 0\&...63\&. Only used when \fIERSPANVersion=2\fR\&. Defaults to 0\&. +.sp +Added in version 252\&. .RE .SH "[FOOOVERUDP] SECTION OPTIONS" .PP @@ -1317,11 +1587,15 @@ provides the simplest no\-frills model of UDP encapsulation, it simply encapsula is a generic and extensible encapsulation, it allows encapsulation of packets for any IP protocol and optional data as part of the encapsulation\&. For more detailed information see \m[blue]\fBGeneric UDP Encapsulation\fR\m[]\&\s-2\u[17]\d\s+2\&. Defaults to "FooOverUDP"\&. +.sp +Added in version 240\&. .RE .PP \fIPort=\fR .RS 4 Specifies the port number where the encapsulated packets will arrive\&. Those packets will be removed and manually fed back into the network stack with the encapsulation removed to be sent to the real destination\&. This option is mandatory\&. +.sp +Added in version 240\&. .RE .PP \fIPeerPort=\fR @@ -1329,6 +1603,8 @@ Specifies the port number where the encapsulated packets will arrive\&. Those pa Specifies the peer port number\&. Defaults to unset\&. Note that when peer port is set "Peer=" address is mandatory\&. +.sp +Added in version 243\&. .RE .PP \fIProtocol=\fR @@ -1341,6 +1617,8 @@ specifies the protocol number of the packets arriving at the UDP port\&. When or "ipip", or an integer within the range 1\&...255\&. When \fIEncapsulation=GenericUDPEncapsulation\fR, this must not be specified\&. +.sp +Added in version 240\&. .RE .PP \fIPeer=\fR @@ -1348,11 +1626,15 @@ or Configures peer IP address\&. Note that when peer address is set "PeerPort=" is mandatory\&. +.sp +Added in version 243\&. .RE .PP \fILocal=\fR .RS 4 Configures local IP address\&. +.sp +Added in version 243\&. .RE .SH "[PEER] SECTION OPTIONS" .PP @@ -1363,11 +1645,15 @@ and accepts the following keys: \fIName=\fR .RS 4 The interface name used when creating the netdev\&. This setting is compulsory\&. +.sp +Added in version 215\&. .RE .PP \fIMACAddress=\fR .RS 4 The peer MACAddress, if not set, it is generated in the same way as the MAC address of the main interface\&. +.sp +Added in version 215\&. .RE .SH "[VXCAN] SECTION OPTIONS" .PP @@ -1378,6 +1664,8 @@ and accepts the following key: \fIPeer=\fR .RS 4 The peer interface name used when creating the netdev\&. This setting is compulsory\&. +.sp +Added in version 236\&. .RE .SH "[TUN] SECTION OPTIONS" .PP @@ -1388,18 +1676,24 @@ The [Tun] section only applies for netdevs of kind .RS 4 Takes a boolean\&. Configures whether to use multiple file descriptors (queues) to parallelize packets sending and receiving\&. Defaults to "no"\&. +.sp +Added in version 215\&. .RE .PP \fIPacketInfo=\fR .RS 4 Takes a boolean\&. Configures whether packets should be prepended with four extra bytes (two flag bytes and two protocol bytes)\&. If disabled, it indicates that the packets will be pure IP packets\&. Defaults to "no"\&. +.sp +Added in version 215\&. .RE .PP \fIVNetHeader=\fR .RS 4 Takes a boolean\&. Configures IFF_VNET_HDR flag for a tun or tap device\&. It allows sending and receiving larger Generic Segmentation Offload (GSO) packets\&. This may increase throughput significantly\&. Defaults to "no"\&. +.sp +Added in version 223\&. .RE .PP \fIUser=\fR @@ -1407,6 +1701,8 @@ Takes a boolean\&. Configures IFF_VNET_HDR flag for a tun or tap device\&. It al User to grant access to the /dev/net/tun device\&. +.sp +Added in version 215\&. .RE .PP \fIGroup=\fR @@ -1414,12 +1710,16 @@ device\&. Group to grant access to the /dev/net/tun device\&. +.sp +Added in version 215\&. .RE .PP \fIKeepCarrier=\fR .RS 4 Takes a boolean\&. If enabled, to make the interface maintain its carrier status, the file descriptor of the interface is kept open\&. This may be useful to keep the interface in running state, for example while the backing process is temporarily shutdown\&. Defaults to "no"\&. +.sp +Added in version 252\&. .RE .SH "[TAP] SECTION OPTIONS" .PP @@ -1441,6 +1741,8 @@ is mandatory to use WireGuard\&. Note that because this information is secret, y with a "0640" file mode\&. +.sp +Added in version 237\&. .RE .PP \fIPrivateKeyFile=\fR @@ -1455,6 +1757,8 @@ with a file mode\&. If the path refers to an \fBAF_UNIX\fR stream socket in the file system a connection is made to it and the key read from it\&. +.sp +Added in version 242\&. .RE .PP \fIListenPort=\fR @@ -1464,11 +1768,15 @@ Sets UDP port for listening\&. Takes either value between 1 and 65535 or "auto" is specified, the port is automatically generated based on interface name\&. Defaults to "auto"\&. +.sp +Added in version 237\&. .RE .PP \fIFirewallMark=\fR .RS 4 Sets a firewall mark on outgoing WireGuard packets from this interface\&. Takes a number between 1 and 4294967295\&. +.sp +Added in version 243\&. .RE .PP \fIRouteTable=\fR @@ -1485,12 +1793,16 @@ in the routes to the addresses specified in the \fIAllowedIPs=\fR setting will not be configured\&. Defaults to false\&. This setting will be ignored when the same setting is specified in the [WireGuardPeer] section\&. +.sp +Added in version 250\&. .RE .PP \fIRouteMetric=\fR .RS 4 The priority of the routes to the addresses specified in the \fIAllowedIPs=\fR\&. Takes an integer in the range 0\&...4294967295\&. Defaults to 0 for IPv4 addresses, and 1024 for IPv6 addresses\&. This setting will be ignored when the same setting is specified in the [WireGuardPeer] section\&. +.sp +Added in version 250\&. .RE .SH "[WIREGUARDPEER] SECTION OPTIONS" .PP @@ -1502,6 +1814,8 @@ Sets a Base64 encoded public key calculated by \fBwg pubkey\fR (see \fBwg\fR(8)) from a private key, and usually transmitted out of band to the author of the configuration file\&. This option is mandatory for this section\&. +.sp +Added in version 237\&. .RE .PP \fIPresharedKey=\fR @@ -1513,6 +1827,8 @@ command\&. This option adds an additional layer of symmetric\-key cryptography t with a "0640" file mode\&. +.sp +Added in version 237\&. .RE .PP \fIPresharedKeyFile=\fR @@ -1527,6 +1843,8 @@ with a file mode\&. If the path refers to an \fBAF_UNIX\fR stream socket in the file system a connection is made to it and the key read from it\&. +.sp +Added in version 242\&. .RE .PP \fIAllowedIPs=\fR @@ -1542,6 +1860,8 @@ section on the "\&.network" matching the wireguard interface, or externally to systemd\-networkd\&. +.sp +Added in version 237\&. .RE .PP \fIEndpoint=\fR @@ -1551,11 +1871,15 @@ Sets an endpoint IP address or hostname, followed by a colon, and then a port nu for IPv4 and "[1111:2222::3333]:51820" for IPv6 address\&. This endpoint will be updated automatically once to the most recent source IP address and port of correctly authenticated packets from the peer at configuration time\&. +.sp +Added in version 237\&. .RE .PP \fIPersistentKeepalive=\fR .RS 4 Sets a seconds interval, between 1 and 65535 inclusive, of how often to send an authenticated empty packet to the peer for the purpose of keeping a stateful firewall or NAT mapping valid persistently\&. For example, if the interface very rarely sends traffic, but it might at anytime receive traffic from a peer, and it is behind NAT, the interface might benefit from having a persistent keepalive interval of 25 seconds\&. If set to 0 or "off", this option is disabled\&. By default or when unspecified, this option is off\&. Most users will not need this\&. +.sp +Added in version 237\&. .RE .PP \fIRouteTable=\fR @@ -1568,12 +1892,16 @@ The table identifier for the routes to the addresses specified in the \fIRouteTable=\fR in \fBnetworkd.conf\fR(5), or a number in the range 1\&...4294967295\&. Defaults to unset, and the value specified in the same setting in the [WireGuard] section will be used\&. +.sp +Added in version 250\&. .RE .PP \fIRouteMetric=\fR .RS 4 The priority of the routes to the addresses specified in the \fIAllowedIPs=\fR\&. Takes an integer in the range 0\&...4294967295\&. Defaults to unset, and the value specified in the same setting in the [WireGuard] section will be used\&. +.sp +Added in version 250\&. .RE .SH "[BOND] SECTION OPTIONS" .PP @@ -1591,6 +1919,8 @@ Specifies one of the bonding policies\&. The default is "802\&.3ad", "balance\-tlb", and "balance\-alb"\&. +.sp +Added in version 216\&. .RE .PP \fITransmitHashPolicy=\fR @@ -1601,6 +1931,8 @@ Selects the transmit hash policy to use for slave selection in balance\-xor, 802 "layer2+3", "encap2+3", and "encap3+4"\&. +.sp +Added in version 216\&. .RE .PP \fILACPTransmitRate=\fR @@ -1609,28 +1941,38 @@ Specifies the rate with which link partner transmits Link Aggregation Control Pr "slow", which requests partner to transmit LACPDUs every 30 seconds, and "fast", which requests partner to transmit LACPDUs every second\&. The default value is "slow"\&. +.sp +Added in version 216\&. .RE .PP \fIMIIMonitorSec=\fR .RS 4 Specifies the frequency that Media Independent Interface link monitoring will occur\&. A value of zero disables MII link monitoring\&. This value is rounded down to the nearest millisecond\&. The default value is 0\&. +.sp +Added in version 216\&. .RE .PP \fIUpDelaySec=\fR .RS 4 Specifies the delay before a link is enabled after a link up status has been detected\&. This value is rounded down to a multiple of \fIMIIMonitorSec=\fR\&. The default value is 0\&. +.sp +Added in version 216\&. .RE .PP \fIDownDelaySec=\fR .RS 4 Specifies the delay before a link is disabled after a link down status has been detected\&. This value is rounded down to a multiple of \fIMIIMonitorSec=\fR\&. The default value is 0\&. +.sp +Added in version 216\&. .RE .PP \fILearnPacketIntervalSec=\fR .RS 4 Specifies the number of seconds between instances where the bonding driver sends learning packets to each slave peer switch\&. The valid range is 1\&...0x7fffffff; the default value is 1\&. This option has an effect only for the balance\-tlb and balance\-alb modes\&. +.sp +Added in version 220\&. .RE .PP \fIAdSelect=\fR @@ -1640,21 +1982,29 @@ Specifies the 802\&.3ad aggregation selection logic to use\&. Possible values ar "bandwidth" and "count"\&. +.sp +Added in version 220\&. .RE .PP \fIAdActorSystemPriority=\fR .RS 4 Specifies the 802\&.3ad actor system priority\&. Takes a number in the range 1\&...65535\&. +.sp +Added in version 240\&. .RE .PP \fIAdUserPortKey=\fR .RS 4 Specifies the 802\&.3ad user defined portion of the port key\&. Takes a number in the range 0\&...1023\&. +.sp +Added in version 240\&. .RE .PP \fIAdActorSystem=\fR .RS 4 Specifies the 802\&.3ad system MAC address\&. This cannot be a null or multicast address\&. +.sp +Added in version 240\&. .RE .PP \fIFailOverMACPolicy=\fR @@ -1664,6 +2014,8 @@ Specifies whether the active\-backup mode should set all slaves to the same MAC "active" and "follow"\&. +.sp +Added in version 220\&. .RE .PP \fIARPValidate=\fR @@ -1674,11 +2026,15 @@ Specifies whether or not ARP probes and replies should be validated in any mode "backup" and "all"\&. +.sp +Added in version 220\&. .RE .PP \fIARPIntervalSec=\fR .RS 4 Specifies the ARP link monitoring frequency\&. A value of 0 disables ARP monitoring\&. The default value is 0, and the default unit seconds\&. +.sp +Added in version 220\&. .RE .PP \fIARPIPTargets=\fR @@ -1686,6 +2042,8 @@ Specifies the ARP link monitoring frequency\&. A value of 0 disables ARP monitor Specifies the IP addresses to use as ARP monitoring peers when \fIARPIntervalSec=\fR is greater than 0\&. These are the targets of the ARP request sent to determine the health of the link to the targets\&. Specify these values in IPv4 dotted decimal format\&. At least one IP address must be given for ARP monitoring to function\&. The maximum number of targets that can be specified is 16\&. The default value is no IP addresses\&. +.sp +Added in version 220\&. .RE .PP \fIARPAllTargets=\fR @@ -1696,6 +2054,8 @@ that must be reachable in order for the ARP monitor to consider a slave as being "any" and "all"\&. +.sp +Added in version 220\&. .RE .PP \fIPrimaryReselectPolicy=\fR @@ -1705,36 +2065,50 @@ Specifies the reselection policy for the primary slave\&. This affects how the p "better" and "failure"\&. +.sp +Added in version 220\&. .RE .PP \fIResendIGMP=\fR .RS 4 Specifies the number of IGMP membership reports to be issued after a failover event\&. One membership report is issued immediately after the failover, subsequent packets are sent in each 200ms interval\&. The valid range is 0\&...255\&. Defaults to 1\&. A value of 0 prevents the IGMP membership report from being issued in response to the failover event\&. +.sp +Added in version 220\&. .RE .PP \fIPacketsPerSlave=\fR .RS 4 Specify the number of packets to transmit through a slave before moving to the next one\&. When set to 0, then a slave is chosen at random\&. The valid range is 0\&...65535\&. Defaults to 1\&. This option only has effect when in balance\-rr mode\&. +.sp +Added in version 220\&. .RE .PP \fIGratuitousARP=\fR .RS 4 Specify the number of peer notifications (gratuitous ARPs and unsolicited IPv6 Neighbor Advertisements) to be issued after a failover event\&. As soon as the link is up on the new slave, a peer notification is sent on the bonding device and each VLAN sub\-device\&. This is repeated at each link monitor interval (ARPIntervalSec or MIIMonitorSec, whichever is active) if the number is greater than 1\&. The valid range is 0\&...255\&. The default value is 1\&. These options affect only the active\-backup mode\&. +.sp +Added in version 220\&. .RE .PP \fIAllSlavesActive=\fR .RS 4 Takes a boolean\&. Specifies that duplicate frames (received on inactive ports) should be dropped when false, or delivered when true\&. Normally, bonding will drop duplicate frames (received on inactive ports), which is desirable for most users\&. But there are some times it is nice to allow duplicate frames to be delivered\&. The default value is false (drop duplicate frames received on inactive ports)\&. +.sp +Added in version 220\&. .RE .PP \fIDynamicTransmitLoadBalancing=\fR .RS 4 Takes a boolean\&. Specifies if dynamic shuffling of flows is enabled\&. Applies only for balance\-tlb mode\&. Defaults to unset\&. +.sp +Added in version 240\&. .RE .PP \fIMinLinks=\fR .RS 4 Specifies the minimum number of links that must be active before asserting carrier\&. The default value is 0\&. +.sp +Added in version 220\&. .RE .PP For more detail information see @@ -1746,11 +2120,15 @@ The [Xfrm] section accepts the following keys: \fIInterfaceId=\fR .RS 4 Sets the ID/key of the xfrm interface which needs to be associated with a SA/policy\&. Can be decimal or hexadecimal, valid range is 1\-0xffffffff\&. This is mandatory\&. +.sp +Added in version 243\&. .RE .PP \fIIndependent=\fR .RS 4 Takes a boolean\&. If false (the default), the xfrm interface must have an underlying device which can be used for hardware offloading\&. +.sp +Added in version 243\&. .RE .PP For more detail information see @@ -1764,6 +2142,8 @@ and accepts the following key: \fITable=\fR .RS 4 The numeric routing table identifier\&. This setting is compulsory\&. +.sp +Added in version 243\&. .RE .SH "[BATMANADVANCED] SECTION OPTIONS" .PP @@ -1777,26 +2157,36 @@ Takes one of "off", "server", or "client"\&. A batman\-adv node can either run in server mode (sharing its internet connection with the mesh) or in client mode (searching for the most suitable internet connection in the mesh) or having the gateway support turned off entirely (which is the default setting)\&. +.sp +Added in version 248\&. .RE .PP \fIAggregation=\fR .RS 4 Takes a boolean value\&. Enables or disables aggregation of originator messages\&. Defaults to true\&. +.sp +Added in version 248\&. .RE .PP \fIBridgeLoopAvoidance=\fR .RS 4 Takes a boolean value\&. Enables or disables avoidance of loops on bridges\&. Defaults to true\&. +.sp +Added in version 248\&. .RE .PP \fIDistributedArpTable=\fR .RS 4 Takes a boolean value\&. Enables or disables the distributed ARP table\&. Defaults to true\&. +.sp +Added in version 248\&. .RE .PP \fIFragmentation=\fR .RS 4 Takes a boolean value\&. Enables or disables fragmentation\&. Defaults to true\&. +.sp +Added in version 248\&. .RE .PP \fIHopPenalty=\fR @@ -1804,6 +2194,8 @@ Takes a boolean value\&. Enables or disables fragmentation\&. Defaults to true\& The hop penalty setting allows one to modify \fBbatctl\fR(8) preference for multihop routes vs\&. short routes\&. This integer value is applied to the TQ (Transmit Quality) of each forwarded OGM (Originator Message), thereby propagating the cost of an extra hop (the packet has to be received and retransmitted which costs airtime)\&. A higher hop penalty will make it more unlikely that other nodes will choose this node as intermediate hop towards any given destination\&. The default hop penalty of \*(Aq15\*(Aq is a reasonable value for most setups and probably does not need to be changed\&. However, mobile nodes could choose a value of 255 (maximum value) to avoid being chosen as a router by other nodes\&. The minimum value is 0\&. +.sp +Added in version 248\&. .RE .PP \fIOriginatorIntervalSec=\fR @@ -1811,16 +2203,22 @@ preference for multihop routes vs\&. short routes\&. This integer value is appli The value specifies the interval in seconds, unless another time unit is specified in which batman\-adv floods the network with its protocol information\&. See \fBsystemd.time\fR(7) for more information\&. +.sp +Added in version 248\&. .RE .PP \fIGatewayBandwidthDown=\fR .RS 4 If the node is a server, this parameter is used to inform other nodes in the network about this node\*(Aqs internet connection download bandwidth in bits per second\&. Just enter any number suffixed with K, M, G or T (base 1000) and the batman\-adv module will propagate the entered value in the mesh\&. +.sp +Added in version 248\&. .RE .PP \fIGatewayBandwidthUp=\fR .RS 4 If the node is a server, this parameter is used to inform other nodes in the network about this node\*(Aqs internet connection upload bandwidth in bits per second\&. Just enter any number suffixed with K, M, G or T (base 1000) and the batman\-adv module will propagate the entered value in the mesh\&. +.sp +Added in version 248\&. .RE .PP \fIRoutingAlgorithm=\fR @@ -1833,6 +2231,8 @@ and describes which routing_algo of \fBbatctl\fR(8) to use\&. The algorithm cannot be changed after interface creation\&. Defaults to "batman\-v"\&. +.sp +Added in version 248\&. .RE .SH "[IPOIB] SECTION OPTIONS" .PP @@ -1843,6 +2243,8 @@ and accepts the following keys: \fIPartitionKey=\fR .RS 4 Takes an integer in the range 1\&...0xffff, except for 0x8000\&. Defaults to unset, and the kernel\*(Aqs default is used\&. +.sp +Added in version 250\&. .RE .PP \fIMode=\fR @@ -1857,11 +2259,15 @@ When .sp When "connected", the Infiniband reliable connected (RC) transport is used\&. Connected mode takes advantage of the connected nature of the IB transport and allows an MTU up to the maximal IP packet size of 64K, which reduces the number of IP packets needed for handling large UDP datagrams, TCP segments, etc and increases the performance for large messages\&. +.sp +Added in version 250\&. .RE .PP \fIIgnoreUserspaceMulticastGroup=\fR .RS 4 Takes an boolean value\&. When true, the kernel ignores multicast groups handled by userspace\&. Defaults to unset, and the kernel\*(Aqs default is used\&. +.sp +Added in version 250\&. .RE .SH "[WLAN] SECTION OPTIONS" .PP @@ -1875,6 +2281,8 @@ or "phy0")\&. The list of the physical WLAN devices that exist on the host can be obtained by \fBiw phy\fR command\&. This option is mandatory\&. +.sp +Added in version 251\&. .RE .PP \fIType=\fR @@ -1892,12 +2300,16 @@ Specifies the type of the interface\&. Takes one of the "p2p\-device", "ocb", and "nan"\&. This option is mandatory\&. +.sp +Added in version 251\&. .RE .PP \fIWDS=\fR .RS 4 Enables the Wireless Distribution System (WDS) mode on the interface\&. The mode is also known as the "4 address mode"\&. Takes a boolean value\&. Defaults to unset, and the kernel\*(Aqs default will be used\&. +.sp +Added in version 251\&. .RE .SH "EXAMPLES" .PP @@ -2273,7 +2685,7 @@ System and Service Credentials \%https://systemd.io/CREDENTIALS .RE .IP " 7." 4 -(DOVE) +Distributed Overlay Virtual Ethernet (DOVE) .RS 4 \%https://en.wikipedia.org/wiki/Distributed_Overlay_Virtual_Ethernet .RE diff --git a/upstream/opensuse-tumbleweed/man5/systemd.network.5 b/upstream/opensuse-tumbleweed/man5/systemd.network.5 index f7cae0db..3a1b53f8 100644 --- a/upstream/opensuse-tumbleweed/man5/systemd.network.5 +++ b/upstream/opensuse-tumbleweed/man5/systemd.network.5 @@ -1,5 +1,5 @@ '\" t -.TH "SYSTEMD\&.NETWORK" "5" "" "systemd 254" "systemd.network" +.TH "SYSTEMD\&.NETWORK" "5" "" "systemd 255" "systemd.network" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -42,7 +42,9 @@ and /usr/local/lib/systemd/network, the volatile runtime network directory /run/systemd/network and the local administration network directory -/etc/systemd/network\&. All configuration files are collectively sorted and processed in alphanumeric order, regardless of the directories in which they live\&. However, files with identical filenames replace each other\&. It is recommended that each filename is prefixed with a number (e\&.g\&. +/etc/systemd/network\&. All configuration files are collectively sorted and processed in alphanumeric order, regardless of the directories in which they live\&. However, files with identical filenames replace each other\&. It is recommended that each filename is prefixed with a number smaller than +"70" +(e\&.g\&. 10\-eth0\&.network)\&. Otherwise, the default \&.network files or those generated by @@ -80,6 +82,17 @@ which in turn take precedence over those in .PP The network file contains a [Match] section, which determines if a given network file may be applied to a given interface; and a [Network] section specifying how the interface should be configured\&. The first (in alphanumeric order) of the network files that matches a given interface is applied, all later files are ignored, even if they match as well\&. .PP +Note that any network interfaces that have the +\fIID_NET_MANAGED_BY=\fR +udev property set will never be matched by any \&.network files \(en unless the property\*(Aqs value is the string +"io\&.systemd\&.Network" +\(en even if the [Match] section would otherwise match\&. This may be used to exclude specific network interfaces from +\fBsystemd\-networkd\fR\*(Aqs management, while keeping the [Match] section generic\&. The +\fIID_NET_MANAGED_BY=\fR +property thus declares intended +\fIownership\fR +of the device, and permits ensuring that concurrent network management implementations do not compete for management of specific devices\&. +.PP A network file is said to match a network interface if all matches specified by the [Match] section are satisfied\&. When a network file does not contain valid settings in [Match] section, then the file will match all interfaces and \fBsystemd\-networkd\fR warns about that\&. Hint: to avoid the warning and to make it clear that all interfaces shall be matched, add the following: @@ -106,6 +119,8 @@ Each field must be one byte\&. E\&.g\&. "12:34:56:78:90:ab" or "AA:BB:CC:DD:EE:FF"\&. +.sp +Added in version 250\&. .RE .PP \fBhyphen\-delimited hexadecimal\fR @@ -114,6 +129,8 @@ Each field must be one byte\&. E\&.g\&. "12\-34\-56\-78\-90\-ab" or "AA\-BB\-CC\-DD\-EE\-FF"\&. +.sp +Added in version 250\&. .RE .PP \fBdot\-delimited hexadecimal\fR @@ -122,6 +139,8 @@ Each field must be two bytes\&. E\&.g\&. "1234\&.5678\&.90ab" or "AABB\&.CCDD\&.EEFF"\&. +.sp +Added in version 250\&. .RE .PP \fBIPv4 address format\fR @@ -130,6 +149,8 @@ E\&.g\&. "127\&.0\&.0\&.1" or "192\&.168\&.0\&.1"\&. +.sp +Added in version 250\&. .RE .PP \fBIPv6 address format\fR @@ -138,9 +159,13 @@ E\&.g\&. "2001:0db8:85a3::8a2e:0370:7334" or "::1"\&. +.sp +Added in version 250\&. .RE .sp The total length of each MAC address must be 4 (for IPv4 tunnel), 6 (for Ethernet), 16 (for IPv6 tunnel), or 20 (for InfiniBand)\&. This option may appear more than once, in which case the lists are merged\&. If the empty string is assigned to this option, the list of hardware addresses defined prior to this is reset\&. Defaults to unset\&. +.sp +Added in version 211\&. .RE .PP \fIPermanentMACAddress=\fR @@ -148,12 +173,16 @@ The total length of each MAC address must be 4 (for IPv4 tunnel), 6 (for Etherne A whitespace\-separated list of hardware\*(Aqs permanent addresses\&. While \fIMACAddress=\fR matches the device\*(Aqs current MAC address, this matches the device\*(Aqs permanent MAC address, which may be different from the current one\&. Use full colon\-, hyphen\- or dot\-delimited hexadecimal, or IPv4 or IPv6 address format\&. This option may appear more than once, in which case the lists are merged\&. If the empty string is assigned to this option, the list of hardware addresses defined prior to this is reset\&. Defaults to unset\&. +.sp +Added in version 245\&. .RE .PP \fIPath=\fR .RS 4 A whitespace\-separated list of shell\-style globs matching the persistent path, as exposed by the udev property \fIID_PATH\fR\&. +.sp +Added in version 211\&. .RE .PP \fIDriver=\fR @@ -163,6 +192,8 @@ A whitespace\-separated list of shell\-style globs matching the driver currently of its parent device, or if that is not set, the driver as exposed by \fBethtool \-i\fR of the device itself\&. If the list is prefixed with a "!", the test is inverted\&. +.sp +Added in version 211\&. .RE .PP \fIType=\fR @@ -178,6 +209,8 @@ attribute, or "ARPHRD_" macros in linux/if_arp\&.h, so this is not comprehensive\&. +.sp +Added in version 211\&. .RE .PP \fIKind=\fR @@ -193,6 +226,8 @@ or "veth"\&. Valid kinds are given by netlink\*(Aqs "IFLA_INFO_KIND" attribute, so this is not comprehensive\&. +.sp +Added in version 251\&. .RE .PP \fIProperty=\fR @@ -213,12 +248,16 @@ Property=ID_MODEL_ID=9999 "ID_VENDOR_FROM_DATABASE=vendor name" "KEY=with \e"quo .\} .sp then, the \&.link file matches only when an interface has all the above three properties\&. +.sp +Added in version 243\&. .RE .PP \fIName=\fR .RS 4 A whitespace\-separated list of shell\-style globs matching the device name, as exposed by the udev property "INTERFACE", or device\*(Aqs alternative names\&. If the list is prefixed with a "!", the test is inverted\&. +.sp +Added in version 211\&. .RE .PP \fIWLANInterfaceType=\fR @@ -236,17 +275,23 @@ A whitespace\-separated list of wireless network type\&. Supported values are "p2p\-device", "ocb", and "nan"\&. If the list is prefixed with a "!", the test is inverted\&. +.sp +Added in version 244\&. .RE .PP \fISSID=\fR .RS 4 A whitespace\-separated list of shell\-style globs matching the SSID of the currently connected wireless LAN\&. If the list is prefixed with a "!", the test is inverted\&. +.sp +Added in version 244\&. .RE .PP \fIBSSID=\fR .RS 4 A whitespace\-separated list of hardware address of the currently connected wireless LAN\&. Use full colon\-, hyphen\- or dot\-delimited hexadecimal\&. See the example in \fIMACAddress=\fR\&. This option may appear more than once, in which case the lists are merged\&. If the empty string is assigned to this option, the list is reset\&. +.sp +Added in version 244\&. .RE .PP \fIHost=\fR @@ -256,6 +301,8 @@ Matches against the hostname or machine ID of the host\&. See in \fBsystemd.unit\fR(5) for details\&. When prefixed with an exclamation mark ("!"), the result is negated\&. If an empty string is assigned, the previously assigned value is cleared\&. +.sp +Added in version 211\&. .RE .PP \fIVirtualization=\fR @@ -265,6 +312,8 @@ Checks whether the system is executed in a virtualized environment and optionall in \fBsystemd.unit\fR(5) for details\&. When prefixed with an exclamation mark ("!"), the result is negated\&. If an empty string is assigned, the previously assigned value is cleared\&. +.sp +Added in version 211\&. .RE .PP \fIKernelCommandLine=\fR @@ -274,6 +323,8 @@ Checks whether a specific kernel command line option is set\&. See in \fBsystemd.unit\fR(5) for details\&. When prefixed with an exclamation mark ("!"), the result is negated\&. If an empty string is assigned, the previously assigned value is cleared\&. +.sp +Added in version 211\&. .RE .PP \fIKernelVersion=\fR @@ -284,6 +335,8 @@ Checks whether the kernel version (as reported by in \fBsystemd.unit\fR(5) for details\&. When prefixed with an exclamation mark ("!"), the result is negated\&. If an empty string is assigned, the previously assigned value is cleared\&. +.sp +Added in version 237\&. .RE .PP \fICredential=\fR @@ -293,6 +346,8 @@ systemd\-udevd\&.service service\&. See \m[blue]\fBSystem and Service Credentials\fR\m[]\&\s-2\u[1]\d\s+2 for details\&. When prefixed with an exclamation mark ("!"), the result is negated\&. If an empty string is assigned, the previously assigned value is cleared\&. +.sp +Added in version 252\&. .RE .PP \fIArchitecture=\fR @@ -302,6 +357,8 @@ Checks whether the system is running on a specific architecture\&. See in \fBsystemd.unit\fR(5) for details\&. When prefixed with an exclamation mark ("!"), the result is negated\&. If an empty string is assigned, the previously assigned value is cleared\&. +.sp +Added in version 211\&. .RE .PP \fIFirmware=\fR @@ -311,6 +368,8 @@ Checks whether the system is running on a machine with the specified firmware\&. in \fBsystemd.unit\fR(5) for details\&. When prefixed with an exclamation mark ("!"), the result is negated\&. If an empty string is assigned, the previously assigned value is cleared\&. +.sp +Added in version 249\&. .RE .SH "[LINK] SECTION OPTIONS" .PP @@ -319,6 +378,8 @@ The [Link] section accepts the following keys: \fIMACAddress=\fR .RS 4 The hardware address to set for the device\&. +.sp +Added in version 218\&. .RE .PP \fIMTUBytes=\fR @@ -326,6 +387,8 @@ The hardware address to set for the device\&. The maximum transmission unit in bytes to set for the device\&. The usual suffixes K, M, G, are supported and are understood to the base of 1024\&. .sp Note that if IPv6 is enabled on the interface, and the MTU is chosen below 1280 (the minimum MTU for IPv6) it will automatically be increased to this value\&. +.sp +Added in version 218\&. .RE .PP \fIARP=\fR @@ -333,16 +396,22 @@ Note that if IPv6 is enabled on the interface, and the MTU is chosen below 1280 Takes a boolean\&. If set to true, the ARP (low\-level Address Resolution Protocol) for this interface is enabled\&. When unset, the kernel\*(Aqs default will be used\&. .sp For example, disabling ARP is useful when creating multiple MACVLAN or VLAN virtual interfaces atop a single lower\-level physical interface, which will then only serve as a link/"bridge" device aggregating traffic to the same physical link and not participate in the network otherwise\&. Defaults to unset\&. +.sp +Added in version 232\&. .RE .PP \fIMulticast=\fR .RS 4 Takes a boolean\&. If set to true, the multicast flag on the device is enabled\&. Defaults to unset\&. +.sp +Added in version 239\&. .RE .PP \fIAllMulticast=\fR .RS 4 Takes a boolean\&. If set to true, the driver retrieves all multicast packets from the network\&. This happens when multicast routing is enabled\&. Defaults to unset\&. +.sp +Added in version 239\&. .RE .PP \fIPromiscuous=\fR @@ -354,6 +423,8 @@ If this is set to false for the underlying link of a mode MACVLAN/MACVTAP, the virtual interface will be created with the "nopromisc" flag set\&. +.sp +Added in version 248\&. .RE .PP \fIUnmanaged=\fR @@ -363,11 +434,15 @@ Takes a boolean\&. When "no"\&. .sp This is useful for preventing later matching network files from interfering with certain interfaces that are fully controlled by other applications\&. +.sp +Added in version 233\&. .RE .PP \fIGroup=\fR .RS 4 Link groups are similar to port ranges found in managed switches\&. When network interfaces are added to a numbered group, operations on all the interfaces from that group can be performed at once\&. Takes an unsigned integer in the range 0\&...2147483647\&. Defaults to unset\&. +.sp +Added in version 246\&. .RE .PP \fIRequiredForOnline=\fR @@ -407,6 +482,8 @@ The network will be brought up normally (as configured by \fBsystemd\-networkd\-wait\-online\fR if "RequiredForOnline=no"\&. +.sp +Added in version 236\&. .RE .PP \fIRequiredFamilyForOnline=\fR @@ -417,11 +494,10 @@ Takes an address family\&. When specified, an IP address in the given family is "ipv6", "both", or "any"\&. Defaults to -"any"\&. Note that this option has no effect if -"RequiredForOnline=no", or if -"RequiredForOnline=" -specifies a minimum operational state below -"degraded"\&. +"no"\&. Note that this option has no effect if +"RequiredForOnline=no"\&. +.sp +Added in version 249\&. .RE .PP \fIActivationPolicy=\fR @@ -488,6 +564,8 @@ does not mean the link will never lose carrier\&. The link carrier depends on bo "always\-up", \fIIgnoreCarrierLoss=\fR is forced to true\&. +.sp +Added in version 248\&. .RE .SH "[SR\-IOV] SECTION OPTIONS" .PP @@ -496,16 +574,22 @@ The [SR\-IOV] section accepts the following keys\&. Specify several [SR\-IOV] se \fIVirtualFunction=\fR .RS 4 Specifies a Virtual Function (VF), lightweight PCIe function designed solely to move data in and out\&. Takes an integer in the range 0\&...2147483646\&. This option is compulsory\&. +.sp +Added in version 251\&. .RE .PP \fIVLANId=\fR .RS 4 Specifies VLAN ID of the virtual function\&. Takes an integer in the range 1\&...4095\&. +.sp +Added in version 251\&. .RE .PP \fIQualityOfService=\fR .RS 4 Specifies quality of service of the virtual function\&. Takes an integer in the range 1\&...4294967294\&. +.sp +Added in version 251\&. .RE .PP \fIVLANProtocol=\fR @@ -514,21 +598,29 @@ Specifies VLAN protocol of the virtual function\&. Takes "802\&.1Q" or "802\&.1ad"\&. +.sp +Added in version 251\&. .RE .PP \fIMACSpoofCheck=\fR .RS 4 Takes a boolean\&. Controls the MAC spoof checking\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 251\&. .RE .PP \fIQueryReceiveSideScaling=\fR .RS 4 Takes a boolean\&. Toggle the ability of querying the receive side scaling (RSS) configuration of the virtual function (VF)\&. The VF RSS information like RSS hash key may be considered sensitive on some devices where this information is shared between VF and the physical function (PF)\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 251\&. .RE .PP \fITrust=\fR .RS 4 Takes a boolean\&. Allows one to set trust mode of the virtual function (VF)\&. When set, VF users can set a specific feature which may impact security and/or performance\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 251\&. .RE .PP \fILinkState=\fR @@ -541,11 +633,15 @@ means a reflection of the physical function (PF) link state, lets the VF to communicate with other VFs on this host even if the PF link state is down, "no" causes the hardware to drop any packets sent by the VF\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 251\&. .RE .PP \fIMACAddress=\fR .RS 4 Specifies the MAC address for the virtual function\&. +.sp +Added in version 251\&. .RE .SH "[NETWORK] SECTION OPTIONS" .PP @@ -554,6 +650,8 @@ The [Network] section accepts the following keys: \fIDescription=\fR .RS 4 A description of the device\&. This is only used for presentation purposes\&. +.sp +Added in version 211\&. .RE .PP \fIDHCP=\fR @@ -575,6 +673,8 @@ Furthermore, note that by default the domain name specified through DHCP is not below\&. .sp See the [DHCPv4] or [DHCPv6] sections below for further configuration options for the DHCP client support\&. +.sp +Added in version 211\&. .RE .PP \fIDHCPServer=\fR @@ -582,13 +682,13 @@ See the [DHCPv4] or [DHCPv6] sections below for further configuration options fo Takes a boolean\&. If set to "yes", DHCPv4 server will be started\&. Defaults to "no"\&. Further settings for the DHCP server may be set in the [DHCPServer] section described below\&. +.sp +Added in version 215\&. .RE .PP \fILinkLocalAddressing=\fR .RS 4 -Enables link\-local address autoconfiguration\&. Accepts -\fByes\fR, -\fBno\fR, +Enables link\-local address autoconfiguration\&. Accepts a boolean, \fBipv4\fR, and \fBipv6\fR\&. An IPv6 link\-local address is configured when \fByes\fR @@ -611,6 +711,8 @@ has \fIMode=passthru\fR, or \fBipv6\fR otherwise\&. +.sp +Added in version 219\&. .RE .PP \fIIPv6LinkLocalAddressGenerationMode=\fR @@ -641,6 +743,8 @@ or "ipv6", setting \fIIPv6LinkLocalAddressGenerationMode=none\fR disables to configure an IPv6 link\-local address\&. +.sp +Added in version 246\&. .RE .PP \fIIPv6StableSecretAddress=\fR @@ -653,16 +757,22 @@ is implied\&. If this setting is not specified, and "stable\-privacy" is set to \fIIPv6LinkLocalAddressGenerationMode=\fR, then a stable secret address will be generated from the local machine ID and the interface name\&. +.sp +Added in version 249\&. .RE .PP \fIIPv4LLStartAddress=\fR .RS 4 Specifies the first IPv4 link\-local address to try\&. Takes an IPv4 address for example 169\&.254\&.1\&.2, from the link\-local address range: 169\&.254\&.0\&.0/16 except for 169\&.254\&.0\&.0/24 and 169\&.254\&.255\&.0/24\&. This setting may be useful if the device should always have the same address as long as there is no address conflict\&. When unset, a random address will be automatically selected\&. Defaults to unset\&. +.sp +Added in version 252\&. .RE .PP \fIIPv4LLRoute=\fR .RS 4 Takes a boolean\&. If set to true, sets up the route needed for non\-IPv4LL hosts to communicate with IPv4LL\-only hosts\&. Defaults to false\&. +.sp +Added in version 216\&. .RE .PP \fIDefaultRouteOnDevice=\fR @@ -719,6 +829,8 @@ Table=1234 .if n \{\ .RE .\} +.sp +Added in version 243\&. .RE .PP \fILLMNR=\fR @@ -729,6 +841,8 @@ Takes a boolean or on the link\&. When set to "resolve", only resolution is enabled, but not host registration and announcement\&. Defaults to true\&. This setting is read by \fBsystemd-resolved.service\fR(8)\&. +.sp +Added in version 216\&. .RE .PP \fIMulticastDNS=\fR @@ -739,6 +853,8 @@ Takes a boolean or support on the link\&. When set to "resolve", only resolution is enabled, but not host or service registration and announcement\&. Defaults to false\&. This setting is read by \fBsystemd-resolved.service\fR(8)\&. +.sp +Added in version 229\&. .RE .PP \fIDNSOverTLS=\fR @@ -752,6 +868,8 @@ support on the link\&. When set to \fIDNSOverTLS=\fR option\&. Defaults to unset, and the global setting will be used\&. This setting is read by \fBsystemd-resolved.service\fR(8)\&. +.sp +Added in version 239\&. .RE .PP \fIDNSSEC=\fR @@ -765,12 +883,16 @@ DNS validation support on the link\&. When set to \fIDNSSEC=\fR option\&. Defaults to unset, and the global setting will be used\&. This setting is read by \fBsystemd-resolved.service\fR(8)\&. +.sp +Added in version 229\&. .RE .PP \fIDNSSECNegativeTrustAnchors=\fR .RS 4 A space\-separated list of DNSSEC negative trust anchor domains\&. If specified and DNSSEC is enabled, look\-ups done via the interface\*(Aqs DNS server will be subject to the list of negative trust anchors, and not require authentication for the specified domains, or anything below it\&. Use this to disable DNSSEC authentication for specific private domains, that cannot be proven valid using the Internet DNS hierarchy\&. Defaults to the empty list\&. This setting is read by \fBsystemd-resolved.service\fR(8)\&. +.sp +Added in version 229\&. .RE .PP \fILLDP=\fR @@ -784,6 +906,8 @@ is set only LLDP data of various types of routers is collected and LLDP data abo to query the collected neighbor data\&. LLDP is only available on Ethernet links\&. See \fIEmitLLDP=\fR below for enabling LLDP packet emission from the local system\&. +.sp +Added in version 219\&. .RE .PP \fIEmitLLDP=\fR @@ -805,6 +929,8 @@ permits propagation until a customer bridge is reached\&. For details about thes "nearest\-bridge", the recommended and most restricted level of propagation\&. See \fILLDP=\fR above for an option to enable LLDP reception\&. +.sp +Added in version 230\&. .RE .PP \fIBindCarrier=\fR @@ -815,6 +941,8 @@ This forces \fIActivationPolicy=\fR to be set to "bound"\&. +.sp +Added in version 220\&. .RE .PP \fIAddress=\fR @@ -829,6 +957,8 @@ If the specified address is (for IPv4) or "::" (for IPv6), a new address range of the requested size is automatically allocated from a system\-wide pool of unused ranges\&. Note that the prefix length must be equal or larger than 8 for IPv4, and 64 for IPv6\&. The allocated range is checked against all current network interfaces and all known network configuration files to avoid address range conflicts\&. The default system\-wide pool consists of 192\&.168\&.0\&.0/16, 172\&.16\&.0\&.0/12 and 10\&.0\&.0\&.0/8 for IPv4, and fd00::/8 for IPv6\&. This functionality is useful to manage a large number of dynamically created network interfaces with the same network configuration and automatic address range assignment\&. +.sp +Added in version 211\&. .RE .PP \fIGateway=\fR @@ -837,6 +967,8 @@ The gateway address, which must be in the format described in \fBinet_pton\fR(3)\&. This is a short\-hand for a [Route] section only containing a \fIGateway=\fR key\&. This option may be specified more than once\&. +.sp +Added in version 211\&. .RE .PP \fIDNS=\fR @@ -851,6 +983,8 @@ for IPv4 and "[1111:2222::3333]:9953%ifname#example\&.com" for IPv6\&. If an empty string is assigned, then the all previous assignments are cleared\&. This setting is read by \fBsystemd-resolved.service\fR(8)\&. +.sp +Added in version 211\&. .RE .PP \fIDomains=\fR @@ -870,6 +1004,8 @@ and \fIsearch\fR entries in \fBresolv.conf\fR(5)\&. Domain name routing has no equivalent in the traditional glibc API, which has no concept of domain name servers limited to a specific link\&. +.sp +Added in version 216\&. .RE .PP \fIDNSDefaultRoute=\fR @@ -877,12 +1013,16 @@ entries in Takes a boolean argument\&. If true, this link\*(Aqs configured DNS servers are used for resolving domain names that do not match any link\*(Aqs configured \fIDomains=\fR setting\&. If false, this link\*(Aqs configured DNS servers are never used for such domains, and are exclusively used for resolving names that match at least one of the domains configured on this link\&. If not specified defaults to an automatic mode: queries not matching any link\*(Aqs configured domains will be routed to this link if it has no routing\-only domains configured\&. +.sp +Added in version 240\&. .RE .PP \fINTP=\fR .RS 4 An NTP server address (either an IP address, or a hostname)\&. This option may be specified more than once\&. This setting is read by \fBsystemd-timesyncd.service\fR(8)\&. +.sp +Added in version 216\&. .RE .PP \fIIPForward=\fR @@ -902,6 +1042,8 @@ for details about sysctl options)\&. Defaults to Note: this setting controls a global kernel option, and does so one way only: if a network that has this setting enabled is set up the global setting is turned on\&. However, it is never turned off again, even after all networks with this setting enabled are shut down again\&. .sp To allow IP packet forwarding only between specific network interfaces use a firewall\&. +.sp +Added in version 219\&. .RE .PP \fIIPMasquerade=\fR @@ -923,7 +1065,9 @@ Note\&. Any positive boolean values such as "yes" or "true" -are now deprecated\&. Please use one of the values in the above\&. +are now deprecated\&. Please use one of the values above\&. +.sp +Added in version 219\&. .RE .PP \fIIPv6PrivacyExtensions=\fR @@ -937,6 +1081,8 @@ and "kernel", the kernel\*(Aqs default setting will be left in place\&. When unspecified, the value specified in the same setting in \fBnetworkd.conf\fR(5), which defaults to "no", will be used\&. +.sp +Added in version 222\&. .RE .PP \fIIPv6AcceptRA=\fR @@ -956,38 +1102,68 @@ in the kernel documentation regarding Note that kernel\*(Aqs implementation of the IPv6 RA protocol is always disabled, regardless of this setting\&. If this option is enabled, a userspace implementation of the IPv6 RA protocol is used, and the kernel\*(Aqs own implementation remains disabled, since \fBsystemd\-networkd\fR needs to know all details supplied in the advertisements, and these are not available from the kernel if the kernel\*(Aqs own implementation is used\&. +.sp +Added in version 231\&. .RE .PP \fIIPv6DuplicateAddressDetection=\fR .RS 4 Configures the amount of IPv6 Duplicate Address Detection (DAD) probes to send\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 228\&. .RE .PP \fIIPv6HopLimit=\fR .RS 4 -Configures IPv6 Hop Limit\&. For each router that forwards the packet, the hop limit is decremented by 1\&. When the hop limit field reaches zero, the packet is discarded\&. When unset, the kernel\*(Aqs default will be used\&. +Configures IPv6 Hop Limit\&. Takes an integer in the range 1\&...255\&. For each router that forwards the packet, the hop limit is decremented by 1\&. When the hop limit field reaches zero, the packet is discarded\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 228\&. +.RE +.PP +\fIIPv4ReversePathFilter=\fR +.RS 4 +Configure IPv4 Reverse Path Filtering\&. If enabled, when an IPv4 packet is received, the machine will first check whether the +\fIsource\fR +of the packet would be routed through the interface it came in\&. If there is no route to the source on that interface, the machine will drop the packet\&. Takes one of +"no", +"strict", or +"loose"\&. When +"no", no source validation will be done\&. When +"strict", mode each incoming packet is tested against the FIB and if the incoming interface is not the best reverse path, the packet check will fail\&. By default failed packets are discarded\&. When +"loose", mode each incoming packet\*(Aqs source address is tested against the FIB\&. The packet is dropped only if the source address is not reachable via any interface on that router\&. See +\m[blue]\fBRFC 3704\fR\m[]\&\s-2\u[9]\d\s+2\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 255\&. .RE .PP \fIIPv4AcceptLocal=\fR .RS 4 Takes a boolean\&. Accept packets with local source addresses\&. In combination with suitable routing, this can be used to direct packets between two local interfaces over the wire and have them accepted properly\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 246\&. .RE .PP \fIIPv4RouteLocalnet=\fR .RS 4 Takes a boolean\&. When true, the kernel does not consider loopback addresses as martian source or destination while routing\&. This enables the use of 127\&.0\&.0\&.0/8 for local routing purposes\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 248\&. .RE .PP \fIIPv4ProxyARP=\fR .RS 4 Takes a boolean\&. Configures proxy ARP for IPv4\&. Proxy ARP is the technique in which one host, usually a router, answers ARP requests intended for another machine\&. By "faking" its identity, the router accepts responsibility for routing packets to the "real" destination\&. See \m[blue]\fBRFC 1027\fR\m[]\&\s-2\u[9]\d\s+2\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 233\&. .RE .PP \fIIPv6ProxyNDP=\fR .RS 4 Takes a boolean\&. Configures proxy NDP for IPv6\&. Proxy NDP (Neighbor Discovery Protocol) is a technique for IPv6 to allow routing of addresses to a different destination when peers expect them to be present on a certain physical link\&. In this case a router answers Neighbour Advertisement messages intended for another machine by offering its own MAC address as destination\&. Unlike proxy ARP for IPv4, it is not enabled globally, but will only send Neighbour Advertisement messages for addresses in the IPv6 neighbor proxy table, which can also be shown by \fBip \-6 neighbour show proxy\fR\&. systemd\-networkd will control the per\-interface `proxy_ndp` switch for each configured interface depending on this option\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 234\&. .RE .PP \fIIPv6ProxyNDPAddress=\fR @@ -999,6 +1175,8 @@ entries to the kernel\*(Aqs IPv6 neighbor proxy table\&. This setting implies but has no effect if \fIIPv6ProxyNDP=\fR has been set to false\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 233\&. .RE .PP \fIIPv6SendRA=\fR @@ -1008,6 +1186,8 @@ Whether to enable or disable Router Advertisement sending on a link\&. Takes a b is enabled, then the delegated prefixes are also distributed\&. See \fIDHCPPrefixDelegation=\fR setting and the [IPv6SendRA], [IPv6Prefix], [IPv6RoutePrefix], and [DHCPPrefixDelegation] sections for more configuration options\&. +.sp +Added in version 247\&. .RE .PP \fIDHCPPrefixDelegation=\fR @@ -1015,11 +1195,15 @@ setting and the [IPv6SendRA], [IPv6Prefix], [IPv6RoutePrefix], and [DHCPPrefixDe Takes a boolean value\&. When enabled, requests subnet prefixes on another link via the DHCPv6 protocol or via the 6RD option in the DHCPv4 protocol\&. An address within each delegated prefix will be assigned, and the prefixes will be announced through IPv6 Router Advertisement if \fIIPv6SendRA=\fR is enabled\&. This behaviour can be configured in the [DHCPPrefixDelegation] section\&. Defaults to disabled\&. +.sp +Added in version 250\&. .RE .PP \fIIPv6MTUBytes=\fR .RS 4 Configures IPv6 maximum transmission unit (MTU)\&. An integer greater than or equal to 1280 bytes\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 239\&. .RE .PP \fIKeepMaster=\fR @@ -1031,18 +1215,24 @@ Takes a boolean value\&. When enabled, the current master interface index will n \fIVRF=\fR settings are ignored\&. This may be useful when a netdev with a master interface is created by another program, e\&.g\&. \fBsystemd-nspawn\fR(1)\&. Defaults to false\&. +.sp +Added in version 250\&. .RE .PP \fIBatmanAdvanced=\fR, \fIBond=\fR, \fIBridge=\fR, \fIVRF=\fR .RS 4 The name of the B\&.A\&.T\&.M\&.A\&.N\&. Advanced, bond, bridge, or VRF interface to add the link to\&. See \fBsystemd.netdev\fR(5)\&. +.sp +Added in version 211\&. .RE .PP \fIIPoIB=\fR, \fIIPVLAN=\fR, \fIIPVTAP=\fR, \fIMACsec=\fR, \fIMACVLAN=\fR, \fIMACVTAP=\fR, \fITunnel=\fR, \fIVLAN=\fR, \fIVXLAN=\fR, \fIXfrm=\fR .RS 4 The name of an IPoIB, IPVLAN, IPVTAP, MACsec, MACVLAN, MACVTAP, tunnel, VLAN, VXLAN, or Xfrm to be created on the link\&. See \fBsystemd.netdev\fR(5)\&. This option may be specified more than once\&. +.sp +Added in version 211\&. .RE .PP \fIActiveSlave=\fR @@ -1053,6 +1243,8 @@ option is only valid for following modes: "active\-backup", "balance\-alb", and "balance\-tlb"\&. Defaults to false\&. +.sp +Added in version 235\&. .RE .PP \fIPrimarySlave=\fR @@ -1063,6 +1255,8 @@ option is only valid for following modes: "active\-backup", "balance\-alb", and "balance\-tlb"\&. Defaults to false\&. +.sp +Added in version 235\&. .RE .PP \fIConfigureWithoutCarrier=\fR @@ -1070,6 +1264,8 @@ option is only valid for following modes: Takes a boolean\&. Allows networkd to configure a specific link even if it has no carrier\&. Defaults to false\&. If enabled, and the \fIIgnoreCarrierLoss=\fR setting is not explicitly set, then it is enabled as well\&. +.sp +Added in version 235\&. .RE .PP \fIIgnoreCarrierLoss=\fR @@ -1131,6 +1327,8 @@ in the [DHCPv4] section enabled, defaults to 5 seconds\&. Otherwise, defaults to is set to "always\-up", this is forced to "yes", and ignored any user specified values\&. +.sp +Added in version 242\&. .RE .PP \fIKeepConfiguration=\fR @@ -1162,6 +1360,8 @@ is running in initrd, when the root filesystem is a network filesystem, and "no" otherwise\&. +.sp +Added in version 243\&. .RE .SH "[ADDRESS] SECTION OPTIONS" .PP @@ -1172,6 +1372,8 @@ An [Address] section accepts the following keys\&. Specify several [Address] sec As in the [Network] section\&. This setting is mandatory\&. Each [Address] section can contain one \fIAddress=\fR setting\&. +.sp +Added in version 211\&. .RE .PP \fIPeer=\fR @@ -1179,6 +1381,8 @@ setting\&. The peer address in a point\-to\-point connection\&. Accepts the same format as the \fIAddress=\fR setting\&. +.sp +Added in version 216\&. .RE .PP \fIBroadcast=\fR @@ -1187,11 +1391,15 @@ Takes an IPv4 address or boolean value\&. The address must be in the format desc \fBinet_pton\fR(3)\&. If set to true, then the IPv4 broadcast address will be derived from the \fIAddress=\fR setting\&. If set to false, then the broadcast address will not be set\&. Defaults to true, except for wireguard interfaces, where it default to false\&. +.sp +Added in version 211\&. .RE .PP \fILabel=\fR .RS 4 Specifies the label for the IPv4 address\&. The label must be a 7\-bit ASCII string with a length of 1\&...15 characters\&. Defaults to unset\&. +.sp +Added in version 211\&. .RE .PP \fIPreferredLifetime=\fR @@ -1202,6 +1410,8 @@ Allows the default "preferred lifetime" of the address to be overridden\&. Only "0", which means that the address is considered immediately "expired" and will not be used, unless explicitly requested\&. A setting of \fBPreferredLifetime=0\fR is useful for addresses which are added to be used only by a specific application, which is then configured to use them explicitly\&. +.sp +Added in version 230\&. .RE .PP \fIScope=\fR @@ -1213,7 +1423,9 @@ The scope of the address, which can be (only valid on this device, will not traverse a gateway) or "host" (only valid within the device itself, e\&.g\&. 127\&.0\&.0\&.1) or an integer in the range 0\&...255\&. Defaults to -"global"\&. +"global"\&. IPv4 only \- IPv6 scope is automatically assigned by the kernel and cannot be set manually\&. +.sp +Added in version 235\&. .RE .PP \fIRouteMetric=\fR @@ -1221,12 +1433,16 @@ The scope of the address, which can be The metric of the prefix route, which is pointing to the subnet of the configured IP address, taking the configured prefix length into account\&. Takes an unsigned integer in the range 0\&...4294967295\&. When unset or set to 0, the kernel\*(Aqs default value is used\&. This setting will be ignored when \fIAddPrefixRoute=\fR is false\&. +.sp +Added in version 246\&. .RE .PP \fIHomeAddress=\fR .RS 4 Takes a boolean\&. Designates this address the "home address" as defined in \m[blue]\fBRFC 6275\fR\m[]\&\s-2\u[10]\d\s+2\&. Supported only on IPv6\&. Defaults to false\&. +.sp +Added in version 232\&. .RE .PP \fIDuplicateAddressDetection=\fR @@ -1246,17 +1462,23 @@ for IPv4 link\-local addresses, for IPv6 addresses, and "none" otherwise\&. +.sp +Added in version 232\&. .RE .PP \fIManageTemporaryAddress=\fR .RS 4 Takes a boolean\&. If true the kernel manage temporary addresses created from this one as template on behalf of Privacy Extensions \m[blue]\fBRFC 3041\fR\m[]\&\s-2\u[13]\d\s+2\&. For this to become active, the use_tempaddr sysctl setting has to be set to a value greater than zero\&. The given address needs to have a prefix length of 64\&. This flag allows using privacy extensions in a manually configured network, just like if stateless auto\-configuration was active\&. Defaults to false\&. +.sp +Added in version 232\&. .RE .PP \fIAddPrefixRoute=\fR .RS 4 Takes a boolean\&. When true, the prefix route for the address is automatically added\&. Defaults to true\&. +.sp +Added in version 245\&. .RE .PP \fIAutoJoin=\fR @@ -1271,6 +1493,8 @@ command with option "autojoin" we can get similar functionality for openvswitch (OVS) vxlan interfaces as well as other tunneling mechanisms that need to receive multicast traffic\&. Defaults to "no"\&. +.sp +Added in version 232\&. .RE .PP \fINetLabel=\fR\fIlabel\fR @@ -1341,6 +1565,113 @@ The effect of the above configuration and rules (in absence of other rules as ma "my_server_t" (and nothing else) to receive data from local subnet 10\&.0\&.0\&.0/8 of interface "eth0"\&. +.sp +Added in version 252\&. +.RE +.PP +\fINFTSet=\fR\fIsource\fR:\fIfamily\fR:\fItable\fR:\fIset\fR +.RS 4 +This setting provides a method for integrating network configuration into firewall rules with +\m[blue]\fBNFT\fR\m[]\&\s-2\u[17]\d\s+2 +sets\&. The benefit of using the setting is that static network configuration (or dynamically obtained network addresses, see similar directives in other sections) can be used in firewall rules with the indirection of NFT set types\&. For example, access could be granted for hosts in the local subnetwork only\&. Firewall rules using IP address of an interface are also instantly updated when the network configuration changes, for example via DHCP\&. +.sp +This option expects a whitespace separated list of NFT set definitions\&. Each definition consists of a colon\-separated tuple of source type (one of +"address", +"prefix" +or +"ifindex"), NFT address family (one of +"arp", +"bridge", +"inet", +"ip", +"ip6", or +"netdev"), table name and set name\&. The names of tables and sets must conform to lexical restrictions of NFT table names\&. The type of the element used in the NFT filter must match the type implied by the directive ("address", +"prefix" +or +"ifindex") and address type (IPv4 or IPv6) as shown in the table below\&. +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.B Table\ \&1.\ \&Defined \fIsource type\fR values +.TS +allbox tab(:); +lB lB lB. +T{ +Source type +T}:T{ +Description +T}:T{ +Corresponding NFT type name +T} +.T& +l l l +l l l +l l l. +T{ +"address" +T}:T{ +host IP address +T}:T{ +"ipv4_addr" or "ipv6_addr" +T} +T{ +"prefix" +T}:T{ +network prefix +T}:T{ +"ipv4_addr" or "ipv6_addr", with "flags interval" +T} +T{ +"ifindex" +T}:T{ +interface index +T}:T{ +"iface_index" +T} +.TE +.sp 1 +When an interface is configured with IP addresses, the addresses, subnetwork masks or interface index will be appended to the NFT sets\&. The information will be removed when the interface is deconfigured\&. +\fBsystemd\-networkd\fR +only inserts elements to (or removes from) the sets, so the related NFT rules, tables and sets must be prepared elsewhere in advance\&. Failures to manage the sets will be ignored\&. +.sp +Example: +.sp +.if n \{\ +.RS 4 +.\} +.nf +[Address] +NFTSet=prefix:netdev:filter:eth_ipv4_prefix +.fi +.if n \{\ +.RE +.\} +.sp +Corresponding NFT rules: +.sp +.if n \{\ +.RS 4 +.\} +.nf +table netdev filter { + set eth_ipv4_prefix { + type ipv4_addr + flags interval + } + chain eth_ingress { + type filter hook ingress device "eth0" priority filter; policy drop; + ip daddr != @eth_ipv4_prefix drop + accept + } +} +.fi +.if n \{\ +.RE +.\} +.sp +Added in version 255\&. .RE .SH "[NEIGHBOR] SECTION OPTIONS" .PP @@ -1349,20 +1680,26 @@ A [Neighbor] section accepts the following keys\&. The neighbor section adds a p \fIAddress=\fR .RS 4 The IP address of the neighbor\&. +.sp +Added in version 240\&. .RE .PP \fILinkLayerAddress=\fR .RS 4 The link layer address (MAC address or IP address) of the neighbor\&. +.sp +Added in version 243\&. .RE .SH "[IPV6ADDRESSLABEL] SECTION OPTIONS" .PP An [IPv6AddressLabel] section accepts the following keys\&. Specify several [IPv6AddressLabel] sections to configure several address labels\&. IPv6 address labels are used for address selection\&. See -\m[blue]\fBRFC 3484\fR\m[]\&\s-2\u[17]\d\s+2\&. Precedence is managed by userspace, and only the label itself is stored in the kernel\&. +\m[blue]\fBRFC 3484\fR\m[]\&\s-2\u[18]\d\s+2\&. Precedence is managed by userspace, and only the label itself is stored in the kernel\&. .PP \fILabel=\fR .RS 4 The label for the prefix, an unsigned integer in the range 0\&...4294967294\&. 0xffffffff is reserved\&. This setting is mandatory\&. +.sp +Added in version 234\&. .RE .PP \fIPrefix=\fR @@ -1370,6 +1707,8 @@ The label for the prefix, an unsigned integer in the range 0\&...4294967294\&. 0 IPv6 prefix is an address with a prefix length, separated by a slash "/" character\&. This setting is mandatory\&. +.sp +Added in version 234\&. .RE .SH "[ROUTINGPOLICYRULE] SECTION OPTIONS" .PP @@ -1378,26 +1717,34 @@ An [RoutingPolicyRule] section accepts the following settings\&. Specify several \fITypeOfService=\fR .RS 4 This specifies the Type of Service (ToS) field of packets to match; it takes an unsigned integer in the range 0\&...255\&. The field can be used to specify precedence (the first 3 bits) and ToS (the next 3 bits)\&. The field can be also used to specify Differentiated Services Code Point (DSCP) (the first 6 bits) and Explicit Congestion Notification (ECN) (the last 2 bits)\&. See -\m[blue]\fBType of Service\fR\m[]\&\s-2\u[18]\d\s+2 +\m[blue]\fBType of Service\fR\m[]\&\s-2\u[19]\d\s+2 and -\m[blue]\fBDifferentiated services\fR\m[]\&\s-2\u[19]\d\s+2 +\m[blue]\fBDifferentiated services\fR\m[]\&\s-2\u[20]\d\s+2 for more details\&. +.sp +Added in version 235\&. .RE .PP \fIFrom=\fR .RS 4 Specifies the source address prefix to match\&. Possibly followed by a slash and the prefix length\&. +.sp +Added in version 235\&. .RE .PP \fITo=\fR .RS 4 Specifies the destination address prefix to match\&. Possibly followed by a slash and the prefix length\&. +.sp +Added in version 235\&. .RE .PP \fIFirewallMark=\fR .RS 4 Specifies the iptables firewall mark value to match (a number in the range 1\&...4294967295)\&. Optionally, the firewall mask (also a number between 1\&...4294967295) can be suffixed with a slash ("/"), e\&.g\&., "7/255"\&. +.sp +Added in version 235\&. .RE .PP \fITable=\fR @@ -1410,6 +1757,8 @@ Specifies the routing table identifier to look up if the rule selector matches\& in \fBnetworkd.conf\fR(5), or a number between 1 and 4294967295\&. Defaults to "main"\&. +.sp +Added in version 235\&. .RE .PP \fIPriority=\fR @@ -1417,26 +1766,36 @@ in Specifies the priority of this rule\&. \fIPriority=\fR is an integer in the range 0\&...4294967295\&. Higher number means lower priority, and rules get processed in order of increasing number\&. Defaults to unset, and the kernel will pick a value dynamically\&. +.sp +Added in version 235\&. .RE .PP \fIIncomingInterface=\fR .RS 4 Specifies incoming device to match\&. If the interface is loopback, the rule only matches packets originating from this host\&. +.sp +Added in version 236\&. .RE .PP \fIOutgoingInterface=\fR .RS 4 Specifies the outgoing device to match\&. The outgoing interface is only available for packets originating from local sockets that are bound to a device\&. +.sp +Added in version 236\&. .RE .PP \fISourcePort=\fR .RS 4 Specifies the source IP port or IP port range match in forwarding information base (FIB) rules\&. A port range is specified by the lower and upper port separated by a dash\&. Defaults to unset\&. +.sp +Added in version 240\&. .RE .PP \fIDestinationPort=\fR .RS 4 Specifies the destination IP port or IP port range match in forwarding information base (FIB) rules\&. A port range is specified by the lower and upper port separated by a dash\&. Defaults to unset\&. +.sp +Added in version 240\&. .RE .PP \fIIPProtocol=\fR @@ -1453,11 +1812,15 @@ or "17" for "udp"\&. Defaults to unset\&. +.sp +Added in version 240\&. .RE .PP \fIInvertRule=\fR .RS 4 A boolean\&. Specifies whether the rule is to be inverted\&. Defaults to false\&. +.sp +Added in version 240\&. .RE .PP \fIFamily=\fR @@ -1474,11 +1837,15 @@ nor \fIFrom=\fR are specified, then defaults to "ipv4"\&. +.sp +Added in version 243\&. .RE .PP \fIUser=\fR .RS 4 Takes a username, a user ID, or a range of user IDs separated by a dash\&. Defaults to unset\&. +.sp +Added in version 245\&. .RE .PP \fISuppressPrefixLength=\fR @@ -1488,6 +1855,8 @@ Takes a number in the range 0\&...128 and rejects routing decisions that have a prefix length of \fIN\fR or less\&. Defaults to unset\&. +.sp +Added in version 245\&. .RE .PP \fISuppressInterfaceGroup=\fR @@ -1496,6 +1865,8 @@ Takes an integer in the range 0\&...2147483647 and rejects routing decisions tha \fBsuppress_ifgroup\fR in \fBip rule\fR\&. Defaults to unset\&. +.sp +Added in version 250\&. .RE .PP \fIType=\fR @@ -1505,6 +1876,8 @@ Specifies Routing Policy Database (RPDB) rule type\&. Takes one of "unreachable" or "prohibit"\&. +.sp +Added in version 248\&. .RE .SH "[NEXTHOP] SECTION OPTIONS" .PP @@ -1513,11 +1886,15 @@ The [NextHop] section is used to manipulate entries in the kernel\*(Aqs "nexthop \fIId=\fR .RS 4 The id of the next hop\&. Takes an integer in the range 1\&...4294967295\&. If unspecified, then automatically chosen by kernel\&. +.sp +Added in version 244\&. .RE .PP \fIGateway=\fR .RS 4 As in the [Network] section\&. +.sp +Added in version 244\&. .RE .PP \fIFamily=\fR @@ -1530,12 +1907,16 @@ or \fIGateway=\fR is not specified, then defaults to "ipv4"\&. +.sp +Added in version 248\&. .RE .PP \fIOnLink=\fR .RS 4 Takes a boolean\&. If set to true, the kernel does not have to check if the gateway is reachable directly by the current machine (i\&.e\&., attached to the local network), so that we can insert the nexthop in the kernel table without it being complained about\&. Defaults to "no"\&. +.sp +Added in version 248\&. .RE .PP \fIBlackhole=\fR @@ -1544,6 +1925,8 @@ Takes a boolean\&. If enabled, packets to the corresponding routes are discarded \fIGateway=\fR cannot be specified\&. Defaults to "no"\&. +.sp +Added in version 248\&. .RE .PP \fIGroup=\fR @@ -1552,6 +1935,8 @@ Takes a whitespace separated list of nexthop IDs\&. Each ID must be in the range \fIGateway=\fR, \fIFamily=\fR, \fIBlackhole=\fR\&. This setting can be specified multiple times\&. If an empty string is assigned, then the all previous assignments are cleared\&. Defaults to unset\&. +.sp +Added in version 249\&. .RE .SH "[ROUTE] SECTION OPTIONS" .PP @@ -1567,33 +1952,43 @@ and or "_ipv6ra" is set, then the gateway address provided by DHCPv4 or IPv6 RA is used\&. +.sp +Added in version 211\&. .RE .PP \fIGatewayOnLink=\fR .RS 4 Takes a boolean\&. If set to true, the kernel does not have to check if the gateway is reachable directly by the current machine (i\&.e\&., attached to the local network), so that we can insert the route in the kernel table without it being complained about\&. Defaults to "no"\&. +.sp +Added in version 234\&. .RE .PP \fIDestination=\fR .RS 4 The destination prefix of the route\&. Possibly followed by a slash and the prefix length\&. If omitted, a full\-length host route is assumed\&. +.sp +Added in version 211\&. .RE .PP \fISource=\fR .RS 4 The source prefix of the route\&. Possibly followed by a slash and the prefix length\&. If omitted, a full\-length host route is assumed\&. +.sp +Added in version 218\&. .RE .PP \fIMetric=\fR .RS 4 The metric of the route\&. Takes an unsigned integer in the range 0\&...4294967295\&. Defaults to unset, and the kernel\*(Aqs default will be used\&. +.sp +Added in version 216\&. .RE .PP \fIIPv6Preference=\fR .RS 4 Specifies the route preference as defined in -\m[blue]\fBRFC 4191\fR\m[]\&\s-2\u[20]\d\s+2 +\m[blue]\fBRFC 4191\fR\m[]\&\s-2\u[21]\d\s+2 for Router Discovery messages\&. Which can be one of "low" the route has a lowest priority, @@ -1601,6 +1996,8 @@ the route has a lowest priority, the route has a default priority or "high" the route has a highest priority\&. +.sp +Added in version 234\&. .RE .PP \fIScope=\fR @@ -1689,12 +2086,16 @@ is "anycast", or "unicast"\&. In other cases, defaults to "global"\&. The value is not used for IPv6\&. +.sp +Added in version 219\&. .RE .PP \fIPreferredSource=\fR .RS 4 The preferred source address of the route\&. The address must be in the format described in \fBinet_pton\fR(3)\&. +.sp +Added in version 227\&. .RE .PP \fITable=\fR @@ -1716,6 +2117,16 @@ is "local" is used\&. In other cases, defaults to "main"\&. +.sp +Added in version 230\&. +.RE +.PP +\fIHopLimit=\fR +.RS 4 +Configures per route hop limit\&. Takes an integer in the range 1\&...255\&. See also +\fIIPv6HopLimit=\fR\&. +.sp +Added in version 255\&. .RE .PP \fIProtocol=\fR @@ -1728,6 +2139,8 @@ The protocol identifier for the route\&. Takes a number between 0 and 255 or the and "dhcp"\&. Defaults to "static"\&. +.sp +Added in version 234\&. .RE .PP \fIType=\fR @@ -1750,41 +2163,57 @@ Specifies the type for the route\&. Takes one of "prohibit", packets to the defined route are discarded and the ICMP message "Communication Administratively Prohibited" is generated\&. If "throw", route lookup in the current routing table will fail and the route selection process will return to Routing Policy Database (RPDB)\&. Defaults to "unicast"\&. +.sp +Added in version 235\&. .RE .PP \fIInitialCongestionWindow=\fR .RS 4 The TCP initial congestion window is used during the start of a TCP connection\&. During the start of a TCP session, when a client requests a resource, the server\*(Aqs initial congestion window determines how many packets will be sent during the initial burst of data without waiting for acknowledgement\&. Takes a number between 1 and 1023\&. Note that 100 is considered an extremely large value for this option\&. When unset, the kernel\*(Aqs default (typically 10) will be used\&. +.sp +Added in version 237\&. .RE .PP \fIInitialAdvertisedReceiveWindow=\fR .RS 4 The TCP initial advertised receive window is the amount of receive data (in bytes) that can initially be buffered at one time on a connection\&. The sending host can send only that amount of data before waiting for an acknowledgment and window update from the receiving host\&. Takes a number between 1 and 1023\&. Note that 100 is considered an extremely large value for this option\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 237\&. .RE .PP \fIQuickAck=\fR .RS 4 Takes a boolean\&. When true, the TCP quick ACK mode for the route is enabled\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 237\&. .RE .PP \fIFastOpenNoCookie=\fR .RS 4 Takes a boolean\&. When true enables TCP fastopen without a cookie on a per\-route basis\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 243\&. .RE .PP \fITTLPropagate=\fR .RS 4 Takes a boolean\&. When true enables TTL propagation at Label Switched Path (LSP) egress\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 243\&. .RE .PP \fIMTUBytes=\fR .RS 4 The maximum transmission unit in bytes to set for the route\&. The usual suffixes K, M, G, are supported and are understood to the base of 1024\&. +.sp +Added in version 239\&. .RE .PP \fITCPAdvertisedMaximumSegmentSize=\fR .RS 4 Specifies the Path MSS (in bytes) hints given on TCP layer\&. The usual suffixes K, M, G, are supported and are understood to the base of 1024\&. An unsigned integer in the range 1\&...4294967294\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 248\&. .RE .PP \fITCPCongestionControlAlgorithm=\fR @@ -1793,17 +2222,30 @@ Specifies the TCP congestion control algorithm for the route\&. Takes a name of "bbr", "dctcp", or "vegas"\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 252\&. +.RE +.PP +\fITCPRetransmissionTimeoutSec=\fR +.RS 4 +Specifies the TCP Retransmission Timeout (RTO) for the route\&. Takes time values in seconds\&. This value specifies the timeout of an alive TCP connection, when retransmissions remain unacknowledged\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 255\&. .RE .PP \fIMultiPathRoute=\fR\fI\fIaddress\fR\fR\fI[@\fR\fI\fIname\fR\fR\fI] [\fR\fI\fIweight\fR\fR\fI]\fR .RS 4 Configures multipath route\&. Multipath routing is the technique of using multiple alternative paths through a network\&. Takes gateway address\&. Optionally, takes a network interface name or index separated with "@", and a weight in 1\&.\&.256 for this multipath route separated with whitespace\&. This setting can be specified multiple times\&. If an empty string is assigned, then the all previous assignments are cleared\&. +.sp +Added in version 245\&. .RE .PP \fINextHop=\fR .RS 4 Specifies the nexthop id\&. Takes an unsigned integer in the range 1\&...4294967295\&. If set, the corresponding [NextHop] section must be configured\&. Defaults to unset\&. +.sp +Added in version 248\&. .RE .SH "[DHCPV4] SECTION OPTIONS" .PP @@ -1811,46 +2253,67 @@ The [DHCPv4] section configures the DHCPv4 client, if it is enabled with the \fIDHCP=\fR setting described above: .PP +\fIRequestAddress=\fR +.RS 4 +Takes an IPv4 address\&. When specified, the Requested IP Address option (option code 50) is added with it to the initial DHCPDISCOVER message sent by the DHCP client\&. Defaults to unset, and an already assigned dynamic address to the interface is automatically picked\&. +.sp +Added in version 255\&. +.RE +.PP \fISendHostname=\fR .RS 4 When true (the default), the machine\*(Aqs hostname (or the value specified with \fIHostname=\fR, described below) will be sent to the DHCP server\&. Note that the hostname must consist only of 7\-bit ASCII lower\-case characters and no spaces or dots, and be formatted as a valid DNS domain name\&. Otherwise, the hostname is not sent even if this option is true\&. +.sp +Added in version 215\&. .RE .PP \fIHostname=\fR .RS 4 Use this value for the hostname which is sent to the DHCP server, instead of machine\*(Aqs hostname\&. Note that the specified hostname must consist only of 7\-bit ASCII lower\-case characters and no spaces or dots, and be formatted as a valid DNS domain name\&. +.sp +Added in version 223\&. .RE .PP \fIMUDURL=\fR .RS 4 When configured, the specified Manufacturer Usage Description (MUD) URL will be sent to the DHCPv4 server\&. Takes a URL of length up to 255 characters\&. A superficial verification that the string is a valid URL will be performed\&. DHCPv4 clients are intended to have at most one MUD URL associated with them\&. See -\m[blue]\fBRFC 8520\fR\m[]\&\s-2\u[21]\d\s+2\&. +\m[blue]\fBRFC 8520\fR\m[]\&\s-2\u[22]\d\s+2\&. .sp MUD is an embedded software standard defined by the IETF that allows IoT device makers to advertise device specifications, including the intended communication patterns for their device when it connects to the network\&. The network can then use this to author a context\-specific access policy, so the device functions only within those parameters\&. +.sp +Added in version 246\&. .RE .PP \fIClientIdentifier=\fR .RS 4 The DHCPv4 client identifier to use\&. Takes one of -\fBmac\fR, -\fBduid\fR +\fBmac\fR or -\fBduid\-only\fR\&. If set to +\fBduid\fR\&. If set to \fBmac\fR, the MAC address of the link is used\&. If set to -\fBduid\fR, an RFC4361\-compliant Client ID, which is the combination of IAID and DUID (see below), is used\&. If set to -\fBduid\-only\fR, only DUID is used, this may not be RFC compliant, but some setups may require to use this\&. Defaults to +\fBduid\fR, an RFC4361\-compliant Client ID, which is the combination of IAID and DUID, is used\&. IAID can be configured by +\fIIAID=\fR\&. DUID can be configured by +\fIDUIDType=\fR +and +\fIDUIDRawData=\fR\&. Defaults to \fBduid\fR\&. +.sp +Added in version 220\&. .RE .PP \fIVendorClassIdentifier=\fR .RS 4 The vendor class identifier used to identify vendor type and configuration\&. +.sp +Added in version 216\&. .RE .PP \fIUserClass=\fR .RS 4 A DHCPv4 client can use UserClass option to identify the type or category of user or applications it represents\&. The information contained in this option is a string that represents the user class of which the client is a member\&. Each class sets an identifying string of information to be used by the DHCP service to classify clients\&. Takes a whitespace\-separated list of strings\&. +.sp +Added in version 239\&. .RE .PP \fIDUIDType=\fR @@ -1860,6 +2323,8 @@ Override the global setting for this network\&. See \fBnetworkd.conf\fR(5) for a description of possible values\&. +.sp +Added in version 230\&. .RE .PP \fIDUIDRawData=\fR @@ -1869,17 +2334,36 @@ Override the global setting for this network\&. See \fBnetworkd.conf\fR(5) for a description of possible values\&. +.sp +Added in version 230\&. .RE .PP \fIIAID=\fR .RS 4 The DHCP Identity Association Identifier (IAID) for the interface, a 32\-bit unsigned integer\&. +.sp +Added in version 230\&. +.RE +.PP +\fIRapidCommit=\fR +.RS 4 +Takes a boolean\&. The DHCPv4 client can obtain configuration parameters from a DHCPv4 server through a rapid two\-message exchange (discover and ack)\&. When the rapid commit option is set by both the DHCPv4 client and the DHCPv4 server, the two\-message exchange is used\&. Otherwise, the four\-message exchange (discover, offer, request, and ack) is used\&. The two\-message exchange provides faster client configuration\&. See +\m[blue]\fBRFC 4039\fR\m[]\&\s-2\u[23]\d\s+2 +for details\&. Defaults to true when +\fIAnonymize=no\fR +and neither +\fIAllowList=\fR +nor +\fIDenyList=\fR +is specified, and false otherwise\&. +.sp +Added in version 255\&. .RE .PP \fIAnonymize=\fR .RS 4 Takes a boolean\&. When true, the options sent to the DHCP server will follow the -\m[blue]\fBRFC 7844\fR\m[]\&\s-2\u[22]\d\s+2 +\m[blue]\fBRFC 7844\fR\m[]\&\s-2\u[24]\d\s+2 (Anonymity Profiles for DHCP Clients) to minimize disclosure of identifying information\&. Defaults to false\&. .sp This option should only be set to true when @@ -1891,6 +2375,7 @@ is set to .sp When true, \fIClientIdentifier=mac\fR, +\fIRapidCommit=no\fR, \fISendHostname=no\fR, \fIUse6RD=no\fR, \fIUseCaptivePortal=no\fR, @@ -1901,6 +2386,7 @@ When true, are implied and these settings in the \&.network file are silently ignored\&. Also, \fIHostname=\fR, \fIMUDURL=\fR, +\fIRequestAddress\fR, \fIRequestOptions=\fR, \fISendOption=\fR, \fISendVendorOption=\fR, @@ -1909,11 +2395,15 @@ are implied and these settings in the \&.network file are silently ignored\&. Al are silently ignored\&. .sp With this option enabled DHCP requests will mimic those generated by Microsoft Windows, in order to reduce the ability to fingerprint and recognize installations\&. This means DHCP request sizes will grow and lease data will be more comprehensive than normally, though most of the requested data is not actually used\&. +.sp +Added in version 235\&. .RE .PP \fIRequestOptions=\fR .RS 4 Sets request options to be sent to the server in the DHCPv4 request options list\&. A whitespace\-separated list of integers in the range 1\&...254\&. Defaults to unset\&. +.sp +Added in version 244\&. .RE .PP \fISendOption=\fR @@ -1924,7 +2414,9 @@ Send an arbitrary raw option in the DHCPv4 request\&. Takes a DHCP option number "uint32", "ipv4address", or "string"\&. Special characters in the data string may be escaped using -\m[blue]\fBC\-style escapes\fR\m[]\&\s-2\u[23]\d\s+2\&. This setting can be specified multiple times\&. If an empty string is specified, then all options specified earlier are cleared\&. Defaults to unset\&. +\m[blue]\fBC\-style escapes\fR\m[]\&\s-2\u[25]\d\s+2\&. This setting can be specified multiple times\&. If an empty string is specified, then all options specified earlier are cleared\&. Defaults to unset\&. +.sp +Added in version 244\&. .RE .PP \fISendVendorOption=\fR @@ -1935,7 +2427,9 @@ Send an arbitrary vendor option in the DHCPv4 request\&. Takes a DHCP option num "uint32", "ipv4address", or "string"\&. Special characters in the data string may be escaped using -\m[blue]\fBC\-style escapes\fR\m[]\&\s-2\u[23]\d\s+2\&. This setting can be specified multiple times\&. If an empty string is specified, then all options specified earlier are cleared\&. Defaults to unset\&. +\m[blue]\fBC\-style escapes\fR\m[]\&\s-2\u[25]\d\s+2\&. This setting can be specified multiple times\&. If an empty string is specified, then all options specified earlier are cleared\&. Defaults to unset\&. +.sp +Added in version 246\&. .RE .PP \fIIPServiceType=\fR @@ -1951,6 +2445,8 @@ no IP service type is set to the packet sent from the DHCPv4 client\&. When "CS4" (realtime), the corresponding service type will be set\&. Defaults to "CS6"\&. +.sp +Added in version 244\&. .RE .PP \fISocketPriority=\fR @@ -1964,11 +2460,15 @@ socket option in \fIEgressQOSMaps=\fR setting of \&.netdev file to set the 802\&.1Q VLAN ethernet tagged header priority, see \fBsystemd.netdev\fR(5)\&. +.sp +Added in version 253\&. .RE .PP \fILabel=\fR .RS 4 Specifies the label for the IPv4 address received from the DHCP server\&. The label must be a 7\-bit ASCII string with a length of 1\&...15 characters\&. Defaults to unset\&. +.sp +Added in version 250\&. .RE .PP \fIUseDNS=\fR @@ -1979,6 +2479,8 @@ This corresponds to the \fBnameserver\fR option in \fBresolv.conf\fR(5)\&. +.sp +Added in version 211\&. .RE .PP \fIRoutesToDNS=\fR @@ -1986,12 +2488,16 @@ option in When true, the routes to the DNS servers received from the DHCP server will be configured\&. When \fIUseDNS=\fR is disabled, this setting is ignored\&. Defaults to true\&. +.sp +Added in version 243\&. .RE .PP \fIUseNTP=\fR .RS 4 When true (the default), the NTP servers received from the DHCP server will be used by systemd\-timesyncd\&.service\&. +.sp +Added in version 220\&. .RE .PP \fIRoutesToNTP=\fR @@ -1999,16 +2505,24 @@ systemd\-timesyncd\&.service\&. When true, the routes to the NTP servers received from the DHCP server will be configured\&. When \fIUseNTP=\fR is disabled, this setting is ignored\&. Defaults to true\&. +.sp +Added in version 249\&. .RE .PP \fIUseSIP=\fR .RS 4 When true (the default), the SIP servers received from the DHCP server will be collected and made available to client programs\&. +.sp +Added in version 244\&. .RE .PP \fIUseCaptivePortal=\fR .RS 4 -When true (the default), the captive portal advertised by the DHCP server will be recorded and made available to client programs and displayed in the networkctl status output per\-link\&. +When true (the default), the captive portal advertised by the DHCP server will be recorded and made available to client programs and displayed in the +\fBnetworkctl\fR(1) +status output per\-link\&. +.sp +Added in version 254\&. .RE .PP \fIUseMTU=\fR @@ -2021,11 +2535,15 @@ Note, some drivers will reset the interfaces if the MTU is changed\&. For such i \fIIgnoreCarrierLoss=\fR with a short timespan, e\&.g\&. "3 seconds"\&. +.sp +Added in version 211\&. .RE .PP \fIUseHostname=\fR .RS 4 When true (the default), the hostname received from the DHCP server will be set as the transient hostname of the system\&. +.sp +Added in version 211\&. .RE .PP \fIUseDomains=\fR @@ -2045,6 +2563,8 @@ When set to true, this setting corresponds to the \fBdomain\fR option in \fBresolv.conf\fR(5)\&. +.sp +Added in version 216\&. .RE .PP \fIUseRoutes=\fR @@ -2058,11 +2578,15 @@ or \fBlink\fR scope will be used\&. For anything else, scope defaults to \fBglobal\fR\&. +.sp +Added in version 215\&. .RE .PP \fIRouteMetric=\fR .RS 4 Set the routing metric for routes specified by the DHCP server (including the prefix route added for the specified prefix)\&. Takes an unsigned integer in the range 0\&...4294967295\&. Defaults to 1024\&. +.sp +Added in version 217\&. .RE .PP \fIRouteTable=\fR\fI\fInum\fR\fR @@ -2077,29 +2601,57 @@ in .sp When used in combination with \fIVRF=\fR, the VRF\*(Aqs routing table is used when this parameter is not specified\&. +.sp +Added in version 232\&. .RE .PP \fIRouteMTUBytes=\fR .RS 4 Specifies the MTU for the DHCP routes\&. Please see the [Route] section for further details\&. +.sp +Added in version 245\&. .RE .PP \fIQuickAck=\fR .RS 4 Takes a boolean\&. When true, the TCP quick ACK mode is enabled for the routes configured by the acquired DHCPv4 lease\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 253\&. +.RE +.PP +\fIInitialCongestionWindow=\fR +.RS 4 +As in the [Route] section\&. +.sp +Added in version 255\&. +.RE +.PP +\fIInitialAdvertisedReceiveWindow=\fR +.RS 4 +As in the [Route] section\&. +.sp +Added in version 255\&. .RE .PP \fIUseGateway=\fR .RS 4 -When true, the gateway will be requested from the DHCP server and added to the routing table with a metric of 1024, and a scope of -\fBlink\fR\&. When unset, the value specified with +When true, and the DHCP server provides a Router option, the default gateway based on the router address will be configured\&. Defaults to unset, and the value specified with \fIUseRoutes=\fR -is used\&. +will be used\&. +.sp +Note, when the server provides both the Router and Classless Static Routes option, and +\fIUseRoutes=\fR +is enabled, the Router option is always ignored regardless of this setting\&. See +\m[blue]\fBRFC 3442\fR\m[]\&\s-2\u[26]\d\s+2\&. +.sp +Added in version 246\&. .RE .PP \fIUseTimezone=\fR .RS 4 When true, the timezone received from the DHCP server will be set as timezone of the local system\&. Defaults to false\&. +.sp +Added in version 226\&. .RE .PP \fIUse6RD=\fR @@ -2108,7 +2660,17 @@ When true, subnets of the received IPv6 prefix are assigned to downstream interf \fIDHCPPrefixDelegation=\fR\&. See also \fIDHCPPrefixDelegation=\fR in the [Network] section, the [DHCPPrefixDelegation] section, and -\m[blue]\fBRFC 5969\fR\m[]\&\s-2\u[24]\d\s+2\&. Defaults to false\&. +\m[blue]\fBRFC 5969\fR\m[]\&\s-2\u[27]\d\s+2\&. Defaults to false\&. +.sp +Added in version 250\&. +.RE +.PP +\fIIPv6OnlyMode=\fR +.RS 4 +When true, the DHCPv4 configuration will be delayed by the timespan provided by the DHCP server and skip to configure dynamic IPv4 network connectivity if IPv6 connectivity is provided within the timespan\&. See +\m[blue]\fBRFC 8925\fR\m[]\&\s-2\u[28]\d\s+2\&. Defaults to false\&. +.sp +Added in version 255\&. .RE .PP \fIFallbackLeaseLifetimeSec=\fR @@ -2117,11 +2679,15 @@ Allows one to set DHCPv4 lease lifetime when DHCPv4 server does not send the lea "forever" or "infinity"\&. If specified, the acquired address never expires\&. Defaults to unset\&. +.sp +Added in version 246\&. .RE .PP \fIRequestBroadcast=\fR .RS 4 Request the server to use broadcast messages before the IP address has been configured\&. This is necessary for devices that cannot receive RAW packets, or that cannot receive packets at all before an IP address has been configured\&. On the other hand, this must not be enabled on networks where broadcasts are filtered out\&. +.sp +Added in version 216\&. .RE .PP \fIMaxAttempts=\fR @@ -2129,11 +2695,15 @@ Request the server to use broadcast messages before the IP address has been conf Specifies how many times the DHCPv4 client configuration should be attempted\&. Takes a number or "infinity"\&. Defaults to "infinity"\&. Note that the time between retries is increased exponentially, up to approximately one per minute, so the network will not be overloaded even if this number is high\&. The default is suitable in most circumstances\&. +.sp +Added in version 243\&. .RE .PP \fIListenPort=\fR .RS 4 Set the port from which the DHCP client packets originate\&. +.sp +Added in version 233\&. .RE .PP \fIDenyList=\fR @@ -2144,17 +2714,35 @@ A whitespace\-separated list of IPv4 addresses\&. Each address can optionally ta is configured then \fIDenyList=\fR is ignored\&. +.sp +Note that this filters only DHCP offers, so the filtering may not work when +\fIRapidCommit=\fR +is enabled\&. See also +\fIRapidCommit=\fR +in the above\&. +.sp +Added in version 246\&. .RE .PP \fIAllowList=\fR .RS 4 A whitespace\-separated list of IPv4 addresses\&. Each address can optionally take a prefix length after "/"\&. DHCP offers from servers in the list are accepted\&. +.sp +Note that this filters only DHCP offers, so the filtering may not work when +\fIRapidCommit=\fR +is enabled\&. See also +\fIRapidCommit=\fR +in the above\&. +.sp +Added in version 246\&. .RE .PP \fISendRelease=\fR .RS 4 When true, the DHCPv4 client sends a DHCP release packet when it stops\&. Defaults to true\&. +.sp +Added in version 243\&. .RE .PP \fISendDecline=\fR @@ -2165,6 +2753,8 @@ performs IPv4 Duplicate Address Detection to the acquired address by the DHCPv4 \fBDHCPDECLINE\fR packet to the DHCP server, and tries to obtain an IP address again\&. See \m[blue]\fBRFC 5227\fR\m[]\&\s-2\u[11]\d\s+2\&. Defaults to false\&. +.sp +Added in version 245\&. .RE .PP \fINetLabel=\fR @@ -2174,6 +2764,24 @@ This applies the NetLabel for the addresses received with DHCP, like in [Address] section applies it to statically configured addresses\&. See \fINetLabel=\fR in [Address] section for more details\&. +.sp +Added in version 252\&. +.RE +.PP +\fINFTSet=\fR +.RS 4 +This applies the NFT set for the network configuration received with DHCP, like +\fINFTSet=\fR +in [Address] section applies it to static configuration\&. See +\fINFTSet=\fR +in [Address] section for more details\&. For +"address" +or +"prefix" +source types, the type of the element used in the NFT filter must be +"ipv4_addr"\&. +.sp +Added in version 255\&. .RE .SH "[DHCPV6] SECTION OPTIONS" .PP @@ -2184,11 +2792,15 @@ setting described above, or invoked by the IPv6 Router Advertisement: \fIMUDURL=\fR, \fIIAID=\fR, \fIDUIDType=\fR, \fIDUIDRawData=\fR, \fIRequestOptions=\fR .RS 4 As in the [DHCPv4] section\&. +.sp +Added in version 246\&. .RE .PP \fISendOption=\fR .RS 4 As in the [DHCPv4] section, however because DHCPv6 uses 16\-bit fields to store option numbers, the option number is an integer in the range 1\&...65536\&. +.sp +Added in version 246\&. .RE .PP \fISendVendorOption=\fR @@ -2200,20 +2812,26 @@ Send an arbitrary vendor option in the DHCPv6 request\&. Takes an enterprise ide "ipv4address", "ipv6address", or "string"\&. Special characters in the data string may be escaped using -\m[blue]\fBC\-style escapes\fR\m[]\&\s-2\u[23]\d\s+2\&. This setting can be specified multiple times\&. If an empty string is specified, then all options specified earlier are cleared\&. Defaults to unset\&. +\m[blue]\fBC\-style escapes\fR\m[]\&\s-2\u[25]\d\s+2\&. This setting can be specified multiple times\&. If an empty string is specified, then all options specified earlier are cleared\&. Defaults to unset\&. +.sp +Added in version 246\&. .RE .PP \fIUserClass=\fR .RS 4 A DHCPv6 client can use User Class option to identify the type or category of user or applications it represents\&. The information contained in this option is a string that represents the user class of which the client is a member\&. Each class sets an identifying string of information to be used by the DHCP service to classify clients\&. Special characters in the data string may be escaped using -\m[blue]\fBC\-style escapes\fR\m[]\&\s-2\u[23]\d\s+2\&. This setting can be specified multiple times\&. If an empty string is specified, then all options specified earlier are cleared\&. Takes a whitespace\-separated list of strings\&. Note that currently +\m[blue]\fBC\-style escapes\fR\m[]\&\s-2\u[25]\d\s+2\&. This setting can be specified multiple times\&. If an empty string is specified, then all options specified earlier are cleared\&. Takes a whitespace\-separated list of strings\&. Note that currently \fBNUL\fR bytes are not allowed\&. +.sp +Added in version 246\&. .RE .PP \fIVendorClass=\fR .RS 4 A DHCPv6 client can use VendorClass option to identify the vendor that manufactured the hardware on which the client is running\&. The information contained in the data area of this option is contained in one or more opaque fields that identify details of the hardware configuration\&. Takes a whitespace\-separated list of strings\&. +.sp +Added in version 246\&. .RE .PP \fIPrefixDelegationHint=\fR @@ -2221,23 +2839,48 @@ A DHCPv6 client can use VendorClass option to identify the vendor that manufactu Takes an IPv6 address with prefix length in the same format as the \fIAddress=\fR in the [Network] section\&. The DHCPv6 client will include a prefix hint in the DHCPv6 solicitation sent to the server\&. The prefix length must be in the range 1\&...128\&. Defaults to unset\&. +.sp +Added in version 244\&. .RE .PP \fIRapidCommit=\fR .RS 4 Takes a boolean\&. The DHCPv6 client can obtain configuration parameters from a DHCPv6 server through a rapid two\-message exchange (solicit and reply)\&. When the rapid commit option is set by both the DHCPv6 client and the DHCPv6 server, the two\-message exchange is used\&. Otherwise, the four\-message exchange (solicit, advertise, request, and reply) is used\&. The two\-message exchange provides faster client configuration\&. See -\m[blue]\fBRFC 3315\fR\m[]\&\s-2\u[25]\d\s+2 +\m[blue]\fBRFC 3315\fR\m[]\&\s-2\u[29]\d\s+2 for details\&. Defaults to true, and the two\-message exchange will be used if the server support it\&. +.sp +Added in version 252\&. +.RE +.PP +\fISendHostname=\fR +.RS 4 +When true (the default), the machine\*(Aqs hostname (or the value specified with +\fIHostname=\fR, described below) will be sent to the DHCPv6 server\&. Note that the hostname must consist only of 7\-bit ASCII lower\-case characters and no spaces or dots, and be formatted as a valid DNS domain name\&. Otherwise, the hostname is not sent even if this option is true\&. +.sp +Added in version 255\&. +.RE +.PP +\fIHostname=\fR +.RS 4 +Use this value for the hostname which is sent to the DHCPv6 server, instead of machine\*(Aqs hostname\&. Note that the specified hostname must consist only of 7\-bit ASCII lower\-case characters and no spaces or dots, and be formatted as a valid DNS domain name\&. +.sp +Added in version 255\&. .RE .PP \fIUseAddress=\fR .RS 4 When true (the default), the IP addresses provided by the DHCPv6 server will be assigned\&. +.sp +Added in version 248\&. .RE .PP \fIUseCaptivePortal=\fR .RS 4 -When true (the default), the captive portal advertised by the DHCPv6 server will be recorded and made available to client programs and displayed in the networkctl status output per\-link\&. +When true (the default), the captive portal advertised by the DHCPv6 server will be recorded and made available to client programs and displayed in the +\fBnetworkctl\fR(1) +status output per\-link\&. +.sp +Added in version 254\&. .RE .PP \fIUseDelegatedPrefix=\fR @@ -2246,12 +2889,32 @@ When true (the default), the client will request the DHCPv6 server to delegate p \fIDHCPPrefixDelegation=yes\fR\&. See also the \fIDHCPPrefixDelegation=\fR setting in the [Network] section, settings in the [DHCPPrefixDelegation] section, and -\m[blue]\fBRFC 8415\fR\m[]\&\s-2\u[26]\d\s+2\&. +\m[blue]\fBRFC 8415\fR\m[]\&\s-2\u[30]\d\s+2\&. +.sp +Added in version 250\&. .RE .PP \fIUseDNS=\fR, \fIUseNTP=\fR, \fIUseHostname=\fR, \fIUseDomains=\fR, \fINetLabel=\fR, \fISendRelease=\fR .RS 4 As in the [DHCPv4] section\&. +.sp +Added in version 243\&. +.RE +.PP +\fINFTSet=\fR +.RS 4 +This applies the NFT set for the network configuration received with DHCP, like +\fINFTSet=\fR +in [Address] section applies it to static configuration\&. See +\fINFTSet=\fR +in [Address] section for more details\&. For +"address" +or +"prefix" +source types, the type of the element used in the NFT filter must be +"ipv6_addr"\&. +.sp +Added in version 255\&. .RE .PP \fIWithoutRA=\fR @@ -2273,6 +2936,8 @@ is specified in the [DHCPPrefixDelegation] section\&. Otherwise, defaults to "no", and the DHCPv6 client will be started when an RA is received\&. See also the \fIDHCPv6Client=\fR setting in the [IPv6AcceptRA] section\&. +.sp +Added in version 246\&. .RE .SH "[DHCPPREFIXDELEGATION] SECTION OPTIONS" .PP @@ -2291,12 +2956,16 @@ and is implied if the setting is not explicitly specified\&. When ":auto", the first link which acquired prefixes to be delegated from the DHCPv6 or DHCPv4 server is selected\&. Defaults to ":auto"\&. +.sp +Added in version 250\&. .RE .PP \fISubnetId=\fR .RS 4 Configure a specific subnet ID on the interface from a (previously) received prefix delegation\&. You can either set "auto" (the default) or a specific subnet ID (as defined in -\m[blue]\fBRFC 4291\fR\m[]\&\s-2\u[27]\d\s+2, section 2\&.5\&.4), in which case the allowed value is hexadecimal, from 0 to 0x7fffffffffffffff inclusive\&. +\m[blue]\fBRFC 4291\fR\m[]\&\s-2\u[31]\d\s+2, section 2\&.5\&.4), in which case the allowed value is hexadecimal, from 0 to 0x7fffffffffffffff inclusive\&. +.sp +Added in version 246\&. .RE .PP \fIAnnounce=\fR @@ -2306,6 +2975,8 @@ Takes a boolean\&. When enabled, and in [Network] section is enabled, the delegated prefixes are distributed through the IPv6 Router Advertisement\&. This setting will be ignored when the \fIDHCPPrefixDelegation=\fR setting is enabled on the upstream interface\&. Defaults to yes\&. +.sp +Added in version 247\&. .RE .PP \fIAssign=\fR @@ -2313,6 +2984,8 @@ setting is enabled on the upstream interface\&. Defaults to yes\&. Takes a boolean\&. Specifies whether to add an address from the delegated prefixes which are received from the WAN interface by the DHCPv6 Prefix Delegation\&. When true (on LAN interface), the EUI\-64 algorithm will be used by default to form an interface identifier from the delegated prefixes\&. See also \fIToken=\fR setting below\&. Defaults to yes\&. +.sp +Added in version 246\&. .RE .PP \fIToken=\fR @@ -2322,16 +2995,22 @@ Specifies an optional address generation mode for assigning an address in each d in the [IPv6AcceptRA] section\&. If \fIAssign=\fR is set to false, then this setting will be ignored\&. Defaults to unset, which means the EUI\-64 algorithm will be used\&. +.sp +Added in version 246\&. .RE .PP \fIManageTemporaryAddress=\fR .RS 4 As in the [Address] section, but defaults to true\&. +.sp +Added in version 248\&. .RE .PP \fIRouteMetric=\fR .RS 4 The metric of the route to the delegated prefix subnet\&. Takes an unsigned integer in the range 0\&...4294967295\&. When set to 0, the kernel\*(Aqs default value is used\&. Defaults to 256\&. +.sp +Added in version 249\&. .RE .PP \fINetLabel=\fR @@ -2341,6 +3020,24 @@ This applies the NetLabel for the addresses received with DHCP, like in [Address] section applies it to statically configured addresses\&. See \fINetLabel=\fR in [Address] section for more details\&. +.sp +Added in version 252\&. +.RE +.PP +\fINFTSet=\fR +.RS 4 +This applies the NFT set for the network configuration received with DHCP, like +\fINFTSet=\fR +in [Address] section applies it to static configuration\&. See +\fINFTSet=\fR +in [Address] section for more details\&. For +"address" +or +"prefix" +source types, the type of the element used in the NFT filter must be +"ipv6_addr"\&. +.sp +Added in version 255\&. .RE .SH "[IPV6ACCEPTRA] SECTION OPTIONS" .PP @@ -2355,6 +3052,8 @@ Specifies an optional address generation mode for the Stateless Address Autoconf \fBeui64\fR .RS 4 The EUI\-64 algorithm will be used to generate an address for that prefix\&. Only supported by Ethernet or InfiniBand interfaces\&. +.sp +Added in version 250\&. .RE .PP \fBstatic:\fR\fB\fIADDRESS\fR\fR @@ -2362,12 +3061,14 @@ The EUI\-64 algorithm will be used to generate an address for that prefix\&. Onl An IPv6 address must be specified after a colon (":"), and the lower bits of the supplied address are combined with the upper bits of a prefix received in a Router Advertisement (RA) message to form a complete address\&. Note that if multiple prefixes are received in an RA message, or in multiple RA messages, addresses will be formed from each of them using the supplied address\&. This mode implements SLAAC but uses a static interface identifier instead of an identifier generated by using the EUI\-64 algorithm\&. Because the interface identifier is static, if Duplicate Address Detection detects that the computed address is a duplicate (in use by another node on the link), then this mode will fail to provide an address for that prefix\&. If an IPv6 address without mode is specified, then "static" mode is assumed\&. +.sp +Added in version 250\&. .RE .PP \fBprefixstable[:\fR\fB\fIADDRESS\fR\fR\fB][,\fR\fB\fIUUID\fR\fR\fB]\fR .RS 4 The algorithm specified in -\m[blue]\fBRFC 7217\fR\m[]\&\s-2\u[28]\d\s+2 +\m[blue]\fBRFC 7217\fR\m[]\&\s-2\u[32]\d\s+2 will be used to generate interface identifiers\&. This mode can optionally take an IPv6 address separated with a colon (":")\&. If an IPv6 address is specified, then an interface identifier is generated only when a prefix received in an RA message matches the supplied address\&. .sp This mode can also optionally take a non\-null UUID in the format which @@ -2383,6 +3084,8 @@ or Note that the "prefixstable" algorithm uses both the interface name and MAC address as input to the hash to compute the interface identifier, so if either of those are changed the resulting interface identifier (and address) will be changed, even if the prefix received in the RA message has not been changed\&. +.sp +Added in version 250\&. .RE .sp If no address generation mode is specified (which is the default), or a received prefix does not match any of the addresses provided in @@ -2408,6 +3111,8 @@ Token=prefixstable:2002:da8:1:: .if n \{\ .RE .\} +.sp +Added in version 250\&. .RE .PP \fIUseDNS=\fR @@ -2418,6 +3123,8 @@ This corresponds to the \fBnameserver\fR option in \fBresolv.conf\fR(5)\&. +.sp +Added in version 231\&. .RE .PP \fIUseDomains=\fR @@ -2437,6 +3144,8 @@ When set to true, this setting corresponds to the \fBdomain\fR option in \fBresolv.conf\fR(5)\&. +.sp +Added in version 231\&. .RE .PP \fIRouteTable=\fR\fI\fInum\fR\fR @@ -2451,6 +3160,8 @@ in .sp When used in combination with \fIVRF=\fR, the VRF\*(Aqs routing table is used when this parameter is not specified\&. +.sp +Added in version 232\&. .RE .PP \fIRouteMetric=\fR @@ -2458,47 +3169,92 @@ When used in combination with Set the routing metric for the routes received in the Router Advertisement\&. Takes an unsigned integer in the range 0\&...4294967295, or three unsigned integer separated with ":", in that case the first one is used when the router preference is high, the second is for medium preference, and the last is for low preference ("\fIhigh\fR:\fImedium\fR:\fIlow\fR")\&. Defaults to "512:1024:2048"\&. +.sp +Added in version 249\&. .RE .PP \fIQuickAck=\fR .RS 4 Takes a boolean\&. When true, the TCP quick ACK mode is enabled for the routes configured by the received RAs\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 253\&. .RE .PP \fIUseMTU=\fR .RS 4 Takes a boolean\&. When true, the MTU received in the Router Advertisement will be used\&. Defaults to true\&. +.sp +Added in version 250\&. +.RE +.PP +\fIUseHopLimit=\fR +.RS 4 +Takes a boolean\&. When true, the hop limit received in the Router Advertisement will be set to routes configured based on the advertisement\&. See also +\fIIPv6HopLimit=\fR\&. Defaults to true\&. +.sp +Added in version 255\&. +.RE +.PP +\fIUseICMP6RateLimit=\fR +.RS 4 +Takes a boolean\&. When true, the ICMP6 rate limit received in the Router Advertisement will be set to ICMP6 rate limit based on the advertisement\&. Defaults to true\&. +.sp +Added in version 255\&. .RE .PP \fIUseGateway=\fR .RS 4 When true (the default), the router address will be configured as the default gateway\&. +.sp +Added in version 250\&. .RE .PP \fIUseRoutePrefix=\fR .RS 4 When true (the default), the routes corresponding to the route prefixes received in the Router Advertisement will be configured\&. +.sp +Added in version 250\&. .RE .PP \fIUseCaptivePortal=\fR .RS 4 -When true (the default), the captive portal received in the Router Advertisement will be recorded and made available to client programs and displayed in the networkctl status output per\-link\&. +When true (the default), the captive portal received in the Router Advertisement will be recorded and made available to client programs and displayed in the +\fBnetworkctl\fR(1) +status output per\-link\&. +.sp +Added in version 254\&. +.RE +.PP +\fIUsePREF64=\fR +.RS 4 +When true, the IPv6 PREF64 (or NAT64) prefixes received in the Router Advertisement will be recorded and made available to client programs and displayed in the +\fBnetworkctl\fR(1) +status output per\-link\&. See +\m[blue]\fBRFC 8781\fR\m[]\&\s-2\u[33]\d\s+2\&. Defaults to false\&. +.sp +Added in version 255\&. .RE .PP \fIUseAutonomousPrefix=\fR .RS 4 When true (the default), the autonomous prefix received in the Router Advertisement will be used and take precedence over any statically configured ones\&. +.sp +Added in version 242\&. .RE .PP \fIUseOnLinkPrefix=\fR .RS 4 When true (the default), the onlink prefix received in the Router Advertisement will be used and takes precedence over any statically configured ones\&. +.sp +Added in version 242\&. .RE .PP \fIRouterDenyList=\fR .RS 4 A whitespace\-separated list of IPv6 router addresses\&. Each address can optionally take a prefix length after "/"\&. Any information advertised by the listed router is ignored\&. +.sp +Added in version 248\&. .RE .PP \fIRouterAllowList=\fR @@ -2509,12 +3265,16 @@ A whitespace\-separated list of IPv6 router addresses\&. Each address can option is configured then \fIRouterDenyList=\fR is ignored\&. +.sp +Added in version 248\&. .RE .PP \fIPrefixDenyList=\fR .RS 4 A whitespace\-separated list of IPv6 prefixes\&. Each prefix can optionally take its prefix length after "/"\&. IPv6 prefixes supplied via router advertisements in the list are ignored\&. +.sp +Added in version 248\&. .RE .PP \fIPrefixAllowList=\fR @@ -2525,12 +3285,16 @@ A whitespace\-separated list of IPv6 prefixes\&. Each prefix can optionally take is configured then \fIPrefixDenyList=\fR is ignored\&. +.sp +Added in version 248\&. .RE .PP \fIRouteDenyList=\fR .RS 4 A whitespace\-separated list of IPv6 route prefixes\&. Each prefix can optionally take its prefix length after "/"\&. IPv6 route prefixes supplied via router advertisements in the list are ignored\&. +.sp +Added in version 248\&. .RE .PP \fIRouteAllowList=\fR @@ -2541,6 +3305,8 @@ A whitespace\-separated list of IPv6 route prefixes\&. Each prefix can optionall is configured then \fIRouteDenyList=\fR is ignored\&. +.sp +Added in version 248\&. .RE .PP \fIDHCPv6Client=\fR @@ -2568,6 +3334,8 @@ flag is set in the RA\&. This will be ignored when in the [DHCPv6] section is enabled, or \fIUplinkInterface=:self\fR in the [DHCPPrefixDelegation] section is specified\&. Defaults to true\&. +.sp +Added in version 246\&. .RE .PP \fINetLabel=\fR @@ -2577,6 +3345,24 @@ This applies the NetLabel for the addresses received with RA, like in [Address] section applies it to statically configured addresses\&. See \fINetLabel=\fR in [Address] section for more details\&. +.sp +Added in version 252\&. +.RE +.PP +\fINFTSet=\fR +.RS 4 +This applies the NFT set for the network configuration received with RA, like +\fINFTSet=\fR +in [Address] section applies it to static configuration\&. See +\fINFTSet=\fR +in [Address] section for more details\&. For +"address" +or +"prefix" +source types, the type of the element used in the NFT filter must be +"ipv6_addr"\&. +.sp +Added in version 255\&. .RE .SH "[DHCPSERVER] SECTION OPTIONS" .PP @@ -2586,7 +3372,71 @@ option described above: .PP \fIServerAddress=\fR .RS 4 -Specifies server address for the DHCP server\&. Takes an IPv4 address with prefix length, for example 192\&.168\&.0\&.1/24\&. This setting may be useful when the link on which the DHCP server is running has multiple static addresses\&. When unset, one of static addresses in the link will be automatically selected\&. Defaults to unset\&. +Specifies the server address for the DHCP server\&. Takes an IPv4 address with prefix length separated with a slash, e\&.g\&. +"192\&.168\&.0\&.1/24"\&. Defaults to unset, and one of static IPv4 addresses configured in [Network] or [Address] section will be automatically selected\&. This setting may be useful when the interface on which the DHCP server is running has multiple static IPv4 addresses\&. +.sp +This implies +\fIAddress=\fR +in [Network] or [Address] section with the same address and prefix length\&. That is, +.sp +.if n \{\ +.RS 4 +.\} +.nf +[Network] +DHCPServer=yes +Address=192\&.168\&.0\&.1/24 +Address=192\&.168\&.0\&.2/24 +[DHCPServer] +ServerAddress=192\&.168\&.0\&.1/24 +.fi +.if n \{\ +.RE +.\} +.sp +or +.sp +.if n \{\ +.RS 4 +.\} +.nf +[Network] +DHCPServer=yes +[Address] +Address=192\&.168\&.0\&.1/24 +[Address] +Address=192\&.168\&.0\&.2/24 +[DHCPServer] +ServerAddress=192\&.168\&.0\&.1/24 +.fi +.if n \{\ +.RE +.\} +.sp +are equivalent to the following: +.sp +.if n \{\ +.RS 4 +.\} +.nf +[Network] +DHCPServer=yes +Address=192\&.168\&.0\&.2/24 +[DHCPServer] +ServerAddress=192\&.168\&.0\&.1/24 +.fi +.if n \{\ +.RE +.\} +.sp +Since version 255, like the +\fIAddress=\fR +setting in [Network] or [Address] section, this also supports a null address, e\&.g\&. +"0\&.0\&.0\&.0/24", and an unused address will be automatically selected\&. For more details about the automatic address selection, see +\fIAddress=\fR +setting in [Network] section in the above\&. +.sp +Added in version 249\&. .RE .PP \fIPoolOffset=\fR, \fIPoolSize=\fR @@ -2596,11 +3446,15 @@ Configures the pool of addresses to hand out\&. The pool is a contiguous sequenc takes the offset of the pool from the start of subnet, or zero to use the default value\&. \fIPoolSize=\fR takes the number of IP addresses in the pool or zero to use the default value\&. By default, the pool starts at the first address after the subnet address and takes up the rest of the subnet, excluding the broadcast address\&. If the pool includes the server address (the default), this is reserved and not handed out to clients\&. +.sp +Added in version 226\&. .RE .PP \fIDefaultLeaseTimeSec=\fR, \fIMaxLeaseTimeSec=\fR .RS 4 Control the default and maximum DHCP lease time to pass to clients\&. These settings take time values in seconds or another common time unit, depending on the suffix\&. The default lease time is used for clients that did not ask for a specific lease time\&. If a client asks for a lease time longer than the maximum lease time, it is automatically shortened to the specified time\&. The default lease time defaults to 1h, the maximum lease time to 12h\&. Shorter lease times are beneficial if the configuration data in DHCP leases changes frequently and clients shall learn the new settings with shorter latencies\&. Longer lease times reduce the generated DHCP network traffic\&. +.sp +Added in version 226\&. .RE .PP \fIUplinkInterface=\fR @@ -2612,6 +3466,8 @@ and ":auto", the link which has a default gateway with the highest priority will be automatically selected\&. When ":none", no uplink interface will be selected\&. Defaults to ":auto"\&. +.sp +Added in version 249\&. .RE .PP \fIEmitDNS=\fR, \fIDNS=\fR @@ -2633,6 +3489,8 @@ is used\&. Also, note that the leases are not refreshed if the uplink network co described above\&. .sp This setting can be specified multiple times\&. If an empty string is specified, then all DNS servers specified earlier are cleared\&. +.sp +Added in version 226\&. .RE .PP \fIEmitNTP=\fR, \fINTP=\fR, \fIEmitSIP=\fR, \fISIP=\fR, \fIEmitPOP3=\fR, \fIPOP3=\fR, \fIEmitSMTP=\fR, \fISMTP=\fR, \fIEmitLPR=\fR, \fILPR=\fR @@ -2645,6 +3503,8 @@ settings described above, these settings configure whether and what server infor \fIEmitDNS=\fR and \fIDNS=\fR\&. +.sp +Added in version 226\&. .RE .PP \fIEmitRouter=\fR, \fIRouter=\fR @@ -2664,6 +3524,8 @@ setting will be ignored\&. The setting defaults to true, and the \fIRouter=\fR setting defaults to unset\&. +.sp +Added in version 230\&. .RE .PP \fIEmitTimezone=\fR, \fITimezone=\fR @@ -2677,6 +3539,8 @@ or "UTC") to pass to clients\&. If no explicit timezone is set, the system timezone of the local host is propagated, as determined by the /etc/localtime symlink\&. +.sp +Added in version 226\&. .RE .PP \fIBootServerAddress=\fR @@ -2684,14 +3548,16 @@ symlink\&. Takes an IPv4 address of the boot server used by e\&.g\&. PXE boot systems\&. When specified, this address is sent in the \fBsiaddr\fR field of the DHCP message header\&. See -\m[blue]\fBRFC 2131\fR\m[]\&\s-2\u[29]\d\s+2 +\m[blue]\fBRFC 2131\fR\m[]\&\s-2\u[34]\d\s+2 for more details\&. Defaults to unset\&. +.sp +Added in version 251\&. .RE .PP \fIBootServerName=\fR .RS 4 Takes a name of the boot server used by e\&.g\&. PXE boot systems\&. When specified, this name is sent in the DHCP option 66 ("TFTP server name")\&. See -\m[blue]\fBRFC 2132\fR\m[]\&\s-2\u[30]\d\s+2 +\m[blue]\fBRFC 2132\fR\m[]\&\s-2\u[35]\d\s+2 for more details\&. Defaults to unset\&. .sp Note that typically setting one of @@ -2699,13 +3565,26 @@ Note that typically setting one of or \fIBootServerAddress=\fR is sufficient, but both can be set too, if desired\&. +.sp +Added in version 251\&. .RE .PP \fIBootFilename=\fR .RS 4 Takes a path or URL to a file loaded by e\&.g\&. a PXE boot loader\&. When specified, this path is sent in the DHCP option 67 ("Bootfile name")\&. See -\m[blue]\fBRFC 2132\fR\m[]\&\s-2\u[30]\d\s+2 +\m[blue]\fBRFC 2132\fR\m[]\&\s-2\u[35]\d\s+2 for more details\&. Defaults to unset\&. +.sp +Added in version 251\&. +.RE +.PP +\fIIPv6OnlyPreferredSec=\fR +.RS 4 +Takes a timespan\&. Controls the +\m[blue]\fBRFC 8925\fR\m[]\&\s-2\u[28]\d\s+2 +IPv6\-Only Preferred option\&. Specifies the DHCPv4 option to indicate that a host supports an IPv6\-only mode and is willing to forgo obtaining an IPv4 address if the network provides IPv6 connectivity\&. Defaults to unset, and not send the option\&. The minimum allowed value is 300 seconds\&. +.sp +Added in version 255\&. .RE .PP \fISendOption=\fR @@ -2717,7 +3596,9 @@ Send a raw option with value via DHCPv4 server\&. Takes a DHCP option number, da "ipv4address", "ipv6address", or "string"\&. Special characters in the data string may be escaped using -\m[blue]\fBC\-style escapes\fR\m[]\&\s-2\u[23]\d\s+2\&. This setting can be specified multiple times\&. If an empty string is specified, then all options specified earlier are cleared\&. Defaults to unset\&. +\m[blue]\fBC\-style escapes\fR\m[]\&\s-2\u[25]\d\s+2\&. This setting can be specified multiple times\&. If an empty string is specified, then all options specified earlier are cleared\&. Defaults to unset\&. +.sp +Added in version 244\&. .RE .PP \fISendVendorOption=\fR @@ -2728,7 +3609,9 @@ Send a vendor option with value via DHCPv4 server\&. Takes a DHCP option number, "uint32", "ipv4address", or "string"\&. Special characters in the data string may be escaped using -\m[blue]\fBC\-style escapes\fR\m[]\&\s-2\u[23]\d\s+2\&. This setting can be specified multiple times\&. If an empty string is specified, then all options specified earlier are cleared\&. Defaults to unset\&. +\m[blue]\fBC\-style escapes\fR\m[]\&\s-2\u[25]\d\s+2\&. This setting can be specified multiple times\&. If an empty string is specified, then all options specified earlier are cleared\&. Defaults to unset\&. +.sp +Added in version 246\&. .RE .PP \fIBindToInterface=\fR @@ -2739,13 +3622,17 @@ Takes a boolean value\&. When \fIRelayTarget=\fR is used (see below), in which case it defaults to "no"\&. +.sp +Added in version 249\&. .RE .PP \fIRelayTarget=\fR .RS 4 Takes an IPv4 address, which must be in the format described in \fBinet_pton\fR(3)\&. Turns this DHCP server into a DHCP relay agent\&. See -\m[blue]\fBRFC 1542\fR\m[]\&\s-2\u[31]\d\s+2\&. The address is the address of DHCP server or another relay agent to forward DHCP messages to and from\&. +\m[blue]\fBRFC 1542\fR\m[]\&\s-2\u[36]\d\s+2\&. The address is the address of DHCP server or another relay agent to forward DHCP messages to and from\&. +.sp +Added in version 249\&. .RE .PP \fIRelayAgentCircuitId=\fR @@ -2756,6 +3643,8 @@ Specifies value for Agent Circuit ID suboption of Relay Agent Information option should be replaced with the value of the suboption\&. Defaults to unset (means no Agent Circuit ID suboption is generated)\&. Ignored if \fIRelayTarget=\fR is not specified\&. +.sp +Added in version 249\&. .RE .PP \fIRelayAgentRemoteId=\fR @@ -2766,6 +3655,16 @@ Specifies value for Agent Remote ID suboption of Relay Agent Information option\ should be replaced with the value of the suboption\&. Defaults to unset (means no Agent Remote ID suboption is generated)\&. Ignored if \fIRelayTarget=\fR is not specified\&. +.sp +Added in version 249\&. +.RE +.PP +\fIRapidCommit=\fR +.RS 4 +Takes a boolean\&. When true, the server supports +\m[blue]\fBRFC 4039\fR\m[]\&\s-2\u[37]\d\s+2\&. When a client sends a DHCPDISCOVER message with the Rapid Commit option to the server, then the server will reply with a DHCPACK message to the client, instead of DHCPOFFER\&. Defaults to true\&. +.sp +Added in version 255\&. .RE .SH "[DHCPSERVERSTATICLEASE] SECTION OPTIONS" .PP @@ -2776,12 +3675,16 @@ section configures a static DHCP lease to assign a fixed IPv4 address to a speci \fIMACAddress=\fR .RS 4 The hardware address of a device to match\&. This key is mandatory\&. +.sp +Added in version 249\&. .RE .PP \fIAddress=\fR .RS 4 The IPv4 address that should be assigned to the device that was matched with \fIMACAddress=\fR\&. This key is mandatory\&. +.sp +Added in version 249\&. .RE .SH "[IPV6SENDRA] SECTION OPTIONS" .PP @@ -2800,11 +3703,22 @@ or if only additional network information can be obtained via DHCPv6 for the net is set to "true"\&. Both settings default to "false", which means that a DHCPv6 server is not being used\&. +.sp +Added in version 235\&. .RE .PP \fIRouterLifetimeSec=\fR .RS 4 Takes a timespan\&. Configures the IPv6 router lifetime in seconds\&. The value must be 0 seconds, or between 4 seconds and 9000 seconds\&. When set to 0, the host is not acting as a router\&. Defaults to 1800 seconds (30 minutes)\&. +.sp +Added in version 235\&. +.RE +.PP +\fIRetransmitSec=\fR +.RS 4 +Takes a timespan\&. Configures the retransmit time, used by clients to retransmit Neighbor Solicitation messages on address resolution and the Neighbor Unreachability Detection algorithm\&. An integer, the default unit is seconds, in the range 0\&...4294967295 msec\&. Defaults to 0\&. +.sp +Added in version 255\&. .RE .PP \fIRouterPreference=\fR @@ -2822,9 +3736,19 @@ and added as synonyms for "medium" just to make configuration easier\&. See -\m[blue]\fBRFC 4191\fR\m[]\&\s-2\u[20]\d\s+2 +\m[blue]\fBRFC 4191\fR\m[]\&\s-2\u[21]\d\s+2 for details\&. Defaults to "medium"\&. +.sp +Added in version 235\&. +.RE +.PP +\fIHopLimit=\fR +.RS 4 +Configures hop limit\&. Takes an integer in the range 0\&...255\&. See also +\fIIPv6HopLimit=\fR\&. +.sp +Added in version 255\&. .RE .PP \fIUplinkInterface=\fR @@ -2838,6 +3762,8 @@ and is enabled, otherwise the link which has a default gateway with the highest priority will be automatically selected\&. When ":none", no uplink interface will be selected\&. Defaults to ":auto"\&. +.sp +Added in version 250\&. .RE .PP \fIEmitDNS=\fR, \fIDNS=\fR @@ -2857,6 +3783,8 @@ will be used\&. When is false, no DNS server information is sent in Router Advertisement messages\&. \fIEmitDNS=\fR defaults to true\&. +.sp +Added in version 235\&. .RE .PP \fIEmitDomains=\fR, \fIDomains=\fR @@ -2872,6 +3800,8 @@ will be used\&. When is false, no DNS search domain information is sent in Router Advertisement messages\&. \fIEmitDomains=\fR defaults to true\&. +.sp +Added in version 235\&. .RE .PP \fIDNSLifetimeSec=\fR @@ -2880,11 +3810,37 @@ Lifetime in seconds for the DNS server addresses listed in \fIDNS=\fR and search domains listed in \fIDomains=\fR\&. Defaults to 3600 seconds (one hour)\&. +.sp +Added in version 235\&. +.RE +.PP +\fIHomeAgent=\fR +.RS 4 +Takes a boolean\&. Specifies that IPv6 router advertisements which indicate to hosts that the router acts as a Home Agent and includes a Home Agent option\&. Defaults to false\&. See +\m[blue]\fBRFC 6275\fR\m[]\&\s-2\u[10]\d\s+2 +for further details\&. +.sp +Added in version 255\&. +.RE +.PP +\fIHomeAgentLifetimeSec=\fR +.RS 4 +Takes a timespan\&. Specifies the lifetime of the Home Agent\&. An integer, the default unit is seconds, in the range 1\&...65535\&. Defaults to the value set to +\fIRouterLifetimeSec=\fR\&. +.sp +Added in version 255\&. +.RE +.PP +\fIHomeAgentPreference=\fR +.RS 4 +Configures IPv6 Home Agent preference\&. Takes an integer in the range 0\&...65535\&. Defaults to 0\&. +.sp +Added in version 255\&. .RE .SH "[IPV6PREFIX] SECTION OPTIONS" .PP One or more [IPv6Prefix] sections contain the IPv6 prefixes that are announced via Router Advertisements\&. See -\m[blue]\fBRFC 4861\fR\m[]\&\s-2\u[32]\d\s+2 +\m[blue]\fBRFC 4861\fR\m[]\&\s-2\u[38]\d\s+2 for further details\&. .PP \fIAddressAutoconfiguration=\fR, \fIOnLink=\fR @@ -2892,6 +3848,8 @@ for further details\&. Takes a boolean to specify whether IPv6 addresses can be autoconfigured with this prefix and whether the prefix can be used for onlink determination\&. Both settings default to "true" in order to ease configuration\&. +.sp +Added in version 235\&. .RE .PP \fIPrefix=\fR @@ -2899,6 +3857,8 @@ in order to ease configuration\&. The IPv6 prefix that is to be distributed to hosts\&. Similarly to configuring static IPv6 addresses, the setting is configured as an IPv6 prefix and its prefix length, separated by a "/" character\&. Use multiple [IPv6Prefix] sections to configure multiple IPv6 prefixes since prefix lifetimes, address autoconfiguration and onlink status may differ from one prefix to another\&. +.sp +Added in version 235\&. .RE .PP \fIPreferredLifetimeSec=\fR, \fIValidLifetimeSec=\fR @@ -2908,11 +3868,15 @@ Preferred and valid lifetimes for the prefix measured in seconds\&. defaults to 1800 seconds (30 minutes) and \fIValidLifetimeSec=\fR defaults to 3600 seconds (one hour)\&. +.sp +Added in version 235\&. .RE .PP \fIAssign=\fR .RS 4 Takes a boolean\&. When true, adds an address from the prefix\&. Default to false\&. +.sp +Added in version 246\&. .RE .PP \fIToken=\fR @@ -2922,6 +3886,8 @@ Specifies an optional address generation mode for assigning an address in each p in the [IPv6AcceptRA] section\&. If \fIAssign=\fR is set to false, then this setting will be ignored\&. Defaults to unset, which means the EUI\-64 algorithm will be used\&. +.sp +Added in version 250\&. .RE .PP \fIRouteMetric=\fR @@ -2929,11 +3895,13 @@ is set to false, then this setting will be ignored\&. Defaults to unset, which m The metric of the prefix route\&. Takes an unsigned integer in the range 0\&...4294967295\&. When unset or set to 0, the kernel\*(Aqs default value is used\&. This setting is ignored when \fIAssign=\fR is false\&. +.sp +Added in version 249\&. .RE .SH "[IPV6ROUTEPREFIX] SECTION OPTIONS" .PP One or more [IPv6RoutePrefix] sections contain the IPv6 prefix routes that are announced via Router Advertisements\&. See -\m[blue]\fBRFC 4191\fR\m[]\&\s-2\u[20]\d\s+2 +\m[blue]\fBRFC 4191\fR\m[]\&\s-2\u[21]\d\s+2 for further details\&. .PP \fIRoute=\fR @@ -2941,6 +3909,8 @@ for further details\&. The IPv6 route that is to be distributed to hosts\&. Similarly to configuring static IPv6 routes, the setting is configured as an IPv6 prefix routes and its prefix route length, separated by a "/" character\&. Use multiple [IPv6RoutePrefix] sections to configure multiple IPv6 prefix routes\&. +.sp +Added in version 244\&. .RE .PP \fILifetimeSec=\fR @@ -2948,6 +3918,32 @@ character\&. Use multiple [IPv6RoutePrefix] sections to configure multiple IPv6 Lifetime for the route prefix measured in seconds\&. \fILifetimeSec=\fR defaults to 3600 seconds (one hour)\&. +.sp +Added in version 244\&. +.RE +.SH "[IPV6PREF64PREFIX] SECTION OPTIONS" +.PP +One or more [IPv6PREF64Prefix] sections contain the IPv6 PREF64 (or NAT64) prefixes that are announced via Router Advertisements\&. See +\m[blue]\fBRFC 8781\fR\m[]\&\s-2\u[33]\d\s+2 +for further details\&. +.PP +\fIPrefix=\fR +.RS 4 +The IPv6 PREF64 (or NAT64) prefix that is to be distributed to hosts\&. The setting holds an IPv6 prefix that should be set up for NAT64 translation (PLAT) to allow 464XLAT on the network segment\&. Use multiple [IPv6PREF64Prefix] sections to configure multiple IPv6 prefixes since prefix lifetime may differ from one prefix to another\&. The prefix is an address with a prefix length, separated by a slash +"/" +character\&. Valid NAT64 prefix length are 96, 64, 56, 48, 40, and 32 bits\&. +.sp +Added in version 255\&. +.RE +.PP +\fILifetimeSec=\fR +.RS 4 +Lifetime for the prefix measured in seconds\&. Should be greater than or equal to +\fIRouterLifetimeSec=\fR\&. +\fILifetimeSec=\fR +defaults to 1800 seconds\&. +.sp +Added in version 255\&. .RE .SH "[BRIDGE] SECTION OPTIONS" .PP @@ -2956,61 +3952,85 @@ The [Bridge] section accepts the following keys: \fIUnicastFlood=\fR .RS 4 Takes a boolean\&. Controls whether the bridge should flood traffic for which an FDB entry is missing and the destination is unknown through this port\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 223\&. .RE .PP \fIMulticastFlood=\fR .RS 4 Takes a boolean\&. Controls whether the bridge should flood traffic for which an MDB entry is missing and the destination is unknown through this port\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 242\&. .RE .PP \fIMulticastToUnicast=\fR .RS 4 Takes a boolean\&. Multicast to unicast works on top of the multicast snooping feature of the bridge\&. Which means unicast copies are only delivered to hosts which are interested in it\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 240\&. .RE .PP \fINeighborSuppression=\fR .RS 4 Takes a boolean\&. Configures whether ARP and ND neighbor suppression is enabled for this port\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 242\&. .RE .PP \fILearning=\fR .RS 4 Takes a boolean\&. Configures whether MAC address learning is enabled for this port\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 242\&. .RE .PP \fIHairPin=\fR .RS 4 Takes a boolean\&. Configures whether traffic may be sent back out of the port on which it was received\&. When this flag is false, then the bridge will not forward traffic back out of the receiving port\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 223\&. .RE .PP \fIIsolated=\fR .RS 4 Takes a boolean\&. Configures whether this port is isolated or not\&. Within a bridge, isolated ports can only communicate with non\-isolated ports\&. When set to true, this port can only communicate with other ports whose Isolated setting is false\&. When set to false, this port can communicate with any other ports\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 251\&. .RE .PP \fIUseBPDU=\fR .RS 4 Takes a boolean\&. Configures whether STP Bridge Protocol Data Units will be processed by the bridge port\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 223\&. .RE .PP \fIFastLeave=\fR .RS 4 Takes a boolean\&. This flag allows the bridge to immediately stop multicast traffic on a port that receives an IGMP Leave message\&. It is only used with IGMP snooping if enabled on the bridge\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 223\&. .RE .PP \fIAllowPortToBeRoot=\fR .RS 4 Takes a boolean\&. Configures whether a given port is allowed to become a root port\&. Only used when STP is enabled on the bridge\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 223\&. .RE .PP \fIProxyARP=\fR .RS 4 Takes a boolean\&. Configures whether proxy ARP to be enabled on this port\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 243\&. .RE .PP \fIProxyARPWiFi=\fR .RS 4 Takes a boolean\&. Configures whether proxy ARP to be enabled on this port which meets extended requirements by IEEE 802\&.11 and Hotspot 2\&.0 specifications\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 243\&. .RE .PP \fIMulticastRouter=\fR @@ -3024,16 +4044,22 @@ to let the system detect the presence of routers, to permanently enable multicast traffic forwarding on this port, or "temporary" to enable multicast routers temporarily on this port, not depending on incoming queries\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 243\&. .RE .PP \fICost=\fR .RS 4 Sets the "cost" of sending packets of this interface\&. Each port in a bridge may have a different speed and the cost is used to decide which link to use\&. Faster interfaces should have lower costs\&. It is an integer value between 1 and 65535\&. +.sp +Added in version 218\&. .RE .PP \fIPriority=\fR .RS 4 Sets the "priority" of sending packets on this interface\&. Each port in a bridge may have a different priority which is used to decide which link to use\&. Lower value means higher priority\&. It is an integer value between 0 to 63\&. Networkd does not set any default, meaning the kernel default value of 32 is used\&. +.sp +Added in version 234\&. .RE .SH "[BRIDGEFDB] SECTION OPTIONS" .PP @@ -3042,21 +4068,29 @@ The [BridgeFDB] section manages the forwarding database table of a port and acce \fIMACAddress=\fR .RS 4 As in the [Network] section\&. This key is mandatory\&. +.sp +Added in version 219\&. .RE .PP \fIDestination=\fR .RS 4 Takes an IP address of the destination VXLAN tunnel endpoint\&. +.sp +Added in version 243\&. .RE .PP \fIVLANId=\fR .RS 4 The VLAN ID for the new static MAC table entry\&. If omitted, no VLAN ID information is appended to the new static MAC table entry\&. +.sp +Added in version 219\&. .RE .PP \fIVNI=\fR .RS 4 The VXLAN Network Identifier (or VXLAN Segment ID) to use to connect to the remote VXLAN tunnel endpoint\&. Takes a number in the range 1\&...16777215\&. Defaults to unset\&. +.sp +Added in version 243\&. .RE .PP \fIAssociatedWith=\fR @@ -3076,11 +4110,15 @@ means the address is associated with master devices fdb\&. "router" means the destination address is associated with a router\&. Note that it\*(Aqs valid if the referenced device is a VXLAN type device and has route shortcircuit enabled\&. Defaults to "self"\&. +.sp +Added in version 243\&. .RE .PP \fIOutgoingInterface=\fR .RS 4 Specifies the name or index of the outgoing interface for the VXLAN device driver to reach the remote VXLAN tunnel endpoint\&. Defaults to unset\&. +.sp +Added in version 249\&. .RE .SH "[BRIDGEMDB] SECTION OPTIONS" .PP @@ -3089,11 +4127,15 @@ The [BridgeMDB] section manages the multicast membership entries forwarding data \fIMulticastGroupAddress=\fR .RS 4 Specifies the IPv4 or IPv6 multicast group address to add\&. This setting is mandatory\&. +.sp +Added in version 247\&. .RE .PP \fIVLANId=\fR .RS 4 The VLAN ID for the new entry\&. Valid ranges are 0 (no VLAN) to 4094\&. Optional, defaults to 0\&. +.sp +Added in version 247\&. .RE .SH "[LLDP] SECTION OPTIONS" .PP @@ -3108,6 +4150,8 @@ in the [DHCPv4] section described above\&. The MUD URLs received via LLDP packets are saved and can be read using the \fBsd_lldp_neighbor_get_mud_url()\fR function\&. +.sp +Added in version 246\&. .RE .SH "[CAN] SECTION OPTIONS" .PP @@ -3116,6 +4160,8 @@ The [CAN] section manages the Controller Area Network (CAN bus) and accepts the \fIBitRate=\fR .RS 4 The bitrate of CAN device in bits per second\&. The usual SI prefixes (K, M) with the base of 1000 can be used here\&. Takes a number in the range 1\&...4294967295\&. +.sp +Added in version 239\&. .RE .PP \fISamplePoint=\fR @@ -3126,6 +4172,8 @@ Optional sample point in percent with one decimal (e\&.g\&. "875‰")\&. This will be ignored when \fIBitRate=\fR is unspecified\&. +.sp +Added in version 239\&. .RE .PP \fITimeQuantaNSec=\fR, \fIPropagationSegment=\fR, \fIPhaseBufferSegment1=\fR, \fIPhaseBufferSegment2=\fR, \fISyncJumpWidth=\fR @@ -3144,6 +4192,8 @@ and must be an unsigned integer in the range 0\&...4294967295\&. These settings will be ignored when \fIBitRate=\fR is specified\&. +.sp +Added in version 250\&. .RE .PP \fIDataBitRate=\fR, \fIDataSamplePoint=\fR @@ -3153,6 +4203,8 @@ The bitrate and sample point for the data phase, if CAN\-FD is used\&. These set and \fISamplePoint=\fR keys\&. +.sp +Added in version 246\&. .RE .PP \fIDataTimeQuantaNSec=\fR, \fIDataPropagationSegment=\fR, \fIDataPhaseBufferSegment1=\fR, \fIDataPhaseBufferSegment2=\fR, \fIDataSyncJumpWidth=\fR @@ -3160,6 +4212,8 @@ keys\&. Specifies the time quanta, propagation segment, phase buffer segment 1 and 2, and the synchronization jump width for the data phase, if CAN\-FD is used\&. These settings are analogous to the \fITimeQuantaNSec=\fR or related settings\&. +.sp +Added in version 250\&. .RE .PP \fIFDMode=\fR @@ -3172,12 +4226,16 @@ and keys, or \fIDataTimeQuanta=\fR and related settings\&. +.sp +Added in version 246\&. .RE .PP \fIFDNonISO=\fR .RS 4 Takes a boolean\&. When "yes", non\-ISO CAN\-FD mode is enabled for the interface\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 246\&. .RE .PP \fIRestartSec=\fR @@ -3192,6 +4250,8 @@ postfix\&. Using or "0" will turn the automatic restart off\&. By default automatic restart is disabled\&. +.sp +Added in version 239\&. .RE .PP \fITermination=\fR @@ -3202,48 +4262,64 @@ Takes a boolean or a termination resistor value in ohm in the range 0\&...65535\ or "0" is set, the termination resistor is disabled\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 246\&. .RE .PP \fITripleSampling=\fR .RS 4 Takes a boolean\&. When "yes", three samples (instead of one) are used to determine the value of a received bit by majority rule\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 242\&. .RE .PP \fIBusErrorReporting=\fR .RS 4 Takes a boolean\&. When "yes", reporting of CAN bus errors is activated (those include single bit, frame format, and bit stuffing errors, unable to send dominant bit, unable to send recessive bit, bus overload, active error announcement, error occurred on transmission)\&. When unset, the kernel\*(Aqs default will be used\&. Note: in case of a CAN bus with a single CAN device, sending a CAN frame may result in a huge number of CAN bus errors\&. +.sp +Added in version 248\&. .RE .PP \fIListenOnly=\fR .RS 4 Takes a boolean\&. When "yes", listen\-only mode is enabled\&. When the interface is in listen\-only mode, the interface neither transmit CAN frames nor send ACK bit\&. Listen\-only mode is important to debug CAN networks without interfering with the communication or acknowledge the CAN frame\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 246\&. .RE .PP \fILoopback=\fR .RS 4 Takes a boolean\&. When "yes", loopback mode is enabled\&. When the loopback mode is enabled, the interface treats messages transmitted by itself as received messages\&. The loopback mode is important to debug CAN networks\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 250\&. .RE .PP \fIOneShot=\fR .RS 4 Takes a boolean\&. When "yes", one\-shot mode is enabled\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 250\&. .RE .PP \fIPresumeAck=\fR .RS 4 Takes a boolean\&. When "yes", the interface will ignore missing CAN ACKs\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 250\&. .RE .PP \fIClassicDataLengthCode=\fR .RS 4 Takes a boolean\&. When "yes", the interface will handle the 4bit data length code (DLC)\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 250\&. .RE .SH "[IPOIB] SECTION OPTIONS" .PP @@ -3261,11 +4337,15 @@ When .sp When "connected", the Infiniband reliable connected (RC) transport is used\&. Connected mode takes advantage of the connected nature of the IB transport and allows an MTU up to the maximal IP packet size of 64K, which reduces the number of IP packets needed for handling large UDP datagrams, TCP segments, etc and increases the performance for large messages\&. +.sp +Added in version 250\&. .RE .PP \fIIgnoreUserspaceMulticastGroup=\fR .RS 4 Takes an boolean value\&. When true, the kernel ignores multicast groups handled by userspace\&. Defaults to unset, and the kernel\*(Aqs default is used\&. +.sp +Added in version 250\&. .RE .SH "[QDISC] SECTION OPTIONS" .PP @@ -3277,6 +4357,8 @@ Specifies the parent Queueing Discipline (qdisc)\&. Takes one of "clsact" or "ingress"\&. This is mandatory\&. +.sp +Added in version 244\&. .RE .PP \fIHandle=\fR @@ -3305,26 +4387,36 @@ Configures the major number of unique identifier of the qdisc, known as the hand \fIDelaySec=\fR .RS 4 Specifies the fixed amount of delay to be added to all packets going out of the interface\&. Defaults to unset\&. +.sp +Added in version 245\&. .RE .PP \fIDelayJitterSec=\fR .RS 4 Specifies the chosen delay to be added to the packets outgoing to the network interface\&. Defaults to unset\&. +.sp +Added in version 245\&. .RE .PP \fIPacketLimit=\fR .RS 4 Specifies the maximum number of packets the qdisc may hold queued at a time\&. An unsigned integer in the range 0\&...4294967294\&. Defaults to 1000\&. +.sp +Added in version 245\&. .RE .PP \fILossRate=\fR .RS 4 Specifies an independent loss probability to be added to the packets outgoing from the network interface\&. Takes a percentage value, suffixed with "%"\&. Defaults to unset\&. +.sp +Added in version 245\&. .RE .PP \fIDuplicateRate=\fR .RS 4 Specifies that the chosen percent of packets is duplicated before queuing them\&. Takes a percentage value, suffixed with "%"\&. Defaults to unset\&. +.sp +Added in version 245\&. .RE .SH "[TOKENBUCKETFILTER] SECTION OPTIONS" .PP @@ -3348,36 +4440,50 @@ Configures the major number of unique identifier of the qdisc, known as the hand \fILatencySec=\fR .RS 4 Specifies the latency parameter, which specifies the maximum amount of time a packet can sit in the Token Bucket Filter (TBF)\&. Defaults to unset\&. +.sp +Added in version 245\&. .RE .PP \fILimitBytes=\fR .RS 4 Takes the number of bytes that can be queued waiting for tokens to become available\&. When the size is suffixed with K, M, or G, it is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024\&. Defaults to unset\&. +.sp +Added in version 246\&. .RE .PP \fIBurstBytes=\fR .RS 4 Specifies the size of the bucket\&. This is the maximum amount of bytes that tokens can be available for instantaneous transfer\&. When the size is suffixed with K, M, or G, it is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024\&. Defaults to unset\&. +.sp +Added in version 246\&. .RE .PP \fIRate=\fR .RS 4 Specifies the device specific bandwidth\&. When suffixed with K, M, or G, the specified bandwidth is parsed as Kilobits, Megabits, or Gigabits, respectively, to the base of 1000\&. Defaults to unset\&. +.sp +Added in version 245\&. .RE .PP \fIMPUBytes=\fR .RS 4 The Minimum Packet Unit (MPU) determines the minimal token usage (specified in bytes) for a packet\&. When suffixed with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024\&. Defaults to zero\&. +.sp +Added in version 245\&. .RE .PP \fIPeakRate=\fR .RS 4 Takes the maximum depletion rate of the bucket\&. When suffixed with K, M, or G, the specified size is parsed as Kilobits, Megabits, or Gigabits, respectively, to the base of 1000\&. Defaults to unset\&. +.sp +Added in version 245\&. .RE .PP \fIMTUBytes=\fR .RS 4 Specifies the size of the peakrate bucket\&. When suffixed with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024\&. Defaults to unset\&. +.sp +Added in version 245\&. .RE .SH "[PIE] SECTION OPTIONS" .PP @@ -3401,6 +4507,8 @@ Configures the major number of unique identifier of the qdisc, known as the hand \fIPacketLimit=\fR .RS 4 Specifies the hard limit on the queue size in number of packets\&. When this limit is reached, incoming packets are dropped\&. An unsigned integer in the range 1\&...4294967294\&. Defaults to unset and kernel\*(Aqs default is used\&. +.sp +Added in version 246\&. .RE .SH "[FLOWQUEUEPIE] SECTION OPTIONS" .PP @@ -3426,6 +4534,8 @@ Configures the major number of unique identifier of the qdisc, known as the hand \fIPacketLimit=\fR .RS 4 Specifies the hard limit on the queue size in number of packets\&. When this limit is reached, incoming packets are dropped\&. An unsigned integer ranges 1 to 4294967294\&. Defaults to unset and kernel\*(Aqs default is used\&. +.sp +Added in version 247\&. .RE .SH "[STOCHASTICFAIRBLUE] SECTION OPTIONS" .PP @@ -3449,6 +4559,8 @@ Configures the major number of unique identifier of the qdisc, known as the hand \fIPacketLimit=\fR .RS 4 Specifies the hard limit on the queue size in number of packets\&. When this limit is reached, incoming packets are dropped\&. An unsigned integer in the range 0\&...4294967294\&. Defaults to unset and kernel\*(Aqs default is used\&. +.sp +Added in version 246\&. .RE .SH "[STOCHASTICFAIRNESSQUEUEING] SECTION OPTIONS" .PP @@ -3472,6 +4584,8 @@ Configures the major number of unique identifier of the qdisc, known as the hand \fIPerturbPeriodSec=\fR .RS 4 Specifies the interval in seconds for queue algorithm perturbation\&. Defaults to unset\&. +.sp +Added in version 245\&. .RE .SH "[BFIFO] SECTION OPTIONS" .PP @@ -3495,6 +4609,8 @@ Configures the major number of unique identifier of the qdisc, known as the hand \fILimitBytes=\fR .RS 4 Specifies the hard limit in bytes on the FIFO buffer size\&. The size limit prevents overflow in case the kernel is unable to dequeue packets as quickly as it receives them\&. When this limit is reached, incoming packets are dropped\&. When suffixed with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024\&. Defaults to unset and kernel default is used\&. +.sp +Added in version 246\&. .RE .SH "[PFIFO] SECTION OPTIONS" .PP @@ -3518,6 +4634,8 @@ Configures the major number of unique identifier of the qdisc, known as the hand \fIPacketLimit=\fR .RS 4 Specifies the hard limit on the number of packets in the FIFO queue\&. The size limit prevents overflow in case the kernel is unable to dequeue packets as quickly as it receives them\&. When this limit is reached, incoming packets are dropped\&. An unsigned integer in the range 0\&...4294967294\&. Defaults to unset and kernel\*(Aqs default is used\&. +.sp +Added in version 246\&. .RE .SH "[PFIFOHEADDROP] SECTION OPTIONS" .PP @@ -3541,6 +4659,8 @@ Configures the major number of unique identifier of the qdisc, known as the hand \fIPacketLimit=\fR .RS 4 As in [PFIFO] section\&. +.sp +Added in version 246\&. .RE .SH "[PFIFOFAST] SECTION OPTIONS" .PP @@ -3582,6 +4702,8 @@ Configures the major number of unique identifier of the qdisc, known as the hand \fIBandwidth=\fR .RS 4 Specifies the shaper bandwidth\&. When suffixed with K, M, or G, the specified size is parsed as Kilobits, Megabits, or Gigabits, respectively, to the base of 1000\&. Defaults to unset and kernel\*(Aqs default is used\&. +.sp +Added in version 246\&. .RE .PP \fIAutoRateIngress=\fR @@ -3589,16 +4711,22 @@ Specifies the shaper bandwidth\&. When suffixed with K, M, or G, the specified s Takes a boolean value\&. Enables automatic capacity estimation based on traffic arriving at this qdisc\&. This is most likely to be useful with cellular links, which tend to change quality randomly\&. If this setting is enabled, the \fIBandwidth=\fR setting is used as an initial estimate\&. Defaults to unset, and the kernel\*(Aqs default is used\&. +.sp +Added in version 250\&. .RE .PP \fIOverheadBytes=\fR .RS 4 Specifies that bytes to be addeded to the size of each packet\&. Bytes may be negative\&. Takes an integer in the range \-64\&...256\&. Defaults to unset and kernel\*(Aqs default is used\&. +.sp +Added in version 246\&. .RE .PP \fIMPUBytes=\fR .RS 4 Rounds each packet (including overhead) up to the specified bytes\&. Takes an integer in the range 1\&...256\&. Defaults to unset and kernel\*(Aqs default is used\&. +.sp +Added in version 250\&. .RE .PP \fICompensationMode=\fR @@ -3610,11 +4738,15 @@ Takes one of "none", no compensation is taken into account\&. When "atm", enables the compensation for ATM cell framing, which is normally found on ADSL links\&. When "ptm", enables the compensation for PTM encoding, which is normally found on VDSL2 links and uses a 64b/65b encoding scheme\&. Defaults to unset and the kernel\*(Aqs default is used\&. +.sp +Added in version 250\&. .RE .PP \fIUseRawPacketSize=\fR .RS 4 Takes a boolean value\&. When true, the packet size reported by the Linux kernel will be used, instead of the underlying IP packet size\&. Defaults to unset, and the kernel\*(Aqs default is used\&. +.sp +Added in version 250\&. .RE .PP \fIFlowIsolationMode=\fR @@ -3624,6 +4756,8 @@ CAKE places packets from different flows into different queues, then packets fro \fBnone\fR .RS 4 The flow isolation is disabled, and all traffic passes through a single queue\&. +.sp +Added in version 250\&. .RE .PP \fBsrc\-host\fR @@ -3634,6 +4768,8 @@ option for \fBtc qdisc\fR command\&. See also \fBtc-cake\fR(8)\&. +.sp +Added in version 250\&. .RE .PP \fBdst\-host\fR @@ -3644,6 +4780,8 @@ option for \fBtc qdisc\fR command\&. See also \fBtc-cake\fR(8)\&. +.sp +Added in version 250\&. .RE .PP \fBhosts\fR @@ -3652,6 +4790,8 @@ Flows are defined by source\-destination host pairs\&. Equivalent to the same op \fBtc qdisc\fR command\&. See also \fBtc-cake\fR(8)\&. +.sp +Added in version 250\&. .RE .PP \fBflows\fR @@ -3660,6 +4800,8 @@ Flows are defined by the entire 5\-tuple of source address, destination address, \fBtc qdisc\fR command\&. See also \fBtc-cake\fR(8)\&. +.sp +Added in version 250\&. .RE .PP \fBdual\-src\-host\fR @@ -3672,6 +4814,8 @@ option for \fBtc qdisc\fR command\&. See also \fBtc-cake\fR(8)\&. +.sp +Added in version 250\&. .RE .PP \fBdual\-dst\-host\fR @@ -3684,6 +4828,8 @@ option for \fBtc qdisc\fR command\&. See also \fBtc-cake\fR(8)\&. +.sp +Added in version 250\&. .RE .PP \fBtriple\fR @@ -3695,9 +4841,13 @@ option for \fBtc qdisc\fR command\&. See also \fBtc-cake\fR(8)\&. +.sp +Added in version 250\&. .RE .sp Defaults to unset and the kernel\*(Aqs default is used\&. +.sp +Added in version 250\&. .RE .PP \fINAT=\fR @@ -3708,6 +4858,8 @@ is "none" or "flows", or if NAT is performed on a different host\&. Defaults to unset, and the kernel\*(Aqs default is used\&. +.sp +Added in version 250\&. .RE .PP \fIPriorityQueueingPreset=\fR @@ -3718,6 +4870,8 @@ CAKE divides traffic into \fBbesteffort\fR .RS 4 Disables priority queueing by placing all traffic in one tin\&. +.sp +Added in version 250\&. .RE .PP \fBprecedence\fR @@ -3725,44 +4879,62 @@ Disables priority queueing by placing all traffic in one tin\&. Enables priority queueing based on the legacy interpretation of TOS "Precedence" field\&. Use of this preset on the modern Internet is firmly discouraged\&. +.sp +Added in version 250\&. .RE .PP \fBdiffserv8\fR .RS 4 Enables priority queueing based on the Differentiated Service ("DiffServ") field with eight tins: Background Traffic, High Throughput, Best Effort, Video Streaming, Low Latency Transactions, Interactive Shell, Minimum Latency, and Network Control\&. +.sp +Added in version 250\&. .RE .PP \fBdiffserv4\fR .RS 4 Enables priority queueing based on the Differentiated Service ("DiffServ") field with four tins: Background Traffic, Best Effort, Streaming Media, and Latency Sensitive\&. +.sp +Added in version 250\&. .RE .PP \fBdiffserv3\fR .RS 4 Enables priority queueing based on the Differentiated Service ("DiffServ") field with three tins: Background Traffic, Best Effort, and Latency Sensitive\&. +.sp +Added in version 250\&. .RE .sp Defaults to unset, and the kernel\*(Aqs default is used\&. +.sp +Added in version 250\&. .RE .PP \fIFirewallMark=\fR .RS 4 Takes an integer in the range 1\&...4294967295\&. When specified, firewall\-mark\-based overriding of CAKE\*(Aqs tin selection is enabled\&. Defaults to unset, and the kernel\*(Aqs default is used\&. +.sp +Added in version 250\&. .RE .PP \fIWash=\fR .RS 4 Takes a boolean value\&. When true, CAKE clears the DSCP fields, except for ECN bits, of any packet passing through CAKE\&. Defaults to unset, and the kernel\*(Aqs default is used\&. +.sp +Added in version 250\&. .RE .PP \fISplitGSO=\fR .RS 4 Takes a boolean value\&. When true, CAKE will split General Segmentation Offload (GSO) super\-packets into their on\-the\-wire components and dequeue them individually\&. Defaults to unset, and the kernel\*(Aqs default is used\&. +.sp +Added in version 250\&. .RE .PP \fIRTTSec=\fR .RS 4 Specifies the RTT for the filter\&. Takes a timespan\&. Typical values are e\&.g\&. 100us for extremely high\-performance 10GigE+ networks like datacentre, 1ms for non\-WiFi LAN connections, 100ms for typical internet connections\&. Defaults to unset, and the kernel\*(Aqs default will be used\&. +.sp +Added in version 253\&. .RE .PP \fIAckFilter=\fR @@ -3771,6 +4943,8 @@ Takes a boolean value, or special value "aggressive"\&. If enabled, ACKs in each flow are queued and redundant ACKs to the upstream are dropped\&. If yes, the filter will always keep at least two redundant ACKs in the queue, while in "aggressive" mode, it will filter down to a single ACK\&. This may improve download throughput on links with very asymmetrical rate limits\&. Defaults to unset, and the kernel\*(Aqs default will be used\&. +.sp +Added in version 253\&. .RE .SH "[CONTROLLEDDELAY] SECTION OPTIONS" .PP @@ -3794,26 +4968,36 @@ Configures the major number of unique identifier of the qdisc, known as the hand \fIPacketLimit=\fR .RS 4 Specifies the hard limit on the queue size in number of packets\&. When this limit is reached, incoming packets are dropped\&. An unsigned integer in the range 0\&...4294967294\&. Defaults to unset and kernel\*(Aqs default is used\&. +.sp +Added in version 245\&. .RE .PP \fITargetSec=\fR .RS 4 Takes a timespan\&. Specifies the acceptable minimum standing/persistent queue delay\&. Defaults to unset and kernel\*(Aqs default is used\&. +.sp +Added in version 245\&. .RE .PP \fIIntervalSec=\fR .RS 4 Takes a timespan\&. This is used to ensure that the measured minimum delay does not become too stale\&. Defaults to unset and kernel\*(Aqs default is used\&. +.sp +Added in version 245\&. .RE .PP \fIECN=\fR .RS 4 Takes a boolean\&. This can be used to mark packets instead of dropping them\&. Defaults to unset and kernel\*(Aqs default is used\&. +.sp +Added in version 245\&. .RE .PP \fICEThresholdSec=\fR .RS 4 Takes a timespan\&. This sets a threshold above which all packets are marked with ECN Congestion Experienced (CE)\&. Defaults to unset and kernel\*(Aqs default is used\&. +.sp +Added in version 245\&. .RE .SH "[DEFICITROUNDROBINSCHEDULER] SECTION OPTIONS" .PP @@ -3852,6 +5036,8 @@ Configures the unique identifier of the class\&. It is specified as the major an \fIQuantumBytes=\fR .RS 4 Specifies the amount of bytes a flow is allowed to dequeue before the scheduler moves to the next class\&. When suffixed with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024\&. Defaults to the MTU of the interface\&. +.sp +Added in version 246\&. .RE .SH "[ENHANCEDTRANSMISSIONSELECTION] SECTION OPTIONS" .PP @@ -3878,21 +5064,29 @@ Specifies the number of bands\&. An unsigned integer in the range 1\&...16\&. Th \fIStrictBands=\fR and bandwidth\-sharing bands specified in \fIQuantumBytes=\fR\&. +.sp +Added in version 246\&. .RE .PP \fIStrictBands=\fR .RS 4 Specifies the number of bands that should be created in strict mode\&. An unsigned integer in the range 1\&...16\&. +.sp +Added in version 246\&. .RE .PP \fIQuantumBytes=\fR .RS 4 Specifies the white\-space separated list of quantum used in band\-sharing bands\&. When suffixed with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024\&. This setting can be specified multiple times\&. If an empty string is assigned, then the all previous assignments are cleared\&. +.sp +Added in version 246\&. .RE .PP \fIPriorityMap=\fR .RS 4 The priority map maps the priority of a packet to a band\&. The argument is a whitespace separated list of numbers\&. The first number indicates which band the packets with priority 0 should be put to, the second is for priority 1, and so on\&. There can be up to 16 numbers in the list\&. If there are fewer, the default band that traffic with one of the unmentioned priorities goes to is the last one\&. Each band number must be in the range 0\&...255\&. This setting can be specified multiple times\&. If an empty string is assigned, then the all previous assignments are cleared\&. +.sp +Added in version 246\&. .RE .SH "[GENERICRANDOMEARLYDETECTION] SECTION OPTIONS" .PP @@ -3916,17 +5110,23 @@ Configures the major number of unique identifier of the qdisc, known as the hand \fIVirtualQueues=\fR .RS 4 Specifies the number of virtual queues\&. Takes an integer in the range 1\&...16\&. Defaults to unset and kernel\*(Aqs default is used\&. +.sp +Added in version 246\&. .RE .PP \fIDefaultVirtualQueue=\fR .RS 4 Specifies the number of default virtual queue\&. This must be less than \fIVirtualQueue=\fR\&. Defaults to unset and kernel\*(Aqs default is used\&. +.sp +Added in version 246\&. .RE .PP \fIGenericRIO=\fR .RS 4 Takes a boolean\&. It turns on the RIO\-like buffering scheme\&. Defaults to unset and kernel\*(Aqs default is used\&. +.sp +Added in version 246\&. .RE .SH "[FAIRQUEUEINGCONTROLLEDDELAY] SECTION OPTIONS" .PP @@ -3950,41 +5150,57 @@ Configures the major number of unique identifier of the qdisc, known as the hand \fIPacketLimit=\fR .RS 4 Specifies the hard limit on the real queue size\&. When this limit is reached, incoming packets are dropped\&. Defaults to unset and kernel\*(Aqs default is used\&. +.sp +Added in version 245\&. .RE .PP \fIMemoryLimitBytes=\fR .RS 4 Specifies the limit on the total number of bytes that can be queued in this FQ\-CoDel instance\&. When suffixed with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024\&. Defaults to unset and kernel\*(Aqs default is used\&. +.sp +Added in version 246\&. .RE .PP \fIFlows=\fR .RS 4 Specifies the number of flows into which the incoming packets are classified\&. Defaults to unset and kernel\*(Aqs default is used\&. +.sp +Added in version 245\&. .RE .PP \fITargetSec=\fR .RS 4 Takes a timespan\&. Specifies the acceptable minimum standing/persistent queue delay\&. Defaults to unset and kernel\*(Aqs default is used\&. +.sp +Added in version 245\&. .RE .PP \fIIntervalSec=\fR .RS 4 Takes a timespan\&. This is used to ensure that the measured minimum delay does not become too stale\&. Defaults to unset and kernel\*(Aqs default is used\&. +.sp +Added in version 245\&. .RE .PP \fIQuantumBytes=\fR .RS 4 Specifies the number of bytes used as the "deficit" in the fair queuing algorithm timespan\&. When suffixed with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024\&. Defaults to unset and kernel\*(Aqs default is used\&. +.sp +Added in version 246\&. .RE .PP \fIECN=\fR .RS 4 Takes a boolean\&. This can be used to mark packets instead of dropping them\&. Defaults to unset and kernel\*(Aqs default is used\&. +.sp +Added in version 245\&. .RE .PP \fICEThresholdSec=\fR .RS 4 Takes a timespan\&. This sets a threshold above which all packets are marked with ECN Congestion Experienced (CE)\&. Defaults to unset and kernel\*(Aqs default is used\&. +.sp +Added in version 245\&. .RE .SH "[FAIRQUEUEING] SECTION OPTIONS" .PP @@ -4008,46 +5224,64 @@ Configures the major number of unique identifier of the qdisc, known as the hand \fIPacketLimit=\fR .RS 4 Specifies the hard limit on the real queue size\&. When this limit is reached, incoming packets are dropped\&. Defaults to unset and kernel\*(Aqs default is used\&. +.sp +Added in version 245\&. .RE .PP \fIFlowLimit=\fR .RS 4 Specifies the hard limit on the maximum number of packets queued per flow\&. Defaults to unset and kernel\*(Aqs default is used\&. +.sp +Added in version 245\&. .RE .PP \fIQuantumBytes=\fR .RS 4 Specifies the credit per dequeue RR round, i\&.e\&. the amount of bytes a flow is allowed to dequeue at once\&. When suffixed with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024\&. Defaults to unset and kernel\*(Aqs default is used\&. +.sp +Added in version 246\&. .RE .PP \fIInitialQuantumBytes=\fR .RS 4 Specifies the initial sending rate credit, i\&.e\&. the amount of bytes a new flow is allowed to dequeue initially\&. When suffixed with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024\&. Defaults to unset and kernel\*(Aqs default is used\&. +.sp +Added in version 245\&. .RE .PP \fIMaximumRate=\fR .RS 4 Specifies the maximum sending rate of a flow\&. When suffixed with K, M, or G, the specified size is parsed as Kilobits, Megabits, or Gigabits, respectively, to the base of 1000\&. Defaults to unset and kernel\*(Aqs default is used\&. +.sp +Added in version 245\&. .RE .PP \fIBuckets=\fR .RS 4 Specifies the size of the hash table used for flow lookups\&. Defaults to unset and kernel\*(Aqs default is used\&. +.sp +Added in version 245\&. .RE .PP \fIOrphanMask=\fR .RS 4 Takes an unsigned integer\&. For packets not owned by a socket, fq is able to mask a part of hash and reduce number of buckets associated with the traffic\&. Defaults to unset and kernel\*(Aqs default is used\&. +.sp +Added in version 245\&. .RE .PP \fIPacing=\fR .RS 4 Takes a boolean, and enables or disables flow pacing\&. Defaults to unset and kernel\*(Aqs default is used\&. +.sp +Added in version 245\&. .RE .PP \fICEThresholdSec=\fR .RS 4 Takes a timespan\&. This sets a threshold above which all packets are marked with ECN Congestion Experienced (CE)\&. Defaults to unset and kernel\*(Aqs default is used\&. +.sp +Added in version 245\&. .RE .SH "[TRIVIALLINKEQUALIZER] SECTION OPTIONS" .PP @@ -4080,6 +5314,8 @@ with option must be loaded before \fBsystemd\-networkd\fR is started\&. +.sp +Added in version 245\&. .RE .SH "[HIERARCHYTOKENBUCKET] SECTION OPTIONS" .PP @@ -4103,6 +5339,8 @@ Configures the major number of unique identifier of the qdisc, known as the hand \fIDefaultClass=\fR .RS 4 Takes the minor id in hexadecimal of the default class\&. Unclassified traffic gets sent to the class\&. Defaults to unset\&. +.sp +Added in version 246\&. .RE .PP \fIRateToQuantum=\fR @@ -4111,6 +5349,8 @@ Takes an unsigned integer\&. The DRR quantums are calculated by dividing the val \fIRate=\fR by \fIRateToQuantum=\fR\&. +.sp +Added in version 246\&. .RE .SH "[HIERARCHYTOKENBUCKETCLASS] SECTION OPTIONS" .PP @@ -4131,26 +5371,36 @@ Configures the unique identifier of the class\&. It is specified as the major an \fIPriority=\fR .RS 4 Specifies the priority of the class\&. In the round\-robin process, classes with the lowest priority field are tried for packets first\&. +.sp +Added in version 246\&. .RE .PP \fIQuantumBytes=\fR .RS 4 Specifies how many bytes to serve from leaf at once\&. When suffixed with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024\&. +.sp +Added in version 246\&. .RE .PP \fIMTUBytes=\fR .RS 4 Specifies the maximum packet size we create\&. When suffixed with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024\&. +.sp +Added in version 246\&. .RE .PP \fIOverheadBytes=\fR .RS 4 Takes an unsigned integer which specifies per\-packet size overhead used in rate computations\&. When suffixed with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024\&. +.sp +Added in version 246\&. .RE .PP \fIRate=\fR .RS 4 Specifies the maximum rate this class and all its children are guaranteed\&. When suffixed with K, M, or G, the specified size is parsed as Kilobits, Megabits, or Gigabits, respectively, to the base of 1000\&. This setting is mandatory\&. +.sp +Added in version 246\&. .RE .PP \fICeilRate=\fR @@ -4158,16 +5408,22 @@ Specifies the maximum rate this class and all its children are guaranteed\&. Whe Specifies the maximum rate at which a class can send, if its parent has bandwidth to spare\&. When suffixed with K, M, or G, the specified size is parsed as Kilobits, Megabits, or Gigabits, respectively, to the base of 1000\&. When unset, the value specified with \fIRate=\fR is used\&. +.sp +Added in version 246\&. .RE .PP \fIBufferBytes=\fR .RS 4 Specifies the maximum bytes burst which can be accumulated during idle period\&. When suffixed with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024\&. +.sp +Added in version 246\&. .RE .PP \fICeilBufferBytes=\fR .RS 4 Specifies the maximum bytes burst for ceil which can be accumulated during idle period\&. When suffixed with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024\&. +.sp +Added in version 246\&. .RE .SH "[HEAVYHITTERFILTER] SECTION OPTIONS" .PP @@ -4191,6 +5447,8 @@ Configures the major number of unique identifier of the qdisc, known as the hand \fIPacketLimit=\fR .RS 4 Specifies the hard limit on the queue size in number of packets\&. When this limit is reached, incoming packets are dropped\&. An unsigned integer in the range 0\&...4294967294\&. Defaults to unset and kernel\*(Aqs default is used\&. +.sp +Added in version 246\&. .RE .SH "[QUICKFAIRQUEUEING] SECTION OPTIONS" .PP @@ -4229,11 +5487,15 @@ Configures the unique identifier of the class\&. It is specified as the major an \fIWeight=\fR .RS 4 Specifies the weight of the class\&. Takes an integer in the range 1\&...1023\&. Defaults to unset in which case the kernel default is used\&. +.sp +Added in version 246\&. .RE .PP \fIMaxPacketBytes=\fR .RS 4 Specifies the maximum packet size in bytes for the class\&. When suffixed with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024\&. When unset, the kernel default is used\&. +.sp +Added in version 246\&. .RE .SH "[BRIDGEVLAN] SECTION OPTIONS" .PP @@ -4245,6 +5507,8 @@ option has to be enabled, see the [Bridge] section in \fIVLAN=\fR .RS 4 The VLAN ID allowed on the port\&. This can be either a single ID or a range M\-N\&. Takes an integer in the range 1\&...4094\&. +.sp +Added in version 231\&. .RE .PP \fIEgressUntagged=\fR @@ -4254,6 +5518,8 @@ The VLAN ID specified here will be used to untag frames on egress\&. Configuring implicates the use of \fIVLAN=\fR above and will enable the VLAN ID for ingress as well\&. This can be either a single ID or a range M\-N\&. +.sp +Added in version 231\&. .RE .PP \fIPVID=\fR @@ -4265,6 +5531,8 @@ can be used only once\&. Configuring implicates the use of \fIVLAN=\fR above and will enable the VLAN ID for ingress as well\&. +.sp +Added in version 231\&. .RE .SH "EXAMPLES" .PP @@ -4803,7 +6071,7 @@ RFC 4941 \%https://tools.ietf.org/html/rfc4941 .RE .IP " 9." 4 -RFC 1027 +RFC 3704 .RS 4 \%https://tools.ietf.org/html/rfc1027 .RE @@ -4843,81 +6111,111 @@ NetLabel Fallback Peer Labeling \%https://github.com/SELinuxProject/selinux-notebook/blob/main/src/network_support.md .RE .IP "17." 4 +NFT +.RS 4 +\%https://netfilter.org/projects/nftables/index.html +.RE +.IP "18." 4 RFC 3484 .RS 4 \%https://tools.ietf.org/html/rfc3484 .RE -.IP "18." 4 +.IP "19." 4 Type of Service .RS 4 \%https://en.wikipedia.org/wiki/Type_of_service .RE -.IP "19." 4 +.IP "20." 4 Differentiated services .RS 4 \%https://en.wikipedia.org/wiki/Differentiated_services .RE -.IP "20." 4 +.IP "21." 4 RFC 4191 .RS 4 \%https://tools.ietf.org/html/rfc4191 .RE -.IP "21." 4 +.IP "22." 4 RFC 8520 .RS 4 \%https://tools.ietf.org/html/rfc8520 .RE -.IP "22." 4 +.IP "23." 4 +RFC 4039 +.RS 4 +\%https://tools.ietf.org/html/rfc4039 +.RE +.IP "24." 4 RFC 7844 .RS 4 \%https://tools.ietf.org/html/rfc7844 .RE -.IP "23." 4 +.IP "25." 4 C-style escapes .RS 4 \%https://en.wikipedia.org/wiki/Escape_sequences_in_C#Table_of_escape_sequences .RE -.IP "24." 4 +.IP "26." 4 +RFC 3442 +.RS 4 +\%https://datatracker.ietf.org/doc/html/rfc3442 +.RE +.IP "27." 4 RFC 5969 .RS 4 \%https://tools.ietf.org/html/rfc5969 .RE -.IP "25." 4 +.IP "28." 4 +RFC 8925 +.RS 4 +\%https://tools.ietf.org/html/rfc8925 +.RE +.IP "29." 4 RFC 3315 .RS 4 \%https://tools.ietf.org/html/rfc3315#section-17.2.1 .RE -.IP "26." 4 +.IP "30." 4 RFC 8415 .RS 4 \%https://www.rfc-editor.org/rfc/rfc8415.html#section-6.3 .RE -.IP "27." 4 +.IP "31." 4 RFC 4291 .RS 4 \%https://tools.ietf.org/html/rfc4291#section-2.5.4 .RE -.IP "28." 4 +.IP "32." 4 RFC 7217 .RS 4 \%https://tools.ietf.org/html/rfc7217 .RE -.IP "29." 4 +.IP "33." 4 +RFC 8781 +.RS 4 +\%https://tools.ietf.org/html/rfc8781 +.RE +.IP "34." 4 RFC 2131 .RS 4 \%https://www.rfc-editor.org/rfc/rfc2131.html .RE -.IP "30." 4 +.IP "35." 4 RFC 2132 .RS 4 \%https://www.rfc-editor.org/rfc/rfc2132.html .RE -.IP "31." 4 +.IP "36." 4 RFC 1542 .RS 4 \%https://tools.ietf.org/html/rfc1542 .RE -.IP "32." 4 +.IP "37." 4 +RFC 4039 +.RS 4 +\%https://datatracker.ietf.org/doc/html/rfc4039 +.RE +.IP "38." 4 RFC 4861 .RS 4 \%https://tools.ietf.org/html/rfc4861 diff --git a/upstream/opensuse-tumbleweed/man5/systemd.nspawn.5 b/upstream/opensuse-tumbleweed/man5/systemd.nspawn.5 index 40a2ad9b..0c441ba1 100644 --- a/upstream/opensuse-tumbleweed/man5/systemd.nspawn.5 +++ b/upstream/opensuse-tumbleweed/man5/systemd.nspawn.5 @@ -1,5 +1,5 @@ '\" t -.TH "SYSTEMD\&.NSPAWN" "5" "" "systemd 254" "systemd.nspawn" +.TH "SYSTEMD\&.NSPAWN" "5" "" "systemd 255" "systemd.nspawn" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -86,6 +86,8 @@ command line\&. This option may not be combined with \fIProcessTwo=yes\fR\&. This option is specified by default in the systemd\-nspawn@\&.service template unit\&. +.sp +Added in version 226\&. .RE .PP \fIEphemeral=\fR @@ -95,6 +97,8 @@ Takes a boolean argument, which defaults to off, If enabled, the container is ru command line switch\&. See \fBsystemd-nspawn\fR(1) for details about the specific options supported\&. +.sp +Added in version 240\&. .RE .PP \fIProcessTwo=\fR @@ -105,6 +109,8 @@ switch on the \fBsystemd\-nspawn\fR command line\&. This option may not be combined with \fIBoot=yes\fR\&. +.sp +Added in version 229\&. .RE .PP \fIParameters=\fR @@ -124,6 +130,8 @@ is the same as \fBParameters=b \*(Aqc c\*(Aq\fR is the same as \fBsystemd\-nspawn \-\-boot b \*(Aqc c\*(Aq\fR\&. +.sp +Added in version 226\&. .RE .PP \fIEnvironment=\fR @@ -132,6 +140,8 @@ Takes an environment variable assignment consisting of key and value, separated "="\&. Sets an environment variable for the main process invoked in the container\&. This setting may be used multiple times to set multiple environment variables\&. It corresponds to the \fB\-\-setenv=\fR command line switch\&. +.sp +Added in version 226\&. .RE .PP \fIUser=\fR @@ -139,6 +149,8 @@ command line switch\&. Takes a UNIX user name\&. Specifies the user name to invoke the main process of the container as\&. This user must be known in the container\*(Aqs user database\&. This corresponds to the \fB\-\-user=\fR command line switch\&. +.sp +Added in version 226\&. .RE .PP \fIWorkingDirectory=\fR @@ -146,6 +158,8 @@ command line switch\&. Selects the working directory for the process invoked in the container\&. Expects an absolute path in the container\*(Aqs file system namespace\&. This corresponds to the \fB\-\-chdir=\fR command line switch\&. +.sp +Added in version 229\&. .RE .PP \fIPivotRoot=\fR @@ -155,6 +169,8 @@ Selects a directory to pivot to inside the container when starting up\&. Takes a single path, or a pair of two paths separated by a colon\&. Both paths must be absolute, and are resolved in the container\*(Aqs file system namespace\&. This corresponds to the \fB\-\-pivot\-root=\fR command line switch\&. +.sp +Added in version 233\&. .RE .PP \fICapability=\fR, \fIDropCapability=\fR @@ -185,6 +201,8 @@ is passed, all capabilities are retained (or dropped)\&. .sp These settings change the bounding set of capabilities which also limits the ambient capabilities as given with the \fIAmbientCapability=\fR\&. +.sp +Added in version 226\&. .RE .PP \fIAmbientCapability=\fR @@ -211,6 +229,8 @@ and Note that \fIAmbientCapability=\fR is a privileged setting (see above)\&. +.sp +Added in version 248\&. .RE .PP \fINoNewPrivileges=\fR @@ -222,6 +242,8 @@ flag for the container payload\&. This is equivalent to the command line switch\&. See \fBsystemd-nspawn\fR(1) for details\&. +.sp +Added in version 239\&. .RE .PP \fIKillSignal=\fR @@ -230,6 +252,8 @@ Specify the process signal to send to the container\*(Aqs PID 1 when nspawn itse \fBBoot=\fR is used (on systemd\-compatible init systems SIGRTMIN+3 triggers an orderly shutdown)\&. For a list of valid signals, see \fBsignal\fR(7)\&. +.sp +Added in version 230\&. .RE .PP \fIPersonality=\fR @@ -237,6 +261,8 @@ is used (on systemd\-compatible init systems SIGRTMIN+3 triggers an orderly shut Configures the kernel personality for the container\&. This is equivalent to the \fB\-\-personality=\fR switch\&. +.sp +Added in version 226\&. .RE .PP \fIMachineID=\fR @@ -244,6 +270,8 @@ switch\&. Configures the 128\-bit machine ID (UUID) to pass to the container\&. This is equivalent to the \fB\-\-uuid=\fR command line switch\&. This option is privileged (see above)\&. +.sp +Added in version 226\&. .RE .PP \fIPrivateUsers=\fR @@ -253,6 +281,8 @@ Configures support for usernamespacing\&. This is equivalent to the command line switch, and takes the same options\&. This option is privileged (see above)\&. This option is the default if the systemd\-nspawn@\&.service template unit file is used\&. +.sp +Added in version 230\&. .RE .PP \fINotifyReady=\fR @@ -262,6 +292,8 @@ Configures support for notifications from the container\*(Aqs init process\&. Th command line switch, and takes the same parameters\&. See \fBsystemd-nspawn\fR(1) for details about the specific options supported\&. +.sp +Added in version 231\&. .RE .PP \fISystemCallFilter=\fR @@ -271,6 +303,8 @@ Configures the system call filter applied to containers\&. This is equivalent to command line switch, and takes the same list parameter\&. See \fBsystemd-nspawn\fR(1) for details\&. +.sp +Added in version 235\&. .RE .PP \fILimitCPU=\fR, \fILimitFSIZE=\fR, \fILimitDATA=\fR, \fILimitSTACK=\fR, \fILimitCORE=\fR, \fILimitRSS=\fR, \fILimitNOFILE=\fR, \fILimitAS=\fR, \fILimitNPROC=\fR, \fILimitMEMLOCK=\fR, \fILimitLOCKS=\fR, \fILimitSIGPENDING=\fR, \fILimitMSGQUEUE=\fR, \fILimitNICE=\fR, \fILimitRTPRIO=\fR, \fILimitRTTIME=\fR @@ -280,6 +314,8 @@ Configures various types of resource limits applied to containers\&. This is equ command line switch, and takes the same arguments\&. See \fBsystemd-nspawn\fR(1) for details\&. +.sp +Added in version 239\&. .RE .PP \fIOOMScoreAdjust=\fR @@ -289,6 +325,8 @@ Configures the OOM score adjustment value\&. This is equivalent to the command line switch, and takes the same argument\&. See \fBsystemd-nspawn\fR(1) for details\&. +.sp +Added in version 239\&. .RE .PP \fICPUAffinity=\fR @@ -298,6 +336,8 @@ Configures the CPU affinity\&. This is equivalent to the command line switch, and takes the same argument\&. See \fBsystemd-nspawn\fR(1) for details\&. +.sp +Added in version 239\&. .RE .PP \fIHostname=\fR @@ -307,6 +347,8 @@ Configures the kernel hostname set for the container\&. This is equivalent to th command line switch, and takes the same argument\&. See \fBsystemd-nspawn\fR(1) for details\&. +.sp +Added in version 239\&. .RE .PP \fIResolvConf=\fR @@ -318,6 +360,8 @@ in the container shall be handled\&. This is equivalent to the command line switch, and takes the same argument\&. See \fBsystemd-nspawn\fR(1) for details\&. +.sp +Added in version 239\&. .RE .PP \fITimezone=\fR @@ -329,6 +373,8 @@ in the container shall be handled\&. This is equivalent to the command line switch, and takes the same argument\&. See \fBsystemd-nspawn\fR(1) for details\&. +.sp +Added in version 239\&. .RE .PP \fILinkJournal=\fR @@ -338,6 +384,8 @@ Configures how to link host and container journal setups\&. This is equivalent t command line switch, and takes the same parameter\&. See \fBsystemd-nspawn\fR(1) for details\&. +.sp +Added in version 239\&. .RE .PP \fISuppressSync=\fR @@ -347,6 +395,8 @@ Configures whether to suppress disk synchronization for the container payload\&. command line switch, and takes the same parameter\&. See \fBsystemd-nspawn\fR(1) for details\&. +.sp +Added in version 250\&. .RE .SH "[FILES] SECTION OPTIONS" .PP @@ -357,6 +407,8 @@ Settings files may include a [Files] section, which carries various parameters c Takes a boolean argument, which defaults to off\&. If specified, the container will be run with a read\-only file system\&. This setting corresponds to the \fB\-\-read\-only\fR command line switch\&. +.sp +Added in version 226\&. .RE .PP \fIVolatile=\fR @@ -366,6 +418,8 @@ Takes a boolean argument, or the special value \fB\-\-volatile=\fR, see \fBsystemd-nspawn\fR(1) for details about the specific options supported\&. +.sp +Added in version 226\&. .RE .PP \fIBind=\fR, \fIBindReadOnly=\fR @@ -376,6 +430,8 @@ and \fB\-\-bind\-ro=\fR, see \fBsystemd-nspawn\fR(1) for details about the specific options supported\&. This setting is privileged (see above)\&. +.sp +Added in version 226\&. .RE .PP \fIBindUser=\fR @@ -384,6 +440,8 @@ Binds a user from the host into the container\&. This option is equivalent to th \fB\-\-bind\-user=\fR, see \fBsystemd-nspawn\fR(1) for details about the specific options supported\&. This setting is privileged (see above)\&. +.sp +Added in version 249\&. .RE .PP \fITemporaryFileSystem=\fR @@ -396,6 +454,8 @@ mounts\&. This option is equivalent to the command line switch \fB\-\-tmpfs=\fR, see \fBsystemd-nspawn\fR(1) for details about the specific options supported\&. This setting is privileged (see above)\&. +.sp +Added in version 226\&. .RE .PP \fIInaccessible=\fR @@ -404,6 +464,8 @@ Masks the specified file or directory in the container, by over\-mounting it wit \fB\-\-inaccessible=\fR, see \fBsystemd-nspawn\fR(1) for details about the specific options supported\&. This setting is privileged (see above)\&. +.sp +Added in version 242\&. .RE .PP \fIOverlay=\fR, \fIOverlayReadOnly=\fR @@ -414,6 +476,8 @@ and \fB\-\-overlay\-ro=\fR, see \fBsystemd-nspawn\fR(1) for details about the specific options supported\&. This setting is privileged (see above)\&. +.sp +Added in version 233\&. .RE .PP \fIPrivateUsersOwnership=\fR @@ -421,6 +485,8 @@ for details about the specific options supported\&. This setting is privileged ( Configures whether the ownership of the files and directories in the container tree shall be adjusted to the UID/GID range used, if necessary and user namespacing is enabled\&. This is equivalent to the \fB\-\-private\-users\-ownership=\fR command line switch\&. This option is privileged (see above)\&. +.sp +Added in version 249\&. .RE .SH "[NETWORK] SECTION OPTIONS" .PP @@ -431,6 +497,8 @@ Settings files may include a [Network] section, which carries various parameters Takes a boolean argument, which defaults to off\&. If enabled, the container will run in its own network namespace and not share network interfaces and configuration with the host\&. This setting corresponds to the \fB\-\-private\-network\fR command line switch\&. +.sp +Added in version 226\&. .RE .PP \fIVirtualEthernet=\fR @@ -441,6 +509,8 @@ Takes a boolean argument\&. Configures whether to create a virtual Ethernet conn command line switch\&. This option is privileged (see above)\&. This option is the default if the systemd\-nspawn@\&.service template unit file is used\&. +.sp +Added in version 226\&. .RE .PP \fIVirtualEthernetExtra=\fR @@ -452,6 +522,8 @@ command line switch, and may be used multiple times\&. It is independent of \fIVirtualEthernet=\fR\&. Note that this option is unrelated to the \fIBridge=\fR setting below, and thus any connections created this way are not automatically added to any bridge device on the host side\&. This option is privileged (see above)\&. +.sp +Added in version 228\&. .RE .PP \fIInterface=\fR @@ -460,6 +532,8 @@ Takes a space\-separated list of interfaces to add to the container\&. The inter \fB\-\-network\-interface=\fR command line switch and implies \fIPrivate=yes\fR\&. This option is privileged (see above)\&. +.sp +Added in version 226\&. .RE .PP \fIMACVLAN=\fR, \fIIPVLAN=\fR @@ -470,6 +544,8 @@ and \fB\-\-network\-ipvlan=\fR command line switches and imply \fIPrivate=yes\fR\&. These options are privileged (see above)\&. +.sp +Added in version 226\&. .RE .PP \fIBridge=\fR @@ -481,6 +557,8 @@ and and has the effect that the host side of the created virtual Ethernet link is connected to the specified bridge interface\&. This option corresponds to the \fB\-\-network\-bridge=\fR command line switch\&. This option is privileged (see above)\&. +.sp +Added in version 226\&. .RE .PP \fIZone=\fR @@ -493,6 +571,8 @@ and has the effect that the host side of the created virtual Ethernet link is co "vz\-"\&. This option corresponds to the \fB\-\-network\-zone=\fR command line switch\&. This option is privileged (see above)\&. +.sp +Added in version 230\&. .RE .PP \fIPort=\fR @@ -502,6 +582,8 @@ Exposes a TCP or UDP port of the container on the host\&. This option correspond command line switch, see \fBsystemd-nspawn\fR(1) for the precise syntax of the argument this option takes\&. This option is privileged (see above)\&. +.sp +Added in version 226\&. .RE .SH "SEE ALSO" .PP diff --git a/upstream/opensuse-tumbleweed/man5/systemd.path.5 b/upstream/opensuse-tumbleweed/man5/systemd.path.5 index 5194ea7c..9fbc4d47 100644 --- a/upstream/opensuse-tumbleweed/man5/systemd.path.5 +++ b/upstream/opensuse-tumbleweed/man5/systemd.path.5 @@ -1,5 +1,5 @@ '\" t -.TH "SYSTEMD\&.PATH" "5" "" "systemd 254" "systemd.path" +.TH "SYSTEMD\&.PATH" "5" "" "systemd 255" "systemd.path" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -186,6 +186,8 @@ may be used to configure the length of the time interval in the usual time units for details on the various time units understood\&. The \fITriggerLimitBurst=\fR setting takes a positive integer value and specifies the number of permitted activations per time interval, and defaults to 200\&. Set either to 0 to disable any form of trigger rate limiting\&. If the limit is hit, the unit is placed into a failure mode, and will not watch the paths anymore until restarted\&. Note that this limit is enforced before the service activation is enqueued\&. +.sp +Added in version 250\&. .RE .PP Check diff --git a/upstream/opensuse-tumbleweed/man5/systemd.pcrlock.5 b/upstream/opensuse-tumbleweed/man5/systemd.pcrlock.5 new file mode 100644 index 00000000..655b24f2 --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/systemd.pcrlock.5 @@ -0,0 +1,276 @@ +'\" t +.TH "SYSTEMD\&.PCRLOCK" "5" "" "systemd 255" "systemd.pcrlock" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +systemd.pcrlock, systemd.pcrlock.d \- PCR measurement prediction files +.SH "SYNOPSIS" +.PP +.nf +/etc/pcrlock\&.d/*\&.pcrlock +/etc/pcrlock\&.d/*\&.pcrlock\&.d/*\&.pcrlock +/run/pcrlock\&.d/*\&.pcrlock +/run/pcrlock\&.d/*\&.pcrlock\&.d/*\&.pcrlock +/var/lib/pcrlock\&.d/*\&.pcrlock +/var/lib/pcrlock\&.d/*\&.pcrlock\&.d/*\&.pcrlock +/usr/local/pcrlock\&.d/*\&.pcrlock +/usr/local/pcrlock\&.d/*\&.pcrlock\&.d/*\&.pcrlock +/usr/lib/pcrlock\&.d/*\&.pcrlock +/usr/lib/pcrlock\&.d/*\&.pcrlock\&.d/*\&.pcrlock +.fi +.SH "DESCRIPTION" +.PP +*\&.pcrlock +files define expected TPM2 PCR measurements of components involved in the boot process\&. +\fBsystemd-pcrlock\fR(1) +uses such pcrlock files to analyze and predict TPM2 PCR measurements\&. The pcrlock files are JSON arrays that follow a subset of the +\m[blue]\fBTCG Canonical Event Log Format (CEL\-JSON)\fR\m[]\&\s-2\u[1]\d\s+2 +specification\&. Specifically the +"recnum", +"content", and +"content_type" +record fields are not used and ignored if present\&. Each pcrlock file defines one set of expected, ordered PCR measurements of a specific component of the boot\&. +.PP +*\&.pcrlock files may be placed in various +\&.d/ +drop\-in directories (see above for a full list)\&. All matching files discovered in these directories are sorted alphabetically by their file name (without taking the actual directory they were found in into account): pcrlock files with alphabetically earlier names are expected to cover measurements done before those with alphabetically later names\&. In order to make positioning pcrlock files in the boot process convenient the files are expected (by convention, this is not enforced) to be named +"\fINNN\fR\-\fIcomponent\fR\&.pcrlock" +(where +\fINNN\fR +is a three\-digit decimal number), for example +750\-enter\-initrd\&.pcrlock\&. +.PP +For various components of the boot process more than one alternative pcrlock file shall be supported (i\&.e\&. "variants")\&. For example to cover multiple kernels installed in parallel in the access policy, or multiple versions of the boot loader\&. This can be done by placing +*\&.pcrlock\&.d/*\&.pcrlock +in the drop\-in dirs, i\&.e\&. a common directory for a specific component, that contains one or more pcrlock files each covering one +\fIvariant\fR +of the component\&. Example: +650\-kernel\&.pcrlock\&.d/6\&.5\&.5\-200\&.fc38\&.x86_64\&.pcrlock +and +650\-kernel\&.pcrlock\&.d/6\&.5\&.7\-100\&.fc38\&.x86_64\&.pcrlock +.PP +Use +\fBsystemd\-pcrlock list\-components\fR +to list all pcrlock files currently installed\&. +.PP +Use the various +\fBlock\-*\fR +commands of +\fBsystemd\-pcrlock\fR +to automatically generate suitable pcrlock files for various types of resources\&. +.SH "WELL\-KNOWN COMPONENTS" +.PP +Components of the boot process may be defined freely by the administrator or OS vendor\&. The following components are well\-known however, and are defined by systemd\&. The list below is useful for ordering local pcrlock files properly against these components of the boot\&. +.PP +240\-secureboot\-policy\&.pcrlock +.RS 4 +The SecureBoot policy, as recorded to PCR 7\&. May be generated via +\fBsystemd\-pcrlock lock\-secureboot\-policy\fR\&. +.sp +Added in version 255\&. +.RE +.PP +250\-firmware\-code\-early\&.pcrlock +.RS 4 +Firmware code measurements, as recorded to PCR 0 and 2, up to the separator measurement (see +400\-secureboot\-separator\&.pcrlock +below)\&. May be generated via +\fBsystemd\-pcrlock lock\-firmware\-code\fR\&. +.sp +Added in version 255\&. +.RE +.PP +250\-firmware\-config\-early\&.pcrlock +.RS 4 +Firmware configuration measurements, as recorded to PCR 1 and 3, up to the separator measurement (see +400\-secureboot\-separator\&.pcrlock +below)\&. May be generated via +\fBsystemd\-pcrlock lock\-firmware\-config\fR\&. +.sp +Added in version 255\&. +.RE +.PP +350\-action\-efi\-application\&.pcrlock +.RS 4 +The EFI "Application" measurement done once by the firmware\&. Statically defined\&. +.sp +Added in version 255\&. +.RE +.PP +400\-secureboot\-separator\&.pcrlock +.RS 4 +The EFI "separator" measurement on PCR 7 done once by the firmware to indicate where firmware control transitions into boot loader/OS control\&. Statically defined\&. +.sp +Added in version 255\&. +.RE +.PP +500\-separator\&.pcrlock +.RS 4 +The EFI "separator" measurements on PCRs 0\-6 done once by the firmware to indicate where firmware control transitions into boot loader/OS control\&. Statically defined\&. +.sp +Added in version 255\&. +.RE +.PP +550\-firmware\-code\-late\&.pcrlock +.RS 4 +Firmware code measurements, as recorded to PCR 0 and 2, after the separator measurement (see +400\-secureboot\-separator\&.pcrlock +above)\&. May be generated via +\fBsystemd\-pcrlock lock\-firmware\-code\fR\&. +.sp +Added in version 255\&. +.RE +.PP +550\-firmware\-config\-late\&.pcrlock +.RS 4 +Firmware configuration measurements, as recorded to PCR 1 and 3, after the separator measurement (see +400\-secureboot\-separator\&.pcrlock +above)\&. May be generated via +\fBsystemd\-pcrlock lock\-firmware\-config\fR\&. +.sp +Added in version 255\&. +.RE +.PP +600\-gpt\&.pcrlock +.RS 4 +The GPT partition table of the booted medium, as recorded to PCR 5 by the firmware\&. May be generated via +\fBsystemd\-pcrlock lock\-gpt\fR\&. +.sp +Added in version 255\&. +.RE +.PP +620\-secureboot\-authority\&.pcrlock +.RS 4 +The SecureBoot authority, as recorded to PCR 7\&. May be generated via +\fBsystemd\-pcrlock lock\-secureboot\-authority\fR\&. +.sp +Added in version 255\&. +.RE +.PP +700\-action\-efi\-exit\-boot\-services\&.pcrlock +.RS 4 +The EFI action generated when +\fBExitBootServices()\fR +is generated, i\&.e\&. when the UEFI environment is left and the OS takes over\&. Covers the PCR 5 measurement\&. Statically defined\&. +.sp +Added in version 255\&. +.RE +.PP +710\-kernel\-cmdline\&.pcrlock +.RS 4 +The kernel command line, as measured by the Linux kernel to PCR 9\&. May be generated via +\fBsystemd\-pcrlock lock\-kernel\-cmdline\fR\&. +.sp +Added in version 255\&. +.RE +.PP +720\-kernel\-initrd\&.pcrlock +.RS 4 +The kernel initrd, as measured by the Linux kernel to PCR 9\&. May be generated via +\fBsystemd\-pcrlock lock\-kernel\-initrd\fR\&. +.sp +Added in version 255\&. +.RE +.PP +750\-enter\-initrd\&.pcrlock +.RS 4 +The measurement to PCR 11 +\fBsystemd-pcrphase-initrd.service\fR(8) +makes when the initrd initializes\&. Statically defined\&. +.sp +Added in version 255\&. +.RE +.PP +800\-leave\-initrd\&.pcrlock +.RS 4 +The measurement to PCR 11 +\fBsystemd-pcrphase-initrd.service\fR(8) +makes when the initrd finishes\&. Statically defined\&. +.sp +Added in version 255\&. +.RE +.PP +820\-machine\-id\&.pcrlock +.RS 4 +The measurement to PCR 15 +\fBsystemd-pcrmachine.service\fR(8) +makes at boot, covering +/etc/machine\-id +contents\&. May be generated via +\fBsystemd\-pcrlock lock\-machine\-id\fR\&. +.sp +Added in version 255\&. +.RE +.PP +830\-root\-file\-system\&.pcrlock +.RS 4 +The measurement to PCR 15 +\fBsystemd-pcrfs-root.service\fR(8) +makes at boot, covering the root file system identity\&. May be generated via +\fBsystemd\-pcrlock lock\-file\-system\fR\&. +.sp +Added in version 255\&. +.RE +.PP +850\-sysinit\&.pcrlock +.RS 4 +The measurement to PCR 11 +\fBsystemd-pcrphase-sysinit.service\fR(8) +makes when the main userspace did basic initialization and will now proceed to start regular system services\&. Statically defined\&. +.sp +Added in version 255\&. +.RE +.PP +900\-ready\&.pcrlock +.RS 4 +The measurement to PCR 11 +\fBsystemd-pcrphase.service\fR(8) +makes when the system fully booted up\&. Statically defined\&. +.sp +Added in version 255\&. +.RE +.PP +950\-shutdown\&.pcrlock +.RS 4 +The measurement to PCR 11 +\fBsystemd-pcrphase.service\fR(8) +makes when the system begins shutdown\&. Statically defined\&. +.sp +Added in version 255\&. +.RE +.PP +990\-final\&.pcrlock +.RS 4 +The measurement to PCR 11 +\fBsystemd-pcrphase-sysinit.service\fR(8) +makes when the system is close to finishing shutdown\&. Statically defined\&. +.sp +Added in version 255\&. +.RE +.SH "SEE ALSO" +.PP +\fBsystemd\fR(1), +\fBsystemd-pcrlock\fR(1) +.SH "NOTES" +.IP " 1." 4 +TCG Canonical Event Log Format (CEL-JSON) +.RS 4 +\%https://trustedcomputinggroup.org/resource/canonical-event-log-format/ +.RE diff --git a/upstream/opensuse-tumbleweed/man5/systemd.preset.5 b/upstream/opensuse-tumbleweed/man5/systemd.preset.5 index 9e9a24e4..945e0d62 100644 --- a/upstream/opensuse-tumbleweed/man5/systemd.preset.5 +++ b/upstream/opensuse-tumbleweed/man5/systemd.preset.5 @@ -1,5 +1,5 @@ '\" t -.TH "SYSTEMD\&.PRESET" "5" "" "systemd 254" "systemd.preset" +.TH "SYSTEMD\&.PRESET" "5" "" "systemd 255" "systemd.preset" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/upstream/opensuse-tumbleweed/man5/systemd.resource-control.5 b/upstream/opensuse-tumbleweed/man5/systemd.resource-control.5 index 68ae3aaa..fcc40891 100644 --- a/upstream/opensuse-tumbleweed/man5/systemd.resource-control.5 +++ b/upstream/opensuse-tumbleweed/man5/systemd.resource-control.5 @@ -1,5 +1,5 @@ '\" t -.TH "SYSTEMD\&.RESOURCE\-CONTROL" "5" "" "systemd 254" "systemd.resource-control" +.TH "SYSTEMD\&.RESOURCE\-CONTROL" "5" "" "systemd 255" "systemd.resource-control" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -198,6 +198,8 @@ in \fBsystemd-system.conf\fR(5)\&. .sp Under the unified cgroup hierarchy, CPU accounting is available for all units and this setting has no effect\&. +.sp +Added in version 208\&. .RE .PP \fICPUWeight=\fR\fI\fIweight\fR\fR, \fIStartupCPUWeight=\fR\fI\fIweight\fR\fR @@ -253,6 +255,8 @@ controller, the kernel may automatically divide resources based on session\-id g \fBsched\fR(7)\&. The effect of this feature is similar to the \fBcpu\fR controller with no explicit configuration, so users should be careful to not mistake one for the other\&. +.sp +Added in version 232\&. .RE .PP \fICPUQuota=\fR @@ -275,6 +279,8 @@ to an empty value unsets the quota\&. Example: \fICPUQuota=20%\fR ensures that the executed processes will never get more than 20% CPU time on one CPU\&. +.sp +Added in version 213\&. .RE .PP \fICPUQuotaPeriodSec=\fR @@ -301,6 +307,8 @@ and Example: \fICPUQuotaPeriodSec=10ms\fR to request that the CPU quota is measured in periods of 10ms\&. +.sp +Added in version 242\&. .RE .PP \fIAllowedCPUs=\fR, \fIStartupAllowedCPUs=\fR @@ -327,6 +335,8 @@ applies to normal runtime of the system, and if the former is not set also to th allows prioritizing specific services at boot\-up and shutdown differently than during normal runtime\&. .sp This setting is supported only with the unified control group hierarchy\&. +.sp +Added in version 244\&. .RE .SS "Memory Accounting and Control" .PP @@ -340,6 +350,8 @@ Turn on process and kernel memory accounting for this unit\&. Takes a boolean ar \fIDefaultMemoryAccounting=\fR in \fBsystemd-system.conf\fR(5)\&. +.sp +Added in version 208\&. .RE .PP \fIMemoryMin=\fR\fI\fIbytes\fR\fR, \fIMemoryLow=\fR\fI\fIbytes\fR\fR, \fIStartupMemoryLow=\fR\fI\fIbytes\fR\fR, \fIDefaultStartupMemoryLow=\fR\fI\fIbytes\fR\fR @@ -394,6 +406,8 @@ applies to the startup and shutdown phases of the system, applies to normal runtime of the system, and if the former is not set also to the startup and shutdown phases\&. Using \fIStartupMemoryLow=\fR allows prioritizing specific services at boot\-up and shutdown differently than during normal runtime\&. +.sp +Added in version 240\&. .RE .PP \fIMemoryHigh=\fR\fI\fIbytes\fR\fR, \fIStartupMemoryHigh=\fR\fI\fIbytes\fR\fR @@ -420,6 +434,8 @@ applies to the startup and shutdown phases of the system, applies to normal runtime of the system, and if the former is not set also to the startup and shutdown phases\&. Using \fIStartupMemoryHigh=\fR allows prioritizing specific services at boot\-up and shutdown differently than during normal runtime\&. +.sp +Added in version 231\&. .RE .PP \fIMemoryMax=\fR\fI\fIbytes\fR\fR, \fIStartupMemoryMax=\fR\fI\fIbytes\fR\fR @@ -449,6 +465,8 @@ applies to the startup and shutdown phases of the system, applies to normal runtime of the system, and if the former is not set also to the startup and shutdown phases\&. Using \fIStartupMemoryMax=\fR allows prioritizing specific services at boot\-up and shutdown differently than during normal runtime\&. +.sp +Added in version 231\&. .RE .PP \fIMemorySwapMax=\fR\fI\fIbytes\fR\fR, \fIStartupMemorySwapMax=\fR\fI\fIbytes\fR\fR @@ -472,6 +490,8 @@ applies to the startup and shutdown phases of the system, applies to normal runtime of the system, and if the former is not set also to the startup and shutdown phases\&. Using \fIStartupMemorySwapMax=\fR allows prioritizing specific services at boot\-up and shutdown differently than during normal runtime\&. +.sp +Added in version 232\&. .RE .PP \fIMemoryZSwapMax=\fR\fI\fIbytes\fR\fR, \fIStartupMemoryZSwapMax=\fR\fI\fIbytes\fR\fR @@ -497,6 +517,8 @@ applies to the startup and shutdown phases of the system, applies to normal runtime of the system, and if the former is not set also to the startup and shutdown phases\&. Using \fIStartupMemoryZSwapMax=\fR allows prioritizing specific services at boot\-up and shutdown differently than during normal runtime\&. +.sp +Added in version 253\&. .RE .PP \fIAllowedMemoryNodes=\fR, \fIStartupAllowedMemoryNodes=\fR @@ -523,6 +545,8 @@ applies to normal runtime of the system, and if the former is not set also to th allows prioritizing specific services at boot\-up and shutdown differently than during normal runtime\&. .sp This setting is supported only with the unified control group hierarchy\&. +.sp +Added in version 244\&. .RE .SS "Process Accounting and Control" .PP @@ -536,6 +560,8 @@ Turn on task accounting for this unit\&. Takes a boolean argument\&. If enabled, \fIDefaultTasksAccounting=\fR in \fBsystemd-system.conf\fR(5)\&. +.sp +Added in version 227\&. .RE .PP \fITasksMax=\fR\fI\fIN\fR\fR @@ -555,6 +581,8 @@ The system default for this setting may be controlled with \fIDefaultTasksMax=\fR in \fBsystemd-system.conf\fR(5)\&. +.sp +Added in version 227\&. .RE .SS "IO Accounting and Control" .PP @@ -568,6 +596,8 @@ Turn on Block I/O accounting for this unit, if the unified control group hierarc \fIDefaultIOAccounting=\fR in \fBsystemd-system.conf\fR(5)\&. +.sp +Added in version 230\&. .RE .PP \fIIOWeight=\fR\fI\fIweight\fR\fR, \fIStartupIOWeight=\fR\fI\fIweight\fR\fR @@ -586,6 +616,8 @@ While applies to the startup and shutdown phases of the system, \fIIOWeight=\fR applies to the later runtime of the system, and if the former is not set also to the startup and shutdown phases\&. This allows prioritizing specific services at boot\-up and shutdown differently than during runtime\&. +.sp +Added in version 230\&. .RE .PP \fIIODeviceWeight=\fR\fI\fIdevice\fR\fR\fI \fR\fI\fIweight\fR\fR @@ -601,6 +633,8 @@ control group attribute, which defaults to 100\&. Use this option multiple times \m[blue]\fBIO Interface Files\fR\m[]\&\s-2\u[8]\d\s+2\&. .sp The specified device node should reference a block device that has an I/O scheduler associated, i\&.e\&. should not refer to partition or loopback block devices, but to the originating, physical device\&. When a path to a regular file or directory is specified it is attempted to discover the correct originating device backing the file system of the specified path\&. This works correctly only for simpler cases, where the file system is directly placed on a partition or physical block device, or where simple 1:1 encryption using dm\-crypt/LUKS is used\&. This discovery does not cover complex storage and in particular RAID and volume management storage devices\&. +.sp +Added in version 230\&. .RE .PP \fIIOReadBandwidthMax=\fR\fI\fIdevice\fR\fR\fI \fR\fI\fIbytes\fR\fR, \fIIOWriteBandwidthMax=\fR\fI\fIdevice\fR\fR\fI \fR\fI\fIbytes\fR\fR @@ -617,6 +651,8 @@ control group attributes\&. Use this option multiple times to set bandwidth limi Similar restrictions on block device discovery as for \fIIODeviceWeight=\fR apply, see above\&. +.sp +Added in version 230\&. .RE .PP \fIIOReadIOPSMax=\fR\fI\fIdevice\fR\fR\fI \fR\fI\fIIOPS\fR\fR, \fIIOWriteIOPSMax=\fR\fI\fIdevice\fR\fR\fI \fR\fI\fIIOPS\fR\fR @@ -633,6 +669,8 @@ control group attributes\&. Use this option multiple times to set IOPS limits fo Similar restrictions on block device discovery as for \fIIODeviceWeight=\fR apply, see above\&. +.sp +Added in version 230\&. .RE .PP \fIIODeviceLatencyTargetSec=\fR\fI\fIdevice\fR\fR\fI \fR\fI\fItarget\fR\fR @@ -654,6 +692,8 @@ These settings are supported only if the unified control group hierarchy is used Similar restrictions on block device discovery as for \fIIODeviceWeight=\fR apply, see above\&. +.sp +Added in version 240\&. .RE .SS "Network Accounting and Control" .PP @@ -667,6 +707,10 @@ The system default for this setting may be controlled with \fIDefaultIPAccounting=\fR in \fBsystemd-system.conf\fR(5)\&. +.sp +Note that this functionality is currently only available for system services, not for per\-user services\&. +.sp +Added in version 235\&. .RE .PP \fIIPAddressAllow=\fR\fI\fIADDRESS[/PREFIXLENGTH]\&...\fR\fR, \fIIPAddressDeny=\fR\fI\fIADDRESS[/PREFIXLENGTH]\&...\fR\fR @@ -791,13 +835,15 @@ Note that these settings might not be supported on some systems (for example if This option cannot be bypassed by prefixing "+" to the executable path in the service unit, as it applies to the whole control group\&. +.sp +Added in version 235\&. .RE .PP \fISocketBindAllow=\fR\fI\fIbind\-rule\fR\fR, \fISocketBindDeny=\fR\fI\fIbind\-rule\fR\fR .RS 4 -Allow or deny binding a socket address to a socket by matching it with the -\fIbind\-rule\fR -and applying a corresponding action if there is a match\&. +Configures restrictions on the ability of unit processes to invoke +\fBbind\fR(2) +on a socket\&. Both allow and deny rules may defined that restrict which addresses a socket may be bound to\&. .sp \fIbind\-rule\fR describes socket properties such as @@ -926,6 +972,11 @@ and \fBcgroup/bind6\fR cgroup\-bpf hooks\&. .sp +Note that these settings apply to any +\fBbind\fR(2) +system call invocation by the unit processes, regardless in which network namespace they are placed\&. Or in other words: changing the network namespace is not a suitable mechanism for escaping these restrictions on +\fBbind()\fR\&. +.sp Examples: .sp .if n \{\ @@ -975,6 +1026,8 @@ SocketBindDeny=any This option cannot be bypassed by prefixing "+" to the executable path in the service unit, as it applies to the whole control group\&. +.sp +Added in version 249\&. .RE .PP \fIRestrictNetworkInterfaces=\fR @@ -1035,6 +1088,122 @@ Programs in the unit will be only able to use the eth2 network interface\&. This option cannot be bypassed by prefixing "+" to the executable path in the service unit, as it applies to the whole control group\&. +.sp +Added in version 250\&. +.RE +.PP +\fINFTSet=\fR\fIfamily\fR:\fItable\fR:\fIset\fR +.RS 4 +This setting provides a method for integrating dynamic cgroup, user and group IDs into firewall rules with +\m[blue]\fBNFT\fR\m[]\&\s-2\u[9]\d\s+2 +sets\&. The benefit of using this setting is to be able to use the IDs as selectors in firewall rules easily and this in turn allows more fine grained filtering\&. NFT rules for cgroup matching use numeric cgroup IDs, which change every time a service is restarted, making them hard to use in systemd environment otherwise\&. Dynamic and random IDs used by +\fIDynamicUser=\fR +can be also integrated with this setting\&. +.sp +This option expects a whitespace separated list of NFT set definitions\&. Each definition consists of a colon\-separated tuple of source type (one of +"cgroup", +"user" +or +"group"), NFT address family (one of +"arp", +"bridge", +"inet", +"ip", +"ip6", or +"netdev"), table name and set name\&. The names of tables and sets must conform to lexical restrictions of NFT table names\&. The type of the element used in the NFT filter must match the type implied by the directive ("cgroup", +"user" +or +"group") as shown in the table below\&. When a control group or a unit is realized, the corresponding ID will be appended to the NFT sets and it will be be removed when the control group or unit is removed\&. +\fBsystemd\fR +only inserts elements to (or removes from) the sets, so the related NFT rules, tables and sets must be prepared elsewhere in advance\&. Failures to manage the sets will be ignored\&. +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.B Table\ \&2.\ \&Defined \fIsource type\fR values +.TS +allbox tab(:); +lB lB lB. +T{ +Source type +T}:T{ +Description +T}:T{ +Corresponding NFT type name +T} +.T& +l l l +l l l +l l l. +T{ +"cgroup" +T}:T{ +control group ID +T}:T{ +"cgroupsv2" +T} +T{ +"user" +T}:T{ +user ID +T}:T{ +"meta skuid" +T} +T{ +"group" +T}:T{ +group ID +T}:T{ +"meta skgid" +T} +.TE +.sp 1 +If the firewall rules are reinstalled so that the contents of NFT sets are destroyed, command +\fBsystemctl daemon\-reload\fR +can be used to refill the sets\&. +.sp +Example: +.sp +.if n \{\ +.RS 4 +.\} +.nf +[Unit] +NFTSet=cgroup:inet:filter:my_service user:inet:filter:serviceuser +.fi +.if n \{\ +.RE +.\} +.sp +Corresponding NFT rules: +.sp +.if n \{\ +.RS 4 +.\} +.nf +table inet filter { + set my_service { + type cgroupsv2 + } + set serviceuser { + typeof meta skuid + } + chain x { + socket cgroupv2 level 2 @my_service accept + drop + } + chain y { + meta skuid @serviceuser accept + drop + } +} +.fi +.if n \{\ +.RE +.\} +.sp +Added in version 255\&. .RE .SS "BPF Programs" .PP @@ -1071,6 +1240,8 @@ Note that for socket\-activated services, the IP filter programs configured on t .sp Note that these settings might not be supported on some systems (for example if eBPF control group support is not enabled in the underlying kernel or container manager)\&. These settings will fail the service in that case\&. If compatibility with such systems is desired it is hence recommended to attach your filter manually (requires \fIDelegate=\fR\fByes\fR) instead of using this setting\&. +.sp +Added in version 243\&. .RE .PP \fIBPFProgram=\fR\fI\fItype\fR\fR\fI:\fR\fI\fIprogram\-path\fR\fR @@ -1078,11 +1249,11 @@ Note that these settings might not be supported on some systems (for example if \fIBPFProgram=\fR allows attaching custom BPF programs to the cgroup of a unit\&. (This generalizes the functionality exposed via \fIIPEgressFilterPath=\fR -and and +and \fIIPIngressFilterPath=\fR for other hooks\&.) Cgroup\-bpf hooks in the form of BPF programs loaded to the BPF filesystem are attached with cgroup\-bpf attach flags determined by the unit\&. For details about attachment types and flags see -\m[blue]\fBbpf\&.h\fR\m[]\&\s-2\u[9]\d\s+2\&. Also refer to the general -\m[blue]\fBBPF documentation\fR\m[]\&\s-2\u[10]\d\s+2\&. +\m[blue]\fBbpf\&.h\fR\m[]\&\s-2\u[10]\d\s+2\&. Also refer to the general +\m[blue]\fBBPF documentation\fR\m[]\&\s-2\u[11]\d\s+2\&. .sp The specification of BPF program consists of a pair of BPF program type and program path in the file system, with ":" @@ -1090,7 +1261,8 @@ as the separator: \fItype\fR:\fIprogram\-path\fR\&. .sp The BPF program type is equivalent to the BPF attach type used in -\fBbpftool\fR\&. It may be one of +\fBbpftool\fR(8) +It may be one of \fBegress\fR, \fBingress\fR, \fBsock_create\fR, @@ -1107,7 +1279,7 @@ The BPF program type is equivalent to the BPF attach type used in \fBsysctl\fR, \fBrecvmsg4\fR, \fBrecvmsg6\fR, -\fBgetsockopt\fR, +\fBgetsockopt\fR, or \fBsetsockopt\fR\&. .sp The specified program path must be an absolute path referencing a BPF program inode in the bpffs file system (which generally means it must begin with @@ -1153,6 +1325,8 @@ BPFProgram=bind6:/sys/fs/bpf/sock\-addr\-hook .if n \{\ .RE .\} +.sp +Added in version 249\&. .RE .SS "Device Access" .PP @@ -1226,6 +1400,8 @@ DeviceAllow=/dev/loop\-control This option cannot be bypassed by prefixing "+" to the executable path in the service unit, as it applies to the whole control group\&. +.sp +Added in version 208\&. .RE .PP \fIDevicePolicy=auto|closed|strict\fR @@ -1235,6 +1411,8 @@ Control the policy for allowing device access: \fBstrict\fR .RS 4 means to only allow types of access that are explicitly specified\&. +.sp +Added in version 208\&. .RE .PP \fBclosed\fR @@ -1245,6 +1423,8 @@ in addition, allows access to standard pseudo devices including /dev/full, /dev/random, and /dev/urandom\&. +.sp +Added in version 208\&. .RE .PP \fBauto\fR @@ -1252,11 +1432,15 @@ in addition, allows access to standard pseudo devices including in addition, allows access to all devices if no explicit \fIDeviceAllow=\fR is present\&. This is the default\&. +.sp +Added in version 208\&. .RE .sp This option cannot be bypassed by prefixing "+" to the executable path in the service unit, as it applies to the whole control group\&. +.sp +Added in version 208\&. .RE .SS "Control Group Management" .PP @@ -1276,6 +1460,8 @@ Special care should be taken when relying on the default slice assignment in tem \fIDefaultDependencies=no\fR set, see \fBsystemd.service\fR(5), section "Default Dependencies" for details\&. +.sp +Added in version 208\&. .RE .PP \fIDelegate=\fR @@ -1307,7 +1493,9 @@ Not all of these controllers are available on all kernels however, and some are Note that because of the hierarchical nature of cgroup hierarchy, any controllers that are delegated will be enabled for the parent and sibling units of the unit with delegation\&. .sp For further details on the delegation model consult -\m[blue]\fBControl Group APIs and Delegation\fR\m[]\&\s-2\u[11]\d\s+2\&. +\m[blue]\fBControl Group APIs and Delegation\fR\m[]\&\s-2\u[12]\d\s+2\&. +.sp +Added in version 218\&. .RE .PP \fIDelegateSubgroup=\fR @@ -1322,6 +1510,8 @@ and similar\&. If delegation is enabled, the latter are always placed inside a s \&.control\&. The specified subgroup is automatically created (and potentially ownership is passed to the unit\*(Aqs configured user/group) when a process is started in it\&. .sp This option is useful to avoid manually moving the invoked process into a subgroup after it has been started\&. Since no processes should live in inner nodes of the control group tree it\*(Aqs almost always necessary to run the main ("supervising") process of a unit that has delegation turned on in a subgroup\&. +.sp +Added in version 254\&. .RE .PP \fIDisableControllers=\fR @@ -1347,6 +1537,8 @@ The following controller names may be specified: \fBpids\fR, \fBbpf\-firewall\fR, and \fBbpf\-devices\fR\&. +.sp +Added in version 240\&. .RE .SS "Memory Pressure Control" .PP @@ -1390,6 +1582,8 @@ will not actively use this cgroup\*(Aqs data for monitoring and detection\&. How can still be a candidate for \fBsystemd\-oomd\fR to terminate\&. +.sp +Added in version 247\&. .RE .PP \fIManagedOOMMemoryPressureLimit=\fR @@ -1399,6 +1593,8 @@ Overrides the default memory pressure limit set by for this unit (cgroup)\&. Takes a percentage value between 0% and 100%, inclusive\&. This property is ignored unless \fIManagedOOMMemoryPressure=\fR\fBkill\fR\&. Defaults to 0%, which means to use the default set by \fBoomd.conf\fR(5)\&. +.sp +Added in version 247\&. .RE .PP \fIManagedOOMPreference=none|avoid|omit\fR @@ -1450,6 +1646,8 @@ will rank this unit\*(Aqs cgroup as defined in \fBsystemd-oomd.service\fR(8) and \fBoomd.conf\fR(5)\&. +.sp +Added in version 248\&. .RE .PP \fIMemoryPressureWatch=\fR @@ -1468,7 +1666,7 @@ environment variable to the literal string "on" tells the service to watch for memory pressure events\&. This enables memory accounting for the service, and ensures the memory\&.pressure -cgroup attribute files is accessible for read and write to the service\*(Aqs user\&. It then sets the +cgroup attribute file is accessible for reading and writing by the service\*(Aqs user\&. It then sets the \fI$MEMORY_PRESSURE_WATCH\fR environment variable for processes invoked by the unit to the file system path to this file\&. The threshold information configured with \fIMemoryPressureThresholdSec=\fR @@ -1481,7 +1679,7 @@ value is set the protocol is enabled if memory accounting is anyway enabled for the logic is neither enabled, nor disabled and the two environment variables are not set\&. .sp Note that services are free to use the two environment variables, but it\*(Aqs unproblematic if they ignore them\&. Memory pressure handling must be implemented individually in each service, and usually means different things for different software\&. For further details on memory pressure handling see -\m[blue]\fBMemory Pressure Handling in systemd\fR\m[]\&\s-2\u[12]\d\s+2\&. +\m[blue]\fBMemory Pressure Handling in systemd\fR\m[]\&\s-2\u[13]\d\s+2\&. .sp Services implemented using \fBsd-event\fR(3) @@ -1493,6 +1691,8 @@ If not explicit set, defaults to the \fIDefaultMemoryPressureWatch=\fR setting in \fBsystemd-system.conf\fR(5)\&. +.sp +Added in version 254\&. .RE .PP \fIMemoryPressureThresholdSec=\fR @@ -1508,12 +1708,36 @@ or "μs", see \fBsystemd.time\fR(7) for details on the permitted syntax\&. +.sp +Added in version 254\&. +.RE +.SS "Coredump Control" +.PP +\fICoredumpReceive=\fR +.RS 4 +Takes a boolean argument\&. This setting is used to enable coredump forwarding for containers that belong to this unit\*(Aqs cgroup\&. Units with +\fICoredumpReceive=yes\fR +must also be configured with +\fIDelegate=yes\fR\&. Defaults to false\&. +.sp +When +\fBsystemd\-coredump\fR +is handling a coredump for a process from a container, if the container\*(Aqs leader process is a descendant of a cgroup with +\fICoredumpReceive=yes\fR +and +\fIDelegate=yes\fR, then +\fBsystemd\-coredump\fR +will attempt to forward the coredump to +\fBsystemd\-coredump\fR +within the container\&. +.sp +Added in version 255\&. .RE .SH "HISTORY" .PP systemd 252 .RS 4 -Options for controlling the Legacy Control Group Hierarchy (\m[blue]\fBControl Groups version 1\fR\m[]\&\s-2\u[13]\d\s+2) are now fully deprecated: +Options for controlling the Legacy Control Group Hierarchy (\m[blue]\fBControl Groups version 1\fR\m[]\&\s-2\u[14]\d\s+2) are now fully deprecated: \fICPUShares=\fR\fI\fIweight\fR\fR, \fIStartupCPUShares=\fR\fI\fIweight\fR\fR, \fIMemoryLimit=\fR\fI\fIbytes\fR\fR, @@ -1523,6 +1747,8 @@ Options for controlling the Legacy Control Group Hierarchy (\m[blue]\fBControl G \fIBlockIODeviceWeight=\fR\fI\fIdevice\fR\fR\fI \fR\fI\fIweight\fR\fR, \fIBlockIOReadBandwidth=\fR\fI\fIdevice\fR\fR\fI \fR\fI\fIbytes\fR\fR, \fIBlockIOWriteBandwidth=\fR\fI\fIdevice\fR\fR\fI \fR\fI\fIbytes\fR\fR\&. Please switch to the unified cgroup hierarchy\&. +.sp +Added in version 252\&. .RE .SH "SEE ALSO" .PP @@ -1582,26 +1808,31 @@ IO Interface Files \%https://docs.kernel.org/admin-guide/cgroup-v2.html#io-interface-files .RE .IP " 9." 4 +NFT +.RS 4 +\%https://netfilter.org/projects/nftables/index.html +.RE +.IP "10." 4 bpf.h .RS 4 \%https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/plain/include/uapi/linux/bpf.h .RE -.IP "10." 4 +.IP "11." 4 BPF documentation .RS 4 \%https://docs.kernel.org/bpf/ .RE -.IP "11." 4 +.IP "12." 4 Control Group APIs and Delegation .RS 4 \%https://systemd.io/CGROUP_DELEGATION .RE -.IP "12." 4 +.IP "13." 4 Memory Pressure Handling in systemd .RS 4 \%https://systemd.io/MEMORY_PRESSURE .RE -.IP "13." 4 +.IP "14." 4 Control Groups version 1 .RS 4 \%https://docs.kernel.org/admin-guide/cgroup-v1/index.html diff --git a/upstream/opensuse-tumbleweed/man5/systemd.scope.5 b/upstream/opensuse-tumbleweed/man5/systemd.scope.5 index d3784c1d..64cb28d7 100644 --- a/upstream/opensuse-tumbleweed/man5/systemd.scope.5 +++ b/upstream/opensuse-tumbleweed/man5/systemd.scope.5 @@ -1,5 +1,5 @@ '\" t -.TH "SYSTEMD\&.SCOPE" "5" "" "systemd 254" "systemd.scope" +.TH "SYSTEMD\&.SCOPE" "5" "" "systemd 255" "systemd.scope" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -98,8 +98,8 @@ the event is logged but the unit is terminated cleanly by the service manager\&. and one of the unit\*(Aqs processes is killed by the OOM killer the kernel is instructed to kill all remaining processes of the unit too, by setting the memory\&.oom\&.group attribute to -\fB1\fR; also see -\m[blue]\fBkernel documentation\fR\m[]\&\s-2\u[2]\d\s+2\&. +\fB1\fR; also see kernel page +\m[blue]\fBControl Group v2\fR\m[]\&\s-2\u[2]\d\s+2\&. .sp Defaults to the setting \fIDefaultOOMPolicy=\fR @@ -120,6 +120,8 @@ This setting also applies to \fBsystemd-oomd.service\fR(8)\&. Similarly to the kernel OOM kills performed by the kernel, this setting determines the state of the unit after \fBsystemd\-oomd\fR kills a cgroup associated with it\&. +.sp +Added in version 243\&. .RE .PP \fIRuntimeMaxSec=\fR @@ -127,6 +129,8 @@ kills a cgroup associated with it\&. Configures a maximum time for the scope to run\&. If this is used and the scope has been active for longer than the specified time it is terminated and put into a failure state\&. Pass "infinity" (the default) to configure no runtime limit\&. +.sp +Added in version 244\&. .RE .PP \fIRuntimeRandomizedExtraSec=\fR @@ -136,6 +140,8 @@ This option modifies by increasing the maximum runtime by an evenly distributed duration between 0 and the specified value (in seconds)\&. If \fIRuntimeMaxSec=\fR is unspecified, then this feature will be disabled\&. +.sp +Added in version 250\&. .RE .PP Check @@ -158,7 +164,7 @@ New Control Group Interfaces \%https://www.freedesktop.org/wiki/Software/systemd/ControlGroupInterface .RE .IP " 2." 4 -kernel documentation +Control Group v2 .RS 4 \%https://docs.kernel.org/admin-guide/cgroup-v2.html .RE diff --git a/upstream/opensuse-tumbleweed/man5/systemd.service.5 b/upstream/opensuse-tumbleweed/man5/systemd.service.5 index 5685084d..8b68b9b5 100644 --- a/upstream/opensuse-tumbleweed/man5/systemd.service.5 +++ b/upstream/opensuse-tumbleweed/man5/systemd.service.5 @@ -1,5 +1,5 @@ '\" t -.TH "SYSTEMD\&.SERVICE" "5" "" "systemd 254" "systemd.service" +.TH "SYSTEMD\&.SERVICE" "5" "" "systemd 255" "systemd.service" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -208,7 +208,7 @@ are), the service manager will consider the unit started immediately after the m \fBexecve()\fR to invoke the actual service binary)\&. Typically, \fIType=\fR\fBexec\fR -(see below) is the better choice, see below\&. +is the better choice, see below\&. .sp It is expected that the process configured with \fIExecStart=\fR @@ -353,7 +353,7 @@ is missing or set to \fBnone\fR, it will be forcibly set to \fBmain\fR\&. .sp -If the service supports reloading, and uses the a signal to start the reload, using +If the service supports reloading, and uses a signal to start the reload, using \fBnotify\-reload\fR instead is recommended\&. .RE @@ -474,6 +474,8 @@ when a service has a known forking model and a main process can reliably be dete \fIExitType=\fR \fBcgroup\fR is meant for applications whose forking model is not known ahead of time and which might not have a specific main process\&. It is well suited for transient or automatically generated services, such as graphical applications inside of a desktop environment\&. +.sp +Added in version 250\&. .RE .PP \fIRemainAfterExit=\fR @@ -632,6 +634,8 @@ also applies to \fIExecCondition=\fR will also run the commands in \fIExecStopPost=\fR, as part of stopping the service, in the case of any non\-zero or abnormal exits, like the ones described above\&. +.sp +Added in version 243\&. .RE .PP \fIExecReload=\fR @@ -770,6 +774,8 @@ to This setting is effective only if \fIRestartMaxDelaySec=\fR is also set\&. +.sp +Added in version 254\&. .RE .PP \fIRestartMaxDelaySec=\fR @@ -784,6 +790,8 @@ to disable the setting\&. Defaults to This setting is effective only if \fIRestartSteps=\fR is also set\&. +.sp +Added in version 254\&. .RE .PP \fITimeoutStartSec=\fR @@ -811,6 +819,8 @@ is exceeded, and once the start time has extended beyond within the interval specified until the service startup status is finished by "READY=1"\&. (see \fBsd_notify\fR(3))\&. +.sp +Added in version 188\&. .RE .PP \fITimeoutStopSec=\fR @@ -849,6 +859,8 @@ is exceeded, and once the stop time has extended beyond "EXTEND_TIMEOUT_USEC=\&..." within the interval specified, or terminates itself (see \fBsd_notify\fR(3))\&. +.sp +Added in version 188\&. .RE .PP \fITimeoutAbortSec=\fR @@ -887,6 +899,8 @@ is exceeded, and once the abort time has extended beyond "EXTEND_TIMEOUT_USEC=\&..." within the interval specified, or terminates itself (see \fBsd_notify\fR(3))\&. +.sp +Added in version 243\&. .RE .PP \fITimeoutSec=\fR @@ -930,6 +944,8 @@ applies before sending the service is immediately terminated by sending \fIFinalKillSignal=\fR without any further timeout\&. This setting can be used to expedite the shutdown of failing services\&. +.sp +Added in version 246\&. .RE .PP \fIRuntimeMaxSec=\fR @@ -953,6 +969,8 @@ within the interval specified until the service shutdown is achieved by "STOPPING=1" (or termination)\&. (see \fBsd_notify\fR(3))\&. +.sp +Added in version 229\&. .RE .PP \fIRuntimeRandomizedExtraSec=\fR @@ -962,6 +980,8 @@ This option modifies by increasing the maximum runtime by an evenly distributed duration between 0 and the specified value (in seconds)\&. If \fIRuntimeMaxSec=\fR is unspecified, then this feature will be disabled\&. +.sp +Added in version 250\&. .RE .PP \fIWatchdogSec=\fR @@ -1059,7 +1079,13 @@ If set to \fBon\-abnormal\fR, the service will be restarted when the process is terminated by a signal (including on core dump, excluding the aforementioned four signals), when an operation times out, or when the watchdog timeout is triggered\&. If set to \fBon\-abort\fR, the service will be restarted only if the service process exits due to an uncaught signal not specified as a clean exit status\&. If set to \fBon\-watchdog\fR, the service will be restarted only if the watchdog timeout for the service expires\&. If set to -\fBalways\fR, the service will be restarted regardless of whether it exited cleanly or not, got terminated abnormally by a signal, or hit a timeout\&. +\fBalways\fR, the service will be restarted regardless of whether it exited cleanly or not, got terminated abnormally by a signal, or hit a timeout\&. Note that +\fIType=oneshot\fR +services will never be restarted on a clean exit status, i\&.e\&. +\fBalways\fR +and +\fBon\-success\fR +are rejected for them\&. .sp .it 1 an-trap .nr an-no-space-flag 1 @@ -1238,6 +1264,8 @@ are skipped\&. .sp This option is useful in cases where a dependency can fail temporarily but we don\*(Aqt want these temporary failures to make the dependent units fail\&. When this option is set to \fBdirect\fR, dependent units are not notified of these temporary failures\&. +.sp +Added in version 254\&. .RE .PP \fISuccessExitStatus=\fR @@ -1287,6 +1315,8 @@ are considered clean service terminations\&. Note: \fBsystemd\-analyze exit\-status\fR may be used to list exit statuses and translate between numerical status values and names\&. +.sp +Added in version 189\&. .RE .PP \fIRestartPreventExitStatus=\fR @@ -1319,6 +1349,8 @@ or or (depending on \fIType=\fR, \fIPIDFile=\fR, \&...) the otherwise configured main process\&. +.sp +Added in version 189\&. .RE .PP \fIRestartForceExitStatus=\fR @@ -1326,6 +1358,8 @@ or (depending on Takes a list of exit status definitions that, when returned by the main service process, will force automatic service restarts, regardless of the restart setting configured with \fIRestart=\fR\&. The argument format is similar to \fIRestartPreventExitStatus=\fR\&. +.sp +Added in version 215\&. .RE .PP \fIRootDirectoryStartOnly=\fR @@ -1468,6 +1502,8 @@ for details\&. For further information on the file descriptor store see the \m[blue]\fBFile Descriptor Store\fR\m[]\&\s-2\u[1]\d\s+2 overview\&. +.sp +Added in version 219\&. .RE .PP \fIFileDescriptorStorePreserve=\fR @@ -1487,6 +1523,8 @@ the file descriptor store is kept around until the unit is removed from memory ( Use \fBsystemctl clean \-\-what=fdstore \&...\fR to release the file descriptor store explicitly\&. +.sp +Added in version 254\&. .RE .PP \fIUSBFunctionDescriptors=\fR @@ -1498,6 +1536,8 @@ descriptors, for implementation of USB gadget functions\&. This is used only in configured\&. The contents of this file are written to the ep0 file after it is opened\&. +.sp +Added in version 227\&. .RE .PP \fIUSBFunctionStrings=\fR @@ -1505,6 +1545,8 @@ file after it is opened\&. Configure the location of a file containing USB FunctionFS strings\&. Behavior is similar to \fIUSBFunctionDescriptors=\fR above\&. +.sp +Added in version 227\&. .RE .PP \fIOOMPolicy=\fR @@ -1527,8 +1569,8 @@ the event is logged but the unit is terminated cleanly by the service manager\&. and one of the unit\*(Aqs processes is killed by the OOM killer the kernel is instructed to kill all remaining processes of the unit too, by setting the memory\&.oom\&.group attribute to -\fB1\fR; also see -\m[blue]\fBkernel documentation\fR\m[]\&\s-2\u[3]\d\s+2\&. +\fB1\fR; also see kernel page +\m[blue]\fBControl Group v2\fR\m[]\&\s-2\u[3]\d\s+2\&. .sp Defaults to the setting \fIDefaultOOMPolicy=\fR @@ -1549,6 +1591,8 @@ This setting also applies to \fBsystemd-oomd.service\fR(8)\&. Similarly to the kernel OOM kills performed by the kernel, this setting determines the state of the unit after \fBsystemd\-oomd\fR kills a cgroup associated with it\&. +.sp +Added in version 243\&. .RE .PP \fIOpenFile=\fR @@ -1611,6 +1655,8 @@ for more details on how to retrieve these file descriptors\&. This setting is useful to allow services to access files/sockets that they can\*(Aqt access themselves (due to running in a separate mount namespace, not having privileges, \&.\&.\&.)\&. .sp This setting can be specified multiple times, in which case all the specified paths are opened and the file descriptors passed to the service\&. If the empty string is assigned, the entire list of open files defined prior to this is reset\&. +.sp +Added in version 253\&. .RE .PP \fIReloadSignal=\fR @@ -1619,6 +1665,8 @@ Configures the UNIX process signal to send to the service\*(Aqs main process whe \fBSIGHUP\fR\&. This option has no effect unless \fIType=\fR\fBnotify\-reload\fR is used, see above\&. +.sp +Added in version 253\&. .RE .PP Check @@ -1689,7 +1737,7 @@ T} T{ ":" T}:T{ -If the executable path is prefixed with ":", environment variable substitution (as described by the "Command Lines" section below) is not applied\&. +If the executable path is prefixed with ":", environment variable substitution (as described below this table) is not applied\&. T} T{ "+" @@ -1732,7 +1780,7 @@ sbin/ counterparts on systems using split bin/ and -sbin/\&. It is thus safe to use just the executable name in case of executables located in any of the "standard" directories, and an absolute path must be used in other cases\&. Using an absolute path is recommended to avoid ambiguity\&. Hint: this search path may be queried using +sbin/\&. It is thus safe to use just the executable name in case of executables located in any of the "standard" directories, and an absolute path must be used in other cases\&. Hint: this search path may be queried using \fBsystemd\-path search\-binaries\-default\fR\&. .PP The command line accepts @@ -2118,7 +2166,7 @@ for this\&. A typical service file for such a daemon would look like this: Description=Simple notifying service [Service] -Type=notify +Type=notify\-reload ExecStart=/usr/sbin/simple\-notifying\-service [Install] @@ -2134,6 +2182,14 @@ Note that the daemon has to support systemd\*(Aqs notification protocol, else sy Please see \fBsystemd.kill\fR(5) for details on how you can influence the way systemd terminates the service\&. +.PP +To avoid code duplication, it is preferable to use +\fBsd_notify\fR(3) +when possible, especially when other APIs provided by +\fBlibsystemd\fR(3) +are also used, but note that the notification protocol is very simple and guaranteed to be stable as per the +\m[blue]\fBInterface Portability and Stability Promise\fR\m[]\&\s-2\u[4]\d\s+2, so it can be reimplemented by services with no external dependencies\&. For a self\-contained example, see +\fBsd_notify\fR(3)\&. .SH "SEE ALSO" .PP \fBsystemd\fR(1), @@ -2157,7 +2213,12 @@ USB FunctionFS \%https://docs.kernel.org/usb/functionfs.html .RE .IP " 3." 4 -kernel documentation +Control Group v2 .RS 4 \%https://docs.kernel.org/admin-guide/cgroup-v2.html .RE +.IP " 4." 4 +Interface Portability and Stability Promise +.RS 4 +\%https://systemd.io/PORTABILITY_AND_STABILITY/ +.RE diff --git a/upstream/opensuse-tumbleweed/man5/systemd.slice.5 b/upstream/opensuse-tumbleweed/man5/systemd.slice.5 index 9ab905fa..e4e179cc 100644 --- a/upstream/opensuse-tumbleweed/man5/systemd.slice.5 +++ b/upstream/opensuse-tumbleweed/man5/systemd.slice.5 @@ -1,5 +1,5 @@ '\" t -.TH "SYSTEMD\&.SLICE" "5" "" "systemd 254" "systemd.slice" +.TH "SYSTEMD\&.SLICE" "5" "" "systemd 255" "systemd.slice" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/upstream/opensuse-tumbleweed/man5/systemd.socket.5 b/upstream/opensuse-tumbleweed/man5/systemd.socket.5 index 1fb6d77d..f8d4a7cd 100644 --- a/upstream/opensuse-tumbleweed/man5/systemd.socket.5 +++ b/upstream/opensuse-tumbleweed/man5/systemd.socket.5 @@ -1,5 +1,5 @@ '\" t -.TH "SYSTEMD\&.SOCKET" "5" "" "systemd 254" "systemd.socket" +.TH "SYSTEMD\&.SOCKET" "5" "" "systemd 255" "systemd.socket" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -320,6 +320,8 @@ ep0\&. When using this option, the activated service has to have the and \fIUSBFunctionStrings=\fR options set\&. +.sp +Added in version 227\&. .RE .PP \fISocketProtocol=\fR @@ -328,6 +330,8 @@ Takes one of \fBudplite\fR or \fBsctp\fR\&. The socket will use the UDP\-Lite (\fBIPPROTO_UDPLITE\fR) or SCTP (\fBIPPROTO_SCTP\fR) protocol, respectively\&. +.sp +Added in version 229\&. .RE .PP \fIBindIPv6Only=\fR @@ -351,9 +355,9 @@ for details)\&. If .RS 4 Takes an unsigned 32\-bit integer argument\&. Specifies the number of connections to queue that have not been accepted yet\&. This setting matters only for stream and sequential packet sockets\&. See \fBlisten\fR(2) -for details\&. Note that this value is silently capped by the +for details\&. Defaults to 4294967295\&. Note that this value is silently capped by the "net\&.core\&.somaxconn" -sysctl, which typically defaults to 4096\&. By default this is set to 4294967295, so that the sysctl takes full effect\&. +sysctl, which typically defaults to 4096, so typically the sysctl is the setting that actually matters\&. .RE .PP \fIBindToDevice=\fR @@ -371,6 +375,8 @@ for details)\&. If this option is used, an implicit dependency from this socket Takes a UNIX user/group name\&. When specified, all \fBAF_UNIX\fR sockets and FIFO nodes in the file system are owned by the specified user and group\&. If unset (the default), the nodes are owned by the root user/group (if run in system context) or the invoking user/group (if run in user context)\&. If only a user is specified but no group, then the group is derived from the user\*(Aqs default group\&. +.sp +Added in version 214\&. .RE .PP \fISocketMode=\fR @@ -423,6 +429,8 @@ for service instances activated via .RS 4 Takes a boolean argument\&. May only be used in conjunction with \fIListenSpecial=\fR\&. If true, the specified special file is opened in read\-write mode, if false, in read\-only mode\&. Defaults to false\&. +.sp +Added in version 227\&. .RE .PP \fIFlushPending=\fR @@ -430,6 +438,8 @@ Takes a boolean argument\&. May only be used in conjunction with Takes a boolean argument\&. May only be used when \fBAccept=no\fR\&. If yes, the socket\*(Aqs buffers are cleared after the triggered service exited\&. This causes any pending data to be flushed and any pending incoming connections to be rejected\&. If no, the socket\*(Aqs buffers won\*(Aqt be cleared, permitting the service to handle any pending connections after restart, which is the usually expected behaviour\&. Defaults to \fBno\fR\&. +.sp +Added in version 247\&. .RE .PP \fIMaxConnections=\fR @@ -446,6 +456,8 @@ or datagram sockets\&. Defaults to 64\&. The maximum number of connections for a service per source IP address\&. This is very similar to the \fIMaxConnections=\fR directive above\&. Disabled by default\&. +.sp +Added in version 232\&. .RE .PP \fIKeepAlive=\fR @@ -468,6 +480,8 @@ Takes time (in seconds) as argument\&. The connection needs to remain idle befor and the \m[blue]\fBTCP Keepalive HOWTO\fR\m[]\&\s-2\u[2]\d\s+2 for details\&.) Default value is 7200 seconds (2 hours)\&. +.sp +Added in version 216\&. .RE .PP \fIKeepAliveIntervalSec=\fR @@ -481,6 +495,8 @@ socket option (see and the \m[blue]\fBTCP Keepalive HOWTO\fR\m[]\&\s-2\u[2]\d\s+2 for details\&.) Default value is 75 seconds\&. +.sp +Added in version 216\&. .RE .PP \fIKeepAliveProbes=\fR @@ -490,6 +506,8 @@ Takes an integer as argument\&. It is the number of unacknowledged probes to sen and the \m[blue]\fBTCP Keepalive HOWTO\fR\m[]\&\s-2\u[2]\d\s+2 for details\&.) Default value is 9\&. +.sp +Added in version 216\&. .RE .PP \fINoDelay=\fR @@ -497,6 +515,8 @@ for details\&.) Default value is 9\&. Takes a boolean argument\&. TCP Nagle\*(Aqs algorithm works by combining a number of small outgoing messages, and sending them all at once\&. This controls the TCP_NODELAY socket option (see \fBtcp\fR(7))\&. Defaults to \fBfalse\fR\&. +.sp +Added in version 216\&. .RE .PP \fIPriority=\fR @@ -520,6 +540,8 @@ If the client also uses the option, the latency of the initial connection may be reduced, because the kernel will send data in the final packet establishing the connection (the third packet in the "three\-way handshake")\&. .sp Disabled by default\&. +.sp +Added in version 216\&. .RE .PP \fIReceiveBuffer=\fR, \fISendBuffer=\fR @@ -576,6 +598,8 @@ Takes a boolean value\&. If true, allows multiple socket option\&. See \fBsocket\fR(7) for details\&. +.sp +Added in version 206\&. .RE .PP \fISmackLabel=\fR, \fISmackLabelIPIn=\fR, \fISmackLabelIPOut=\fR @@ -587,6 +611,8 @@ and "security\&.SMACK64IPOUT", respectively, i\&.e\&. the security label of the FIFO, or the security label for the incoming or outgoing connections of the socket, respectively\&. See \m[blue]\fBSmack\fR\m[]\&\s-2\u[3]\d\s+2 for details\&. +.sp +Added in version 196\&. .RE .PP \fISELinuxContextFromNet=\fR @@ -595,6 +621,8 @@ Takes a boolean argument\&. When true, systemd will attempt to figure out the SE \fISELinuxContext=\fR option\&. This configuration option applies only when activated service is passed in single socket file descriptor, i\&.e\&. service instances that have standard input connected to a socket or services triggered by exactly one socket unit\&. Also note that this option is useful only when MLS/MCS SELinux policy is deployed\&. Defaults to "false"\&. +.sp +Added in version 217\&. .RE .PP \fIPipeSize=\fR @@ -671,6 +699,8 @@ and \fBAF_PACKET\fR sockets\&. Defaults to \fBfalse\fR\&. +.sp +Added in version 246\&. .RE .PP \fITimestamping=\fR @@ -689,13 +719,15 @@ or \fBSO_TIMESTAMPNS\fR socket options, and enables whether ingress network traffic shall carry timestamping metadata\&. Defaults to \fBoff\fR\&. +.sp +Added in version 247\&. .RE .PP \fITCPCongestion=\fR .RS 4 Takes a string value\&. Controls the TCP congestion algorithm used by this socket\&. Should be one of "westwood", -"veno", +"reno", "cubic", "lp" or any other available algorithm supported by the IP stack\&. This setting applies only to stream sockets\&. @@ -748,6 +780,8 @@ Takes a boolean argument\&. If enabled, any file nodes created by this socket un \fBAF_UNIX\fR sockets in the file system, POSIX message queues, FIFOs, as well as any symlinks to them configured with \fISymlinks=\fR\&. Normally, it should not be necessary to use this option, and is not recommended as services might continue to run after the socket unit has been terminated and it should still be possible to communicate with them via their file system node\&. Defaults to off\&. +.sp +Added in version 214\&. .RE .PP \fISymlinks=\fR @@ -757,6 +791,8 @@ Takes a list of file system paths\&. The specified paths will be created as syml socket path or FIFO path of this socket unit\&. If this setting is used, only one \fBAF_UNIX\fR socket in the file system or one FIFO may be configured for the socket unit\&. Use this option to manage one or more symlinked alias names for a socket, binding their lifecycle together\&. Note that if creation of a symlink fails this is not considered fatal for the socket unit, and the socket unit may still start\&. If an empty string is assigned, the list of paths is reset\&. Defaults to an empty list\&. +.sp +Added in version 214\&. .RE .PP \fIFileDescriptorName=\fR @@ -767,13 +803,15 @@ call to acquire the names configured for the received file descriptors\&. Names ":", and must be at most 255 characters in length\&. If this setting is not used, the file descriptor name defaults to the name of the socket unit, including its \&.socket suffix\&. +.sp +Added in version 227\&. .RE .PP \fITriggerLimitIntervalSec=\fR, \fITriggerLimitBurst=\fR .RS 4 Configures a limit on how often this socket unit may be activated within a specific time interval\&. The \fITriggerLimitIntervalSec=\fR -may be used to configure the length of the time interval in the usual time units +setting may be used to configure the length of the time interval in the usual time units "us", "ms", "s", @@ -784,7 +822,35 @@ for details on the various time units understood)\&. The \fITriggerLimitBurst=\fR setting takes a positive integer value and specifies the number of permitted activations per time interval, and defaults to 200 for \fIAccept=yes\fR -sockets (thus by default permitting 200 activations per 2s), and 20 otherwise (20 activations per 2s)\&. Set either to 0 to disable any form of trigger rate limiting\&. If the limit is hit, the socket unit is placed into a failure mode, and will not be connectible anymore until restarted\&. Note that this limit is enforced before the service activation is enqueued\&. +sockets (thus by default permitting 200 activations per 2s), and 20 otherwise (20 activations per 2s)\&. Set either to 0 to disable any form of trigger rate limiting\&. +.sp +If the limit is hit, the socket unit is placed into a failure mode, and will not be connectible anymore until restarted\&. Note that this limit is enforced before the service activation is enqueued\&. +.sp +Compare with +\fIPollLimitIntervalSec=\fR/\fIPollLimitBurst=\fR +described below, which implements a temporary slowdown if a socket unit is flooded with incoming traffic, as opposed to the permanent failure state +\fITriggerLimitIntervalSec=\fR/\fITriggerLimitBurst=\fR +results in\&. +.sp +Added in version 230\&. +.RE +.PP +\fIPollLimitIntervalSec=\fR, \fIPollLimitBurst=\fR +.RS 4 +Configures a limit on how often polling events on the file descriptors backing this socket unit will be considered\&. This pair of settings is similar to +\fITriggerLimitIntervalSec=\fR/\fITriggerLimitBurst=\fR +but instead of putting a (fatal) limit on the activation frequency puts a (transient) limit on the polling frequency\&. The expected parameter syntax and range are identical to that of the aforementioned options, and can be disabled the same way\&. +.sp +If the polling limit is hit polling is temporarily disabled on it until the specified time window passes\&. The polling limit hence slows down connection attempts if hit, but unlike the trigger limit won\*(Aqt cause permanent failures\&. It\*(Aqs the recommended mechanism to deal with DoS attempts through packet flooding\&. +.sp +The polling limit is enforced per file descriptor to listen on, as opposed to the trigger limit which is enforced for the entire socket unit\&. This distinction matters for socket units that listen on multiple file descriptors (i\&.e\&. have multiple +\fIListenXYZ=\fR +stanzas)\&. +.sp +These setting defaults to 150 (in case of +\fIAccept=yes\fR) and 15 (otherwise) polling events per 2s\&. This is considerably lower than the default values for the trigger limit (see above) and means that the polling limit should typically ensure the trigger limit is never hit, unless one of them is reconfigured or disabled\&. +.sp +Added in version 255\&. .RE .PP Check diff --git a/upstream/opensuse-tumbleweed/man5/systemd.swap.5 b/upstream/opensuse-tumbleweed/man5/systemd.swap.5 index 04698ada..1cb7edb2 100644 --- a/upstream/opensuse-tumbleweed/man5/systemd.swap.5 +++ b/upstream/opensuse-tumbleweed/man5/systemd.swap.5 @@ -1,5 +1,5 @@ '\" t -.TH "SYSTEMD\&.SWAP" "5" "" "systemd 254" "systemd.swap" +.TH "SYSTEMD\&.SWAP" "5" "" "systemd 255" "systemd.swap" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -122,6 +122,8 @@ With swap\&.target\&. This means that it will not be activated automatically during boot, unless it is pulled in by some other unit\&. The \fBauto\fR option has the opposite meaning and is the default\&. +.sp +Added in version 218\&. .RE .PP \fBnofail\fR @@ -129,6 +131,8 @@ option has the opposite meaning and is the default\&. With \fBnofail\fR, the swap unit will be only wanted, not required by swap\&.target\&. This means that the boot will continue even if this swap device is not activated successfully\&. +.sp +Added in version 218\&. .RE .PP \fBx\-systemd\&.device\-timeout=\fR @@ -144,6 +148,8 @@ Note that this option can only be used in /etc/fstab, and will be ignored when part of the \fIOptions=\fR setting in a unit file\&. +.sp +Added in version 215\&. .RE .PP \fBx\-systemd\&.makefs\fR @@ -161,6 +167,8 @@ and the discussion of \fBwipefs\fR(8) in \fBsystemd.mount\fR(5)\&. +.sp +Added in version 240\&. .RE .SH "OPTIONS" .PP @@ -199,6 +207,8 @@ May contain an option string for the swap device\&. This may be used for control \fBswapon\fR(8) for more information\&.) Note that the usual specifier expansion is applied to this setting, literal percent characters should hence be written as "%%"\&. +.sp +Added in version 217\&. .RE .PP \fITimeoutSec=\fR diff --git a/upstream/opensuse-tumbleweed/man5/systemd.target.5 b/upstream/opensuse-tumbleweed/man5/systemd.target.5 index aa14436a..ba0aa547 100644 --- a/upstream/opensuse-tumbleweed/man5/systemd.target.5 +++ b/upstream/opensuse-tumbleweed/man5/systemd.target.5 @@ -1,5 +1,5 @@ '\" t -.TH "SYSTEMD\&.TARGET" "5" "" "systemd 254" "systemd.target" +.TH "SYSTEMD\&.TARGET" "5" "" "systemd 255" "systemd.target" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/upstream/opensuse-tumbleweed/man5/systemd.timer.5 b/upstream/opensuse-tumbleweed/man5/systemd.timer.5 index 39a2d662..de75ccde 100644 --- a/upstream/opensuse-tumbleweed/man5/systemd.timer.5 +++ b/upstream/opensuse-tumbleweed/man5/systemd.timer.5 @@ -1,5 +1,5 @@ '\" t -.TH "SYSTEMD\&.TIMER" "5" "" "systemd 254" "systemd.timer" +.TH "SYSTEMD\&.TIMER" "5" "" "systemd 255" "systemd.timer" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -42,8 +42,10 @@ foo\&.service\&. The unit to activate may be controlled by (see below)\&. .PP Note that in case the unit to activate is already active at the time the timer elapses it is not restarted, but simply left running\&. There is no concept of spawning new service instances in this case\&. Due to this, services with -\fIRemainAfterExit=\fR -set (which stay around continuously even after the service\*(Aqs main process exited) are usually not suitable for activation via repetitive timers, as they will only be activated once, and then stay around forever\&. +\fIRemainAfterExit=yes\fR +set (which stay around continuously even after the service\*(Aqs main process exited) are usually not suitable for activation via repetitive timers, as they will only be activated once, and then stay around forever\&. Target units, which by default do not deactivate on their own, can be activated repeatedly by timers by setting +\fIStopWhenUnneeded=yes\fR +on them\&. This will cause a target unit to be stopped immediately after its activation, if it is not a dependency of another running unit\&. .SH "AUTOMATIC DEPENDENCIES" .SS "Implicit Dependencies" .PP @@ -231,6 +233,8 @@ is ordered before\&. When a system is temporarily put to sleep (i\&.e\&. system suspend or hibernation) the realtime clock does not pause\&. When a calendar timer elapses while the system is sleeping it will not be acted on immediately, but once the system is later resumed it will catch up and process all timers that triggered while the system was sleeping\&. Note that if a calendar timer elapsed more than once while the system was continuously sleeping the timer will only result in a single service activation\&. If \fIWakeSystem=\fR (see below) is enabled a calendar time event elapsing while the system is suspended will cause the system to wake up (under the condition the system\*(Aqs hardware supports time\-triggered wake\-up functionality)\&. +.sp +Added in version 197\&. .RE .PP \fIAccuracySec=\fR @@ -255,6 +259,8 @@ for details\&. To optimize power consumption, make sure to set this value as hig Note that this setting is primarily a power saving option that allows coalescing CPU wake\-ups\&. It should not be confused with \fIRandomizedDelaySec=\fR (see below) which adds a random value to the time the timer shall elapse next and whose purpose is the opposite: to stretch elapsing of timer events over a longer period to reduce workload spikes\&. For further details and explanations and how both settings play together, see below\&. +.sp +Added in version 209\&. .RE .PP \fIRandomizedDelaySec=\fR @@ -279,6 +285,8 @@ to 0, thus encouraging coalescing of timer events\&. In order to optimally stret and \fIRandomizedDelaySec=\fR to some higher value\&. +.sp +Added in version 229\&. .RE .PP \fIFixedRandomDelay=\fR @@ -291,12 +299,16 @@ This setting has no effect if \fIRandomizedDelaySec=\fR is set to 0\&. Defaults to \fBfalse\fR\&. +.sp +Added in version 247\&. .RE .PP \fIOnClockChange=\fR, \fIOnTimezoneChange=\fR .RS 4 These options take boolean arguments\&. When true, the service unit will be triggered when the system clock (\fBCLOCK_REALTIME\fR) jumps relative to the monotonic clock (\fBCLOCK_MONOTONIC\fR), or when the local system timezone is modified\&. These options can be used alone or in combination with other timer expressions (see above) within the same timer unit\&. These options default to \fBfalse\fR\&. +.sp +Added in version 242\&. .RE .PP \fIUnit=\fR @@ -317,6 +329,8 @@ Use on the timer unit to remove the timestamp file maintained by this option from disk\&. In particular, use this command before uninstalling a timer unit\&. See \fBsystemctl\fR(1) for details\&. +.sp +Added in version 212\&. .RE .PP \fIWakeSystem=\fR @@ -334,6 +348,8 @@ Note that behaviour of monotonic clock timers (as configured with \fIOnUnitInactiveSec=\fR, see above) is altered depending on this option\&. If false, a monotonic clock is used that is paused during system suspend (\fBCLOCK_MONOTONIC\fR), if true a different monotonic clock is used that continues advancing during system suspend (\fBCLOCK_BOOTTIME\fR), see \fBclock_getres\fR(2) for details\&. +.sp +Added in version 212\&. .RE .PP \fIRemainAfterElapse=\fR @@ -345,6 +361,8 @@ is on, starting the timer a second time has no effect\&. However, if \fIRemainAfterElapse=\fR is off and the timer unit was already unloaded, it can be started again, and thus the service can be triggered multiple times\&. Defaults to \fBtrue\fR\&. +.sp +Added in version 229\&. .RE .PP Check diff --git a/upstream/opensuse-tumbleweed/man5/systemd.unit.5 b/upstream/opensuse-tumbleweed/man5/systemd.unit.5 index 7d7946c8..9c3e27c6 100644 --- a/upstream/opensuse-tumbleweed/man5/systemd.unit.5 +++ b/upstream/opensuse-tumbleweed/man5/systemd.unit.5 @@ -1,5 +1,5 @@ '\" t -.TH "SYSTEMD\&.UNIT" "5" "" "systemd 254" "systemd.unit" +.TH "SYSTEMD\&.UNIT" "5" "" "systemd 255" "systemd.unit" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -738,6 +738,8 @@ may use this string as a noun in status messages ("Starting \fIdescription\fR\&. "exiting the container" or "updating the database once per day\&."\&. +.sp +Added in version 201\&. .RE .PP \fIDocumentation=\fR @@ -749,6 +751,8 @@ A space\-separated list of URIs referencing documentation for this unit or its c "info:", "man:"\&. For more information about the syntax of these URIs, see \fBuri\fR(7)\&. The URIs should be listed in order of relevance, starting with the most relevant\&. It is a good idea to first reference documentation that explains what the unit\*(Aqs purpose is, followed by how it is configured, followed by any other related documentation\&. This option may be specified more than once, in which case the specified list of URIs is merged\&. If the empty string is assigned to this option, the list is reset and all prior assignments will have no effect\&. +.sp +Added in version 201\&. .RE .PP \fIWants=\fR @@ -775,6 +779,8 @@ or \fIBefore=\fR, then both units will be started simultaneously and without any delay between them if foo\&.service is activated\&. +.sp +Added in version 201\&. .RE .PP \fIRequires=\fR @@ -806,6 +812,8 @@ dependency\&. Use the dependency type together with \fIAfter=\fR to ensure that a unit may never be in active state without a specific other unit also in active state (see below)\&. +.sp +Added in version 201\&. .RE .PP \fIRequisite=\fR @@ -825,6 +833,8 @@ in property listing of b\&.service\&. \fIRequisiteOf=\fR dependency cannot be specified directly\&. +.sp +Added in version 201\&. .RE .PP \fIBindsTo=\fR @@ -854,6 +864,8 @@ in property listing of b\&.service\&. \fIBoundBy=\fR dependency cannot be specified directly\&. +.sp +Added in version 201\&. .RE .PP \fIPartOf=\fR @@ -870,6 +882,8 @@ in property listing of b\&.service\&. \fIConsistsOf=\fR dependency cannot be specified directly\&. +.sp +Added in version 201\&. .RE .PP \fIUpholds=\fR @@ -892,6 +906,8 @@ a\&.service, this dependency will show as \fIUpheldBy=a\&.service\fR in the property listing of b\&.service\&. +.sp +Added in version 249\&. .RE .PP \fIConflicts=\fR @@ -913,6 +929,8 @@ dependency must be declared\&. It doesn\*(Aqt matter which of the two ordering d below\&. .sp If unit A that conflicts with unit B is scheduled to be started at the same time as B, the transaction will either fail (in case both are required parts of the transaction) or be modified to be fixed (in case one or both jobs are not a required part of the transaction)\&. In the latter case, the job that is not required will be removed, or in case both are not required, the unit that conflicts will be started and the unit that is conflicted is stopped\&. +.sp +Added in version 201\&. .RE .PP \fIBefore=\fR, \fIAfter=\fR @@ -961,6 +979,8 @@ options, in which case the unit listed will be started before the unit that is c Note that \fIBefore=\fR dependencies on device units have no effect and are not supported\&. Devices generally become available as a result of an external hotplug event, and systemd creates the corresponding device unit without delay\&. +.sp +Added in version 201\&. .RE .PP \fIOnFailure=\fR @@ -968,6 +988,8 @@ dependencies on device units have no effect and are not supported\&. Devices gen A space\-separated list of one or more units that are activated when this unit enters the "failed" state\&. +.sp +Added in version 201\&. .RE .PP \fIOnSuccess=\fR @@ -975,22 +997,30 @@ state\&. A space\-separated list of one or more units that are activated when this unit enters the "inactive" state\&. +.sp +Added in version 249\&. .RE .PP \fIPropagatesReloadTo=\fR, \fIReloadPropagatedFrom=\fR .RS 4 A space\-separated list of one or more units to which reload requests from this unit shall be propagated to, or units from which reload requests shall be propagated to this unit, respectively\&. Issuing a reload request on a unit will automatically also enqueue reload requests on all units that are linked to it using these two settings\&. +.sp +Added in version 201\&. .RE .PP \fIPropagatesStopTo=\fR, \fIStopPropagatedFrom=\fR .RS 4 A space\-separated list of one or more units to which stop requests from this unit shall be propagated to, or units from which stop requests shall be propagated to this unit, respectively\&. Issuing a stop request on a unit will automatically also enqueue stop requests on all units that are linked to it using these two settings\&. +.sp +Added in version 249\&. .RE .PP \fIJoinsNamespaceOf=\fR .RS 4 -For units that start processes (such as service units), lists one or more other units whose network and/or temporary file namespace to join\&. If this is specified on a unit (say, a\&.service has -\fIJoinsNamespaceOf=b\&.service\fR), then this the inverse dependency (\fIJoinsNamespaceOf=a\&.service\fR +For units that start processes (such as service units), lists one or more other units whose network and/or temporary file namespace to join\&. If this is specified on a unit (say, +a\&.service +has +\fIJoinsNamespaceOf=b\&.service\fR), then the inverse dependency (\fIJoinsNamespaceOf=a\&.service\fR for b\&.service) is implied\&. This only applies to unit types which support the \fIPrivateNetwork=\fR, \fINetworkNamespacePath=\fR, @@ -1007,6 +1037,8 @@ for details)\&. If a unit that has this setting set is started, its processes wi and/or \fIPrivateTmp=\fR is enabled for both the unit that joins the namespace and the unit whose namespace is joined\&. +.sp +Added in version 209\&. .RE .PP \fIRequiresMountsFor=\fR @@ -1021,6 +1053,8 @@ Mount points marked with \fBnoauto\fR are not mounted automatically through local\-fs\&.target, but are still honored for the purposes of this option, i\&.e\&. they will be pulled in by this unit\&. +.sp +Added in version 201\&. .RE .PP \fIOnSuccessJobMode=\fR, \fIOnFailureJobMode=\fR @@ -1042,6 +1076,8 @@ will be enqueued\&. See option for details on the possible values\&. If this is set to "isolate", only a single unit may be listed in \fIOnSuccess=\fR/\fIOnFailure=\fR\&. +.sp +Added in version 209\&. .RE .PP \fIIgnoreOnIsolate=\fR @@ -1052,6 +1088,8 @@ Takes a boolean argument\&. If for service, target, socket, timer, and path units, and \fBtrue\fR for slice, scope, device, swap, mount, and automount units\&. +.sp +Added in version 201\&. .RE .PP \fIStopWhenUnneeded=\fR @@ -1059,6 +1097,8 @@ for slice, scope, device, swap, mount, and automount units\&. Takes a boolean argument\&. If \fBtrue\fR, this unit will be stopped when it is no longer used\&. Note that, in order to minimize the work to be executed, systemd will not stop units by default unless they are conflicting with other units, or the user explicitly requested their shut down\&. If this option is set, a unit will be automatically cleaned up if no other active unit requires it\&. Defaults to \fBfalse\fR\&. +.sp +Added in version 201\&. .RE .PP \fIRefuseManualStart=\fR, \fIRefuseManualStop=\fR @@ -1066,6 +1106,8 @@ Takes a boolean argument\&. If Takes a boolean argument\&. If \fBtrue\fR, this unit can only be activated or deactivated indirectly\&. In this case, explicit start\-up or termination requested by the user is denied, however if it is started or stopped as a dependency of another unit, start\-up or termination will succeed\&. This is mostly a safety feature to ensure that the user does not accidentally activate units that are not intended to be activated explicitly, and not accidentally deactivate units that are not intended to be deactivated\&. These options default to \fBfalse\fR\&. +.sp +Added in version 201\&. .RE .PP \fIAllowIsolate=\fR @@ -1075,6 +1117,8 @@ Takes a boolean argument\&. If \fBsystemctl isolate\fR command\&. Otherwise, this will be refused\&. It probably is a good idea to leave this disabled except for target units that shall be used similar to runlevels in SysV init systems, just as a precaution to avoid unusable system states\&. This option defaults to \fBfalse\fR\&. +.sp +Added in version 201\&. .RE .PP \fIDefaultDependencies=\fR @@ -1083,6 +1127,24 @@ Takes a boolean argument\&. If \fByes\fR, (the default), a few default dependencies will implicitly be created for the unit\&. The actual dependencies created depend on the unit type\&. For example, for service units, these dependencies ensure that the service is started only after basic system initialization is completed and is properly terminated on system shutdown\&. See the respective man pages for details\&. Generally, only services involved with early boot or late shutdown should set this option to \fBno\fR\&. It is highly recommended to leave this option enabled for the majority of common units\&. If set to \fBno\fR, this option does not disable all implicit dependencies, just non\-essential ones\&. +.sp +Added in version 201\&. +.RE +.PP +\fISurviveFinalKillSignal=\fR +.RS 4 +Takes a boolean argument\&. Defaults to +\fBno\fR\&. If +\fByes\fR, processes belonging to this unit will not be sent the final +"SIGTERM" +and +"SIGKILL" +signals during the final phase of the system shutdown process\&. This functionality replaces the older mechanism that allowed a program to set +"argv[0][0] = \*(Aq@\*(Aq" +as described at +\m[blue]\fBsystemd and Storage Daemons for the Root File System\fR\m[]\&\s-2\u[2]\d\s+2, which however continues to be supported\&. +.sp +Added in version 255\&. .RE .PP \fICollectMode=\fR @@ -1109,6 +1171,8 @@ state, and thus an explicitly resetting of the \fBfailed\fR state is not necessary\&. Note that if this mode is used unit results (such as exit codes, exit signals, consumed resources, \&...) are flushed out immediately after the unit completed, except for what is stored in the logging subsystem\&. Defaults to \fBinactive\fR\&. +.sp +Added in version 236\&. .RE .PP \fIFailureAction=\fR, \fISuccessAction=\fR @@ -1177,6 +1241,8 @@ is used by default the exit status of the main process of the unit (if this appl will trigger a userspace reboot operation\&. \fBsoft\-reboot\-force\fR does that too, but does not go through the shutdown transaction beforehand\&. +.sp +Added in version 236\&. .RE .PP \fIFailureActionExitStatus=\fR, \fISuccessActionExitStatus=\fR @@ -1188,6 +1254,8 @@ are set to or \fBexit\-force\fR and the action is triggered\&. By default the exit status of the main process of the triggering unit (if this applies) is propagated\&. Takes a value in the range 0\&...255 or the empty string to request default behaviour\&. +.sp +Added in version 240\&. .RE .PP \fIJobTimeoutSec=\fR, \fIJobRunningTimeoutSec=\fR @@ -1210,6 +1278,8 @@ defaults to Note: these timeouts are independent from any unit\-specific timeouts (for example, the timeout set with \fITimeoutStartSec=\fR in service units)\&. The job timeout has no effect on the unit itself\&. Or in other words: unit\-specific timeouts are useful to abort unit state changes, and revert them\&. The job timeout set with this option however is useful to abort only the job waiting for the unit state to change\&. +.sp +Added in version 201\&. .RE .PP \fIJobTimeoutAction=\fR, \fIJobTimeoutRebootArgument=\fR @@ -1227,6 +1297,8 @@ above\&. It takes the same values as configures an optional reboot string to pass to the \fBreboot\fR(2) system call\&. +.sp +Added in version 240\&. .RE .PP \fIStartLimitIntervalSec=\fR\fI\fIinterval\fR\fR, \fIStartLimitBurst=\fR\fI\fIburst\fR\fR @@ -1243,7 +1315,9 @@ to configure how many starts per interval are allowed\&. .sp \fIinterval\fR is a time span with the default unit of seconds, but other units may be specified, see -\fBsystemd.time\fR(5)\&. Defaults to +\fBsystemd.time\fR(5)\&. The special value +"infinity" +can be used to limit the total number of start attempts, even if they happen at large time intervals\&. Defaults to \fIDefaultStartLimitIntervalSec=\fR in manager configuration file, and may be set to 0 to disable any kind of rate limiting\&. \fIburst\fR @@ -1268,6 +1342,8 @@ will cause the restart rate counter for a service to be flushed, which is useful When a unit is unloaded due to the garbage collection logic (see above) its rate limit counters are flushed out too\&. This means that configuring start rate limiting for a unit that is not referenced continuously has no effect\&. .sp This setting does not apply to slice, target, device, and scope units, since they are unit types whose activation may either never fail, or may succeed only a single time\&. +.sp +Added in version 229\&. .RE .PP \fIStartLimitAction=\fR @@ -1282,6 +1358,8 @@ settings\&. If \fBnone\fR is set, hitting the rate limit will trigger no action except that the start will not be permitted\&. Defaults to \fBnone\fR\&. +.sp +Added in version 229\&. .RE .PP \fIRebootArgument=\fR @@ -1295,11 +1373,15 @@ or is a reboot action\&. This works just like the optional argument to \fBsystemctl reboot\fR command\&. +.sp +Added in version 229\&. .RE .PP \fISourcePath=\fR .RS 4 A path to a configuration file this unit has been generated from\&. This is primarily useful for implementation of generator tools that convert configuration from an external configuration file format into native unit files\&. This functionality should not be used in normal units\&. +.sp +Added in version 201\&. .RE .SS "Conditions and Asserts" .PP @@ -1372,6 +1454,8 @@ and is thus subject to setting in the same unit file has no effect on this condition\&. A special architecture name "native" is mapped to the architecture the system manager itself is compiled for\&. The test may be negated by prepending an exclamation mark\&. +.sp +Added in version 201\&. .RE .PP \fIConditionFirmware=\fR @@ -1451,6 +1535,8 @@ is the expected value of the SMBIOS field value (possibly containing shell style "$="/"!$=" is used)\&. .RE +.sp +Added in version 249\&. .RE .PP \fIConditionVirtualization=\fR @@ -1491,6 +1577,8 @@ to test against a specific implementation, or to check whether we are running in a user namespace\&. See \fBsystemd-detect-virt\fR(1) for a full list of known virtualization technologies and their identifiers\&. If multiple virtualization technologies are nested, only the innermost is considered\&. The test may be negated by prepending an exclamation mark\&. +.sp +Added in version 244\&. .RE .PP \fIConditionHost=\fR @@ -1499,6 +1587,8 @@ for a full list of known virtualization technologies and their identifiers\&. If may be used to match against the hostname or machine ID of the host\&. This either takes a hostname string (optionally with shell style globs) which is tested against the locally set hostname as returned by \fBgethostname\fR(2), or a machine ID formatted as string (see \fBmachine-id\fR(5))\&. The test may be negated by prepending an exclamation mark\&. +.sp +Added in version 244\&. .RE .PP \fIConditionKernelCommandLine=\fR @@ -1510,6 +1600,8 @@ may be used to check whether a specific kernel command line option is set (or if PID 1 is used instead (i\&.e\&. /proc/1/cmdline)\&. +.sp +Added in version 244\&. .RE .PP \fIConditionKernelVersion=\fR @@ -1535,16 +1627,20 @@ for a shell\-style glob match\&. If no operator is specified, is implied\&. .sp Note that using the kernel version string is an unreliable way to determine which features are supported by a kernel, because of the widespread practice of backporting drivers, features, and fixes from newer upstream kernels into older versions provided by distributions\&. Hence, this check is inherently unportable and should not be used for units which may be used on different distributions\&. +.sp +Added in version 244\&. .RE .PP \fIConditionCredential=\fR .RS 4 \fIConditionCredential=\fR may be used to check whether a credential by the specified name was passed into the service manager\&. See -\m[blue]\fBSystem and Service Credentials\fR\m[]\&\s-2\u[2]\d\s+2 +\m[blue]\fBSystem and Service Credentials\fR\m[]\&\s-2\u[3]\d\s+2 for details about credentials\&. If used in services for the system service manager this may be used to conditionalize services based on system credentials passed in\&. If used in services for the per\-user service manager this may be used to conditionalize services based on credentials passed into the unit@\&.service service instance belonging to the user\&. The argument must be a valid credential name\&. +.sp +Added in version 252\&. .RE .PP \fIConditionEnvironment=\fR @@ -1554,22 +1650,94 @@ may be used to check whether a specific environment variable is set (or if prefi \fIEnvironment=\fR or \fIEnvironmentFile=\fR, as described above\&. This is particularly useful when the service manager runs inside a containerized environment or as per\-user service manager, in order to check for variables passed in by the enclosing container manager or PAM\&. +.sp +Added in version 246\&. .RE .PP \fIConditionSecurity=\fR .RS 4 \fIConditionSecurity=\fR -may be used to check whether the given security technology is enabled on the system\&. Currently, the recognized values are -"selinux", -"apparmor", -"tomoyo", -"ima", -"smack", -"audit", -"uefi\-secureboot", -"tpm2" -and -"cvm"\&. The test may be negated by prepending an exclamation mark\&. +may be used to check whether the given security technology is enabled on the system\&. Currently, the following values are recognized: +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.B Table\ \&3.\ \&Recognized security technologies +.TS +allbox tab(:); +lB lB. +T{ +Value +T}:T{ +Description +T} +.T& +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l. +T{ +selinux +T}:T{ +SELinux MAC +T} +T{ +apparmor +T}:T{ +AppArmor MAC +T} +T{ +tomoyo +T}:T{ +Tomoyo MAC +T} +T{ +smack +T}:T{ +SMACK MAC +T} +T{ +ima +T}:T{ +Integrity Measurement Architecture (IMA) +T} +T{ +audit +T}:T{ +Linux Audit Framework +T} +T{ +uefi\-secureboot +T}:T{ +UEFI SecureBoot +T} +T{ +tpm2 +T}:T{ +Trusted Platform Module 2\&.0 (TPM2) +T} +T{ +cvm +T}:T{ +Confidential virtual machine (SEV/TDX) +T} +T{ +measured\-uki +T}:T{ +Unified Kernel Image with PCR 11 Measurements, as per \fBsystemd-stub\fR(7)\&. Added in version 255\&. +T} +.TE +.sp 1 +The test may be negated by prepending an exclamation mark\&. +.sp +Added in version 244\&. .RE .PP \fIConditionCapability=\fR @@ -1578,6 +1746,8 @@ Check whether the given capability exists in the capability bounding set of the \fBcapabilities\fR(7) for details)\&. Pass a capability name such as "CAP_MKNOD", possibly prefixed with an exclamation mark to negate the check\&. +.sp +Added in version 244\&. .RE .PP \fIConditionACPower=\fR @@ -1585,6 +1755,8 @@ for details)\&. Pass a capability name such as Check whether the system has AC power, or is exclusively battery powered at the time of activation of the unit\&. This takes a boolean argument\&. If set to "true", the condition will hold only if at least one AC connector of the system is connected to a power source, or if no AC connectors are known\&. Conversely, if set to "false", the condition will hold only if there is at least one AC connector known and all AC connectors are disconnected from a power source\&. +.sp +Added in version 244\&. .RE .PP \fIConditionNeedsUpdate=\fR @@ -1625,6 +1797,8 @@ Also note that if the update method includes a call to execute appropriate post\ /usr/\&. In a typical distribution packaging scheme, packages will do any required update steps as part of the installation or upgrade, to make package contents immediately usable\&. \fIConditionNeedsUpdate=\fR should be used with other update mechanisms where such an immediate update does not happen\&. +.sp +Added in version 244\&. .RE .PP \fIConditionFirstBoot=\fR @@ -1650,6 +1824,8 @@ If the option is specified on the kernel command line (taking a boolean), it will override the result of this condition check, taking precedence over /etc/machine\-id existence checks\&. +.sp +Added in version 244\&. .RE .PP \fIConditionPathExists=\fR @@ -1657,6 +1833,8 @@ existence checks\&. Check for the existence of a file\&. If the specified absolute path name does not exist, the condition will fail\&. If the absolute path name passed to \fIConditionPathExists=\fR is prefixed with an exclamation mark ("!"), the test is negated, and the unit is only started if the path does not exist\&. +.sp +Added in version 244\&. .RE .PP \fIConditionPathExistsGlob=\fR @@ -1664,6 +1842,8 @@ is prefixed with an exclamation mark ("!"), the test is negated, and the unit is \fIConditionPathExistsGlob=\fR is similar to \fIConditionPathExists=\fR, but checks for the existence of at least one file or directory matching the specified globbing pattern\&. +.sp +Added in version 244\&. .RE .PP \fIConditionPathIsDirectory=\fR @@ -1672,6 +1852,8 @@ is similar to is similar to \fIConditionPathExists=\fR but verifies that a certain path exists and is a directory\&. +.sp +Added in version 244\&. .RE .PP \fIConditionPathIsSymbolicLink=\fR @@ -1680,6 +1862,8 @@ but verifies that a certain path exists and is a directory\&. is similar to \fIConditionPathExists=\fR but verifies that a certain path exists and is a symbolic link\&. +.sp +Added in version 244\&. .RE .PP \fIConditionPathIsMountPoint=\fR @@ -1688,6 +1872,8 @@ but verifies that a certain path exists and is a symbolic link\&. is similar to \fIConditionPathExists=\fR but verifies that a certain path exists and is a mount point\&. +.sp +Added in version 244\&. .RE .PP \fIConditionPathIsReadWrite=\fR @@ -1696,6 +1882,8 @@ but verifies that a certain path exists and is a mount point\&. is similar to \fIConditionPathExists=\fR but verifies that the underlying file system is readable and writable (i\&.e\&. not mounted read\-only)\&. +.sp +Added in version 244\&. .RE .PP \fIConditionPathIsEncrypted=\fR @@ -1704,6 +1892,8 @@ but verifies that the underlying file system is readable and writable (i\&.e\&. is similar to \fIConditionPathExists=\fR but verifies that the underlying file system\*(Aqs backing block device is encrypted using dm\-crypt/LUKS\&. Note that this check does not cover ext4 per\-directory encryption, and only detects block level encryption\&. Moreover, if the specified path resides on a file system on top of a loopback block device, only encryption above the loopback device is detected\&. It is not detected whether the file system backing the loopback block device is encrypted\&. +.sp +Added in version 246\&. .RE .PP \fIConditionDirectoryNotEmpty=\fR @@ -1712,6 +1902,8 @@ but verifies that the underlying file system\*(Aqs backing block device is encry is similar to \fIConditionPathExists=\fR but verifies that a certain path exists and is a non\-empty directory\&. +.sp +Added in version 244\&. .RE .PP \fIConditionFileNotEmpty=\fR @@ -1720,6 +1912,8 @@ but verifies that a certain path exists and is a non\-empty directory\&. is similar to \fIConditionPathExists=\fR but verifies that a certain path exists and refers to a regular file with a non\-zero size\&. +.sp +Added in version 244\&. .RE .PP \fIConditionFileIsExecutable=\fR @@ -1728,6 +1922,8 @@ but verifies that a certain path exists and refers to a regular file with a non\ is similar to \fIConditionPathExists=\fR but verifies that a certain path exists, is a regular file, and marked executable\&. +.sp +Added in version 244\&. .RE .PP \fIConditionUser=\fR @@ -1738,6 +1934,8 @@ takes a numeric "@system"\&. This condition may be used to check whether the service manager is running as the given user\&. The special value "@system" can be used to check if the user id is within the system user range\&. This option is not useful for system services, as the system manager exclusively runs as the root user, and thus the test result is constant\&. +.sp +Added in version 244\&. .RE .PP \fIConditionGroup=\fR @@ -1747,6 +1945,8 @@ is similar to \fIConditionUser=\fR but verifies that the service manager\*(Aqs real or effective group, or any of its auxiliary groups, match the specified group or GID\&. This setting does not support the special value "@system"\&. +.sp +Added in version 244\&. .RE .PP \fIConditionControlGroupController=\fR @@ -1772,6 +1972,8 @@ will pass if the unified v2 cgroup hierarchy is used, and will pass if the legacy v1 hierarchy or the hybrid hierarchy are used\&. Note that legacy or hybrid hierarchies have been deprecated\&. See \fBsystemd\fR(1) for more information\&. +.sp +Added in version 244\&. .RE .PP \fIConditionMemory=\fR @@ -1787,6 +1989,8 @@ Verify that the specified amount of system memory is available to the current sy "<>"), ">=", ">"\&. On bare\-metal systems compares the amount of physical memory in the system with the specified size, adhering to the specified comparison operator\&. In containers compares the amount of memory assigned to the container instead\&. +.sp +Added in version 244\&. .RE .PP \fIConditionCPUs=\fR @@ -1802,6 +2006,8 @@ Verify that the specified number of CPUs is available to the current system\&. T "<>"), ">=", ">"\&. Compares the number of CPUs in the CPU affinity mask configured of the service manager itself with the specified number, adhering to the specified comparison operator\&. On physical systems the number of CPUs in the affinity mask of the service manager usually matches the number of physical CPUs, but in special and virtual environments might differ\&. In particular, in containers the affinity mask usually matches the number of CPUs assigned to the container and not the physically available ones\&. +.sp +Added in version 244\&. .RE .PP \fIConditionCPUFeature=\fR @@ -1864,6 +2070,8 @@ instruction\&. This condition only does something on i386 and x86\-64 processors "lahf_lm", "abm", "constant_tsc"\&. +.sp +Added in version 248\&. .RE .PP \fIConditionOSRelease=\fR @@ -1890,6 +2098,8 @@ and (match) and "!$=" (non\-match)\&. +.sp +Added in version 249\&. .RE .PP \fIConditionMemoryPressure=\fR, \fIConditionCPUPressure=\fR, \fIConditionIOPressure=\fR @@ -1907,10 +2117,12 @@ and PSI will be checked first, and if not found "some" will be checked\&. For more details, see the documentation on -\m[blue]\fBPSI (Pressure Stall Information)\fR\m[]\&\s-2\u[3]\d\s+2\&. +\m[blue]\fBPSI (Pressure Stall Information)\fR\m[]\&\s-2\u[4]\d\s+2\&. .sp Optionally, the threshold value can be prefixed with the slice unit under which the pressure will be checked, followed by a ":"\&. If the slice unit is not specified, the overall system pressure will be measured, instead of a particular cgroup\*(Aqs\&. +.sp +Added in version 250\&. .RE .PP \fIAssertArchitecture=\fR, \fIAssertVirtualization=\fR, \fIAssertHost=\fR, \fIAssertKernelCommandLine=\fR, \fIAssertKernelVersion=\fR, \fIAssertCredential=\fR, \fIAssertEnvironment=\fR, \fIAssertSecurity=\fR, \fIAssertCapability=\fR, \fIAssertACPower=\fR, \fIAssertNeedsUpdate=\fR, \fIAssertFirstBoot=\fR, \fIAssertPathExists=\fR, \fIAssertPathExistsGlob=\fR, \fIAssertPathIsDirectory=\fR, \fIAssertPathIsSymbolicLink=\fR, \fIAssertPathIsMountPoint=\fR, \fIAssertPathIsReadWrite=\fR, \fIAssertPathIsEncrypted=\fR, \fIAssertDirectoryNotEmpty=\fR, \fIAssertFileNotEmpty=\fR, \fIAssertFileIsExecutable=\fR, \fIAssertUser=\fR, \fIAssertGroup=\fR, \fIAssertControlGroupController=\fR, \fIAssertMemory=\fR, \fIAssertCPUs=\fR, \fIAssertCPUFeature=\fR, \fIAssertOSRelease=\fR, \fIAssertMemoryPressure=\fR, \fIAssertCPUPressure=\fR, \fIAssertIOPressure=\fR @@ -1920,6 +2132,8 @@ Similar to the \fIConditionVirtualization=\fR, \&..., condition settings described above, these settings add assertion checks to the start\-up of the unit\&. However, unlike the conditions settings, any assertion setting that is not met results in failure of the start job (which means this is logged loudly)\&. Note that hitting a configured assertion does not cause the unit to enter the "failed" state (or in fact result in any state change of the unit), it affects only the job queued for it\&. Use assertion expressions for units that cannot operate when specific requirements are not met, and when this is something the administrator or user should look into\&. +.sp +Added in version 218\&. .RE .SH "MAPPING OF UNIT PROPERTIES TO THEIR INVERSES" .PP @@ -1931,7 +2145,7 @@ output\&. In some cases the name of the property is the same as the name of the .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&3.\ \& "Forward" and "reverse" unit properties +.B Table\ \&4.\ \& "Forward" and "reverse" unit properties .TS allbox tab(:); lB lB lB s. @@ -2128,6 +2342,8 @@ tool during installation of a unit\&. A space\-separated list of additional names this unit shall be installed under\&. The names listed here must have the same suffix (i\&.e\&. type) as the unit filename\&. This option may be specified more than once, in which case all listed names are used\&. At installation time, \fBsystemctl enable\fR will create symlinks from these names to the unit filename\&. Note that not all unit types support such alias names, and this setting is not supported for them\&. Specifically, mount, slice, swap, and automount units do not support aliasing\&. +.sp +Added in version 201\&. .RE .PP \fIWantedBy=\fR, \fIRequiredBy=\fR, \fIUpheldBy=\fR @@ -2171,6 +2387,8 @@ container@\&.target\&.wants/monitor@\&.service link to monitor@\&.service, which applies to all instances of container@\&.target\&. +.sp +Added in version 201\&. .RE .PP \fIAlso=\fR @@ -2182,11 +2400,15 @@ and will automatically install/uninstall units listed in this option as well\&. .sp This option may be used more than once, or a space\-separated list of unit names may be given\&. +.sp +Added in version 201\&. .RE .PP \fIDefaultInstance=\fR .RS 4 In template unit files, this specifies for which instance the unit shall be enabled if the template is enabled without any explicitly set instance\&. This option has no effect in non\-template unit files\&. The specified string must be usable as instance identifier\&. +.sp +Added in version 215\&. .RE .PP The following specifiers are interpreted in the Install section: %a, %b, %B, %g, %G, %H, %i, %j, %l, %m, %n, %N, %o, %p, %u, %U, %v, %w, %W, %%\&. For their meaning see the next section\&. @@ -2198,7 +2420,7 @@ Many settings resolve specifiers which may be used to write generic unit files r .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&4.\ \&Specifiers available in unit files +.B Table\ \&5.\ \&Specifiers available in unit files .TS allbox tab(:); lB lB lB. @@ -2777,11 +2999,16 @@ Interface Portability and Stability Promise \%https://systemd.io/PORTABILITY_AND_STABILITY/ .RE .IP " 2." 4 +systemd and Storage Daemons for the Root File System +.RS 4 +\%https://systemd.io/ROOT_STORAGE_DAEMONS +.RE +.IP " 3." 4 System and Service Credentials .RS 4 \%https://systemd.io/CREDENTIALS .RE -.IP " 3." 4 +.IP " 4." 4 PSI (Pressure Stall Information) .RS 4 \%https://docs.kernel.org/accounting/psi.html diff --git a/upstream/opensuse-tumbleweed/man5/sysupdate.d.5 b/upstream/opensuse-tumbleweed/man5/sysupdate.d.5 index d5413f55..456bdb01 100644 --- a/upstream/opensuse-tumbleweed/man5/sysupdate.d.5 +++ b/upstream/opensuse-tumbleweed/man5/sysupdate.d.5 @@ -1,5 +1,5 @@ '\" t -.TH "SYSUPDATE\&.D" "5" "" "systemd 254" "sysupdate.d" +.TH "SYSUPDATE\&.D" "5" "" "systemd 255" "sysupdate.d" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -637,6 +637,8 @@ This section defines general properties of this transfer\&. \fIMinVersion=\fR .RS 4 Specifies the minimum version to require for this transfer to take place\&. If the source or target patterns in this transfer definition match files older than this version they will be considered obsolete, and never be considered for the update operation\&. +.sp +Added in version 251\&. .RE .PP \fIProtectVersion=\fR @@ -649,6 +651,8 @@ Like many of the settings in these configuration files this setting supports spe or "%w" specifiers to automatically refer to the current OS version of the running system\&. See below for details on supported specifiers\&. +.sp +Added in version 251\&. .RE .PP \fIVerify=\fR @@ -670,6 +674,8 @@ This option only has an effect if the source resource type is selected as \fBurl\-file\fR or \fBurl\-tar\fR, as integrity and authentication checking is only available for transfers from remote sources\&. +.sp +Added in version 251\&. .RE .SH "[SOURCE] SECTION OPTIONS" .PP @@ -687,6 +693,8 @@ or \fBsubvolume\fR\&. For details about the resource types, see above\&. This option is mandatory\&. .sp Note that only certain combinations of source and target resource types are supported, see above\&. +.sp +Added in version 251\&. .RE .PP \fIPath=\fR @@ -704,6 +712,8 @@ to acquire the manifest file, with to acquire the detached signature file for it, and with the file names listed in the manifest file in case an update is executed and a resource shall be downloaded\&. .sp For all other source resource types this must be a local path in the file system, referring to a local directory to find the versions of this resource in\&. +.sp +Added in version 251\&. .RE .PP \fIMatchPattern=\fR @@ -713,6 +723,18 @@ Specifies one or more file name match patterns that select the subset of files t This option is mandatory\&. Any pattern listed must contain at least the "@v" wildcard, so that a version identifier may be extracted from the filename\&. All other wildcards are optional\&. +.sp +If the source type is +\fBregular\-file\fR +or +\fBdirectory\fR, the pattern may contain slash characters\&. In this case it will match the file or directory in corresponding subdirectory\&. For example +"MatchPattern=foo_@v/bar\&.efi" +will match +"bar\&.efi" +in directory +"foo_1"\&. +.sp +Added in version 251\&. .RE .SH "[TARGET] SECTION OPTIONS" .PP @@ -728,6 +750,8 @@ or \fBsubvolume\fR\&. For details about the resource types, see above\&. This option is mandatory\&. .sp Note that only certain combinations of source and target resource types are supported, see above\&. +.sp +Added in version 251\&. .RE .PP \fIPath=\fR @@ -752,6 +776,8 @@ is set to "_empty" is used to indicate empty partitions\&. To automatically generate suitable partitions on first boot, use a tool such as \fBsystemd-repart\fR(8)\&. +.sp +Added in version 251\&. .RE .PP \fIPathRelativeTo=\fR @@ -781,6 +807,8 @@ is set to \fBregular\-file\fR or \fBdirectory\fR\&. +.sp +Added in version 254\&. .RE .PP \fIMatchPattern=\fR @@ -792,6 +820,18 @@ This option is mandatory\&. Any pattern listed must contain at least the wildcard, so that a version identifier may be extracted from the filename\&. All other wildcards are optional\&. .sp This pattern is both used for matching existing installed versions and for determining the name of new versions to install\&. If multiple patterns are specified, the first specified is used for naming newly installed versions\&. +.sp +If the target type is +\fBregular\-file\fR +or +\fBdirectory\fR, the pattern may contain slash characters\&. In this case it will match the file or directory in corresponding subdirectory\&. For example +"MatchPattern=foo_@v/bar\&.efi" +will match +"bar\&.efi" +in directory +"foo_1"\&. Directories in the path will be created when file is installed\&. Empty directories will be removed when file is removed\&. +.sp +Added in version 251\&. .RE .PP \fIMatchPartitionType=\fR @@ -805,6 +845,8 @@ is used\&. Accepts either a literal type UUID or a symbolic type identifier\&. F \fIType=\fR setting in \fBrepart.d\fR(5)\&. +.sp +Added in version 251\&. .RE .PP \fIPartitionUUID=\fR, \fIPartitionFlags=\fR, \fIPartitionNoAuto=\fR, \fIPartitionGrowFileSystem=\fR @@ -827,6 +869,8 @@ are used (or the wildcards for them), then the latter override the former, i\&.e for details about these flags\&. .sp Note that these settings are not used for matching, they only have effect on newly written partitions in case a transfer takes place\&. +.sp +Added in version 251\&. .RE .PP \fIReadOnly=\fR @@ -846,6 +890,8 @@ is selected as \fBdirectory\fR, the "immutable" file attribute is set, see \fBchattr\fR(1) for details\&. +.sp +Added in version 251\&. .RE .PP \fIMode=\fR @@ -855,6 +901,8 @@ The UNIX file access mode to use for newly created files in case the target reso "@t"), the value from the pattern is used\&. .sp Note that this setting is not used for matching, it only has an effect on newly written files when a transfer takes place\&. +.sp +Added in version 251\&. .RE .PP \fITriesDone=\fR, \fITriesLeft=\fR @@ -865,6 +913,8 @@ These options take positive, decimal integers, and control the number of attempt or "@l" wildcards\&. +.sp +Added in version 251\&. .RE .PP \fIInstancesMax=\fR @@ -888,6 +938,8 @@ If the target \fIType=\fR is selected as \fBpartition\fR, the number of concurrent versions to keep is additionally restricted by the number of partition slots of the right type in the partition table\&. I\&.e\&. if there are only 2 partition slots for the selected partition type, setting this value larger than 2 is without effect, since no more than 2 concurrent versions could be stored in the image anyway\&. +.sp +Added in version 251\&. .RE .PP \fIRemoveTemporary=\fR @@ -899,6 +951,8 @@ is selected as \fBdirectory\fR or \fBsubvolume\fR\&. +.sp +Added in version 251\&. .RE .PP \fICurrentSymlink=\fR @@ -910,6 +964,8 @@ is selected as \fBdirectory\fR or \fBsubvolume\fR\&. +.sp +Added in version 251\&. .RE .SH "SPECIFIERS" .PP @@ -1091,7 +1147,7 @@ Path=auto MatchPattern=foobarOS_@v_verity MatchPartitionType=root\-verity PartitionFlags=0 -PartitionReadOnly=1 +ReadOnly=1 .fi .if n \{\ .RE @@ -1126,7 +1182,7 @@ Path=auto MatchPattern=foobarOS_@v MatchPartitionType=root PartitionFlags=0 -PartitionReadOnly=1 +ReadOnly=1 .fi .if n \{\ .RE diff --git a/upstream/opensuse-tumbleweed/man5/sysusers.d.5 b/upstream/opensuse-tumbleweed/man5/sysusers.d.5 index a0f7c35f..a44d461f 100644 --- a/upstream/opensuse-tumbleweed/man5/sysusers.d.5 +++ b/upstream/opensuse-tumbleweed/man5/sysusers.d.5 @@ -1,5 +1,5 @@ '\" t -.TH "SYSUSERS\&.D" "5" "" "systemd 254" "sysusers.d" +.TH "SYSUSERS\&.D" "5" "" "systemd 255" "sysusers.d" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -105,6 +105,8 @@ The type consists of a single letter\&. The following line types are understood: \fIu\fR .RS 4 Create a system user and group of the specified name should they not exist yet\&. The user\*(Aqs primary group will be set to the group bearing the same name unless the ID field specifies it\&. The account will be created disabled, so that logins are not allowed\&. +.sp +Added in version 215\&. .RE .PP \fIg\fR @@ -112,16 +114,22 @@ Create a system user and group of the specified name should they not exist yet\& Create a system group of the specified name should it not exist yet\&. Note that \fIu\fR implicitly creates a matching group\&. The group will be created with no password set\&. +.sp +Added in version 215\&. .RE .PP \fIm\fR .RS 4 Add a user to a group\&. If the user or group do not exist yet, they will be implicitly created\&. +.sp +Added in version 215\&. .RE .PP \fIr\fR .RS 4 Add a range of numeric UIDs/GIDs to the pool to allocate new UIDs and GIDs from\&. If no line of this type is specified, the range of UIDs/GIDs is set to some compiled\-in default\&. Note that both UIDs and GIDs are allocated from the same pool, in order to ensure that users and groups of the same name are likely to carry the same numeric UID and GID\&. +.sp +Added in version 216\&. .RE .SS "Name" .PP diff --git a/upstream/opensuse-tumbleweed/man5/term.5 b/upstream/opensuse-tumbleweed/man5/term.5 index e6091d6f..69765135 100644 --- a/upstream/opensuse-tumbleweed/man5/term.5 +++ b/upstream/opensuse-tumbleweed/man5/term.5 @@ -28,8 +28,8 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: term.5,v 1.73 2024/01/13 22:05:39 tom Exp $ -.TH term 5 2024-01-13 "ncurses 6.4" "File formats" +.\" $Id: term.5,v 1.77 2024/04/20 21:24:19 tom Exp $ +.TH term 5 2024-04-20 "ncurses 6.5" "File formats" .ie \n(.g \{\ .ds `` \(lq .ds '' \(rq @@ -327,7 +327,7 @@ The problem is that there are at least three versions of terminfo (under HP\-UX, AIX, and OSF/1) which diverged from System V terminfo after SVr1, and have added extension capabilities to the string table that (in the binary format) collide with -System V and XSI Curses extensions. +System V and X/Open Curses extensions. See \fB\%terminfo\fP(5) for detailed discussion of terminfo source compatibility issues. .PP diff --git a/upstream/opensuse-tumbleweed/man5/termcap.5 b/upstream/opensuse-tumbleweed/man5/termcap.5 index 880c957f..633f2d13 100644 --- a/upstream/opensuse-tumbleweed/man5/termcap.5 +++ b/upstream/opensuse-tumbleweed/man5/termcap.5 @@ -9,7 +9,7 @@ .\" If mistakes in the capabilities are found, please send a bug report to: .\" michael@moria.de .\" Modified Mon Oct 21 17:47:19 EDT 1996 by Eric S. Raymond (esr@thyrsus.com) -.TH termcap 5 2023-03-08 "Linux man-pages 6.05.01" +.TH termcap 5 2024-05-02 "Linux man-pages (unreleased)" .SH NAME termcap \- terminal capability database .SH DESCRIPTION @@ -19,7 +19,7 @@ It is retained only for compatibility with old programs; new programs should use the .BR terminfo (5) database and associated libraries. -.PP +.P .I /etc/termcap is an ASCII file (the database master) that lists the capabilities of many different types of terminals. @@ -32,18 +32,18 @@ handled by The termcap database is indexed on the .B TERM environment variable. -.PP +.P Termcap entries must be defined on a single logical line, with \[aq]\e\[aq] used to suppress the newline. Fields are separated by \[aq]:\[aq]. The first field of each entry starts at the left-hand margin, and contains a list of names for the terminal, separated by \[aq]|\[aq]. -.PP +.P The first subfield may (in BSD termcap entries from 4.3BSD and earlier) contain a short name consisting of two characters. This short name may consist of capital or small letters. In 4.4BSD, termcap entries this field is omitted. -.PP +.P The second subfield (first, in the newer 4.4BSD format) contains the name used by the environment variable .BR TERM . @@ -56,18 +56,18 @@ Usual suffixes are w (more than 80 characters wide), am display). The third subfield contains a long and descriptive name for this termcap entry. -.PP +.P Subsequent fields contain the terminal capabilities; any continued capability lines must be indented one tab from the left margin. -.PP +.P Although there is no defined order, it is suggested to write first boolean, then numeric, and then string capabilities, each sorted alphabetically without looking at lower or upper spelling. Capabilities of similar functions can be written in one line. -.PP +.P Example for: .nf -.PP +.P Head line: vt|vt101|DEC VT 101 terminal in 80 character mode:\e Head line: Vt|vt101-w|DEC VT 101 terminal in (wide) 132 character mode:\e Boolean: :bs:\e @@ -358,15 +358,15 @@ vs Standout cursor wi Set window from line %1 to %2 and column %3 to %4 XF XOFF character if not \fB\[ha]S\fP .fi -.PP +.P There are several ways of defining the control codes for string capabilities: -.PP +.P Every normal character represents itself, except \[aq]\[ha]\[aq], \[aq]\e\[aq], and \[aq]%\[aq]. -.PP +.P A \fB\[ha]x\fP means Control-x. Control-A equals 1 decimal. -.PP +.P \ex means a special code. x can be one of the following characters: .RS @@ -403,7 +403,7 @@ Do ASCII output of this parameter with a field with of 3 .TP % Print a \[aq]%\[aq] -.PP +.P If you use binary output, then you should avoid the null character (\[aq]\e0\[aq]) because it terminates the string. @@ -413,7 +413,7 @@ if a tabulator can be the binary output of a parameter. Warning: The above metacharacters for parameters may be wrong: they document Minix termcap which may not be compatible with Linux termcap. -.PP +.P The block graphic characters can be specified by three string capabilities: .TP as @@ -426,9 +426,9 @@ ac pairs of characters. The first character is the name of the block graphic symbol and the second characters is its definition. -.PP +.P The following names are available: -.PP +.P .nf + right arrow (>) , left arrow (<) @@ -456,7 +456,7 @@ w normal tee (+) x vertical line (|) \[ti] paragraph (???) .fi -.PP +.P The values in parentheses are suggested defaults which are used by the .I curses library, if the capabilities are missing. diff --git a/upstream/opensuse-tumbleweed/man5/terminfo.5 b/upstream/opensuse-tumbleweed/man5/terminfo.5 index 4f15239e..5a79fe44 100644 --- a/upstream/opensuse-tumbleweed/man5/terminfo.5 +++ b/upstream/opensuse-tumbleweed/man5/terminfo.5 @@ -33,8 +33,8 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: terminfo.head,v 1.63 2024/01/13 23:07:27 tom Exp $ -.TH terminfo 5 2024-01-13 "ncurses 6.4" "File formats" +.\" $Id: terminfo.head,v 1.65 2024/04/20 21:14:00 tom Exp $ +.TH terminfo 5 2024-04-20 "ncurses 6.5" "File formats" .ie \n(.g \{\ .ds `` \(lq .ds '' \(rq @@ -81,8 +81,10 @@ describes terminals by giving a set of capabilities which they have, by specifying how to perform screen operations, and by specifying padding requirements and initialization sequences. .PP -This manual describes \fI\%ncurses\fP -version 6.4 (patch 20240224). +This document describes +.I \%ncurses +version 6.5 +(patch 20240504). .SS "\fIterminfo\fP Entry Syntax" Entries in .I terminfo @@ -229,53 +231,72 @@ using terminal entry. .SS "Predefined Capabilities" .\" Head of terminfo man page ends here .ps -1 -The following is a complete table of the capabilities included in a -terminfo description block and available to terminfo-using code. -In each line of the table, +Tables of capabilities +.I \%ncurses +recognizes in a +.I \%term\%info +terminal type description and available to +.IR \%term\%info -using +code follow. .bP -The \fBvariable\fR is the name by which the programmer (at the terminfo level) -accesses the capability. +The capability name identifies the symbol by which the programmer +using the +.I \%term\%info +API accesses the capability. .bP -The \fBcapname\fR (\fICap-name\fP) -is the short name used in the text of the database, -and is used by a person updating the database. +The TI +.RI ( \%term\%info ) +code is the short name used by a person composing or updating a +terminal type entry. .IP -Whenever possible, capnames are chosen to be the same as or similar to -the ANSI X3.64-1979 standard (now superseded by ECMA-48, which uses -identical or very similar names). +Whenever possible, +these codes are the same as or similar to those of the ANSI X3.64-1979 +standard +(now superseded by ECMA-48, +which uses identical or very similar names). Semantics are also intended to match those of the specification. .IP -Capability names have no hard length limit, but an informal limit of 5 -characters has been adopted to keep them short and to allow the tabs in -the source file -.B Caps +.I \%term\%info +codes have no hard length limit, +but +.I \%ncurses +maintains an informal one of 5 characters to keep them short and to +allow the tabs in the source file +.I Caps to line up nicely. +(Some standard codes exceed this limit regardless.) .bP -The \fBtermcap\fP (\fITcap\fP) code is the old capability name -(some capabilities are new, and have names which termcap did not originate). +The TC +.RI ( termcap ) +code is that used by the corresponding API of +.IR \%ncurses . +(Some capabilities are new, +and have names that BSD +.I termcap +did not originate.) .bP -Finally, the \fBdescription\fP field attempts to convey the semantics of the -capability. +The description field attempts to convey the capability's semantics. .PP -You may find some codes in the description field: +The description field employs a handful of notations. .TP -(P) -indicates that padding may be specified +.B (P) +indicates that padding may be specified. .TP -#[1-9] -in the description field indicates that the string is passed -through \fB\%tparm\fP(3NCURSES) with parameters as given (#\fIi\fP). -.IP -If no parameters are listed in the description, -passing the string through \fB\%tparm\fP(3NCURSES) may give unexpected results, -e.g., if it contains percent (%%) signs. -.TP -(P*) -indicates that padding may vary in proportion to the number of -lines affected +.B (P*) +indicates that padding may vary in proportion to the number of output +lines affected. .TP -(#\d\fIi\fP\u) -indicates the \fIi\fP\uth\d parameter. +.BI # i +indicates the +.IR i th +parameter of a string capability; +the programmer should pass the string to \fB\%tparm\fP(3NCURSES) with the +parameters listed. +.IP +If the description lists no parameters, +passing the string to \fB\%tparm\fP(3NCURSES) may produce unexpected +behavior, +for instance if the string contains percent signs. . .PP .TS @@ -852,6 +873,10 @@ key_down kcud1 kd T{ .ad l down-arrow key T} +.TE +.TS +center; +Lbw(25n)2 Lbw(8n)2 Lb2 Lx. key_eic krmir kM T{ .ad l sent by rmir or smir in insert mode @@ -1100,6 +1125,10 @@ reset_2string rs2 r2 T{ .ad l reset string T} +.TE +.TS +center; +Lbw(25n)2 Lbw(8n)2 Lb2 Lx. reset_3string rs3 r3 T{ .ad l reset string @@ -1348,6 +1377,10 @@ key_undo kund &8 T{ .ad l undo key T} +.TE +.TS +center; +Lbw(25n)2 Lbw(8n)2 Lb2 Lx. key_sbeg kBEG &9 T{ .ad l shifted begin key @@ -1596,6 +1629,10 @@ key_f42 kf42 FW T{ .ad l F42 function key T} +.TE +.TS +center; +Lbw(25n)2 Lbw(8n)2 Lb2 Lx. key_f43 kf43 FX T{ .ad l F43 function key @@ -1690,7 +1727,7 @@ clear right and left soft margins T} set_left_margin smgl ML T{ .ad l -set left soft margin at current column. (ML is not in BSD termcap). +set left soft margin at current column (not in BSD \fItermcap\fP) T} set_right_margin smgr MR T{ .ad l @@ -1844,6 +1881,10 @@ enter_doublewide_mode swidm ZF T{ .ad l Enter double-wide mode T} +.TE +.TS +center; +Lbw(25n)2 Lbw(8n)2 Lb2 Lx. enter_draft_quality sdrfq ZG T{ .ad l Enter draft-quality mode @@ -2246,7 +2287,7 @@ T} .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: terminfo.tail,v 1.143 2024/01/13 22:05:39 tom Exp $ +.\" $Id: terminfo.tail,v 1.148 2024/04/20 21:24:19 tom Exp $ .ps +1 .SS "User-Defined Capabilities" . @@ -3111,7 +3152,7 @@ and do \fBri\fP followed by \fBdl1\fP or \fBind\fP. If the data scrolled off the bottom of the region by the \fBri\fP re-appears, then scrolling is non-destructive. -System V and XSI Curses expect that \fBind\fP, \fBri\fP, +System V and X/Open Curses expect that \fBind\fP, \fBri\fP, \fBindn\fP, and \fBrin\fP will simulate destructive scrolling; their documentation cautions you not to define \fBcsr\fP unless this is true. This \fBcurses\fP implementation is more liberal and will do explicit erases @@ -3133,7 +3174,7 @@ or that scrolling back with \fBri\fP may bring down non-blank lines. .SS "Insert/Delete Character" There are two basic kinds of intelligent terminals with respect to insert/delete character which can be described using -.I terminfo. +.IR terminfo . The most common insert/delete character operations affect only the characters on the current line and shift characters off the end of the line rigidly. Other terminals, such as the Concept 100 and the Perkin Elmer Owl, make @@ -3227,7 +3268,7 @@ to delete a single character, with one parameter, .IR n , to delete -.I n characters, +.IR n "characters," and delete mode by giving \fBsmdc\fP and \fBrmdc\fP to enter and exit delete mode (any mode the terminal needs to be placed in for @@ -3914,6 +3955,8 @@ magenta COLOR_MAGENTA 5 max, 0, max cyan COLOR_CYAN 6 0, max, max white COLOR_WHITE 7 max, max, max .TE +.br +.if t .ne 6v .PP The argument values of \fBsetf\fP/\fBsetb\fP historically correspond to a different mapping, i.e., @@ -4262,7 +4305,7 @@ See the \fBInsert/Delete Character\fP subsection above. .PP The parameter substitutions for \fBset_clock\fP and \fBdisplay_clock\fP are -not documented in SVr4 or the XSI Curses standard. +not documented in SVr4 or X/Open Curses. They are deduced from the documentation for the AT&T 505 terminal. .PP @@ -4281,7 +4324,7 @@ If italics should work with colors, then the \fBncv\fP value must be specified, even if it is zero. .PP Different commercial ports of \fI\%terminfo\fP and \fIcurses\fP support -different subsets of XSI Curses and +different subsets of X/Open Curses and (in some cases) different extensions. Here is a summary, @@ -4327,7 +4370,7 @@ At least two implementations of \fI\%terminfo\fP diverged from those of other System V Unices after SVr1, adding extension capabilities to the string table that (in the binary format) -collide with subsequent System V and XSI Curses extensions. +collide with subsequent System V and X/Open Curses extensions. .SH AUTHORS Zeyd M. Ben-Halim, Eric S. Raymond, Thomas E. Dickey. Based on \fIpcurses\fP by Pavel Curtis. diff --git a/upstream/opensuse-tumbleweed/man5/tmpfiles.d.5 b/upstream/opensuse-tumbleweed/man5/tmpfiles.d.5 index 89b488b0..9c32f27f 100644 --- a/upstream/opensuse-tumbleweed/man5/tmpfiles.d.5 +++ b/upstream/opensuse-tumbleweed/man5/tmpfiles.d.5 @@ -1,5 +1,5 @@ '\" t -.TH "TMPFILES\&.D" "5" "" "systemd 254" "tmpfiles.d" +.TH "TMPFILES\&.D" "5" "" "systemd 255" "tmpfiles.d" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -210,6 +210,8 @@ is run\&. .sp For this entry to be useful, at least one of the mode, user, group, or age arguments must be specified, since otherwise this entry has no effect\&. As an exception, an entry with no effect may be useful when combined with \fI!\fR, see the examples\&. +.sp +Added in version 230\&. .RE .PP \fIv\fR @@ -223,6 +225,8 @@ A subvolume created with this line type is not assigned to any higher\-level quo \fIq\fR or \fIQ\fR, which allow creating simple quota group hierarchies, see below\&. +.sp +Added in version 219\&. .RE .PP \fIq\fR @@ -236,6 +240,8 @@ If the subvolume already exists, no change to the quota hierarchy is made, regar below\&. See \fBbtrfs-qgroup\fR(8) for details about the btrfs quota group concept\&. +.sp +Added in version 228\&. .RE .PP \fIQ\fR @@ -274,6 +280,8 @@ As with \fIq\fR, \fIQ\fR has no effect on the quota group hierarchy if the subvolume already exists, regardless of whether the subvolume already belong to a quota group or not\&. +.sp +Added in version 228\&. .RE .PP \fIp\fR, \fIp+\fR @@ -312,6 +320,8 @@ Recursively copy a file or directory, if the destination files or directories do \fI+\fR\&. Instead, the entire copy operation is skipped\&. If the argument is omitted, files from the source directory /usr/share/factory/ with the same name are copied\&. Does not follow symlinks\&. Contents of the directories are subject to time\-based cleanup if the age argument is specified\&. +.sp +Added in version 214\&. .RE .PP \fIx\fR @@ -331,6 +341,8 @@ Ignore a path during cleaning\&. Use this type to exclude paths from clean\-up a or \fIR\fR lines\&. Lines of this type accept shell\-style globs in place of normal path names\&. +.sp +Added in version 198\&. .RE .PP \fIr\fR @@ -364,12 +376,16 @@ for details\&. The argument field should take one or more assignment expressions .sp Please note that extended attributes settable with this line type are a different concept from the Linux file attributes settable with \fIh\fR/\fIH\fR, see below\&. +.sp +Added in version 218\&. .RE .PP \fIT\fR .RS 4 Same as \fIt\fR, but operates recursively\&. +.sp +Added in version 219\&. .RE .PP \fIh\fR @@ -403,6 +419,8 @@ Please note that the Linux file attributes settable with this line type are a di .RS 4 Sames as \fIh\fR, but operates recursively\&. +.sp +Added in version 220\&. .RE .PP \fIa\fR, \fIa+\fR @@ -413,6 +431,8 @@ Set POSIX ACLs (access control lists), see \fI+\fR, the specified entries will be added to the existing set\&. \fBsystemd-tmpfiles\fR(8) will automatically add the required base entries for user and group based on the access mode of the file, unless base entries already exist or are explicitly specified\&. The mask will be added if not specified explicitly or already present\&. Lines of this type accept shell\-style globs in place of normal path names\&. This can be useful for allowing additional access to certain files\&. Does not follow symlinks\&. +.sp +Added in version 219\&. .RE .PP \fIA\fR, \fIA+\fR @@ -421,6 +441,8 @@ Same as \fIa\fR and \fIa+\fR, but recursive\&. Does not follow symlinks\&. +.sp +Added in version 219\&. .RE .SS "Type Modifiers" .PP @@ -984,7 +1006,9 @@ will be removed on boot\&. The directory will not be created\&. .RE .\} .PP -By passing this line to QEMU, the public key of the current user will be encoded in base64, added to a tmpfiles\&.d line that tells systemd\-tmpfiles to decode it into +By passing this line to QEMU, the public key of the current user will be encoded in base64, added to a tmpfiles\&.d line that tells +\fBsystemd\-tmpfiles\fR +to decode it into /root/\&.ssh/authorized_keys, encode that line itself in base64 and pass it as a Credential that will be picked up by systemd from SMBIOS on boot\&. .SH "/RUN/ AND /VAR/RUN/" .PP diff --git a/upstream/opensuse-tumbleweed/man5/tmpfs.5 b/upstream/opensuse-tumbleweed/man5/tmpfs.5 index 8e4d063a..51ea8f80 100644 --- a/upstream/opensuse-tumbleweed/man5/tmpfs.5 +++ b/upstream/opensuse-tumbleweed/man5/tmpfs.5 @@ -2,7 +2,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH tmpfs 5 2023-07-28 "Linux man-pages 6.05.01" +.TH tmpfs 5 2024-05-02 "Linux man-pages (unreleased)" .SH NAME tmpfs \- a virtual memory filesystem .SH DESCRIPTION @@ -12,18 +12,18 @@ facility allows the creation of filesystems whose contents reside in virtual memory. Since the files on such filesystems typically reside in RAM, file access is extremely fast. -.PP +.P The filesystem is automatically created when mounting a filesystem with the type .B tmpfs via a command such as the following: -.PP +.P .in +4n .EX $ sudo mount \-t tmpfs \-o size=10M tmpfs /mnt/mytmpfs .EE .in -.PP +.P A .B tmpfs filesystem has the following properties: @@ -38,7 +38,7 @@ During a remount operation .RI ( "mount\ \-o\ remount" ), the filesystem size can be changed (without losing the existing contents of the filesystem). -.PP +.P If a .B tmpfs filesystem is unmounted, its contents are discarded (lost). @@ -51,6 +51,8 @@ filesystem supports the following mount options: .BR size "=\fIbytes\fP" Specify an upper limit on the size of the filesystem. The size is given in bytes, and rounded up to entire pages. +The limit is removed if the size is +.BR 0 . .IP The size may have a .BR k , @@ -89,6 +91,8 @@ but not a % suffix. The maximum number of inodes for this instance. The default is half of the number of your physical RAM pages, or (on a machine with highmem) the number of lowmem RAM pages, whichever is smaller. +The limit is removed if the number is +.BR 0 . .IP Inodes may be specified with .BR k , @@ -99,6 +103,12 @@ suffixes like .BR size , but not a % suffix. .TP +.BR noswap "(since Linux 6.4)" +.\" commit 2c6efe9cf2d7841b75fe38ed1adbd41a90f51ba0 +Disables swap. +Remounts must respect the original settings. +By default swap is enabled. +.TP .BR mode "=\fImode\fP" Set initial permissions of the root directory. .TP @@ -208,7 +218,7 @@ In order for user-space tools and applications to create filesystems, the kernel must be configured with the .B CONFIG_TMPFS option. -.PP +.P The .B tmpfs filesystem supports extended attributes (see @@ -216,7 +226,7 @@ filesystem supports extended attributes (see but .I user extended attributes are not permitted. -.PP +.P An internal shared memory filesystem is used for System V shared memory .RB ( shmget (2)) @@ -231,7 +241,7 @@ This filesystem is available regardless of whether the kernel was configured with the .B CONFIG_TMPFS option. -.PP +.P A .B tmpfs filesystem mounted at @@ -240,7 +250,7 @@ is used for the implementation of POSIX shared memory .RB ( shm_overview (7)) and POSIX semaphores .RB ( sem_overview (7)). -.PP +.P The amount of memory consumed by all .B tmpfs filesystems is shown in the @@ -251,7 +261,7 @@ and in the .I shared field displayed by .BR free (1). -.PP +.P The .B tmpfs facility was formerly called @@ -264,7 +274,7 @@ facility was formerly called .BR set_mempolicy (2), .BR shm_open (3), .BR mount (8) -.PP +.P The kernel source files .I Documentation/filesystems/tmpfs.txt and diff --git a/upstream/opensuse-tumbleweed/man5/ttytype.5 b/upstream/opensuse-tumbleweed/man5/ttytype.5 index 94030e8b..92dcf0f4 100644 --- a/upstream/opensuse-tumbleweed/man5/ttytype.5 +++ b/upstream/opensuse-tumbleweed/man5/ttytype.5 @@ -7,7 +7,7 @@ .\" Modified Thu Oct 19 21:25:21 MET 1995 by Martin Schulze <joey@infodrom.north.de> .\" Modified Mon Oct 21 17:47:19 EDT 1996 by Eric S. Raymond .\" <esr@thyrsus.com>xk -.TH ttytype 5 2023-01-22 "Linux man-pages 6.05.01" +.TH ttytype 5 2024-05-02 "Linux man-pages (unreleased)" .SH NAME ttytype \- terminal device to default terminal type mapping .SH DESCRIPTION @@ -23,14 +23,14 @@ Each line consists of a terminal type, followed by whitespace, followed by a tty name (a device name without the .I /dev/ prefix). -.PP +.P This association is used by the program .BR tset (1) to set the environment variable .B TERM to the default terminal name for the user's current tty. -.PP +.P This facility was designed for a traditional time-sharing environment featuring character-cell terminals hardwired to a UNIX minicomputer. It is little used on modern workstation and personal UNIX systems. @@ -42,7 +42,7 @@ the tty definitions file. A typical .I /etc/ttytype is: -.PP +.P .in +4n .EX con80x25 tty1 diff --git a/upstream/opensuse-tumbleweed/man5/tzfile.5 b/upstream/opensuse-tumbleweed/man5/tzfile.5 index 59d9f6ba..4aa3f6c2 100644 --- a/upstream/opensuse-tumbleweed/man5/tzfile.5 +++ b/upstream/opensuse-tumbleweed/man5/tzfile.5 @@ -26,23 +26,24 @@ a signed binary integer is represented using two's complement, and a boolean is represented by a one-byte binary integer that is either 0 (false) or 1 (true). The format begins with a 44-byte header containing the following fields: -.IP * 2 +.RS 2 +.IP \(bu 3 The magic four-byte ASCII sequence .q "TZif" identifies the file as a timezone information file. -.IP * +.IP \(bu A byte identifying the version of the file's format (as of 2021, either an ASCII NUL, .q "2", .q "3", or .q "4" ). -.IP * +.IP \(bu Fifteen bytes containing zeros reserved for future use. -.IP * +.IP \(bu Six four-byte integer values, in the following order: .RS -.TP +.TP 2 .B tzh_ttisutcnt The number of UT/local indicators stored in the file. (UT is Universal Time.) @@ -65,17 +66,19 @@ in the file (must not be zero). The number of bytes of time zone abbreviation strings stored in the file. .RE +.RE .PP The above header is followed by the following fields, whose lengths depend on the contents of the header: -.IP * 2 +.RS 2 +.IP \(bu 3 .B tzh_timecnt four-byte signed integer values sorted in ascending order. These values are written in network byte order. Each is used as a transition time (as returned by .BR time (2)) at which the rules for computing local time change. -.IP * +.IP \(bu .B tzh_timecnt one-byte unsigned integer values; each one but the last tells which of the different types of local time types @@ -83,22 +86,22 @@ described in the file is associated with the time period starting with the same-indexed transition time and continuing up to but not including the next transition time. (The last time type is present only for consistency checking with the -POSIX-style TZ string described below.) +POSIX.1-2017-style TZ string described below.) These values serve as indices into the next field. -.IP * +.IP \(bu .B tzh_typecnt .B ttinfo entries, each defined as follows: -.in +.5i +.in +2 .sp .nf -.ta .5i +\w'unsigned char\0\0'u +.ta \w'\0\0\0\0'u +\w'unsigned char\0'u struct ttinfo { int32_t tt_utoff; unsigned char tt_isdst; unsigned char tt_desigidx; }; -.in -.5i +.in .fi .sp Each structure is written as a four-byte signed integer value for @@ -132,7 +135,7 @@ Also, in realistic applications is in the range [\-89999, 93599] (i.e., more than \-25 hours and less than 26 hours); this allows easy support by implementations that already support the POSIX-required range [\-24:59:59, 25:59:59]. -.IP * +.IP \(bu .B tzh_charcnt bytes that represent time zone designations, which are null-terminated byte strings, each indexed by the @@ -140,7 +143,7 @@ which are null-terminated byte strings, each indexed by the values mentioned above. The byte strings can overlap if one is a suffix of the other. The encoding of these strings is not specified. -.IP * +.IP \(bu .B tzh_leapcnt pairs of four-byte values, written in network byte order; the first value of each pair gives the nonnegative time @@ -167,22 +170,24 @@ otherwise, for timestamps before the first occurrence time, the leap-second correction is zero if the first pair's correction is 1 or \-1, and is unspecified otherwise (which can happen only in files truncated at the start). -.IP * +.IP \(bu .B tzh_ttisstdcnt standard/wall indicators, each stored as a one-byte boolean; they tell whether the transition times associated with local time types were specified as standard time or local (wall clock) time. -.IP * +.IP \(bu .B tzh_ttisutcnt UT/local indicators, each stored as a one-byte boolean; they tell whether the transition times associated with local time types were specified as UT or local time. If a UT/local indicator is set, the corresponding standard/wall indicator must also be set. +.RE .PP The standard/wall and UT/local indicators were designed for transforming a TZif file's transition times into transitions appropriate -for another time zone specified via a POSIX-style TZ string that lacks rules. +for another time zone specified via +a POSIX.1-2017-style TZ string that lacks rules. For example, when TZ="EET\*-2EEST" and there is no TZif file "EET\*-2EEST", the idea was to adapt the transition times from a TZif file with the well-known name "posixrules" that is present only for this purpose and @@ -211,13 +216,14 @@ the above header and data are followed by a second header and data, identical in format except that eight bytes are used for each transition time or leap second time. (Leap second counts remain four bytes.) -After the second header and data comes a newline-enclosed, -POSIX-TZ-environment-variable-style string for use in handling instants +After the second header and data comes a newline-enclosed string +in the style of the contents of a POSIX.1-2017 TZ environment variable, +for use in handling instants after the last transition time stored in the file or for all instants if the file has no transitions. -The POSIX-style TZ string is empty (i.e., nothing between the newlines) -if there is no POSIX-style representation for such instants. -If nonempty, the POSIX-style TZ string must agree with the local time +The TZ string is empty (i.e., nothing between the newlines) +if there is no POSIX.1-2017-style representation for such instants. +If nonempty, the TZ string must agree with the local time type after the last transition time if present in the eight-byte data; for example, given the string .q "WET0WEST,M3.5.0/1,M10.5.0" @@ -229,8 +235,8 @@ Also, if there is at least one transition, time type 0 is associated with the time period from the indefinite past up to but not including the earliest transition time. .SS Version 3 format -For version-3-format timezone files, the POSIX-TZ-style string may -use two minor extensions to the POSIX TZ format, as described in +For version-3-format timezone files, the TZ string may +use two minor extensions to the POSIX.1-2017 TZ format, as described in .BR newtzset (3). First, the hours part of its transition times may be signed and range from \-167 through 167 instead of the POSIX-required unsigned values @@ -312,15 +318,17 @@ This section documents common problems in reading or writing TZif files. Most of these are problems in generating TZif files for use by older readers. The goals of this section are: -.IP * 2 +.RS 2 +.IP \(bu 3 to help TZif writers output files that avoid common pitfalls in older or buggy TZif readers, -.IP * +.IP \(bu to help TZif readers avoid common pitfalls when reading files generated by future TZif writers, and -.IP * +.IP \(bu to help any future specification authors see what sort of problems arise when the TZif format is changed. +.RE .PP When new versions of the TZif format have been defined, a design goal has been that a reader can successfully use a TZif @@ -335,21 +343,22 @@ workarounds, as well as to document other common bugs in readers. .PP Interoperability problems with TZif include the following: -.IP * 2 +.RS 2 +.IP \(bu 3 Some readers examine only version 1 data. As a partial workaround, a writer can output as much version 1 data as possible. However, a reader should ignore version 1 data, and should use version 2+ data even if the reader's native timestamps have only 32 bits. -.IP * +.IP \(bu Some readers designed for version 2 might mishandle timestamps after a version 3 or higher file's last transition, because -they cannot parse extensions to POSIX in the TZ-like string. +they cannot parse extensions to POSIX.1-2017 in the TZ-like string. As a partial workaround, a writer can output more transitions than necessary, so that only far-future timestamps are mishandled by version 2 readers. -.IP * +.IP \(bu Some readers designed for version 2 do not support permanent daylight saving time with transitions after 24:00 \(en e.g., a TZ string @@ -367,22 +376,22 @@ for the next time zone east \(en e.g., .q "AST4" for permanent Atlantic Standard Time (\-04). -.IP * +.IP \(bu Some readers designed for version 2 or 3, and that require strict conformance to RFC 8536, reject version 4 files whose leap second tables are truncated at the start or that end in expiration times. -.IP * +.IP \(bu Some readers ignore the footer, and instead predict future timestamps from the time type of the last transition. As a partial workaround, a writer can output more transitions than necessary. -.IP * +.IP \(bu Some readers do not use time type 0 for timestamps before the first transition, in that they infer a time type using a heuristic that does not always select time type 0. As a partial workaround, a writer can output a dummy (no-op) first transition at an early time. -.IP * +.IP \(bu Some readers mishandle timestamps before the first transition that has a timestamp not less than \-2**31. Readers that support only 32-bit timestamps are likely to be @@ -391,12 +400,12 @@ more prone to this problem, for example, when they process bits. As a partial workaround, a writer can output a dummy transition at timestamp \-2**31. -.IP * +.IP \(bu Some readers mishandle a transition if its timestamp has the minimum possible signed 64-bit value. Timestamps less than \-2**59 are not recommended. -.IP * -Some readers mishandle POSIX-style TZ strings that +.IP \(bu +Some readers mishandle TZ strings that contain .q "<" or @@ -407,11 +416,11 @@ or .q ">" for time zone abbreviations containing only alphabetic characters. -.IP * +.IP \(bu Many readers mishandle time zone abbreviations that contain non-ASCII characters. These characters are not recommended. -.IP * +.IP \(bu Some readers may mishandle time zone abbreviations that contain fewer than 3 or more than 6 characters, or that contain ASCII characters other than alphanumerics, @@ -419,23 +428,23 @@ contain ASCII characters other than alphanumerics, and .q "+". These abbreviations are not recommended. -.IP * +.IP \(bu Some readers mishandle TZif files that specify daylight-saving time UT offsets that are less than the UT offsets for the corresponding standard time. These readers do not support locations like Ireland, which -uses the equivalent of the POSIX TZ string +uses the equivalent of the TZ string .q "IST\*-1GMT0,M10.5.0,M3.5.0/1", observing standard time (IST, +01) in summer and daylight saving time (GMT, +00) in winter. As a partial workaround, a writer can output data for the -equivalent of the POSIX TZ string +equivalent of the TZ string .q "GMT0IST,M3.5.0/1,M10.5.0", thus swapping standard and daylight saving time. Although this workaround misidentifies which part of the year uses daylight saving time, it records UT offsets and time zone abbreviations correctly. -.IP * +.IP \(bu Some readers generate ambiguous timestamps for positive leap seconds that occur when the UTC offset is not a multiple of 60 seconds. For example, in a timezone with UTC offset +01:23:45 and with @@ -446,38 +455,41 @@ instead of mapping the latter to 01:23:46, and they will map 78796815 to This has not yet been a practical problem, since no civil authority has observed such UTC offsets since leap seconds were introduced in 1972. +.RE .PP Some interoperability problems are reader bugs that are listed here mostly as warnings to developers of readers. -.IP * 2 +.RS 2 +.IP \(bu 3 Some readers do not support negative timestamps. Developers of distributed applications should keep this in mind if they need to deal with pre-1970 data. -.IP * +.IP \(bu Some readers mishandle timestamps before the first transition that has a nonnegative timestamp. Readers that do not support negative timestamps are likely to be more prone to this problem. -.IP * +.IP \(bu Some readers mishandle time zone abbreviations like .q "\*-08" that contain .q "+", .q "\*-", or digits. -.IP * +.IP \(bu Some readers mishandle UT offsets that are out of the traditional range of \-12 through +12 hours, and so do not support locations like Kiritimati that are outside this range. -.IP * +.IP \(bu Some readers mishandle UT offsets in the range [\-3599, \-1] seconds from UT, because they integer-divide the offset by 3600 to get 0 and then display the hour part as .q "+00". -.IP * +.IP \(bu Some readers mishandle UT offsets that are not a multiple of one hour, or of 15 minutes, or of 1 minute. +.RE .SH SEE ALSO .BR time (2), .BR localtime (3), diff --git a/upstream/opensuse-tumbleweed/man5/user@.service.5 b/upstream/opensuse-tumbleweed/man5/user@.service.5 index 224dae64..0f068135 100644 --- a/upstream/opensuse-tumbleweed/man5/user@.service.5 +++ b/upstream/opensuse-tumbleweed/man5/user@.service.5 @@ -1,5 +1,5 @@ '\" t -.TH "USER@\&.SERVICE" "5" "" "systemd 254" "user@.service" +.TH "USER@\&.SERVICE" "5" "" "systemd 255" "user@.service" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/upstream/opensuse-tumbleweed/man5/user_caps.5 b/upstream/opensuse-tumbleweed/man5/user_caps.5 index 2c13d635..f68868e7 100644 --- a/upstream/opensuse-tumbleweed/man5/user_caps.5 +++ b/upstream/opensuse-tumbleweed/man5/user_caps.5 @@ -28,8 +28,8 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: user_caps.5,v 1.47 2024/01/13 22:05:39 tom Exp $ -.TH user_caps 5 2024-01-13 "ncurses 6.4" "File formats" +.\" $Id: user_caps.5,v 1.49 2024/03/16 15:35:01 tom Exp $ +.TH user_caps 5 2024-03-16 "ncurses 6.5" "File formats" .ie \n(.g \{\ .ds `` \(lq .ds '' \(rq diff --git a/upstream/opensuse-tumbleweed/man5/utmp.5 b/upstream/opensuse-tumbleweed/man5/utmp.5 index 4a029640..2f3c07e5 100644 --- a/upstream/opensuse-tumbleweed/man5/utmp.5 +++ b/upstream/opensuse-tumbleweed/man5/utmp.5 @@ -8,7 +8,7 @@ .\" Modified 1996-07-20 by Michael Haardt .\" Modified 1997-07-02 by Nicolás Lichtmaier <nick@debian.org> .\" Modified 2004-10-31 by aeb, following Gwenole Beauchesne -.TH utmp 5 2023-05-03 "Linux man-pages 6.05.01" +.TH utmp 5 2024-05-02 "Linux man-pages (unreleased)" .SH NAME utmp, wtmp \- login records .SH SYNOPSIS @@ -22,7 +22,7 @@ file allows one to discover information about who is currently using the system. There may be more users currently using the system, because not all programs use utmp logging. -.PP +.P .B Warning: .I utmp must not be writable by the user class "other", @@ -32,7 +32,7 @@ You risk faked system logfiles and modifications of system files if you leave .I utmp writable to any user other than the owner and group owner of the file. -.PP +.P The file is a sequence of .I utmp structures, @@ -40,7 +40,7 @@ declared as follows in .I <utmp.h> (note that this is only one of several definitions around; details depend on the version of libc): -.PP +.P .in +4n .EX /* Values for ut_type field, below */ @@ -112,7 +112,7 @@ struct utmp { #define ut_addr ut_addr_v6[0] .EE .in -.PP +.P This structure gives the name of the special file associated with the user's terminal, the user's login name, and the time of login in the form of @@ -120,7 +120,7 @@ of String fields are terminated by a null byte (\[aq]\e0\[aq]) if they are shorter than the size of the field. -.PP +.P The first entries ever created result from .BR init (1) processing @@ -137,7 +137,7 @@ with the needed \fIut_id\fP can be found, creates a new one. It sets \fIut_id\fP from the inittab, \fIut_pid\fP and \fIut_time\fP to the current values, and \fIut_type\fP to \fBINIT_PROCESS\fP. -.PP +.P .BR mingetty (8) (or .BR agetty (8)) @@ -156,7 +156,7 @@ and .BR login (1), records may be located by \fIut_line\fP instead of the preferable \fIut_pid\fP. -.PP +.P When .BR init (1) finds that a process has exited, it locates its utmp entry by @@ -171,7 +171,7 @@ and clears and .I ut_time with null bytes. -.PP +.P .BR xterm (1) and other terminal emulators directly create a \fBUSER_PROCESS\fP record and generate the \fIut_id\fP by using the @@ -184,7 +184,7 @@ If they can, they will mark it as \fBDEAD_PROCESS\fP on exiting and it is advised that they null \fIut_line\fP, \fIut_time\fP, \fIut_user\fP, and \fIut_host\fP as well. -.PP +.P .BR telnetd (8) sets up a \fBLOGIN_PROCESS\fP entry and leaves the rest to .BR login (1) @@ -192,7 +192,7 @@ as usual. After the telnet session ends, .BR telnetd (8) cleans up utmp in the described way. -.PP +.P The \fIwtmp\fP file records all logins and logouts. Its format is exactly like \fIutmp\fP except that a null username indicates a logout @@ -237,7 +237,7 @@ POSIX.1 does not specify the lengths of the and .I ut_user fields. -.PP +.P Linux defines the .I utmpx structure to be the same as the @@ -248,14 +248,14 @@ Linux. .SH HISTORY Linux utmp entries conform neither to v7/BSD nor to System V; they are a mix of the two. -.PP +.P v7/BSD has fewer fields; most importantly it lacks \fIut_type\fP, which causes native v7/BSD-like programs to display (for example) dead or login entries. Further, there is no configuration file which allocates slots to sessions. BSD does so because it lacks \fIut_id\fP fields. -.PP +.P In Linux (as in System V), the \fIut_id\fP field of a record will never change once it has been set, which reserves that slot without needing a configuration file. @@ -267,7 +267,7 @@ with null bytes is not required by System V semantics, but makes it possible to run many programs which assume BSD semantics and which do not modify utmp. Linux uses the BSD conventions for line contents, as documented above. -.PP +.P .\" mtk: What is the referrent of "them" in the following sentence? .\" System V only uses the type field to mark them and logs .\" informative messages such as \fB"new time"\fP in the line field. @@ -279,10 +279,10 @@ must always exist on Linux. If you want to disable .BR who (1), then do not make utmp world readable. -.PP +.P The file format is machine-dependent, so it is recommended that it be processed only on the machine architecture where it was created. -.PP +.P Note that on \fIbiarch\fP platforms, that is, systems which can run both 32-bit and 64-bit applications (x86-64, ppc64, s390x, etc.), \fIut_tv\fP is the same size in 32-bit mode as in 64-bit mode. @@ -303,15 +303,15 @@ and .IR tv_usec . Since \fIut_tv\fP may not be the same as \fIstruct timeval\fP, then instead of the call: -.PP +.P .in +4n .EX gettimeofday((struct timeval *) &ut.ut_tv, NULL); .EE .in -.PP +.P the following method of setting this field is recommended: -.PP +.P .in +4n .EX struct utmp ut; @@ -322,7 +322,7 @@ ut.ut_tv.tv_sec = tv.tv_sec; ut.ut_tv.tv_usec = tv.tv_usec; .EE .in -.\" .PP +.\" .P .\" Note that the \fIutmp\fP struct from libc5 has changed in libc6. .\" Because of this, .\" binaries using the old libc5 struct will corrupt |