diff options
| author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-06-17 10:52:03 +0000 |
|---|---|---|
| committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-06-17 10:52:03 +0000 |
| commit | 932e4432596447eb9331cc2a2bb74a26a35b4efc (patch) | |
| tree | 95161711ea07fd64f0c82d6e7943024c033dd5a8 /upstream/debian-unstable/man5 | |
| parent | Adding debian version 4.22.0-1. (diff) | |
| download | manpages-l10n-932e4432596447eb9331cc2a2bb74a26a35b4efc.tar.xz manpages-l10n-932e4432596447eb9331cc2a2bb74a26a35b4efc.zip | |
Merging upstream version 4.23.0.
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'upstream/debian-unstable/man5')
292 files changed, 13718 insertions, 10975 deletions
diff --git a/upstream/debian-unstable/man5/acct.5 b/upstream/debian-unstable/man5/acct.5 index e1d88d4a..b60ce8cc 100644 --- a/upstream/debian-unstable/man5/acct.5 +++ b/upstream/debian-unstable/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 6.8" .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/debian-unstable/man5/anacrontab.5 b/upstream/debian-unstable/man5/anacrontab.5 index f03ede2b..269bdbf9 100644 --- a/upstream/debian-unstable/man5/anacrontab.5 +++ b/upstream/debian-unstable/man5/anacrontab.5 @@ -28,11 +28,13 @@ The .I command can be any shell command.\& The fields can be separated by blank spaces or tabs.\& -The .I period_name -can only be set to monthly at the present time.\& +can be set to +.B monthly +or +.BR yearly .\& This will ensure jobs are only run once a month, no matter the number of days -in this month, or the previous month.\& +in this month, or the previous month; or analogously for the year.\& .PP Environment assignment lines are of the form: .PP diff --git a/upstream/debian-unstable/man5/autolog.conf.5 b/upstream/debian-unstable/man5/autolog.conf.5 index 75da4a7c..7c07ee9e 100644 --- a/upstream/debian-unstable/man5/autolog.conf.5 +++ b/upstream/debian-unstable/man5/autolog.conf.5 @@ -106,9 +106,9 @@ with usernames and process-ids (pid). e.g.: ps=ps aux Kyle Bateman <kyle@actarg.com> (autolog 0.35), .PD 0 .TP -James Dingwall <james.dingwall@zynstra.com> +James Dingwall <james.dingwall@ncrvoyix.com> .TP - (autolog 0.41) + (autolog 0.42.1) .PD .PP This manual page was modified for \fBDebian\fP by Paul Telford <pxt@debian.org> diff --git a/upstream/debian-unstable/man5/binfmt.d.5 b/upstream/debian-unstable/man5/binfmt.d.5 index f03a5a39..b52230ef 100644 --- a/upstream/debian-unstable/man5/binfmt.d.5 +++ b/upstream/debian-unstable/man5/binfmt.d.5 @@ -1,5 +1,5 @@ '\" t -.TH "BINFMT\&.D" "5" "" "systemd 255" "binfmt.d" +.TH "BINFMT\&.D" "5" "" "systemd 256~rc3" "binfmt.d" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -23,11 +23,15 @@ binfmt.d \- Configure additional binary formats for executables at boot .SH "SYNOPSIS" .PP +.RS 4 /etc/binfmt\&.d/*\&.conf -.PP +.RE +.RS 4 /run/binfmt\&.d/*\&.conf -.PP +.RE +.RS 4 /usr/lib/binfmt\&.d/*\&.conf +.RE .SH "DESCRIPTION" .PP At boot, @@ -70,7 +74,12 @@ Packages should install their configuration files in /usr/local/lib/ (local installs)\&. Files in /etc/ -are reserved for the local administrator, who may use this logic to override the configuration files installed by vendor packages\&. It is recommended to prefix all filenames with a two\-digit number and a dash, to simplify the ordering of the files\&. +are reserved for the local administrator, who may use this logic to override the configuration files installed by vendor packages\&. It is recommended to prefix all filenames with a two\-digit number and a dash, to simplify the ordering of the files\&. It is recommended to use the range 10\-40 for configuration files in +/usr/ +and the range 60\-90 for configuration files in +/etc/ +and +/run/, to make sure that local and transient configuration files will always take priority over configuration files shipped by the OS vendor\&. .PP If the administrator wants to disable a configuration file supplied by the vendor, the recommended way is to place a symlink to /dev/null @@ -92,10 +101,7 @@ in the configuration directory in .\} .SH "SEE ALSO" .PP -\fBsystemd\fR(1), -\fBsystemd-binfmt.service\fR(8), -\fBsystemd-delta\fR(1), -\fBwine\fR(8) +\fBsystemd\fR(1), \fBsystemd-binfmt.service\fR(8), \fBsystemd-delta\fR(1), \fBwine\fR(8) .SH "NOTES" .IP " 1." 4 Kernel Support for miscellaneous Binary Formats (binfmt_misc) diff --git a/upstream/debian-unstable/man5/btrfs.5 b/upstream/debian-unstable/man5/btrfs.5 index 28511197..bb1cfe77 100644 --- a/upstream/debian-unstable/man5/btrfs.5 +++ b/upstream/debian-unstable/man5/btrfs.5 @@ -28,7 +28,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 28, 2024" "6.6.3" "BTRFS" +.TH "BTRFS" "5" "Mar 24, 2024" "6.6.3" "BTRFS" .SH NAME btrfs \- topics about the BTRFS filesystem (mount options, supported file attributes and other) .SH DESCRIPTION diff --git a/upstream/debian-unstable/man5/capsule@.service.5 b/upstream/debian-unstable/man5/capsule@.service.5 new file mode 100644 index 00000000..b18401aa --- /dev/null +++ b/upstream/debian-unstable/man5/capsule@.service.5 @@ -0,0 +1,180 @@ +'\" t +.TH "CAPSULE@\&.SERVICE" "5" "" "systemd 256~rc3" "capsule@.service" +.\" ----------------------------------------------------------------- +.\" * 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" +capsule@.service \- System unit for the capsule service manager +.SH "SYNOPSIS" +.PP +capsule@\fINAME\fR\&.service +.SH "DESCRIPTION" +.PP +Service managers for capsules run in +capsule@\fINAME\fR\&.service +system units, with the capsule name as the instance identifier\&. Capsules are way to run additional instances of the service manager, under dynamic user IDs, i\&.e\&. UIDs that are allocated when the capsule service manager is started, and released when it is stopped\&. +.PP +In many ways +capsule@\&.service +is similar to the per\-user +user@\&.service +service manager, but there are a few important distinctions: +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +The capsule service manager utilizes +\fIDynamicUser=\fR +(see +\fBsystemd.exec\fR(5)) to allocate a new UID dynamically on invocation\&. The user name is automatically generated from the capsule name, by prefixng +"p_"\&. The UID is released when the service is terminated\&. The user service manager on the other hand operates under a statically allocated user ID that must be pre\-existing, before the user service manager is invoked\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +User service managers register themselves with +\fBpam\fR(8), capsule service managers do not\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +User service managers typically read their configuration from a +\fI$HOME\fR +directory below +/home/, capsule service managers from a +\fI$HOME\fR +directory below +/var/lib/capsules/\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +User service managers are collectively contained in the +user\&.slice +unit, capsule service managers in +capsule\&.slice\&. Also see +\fBsystemd.special\fR(7)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +User service managers start the user unit +default\&.target +initially\&. Capsule service managers invoke the user unit +capsule@\&.target +instead\&. +.RE +.PP +The capsule service manager and the capsule\*(Aqs bus broker can be reached via the +\fB\-\-capsule=\fR +switch to +\fBsystemctl\fR(1), +\fBsystemd-run\fR(1) +and +\fBbusctl\fR(1)\&. +.PP +New capsules can be started via a simple +\fBsystemctl start capsule@\fR\fB\fINAME\fR\fR\fB\&.service\fR +command, and stopped via +\fBsystemctl stop capsule@\fR\fB\fINAME\fR\fR\fB\&.service\fR\&. Starting a capsule will implicitly create a home directory +/var/lib/capsules/\fINAME\fR/, if missing\&. A runtime directory is created as +/run/capsules/\fINAME\fR/\&. To remove these resources use +\fBsystemctl clean capsule@\fR\fB\fINAME\fR\fR\fB\&.service\fR, for example with the +\fB\-\-what=all\fR +switch\&. +.PP +The +capsule@\&.service +unit invokes a +\fBsystemd \-\-user\fR +service manager process\&. This means unit files are looked for according to the sames rules as for regular user service managers, for example in +/var/lib/capsules/\fINAME\fR/\&.config/systemd/user/\&. +.PP +Capsule names may be chosen freely by the user, however, they must be suitable as UNIX filenames (i\&.e\&. 255 characters max, and contain no +"/"), and when prefixed with +"p\-" +be suitable as a user name matching strict POSIX rules, see +\m[blue]\fBUser/Group Name Syntax\fR\m[]\&\s-2\u[1]\d\s+2 +for details\&. +.SH "EXAMPLES" +.PP +\fBExample\ \&1.\ \&Create a new capsule, invoke two programs in it (one interactively), terminate it, and clean everything up\fR +.sp +.if n \{\ +.RS 4 +.\} +.nf +# systemctl start capsule@tatze\&.service +# systemd\-run \-\-capsule=tatze \-\-unit=sleeptest\&.service sleep 999 +# systemctl \-\-capsule=tatze status sleeptest\&.service +# systemd\-run \-t \-\-capsule=tatze bash +# systemctl \-\-capsule=tatze stop sleeptest\&.service +# systemctl stop capsule@tatze\&.service +# systemctl clean \-\-all capsule@tatze\&.service +.fi +.if n \{\ +.RE +.\} +.SH "SEE ALSO" +.PP +\fBsystemd\fR(1), +\fBuser@.service\fR(5), +\fBsystemd.service\fR(5), +\fBsystemd.slice\fR(5), +\fBsystemd.exec\fR(5), +\fBsystemd.special\fR(7), +\fBsystemctl\fR(1), +\fBsystemd-run\fR(1), +\fBbusctl\fR(1), +\fBpam\fR(8) +.SH "NOTES" +.IP " 1." 4 +User/Group Name Syntax +.RS 4 +\%https://systemd.io/USER_NAMES +.RE diff --git a/upstream/debian-unstable/man5/charmap.5 b/upstream/debian-unstable/man5/charmap.5 index 280ba4e5..82b61e3f 100644 --- a/upstream/debian-unstable/man5/charmap.5 +++ b/upstream/debian-unstable/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 6.8" .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/debian-unstable/man5/config.5ssl b/upstream/debian-unstable/man5/config.5ssl index c9d3cb55..a6faed83 100644 --- a/upstream/debian-unstable/man5/config.5ssl +++ b/upstream/debian-unstable/man5/config.5ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "CONFIG 5SSL" -.TH CONFIG 5SSL 2024-02-03 3.1.5 OpenSSL +.TH CONFIG 5SSL 2024-04-04 3.2.2-dev OpenSSL .\" 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/debian-unstable/man5/core.5 b/upstream/debian-unstable/man5/core.5 index c19846ee..943fa4c7 100644 --- a/upstream/debian-unstable/man5/core.5 +++ b/upstream/debian-unstable/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 6.8" .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/debian-unstable/man5/coredump.conf.5 b/upstream/debian-unstable/man5/coredump.conf.5 index 10f56339..ba037f56 100644 --- a/upstream/debian-unstable/man5/coredump.conf.5 +++ b/upstream/debian-unstable/man5/coredump.conf.5 @@ -1,5 +1,5 @@ '\" t -.TH "COREDUMP\&.CONF" "5" "" "systemd 255" "coredump.conf" +.TH "COREDUMP\&.CONF" "5" "" "systemd 256~rc3" "coredump.conf" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -23,13 +23,24 @@ coredump.conf, coredump.conf.d \- Core dump storage configuration files .SH "SYNOPSIS" .PP +.RS 4 /etc/systemd/coredump\&.conf -.PP +.RE +.RS 4 +/run/systemd/coredump\&.conf +.RE +.RS 4 +/usr/lib/systemd/coredump\&.conf +.RE +.RS 4 /etc/systemd/coredump\&.conf\&.d/*\&.conf -.PP +.RE +.RS 4 /run/systemd/coredump\&.conf\&.d/*\&.conf -.PP +.RE +.RS 4 /usr/lib/systemd/coredump\&.conf\&.d/*\&.conf +.RE .SH "DESCRIPTION" .PP These files configure the behavior of @@ -45,16 +56,16 @@ and pages for the details\&. .SH "CONFIGURATION DIRECTORIES AND PRECEDENCE" .PP -The default configuration is set during compilation, so configuration is only needed when it is necessary to deviate from those defaults\&. The main configuration file is either in -/usr/lib/systemd/ -or -/etc/systemd/ -and contains commented out entries showing the defaults as a guide to the administrator\&. Local overrides can be created by creating drop\-ins, as described below\&. The main configuration file can also be edited for this purpose (or a copy in +The default configuration is set during compilation, so configuration is only needed when it is necessary to deviate from those defaults\&. The main configuration file is loaded from one of the listed directories in order of priority, only the first file found is used: +/etc/systemd/, +/run/systemd/, +/usr/local/lib/systemd/, +/usr/lib/systemd/\&. The vendor version of the file contains commented out entries showing the defaults as a guide to the administrator\&. Local overrides can also be created by creating drop\-ins, as described below\&. The main configuration file can also be edited for this purpose (or a copy in /etc/ -if it\*(Aqs shipped in -/usr/) however using drop\-ins for local configuration is recommended over modifications to the main configuration file\&. +if it\*(Aqs shipped under +/usr/), however using drop\-ins for local configuration is recommended over modifications to the main configuration file\&. .PP -In addition to the "main" configuration file, drop\-in configuration snippets are read from +In addition to the main configuration file, drop\-in configuration snippets are read from /usr/lib/systemd/*\&.conf\&.d/, /usr/local/lib/systemd/*\&.conf\&.d/, and /etc/systemd/*\&.conf\&.d/\&. Those drop\-ins have higher precedence and override the main configuration file\&. Files in the @@ -64,7 +75,12 @@ configuration subdirectories are sorted by their filename in lexicographic order When packages need to customize the configuration, they can install drop\-ins under /usr/\&. Files in /etc/ -are reserved for the local administrator, who may use this logic to override the configuration files installed by vendor packages\&. Drop\-ins have to be used to override package drop\-ins, since the main configuration file has lower precedence\&. It is recommended to prefix all filenames in those subdirectories with a two\-digit number and a dash, to simplify the ordering of the files\&. This also defined a concept of drop\-in priority to allow distributions to ship drop\-ins within a specific range lower than the range used by users\&. This should lower the risk of package drop\-ins overriding accidentally drop\-ins defined by users\&. +are reserved for the local administrator, who may use this logic to override the configuration files installed by vendor packages\&. Drop\-ins have to be used to override package drop\-ins, since the main configuration file has lower precedence\&. It is recommended to prefix all filenames in those subdirectories with a two\-digit number and a dash, to simplify the ordering of the files\&. This also defines a concept of drop\-in priorities to allow OS vendors to ship drop\-ins within a specific range lower than the range used by users\&. This should lower the risk of package drop\-ins overriding accidentally drop\-ins defined by users\&. It is recommended to use the range 10\-40 for drop\-ins in +/usr/ +and the range 60\-90 for drop\-ins in +/etc/ +and +/run/, to make sure that local and transient drop\-ins take priority over drop\-ins shipped by the OS vendor\&. .PP To disable a configuration file supplied by the vendor, the recommended way is to place a symlink to /dev/null @@ -152,6 +168,4 @@ The defaults for all values are listed as comments in the template file that is installed by default\&. .SH "SEE ALSO" .PP -\fBsystemd-journald.service\fR(8), -\fBcoredumpctl\fR(1), -\fBsystemd-tmpfiles\fR(8) +\fBsystemd-journald.service\fR(8), \fBcoredumpctl\fR(1), \fBsystemd-tmpfiles\fR(8) diff --git a/upstream/debian-unstable/man5/crontab.5 b/upstream/debian-unstable/man5/crontab.5 index b3f3d158..9f9a9618 100644 --- a/upstream/debian-unstable/man5/crontab.5 +++ b/upstream/debian-unstable/man5/crontab.5 @@ -1,407 +1,543 @@ -.\"/* Copyright 1988,1990,1993,1994 by Paul Vixie -.\" * All rights reserved -.\" * -.\" * Distribute freely, except: don't remove my name from the source or -.\" * documentation (don't take credit for my work), mark your changes (don't -.\" * get me blamed for your possible bugs), don't alter or remove this -.\" * notice. May be sold if buildable source is provided to buyer. No -.\" * warrantee of any kind, express or implied, is included with this -.\" * software; use at your own risk, responsibility for damages (if any) to -.\" * anyone resulting from the use of this software rests entirely with the -.\" * user. -.\" * -.\" * Send bug reports, bug fixes, enhancements, requests, flames, etc., and -.\" * I'll try to keep a version up to date. I can be reached as follows: -.\" * Paul Vixie <paul@vix.com> uunet!decwrl!vixie!paul -.\" */ +'\" t +.\" Title: Crontab +.\" Author: Paul Vixie <paul@vix.com> +.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> +.\" Date: 03/26/2024 +.\" Manual: crontab User Manual +.\" Source: crontab +.\" Language: English .\" -.\" $Id: crontab.5,v 2.4 1994/01/15 20:43:43 vixie Exp $ -.\" -.TH CRONTAB 5 "19 April 2010" -.UC 4 -.SH NAME +.TH "CRONTAB" "5" "03/26/2024" "crontab" "crontab User Manual" +.\" ----------------------------------------------------------------- +.\" * 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" crontab \- tables for driving cron -.SH DESCRIPTION +.SH "DESCRIPTION" +.PP A -.I crontab +\fIcrontab\fR file contains instructions to the -.IR cron (8) -daemon of the general form: ``run this command at this time on this date''. -Each user has their own crontab, and commands in any given crontab will be -executed as the user who owns the crontab. Uucp and News will usually have -their own crontabs, eliminating the need for explicitly running -.IR su (1) -as part of a cron command. -.PP -Note that comments on the same line as cron commands are not interpreted as -comments in the cron sense, but are considered part of the command and passed -to the shell. This is similarly true for comments on the same line as -environment variable settings. -.PP -An active line in a crontab will be either an environment setting or a cron -command. An environment setting is of the form, -.PP - name = value -.PP -where the spaces around the equal-sign (=) are optional, and any subsequent -non-leading spaces in -.I value +\fBcron\fR(8) +daemon of the general form: +\(lqrun this command at this time on this date\(rq\&. Each user has their own crontab, and commands in any given crontab will be executed as the user who owns the crontab\&. Uucp and News will usually have their own crontabs, eliminating the need for explicitly running +\fBsu\fR(1) +as part of a cron command\&. +.PP +Note that comments on the same line as cron commands are not interpreted as comments in the cron sense, but are considered part of the command and passed to the shell\&. This is similarly true for comments on the same line as environment variable settings\&. +.PP +An active line in a crontab will be either an environment setting or a cron command\&. An environment setting is of the form, +.sp +.if n \{\ +.RS 4 +.\} +.nf +name = value + +.fi +.if n \{\ +.RE +.\} +.sp +where the spaces around the equal\-sign (=) are optional, and any subsequent non\-leading spaces in +\fIvalue\fR will be part of the value assigned to -.IR name . -The -.I value -string may be placed in quotes (single or double, but matching) to preserve -leading or trailing blanks. To define an empty variable, quotes -.B must -be used. +\fIname\fR\&. The +\fIvalue\fR +string may be placed in quotes (single or double, but matching) to preserve leading or trailing blanks\&. To define an empty variable, quotes can be used\&. .PP The -.I value -string is -.B not -parsed for environmental substitutions or replacement of variables or -tilde(~) expansion, thus lines like -.PP -.in +4n +\fIvalue\fR +string is not parsed for environmental substitutions or replacement of variables or tilde(~) expansion, thus lines like +.sp +.if n \{\ +.RS 4 +.\} .nf PATH=$HOME/bin:$PATH PATH=~/bin:/usr/bin + .fi -.in -.PP -will not work as you might expect. And neither will this work -.PP -.in +4n +.if n \{\ +.RE +.\} +.sp +will not work as you might expect\&. And neither will this work +.sp +.if n \{\ +.RS 4 +.\} .nf A=1 B=2 C=$A $B + .fi -.in -.PP -There will not be any substitution for the defined variables in the -last value. However, with most shells you can also try e.g.,: -.PP - P=PATH=/a/b/c:$PATH - 33 22 1 2 3 eval $P && some commands -.PP +.if n \{\ +.RE +.\} +.sp +There will not be any substitution for the defined variables in the last value\&. However, with most shells you can also try e\&.g\&.,: +.sp +.if n \{\ +.RS 4 +.\} +.nf +P=PATH=/a/b/c:$PATH +33 22 1 2 3 eval $P && some commands + +.fi +.if n \{\ +.RE +.\} +.sp Several environment variables are set up automatically by the -.IR cron (8) -daemon. -SHELL is set to /usr/bin/sh, and LOGNAME and HOME are set from the /etc/passwd -line of the crontab's owner. -HOME and SHELL may be overridden by settings in the crontab; LOGNAME may not. +\fBcron\fR(8) +daemon\&. SHELL is set to +/usr/bin/sh, and LOGNAME and HOME are set from the +/etc/passwd +line of the crontab\*(Aqs owner\&. HOME and SHELL may be overridden by settings in the crontab; LOGNAME may not\&. .PP -(Another note: the LOGNAME variable is sometimes called USER on BSD systems... -on these systems, USER will be set also.) +(Another note: the LOGNAME variable is sometimes called USER on BSD systems\&.\&.\&. on these systems, USER will be set also\&.) .PP In addition to LOGNAME, HOME, and SHELL, -.IR cron (8) -will look at MAILTO if it has any reason to send mail as a result of running -commands in ``this'' crontab. If MAILTO is defined (and non-empty), mail is -sent to the user so named. If MAILTO is defined but empty (MAILTO=""), no -mail will be sent. Otherwise mail is sent to the owner of the crontab. This -option is useful if you decide on /usr/bin/mail instead of /usr/lib/sendmail as -your mailer when you install cron -- /usr/bin/mail doesn't do aliasing, and UUCP -usually doesn't read its mail. -.PP -The format of a cron command is very much the V7 standard, with a number of -upward-compatible extensions. Each line has five time and date fields, -followed by a command, followed by a newline character ('\en'). -The system crontab (/etc/crontab) uses the same format, except that -the username for the command is specified after the time and -date fields and before the command. The fields may be separated -by spaces or tabs. The maximum permitted length for the command field is -998 characters. +\fBcron\fR(8) +will look at MAILTO if it has any reason to send mail as a result of running commands in +\(lqthis\(rq +crontab\&. If MAILTO is defined (and non\-empty), mail is sent to the user so named\&. If MAILTO is defined but empty (MAILTO=""), no mail will be sent\&. Otherwise mail is sent to the owner of the crontab\&. This option is useful if you decide on +\fB/usr/bin/mail\fR +instead of +\fB/usr/lib/sendmail\fR +as your mailer when you install cron \-\- +\fB/usr/bin/mail\fR +doesn\*(Aqt do aliasing, and UUCP usually doesn\*(Aqt read its mail\&. +.PP +The format of a cron command is very much the V7 standard, with a number of upward\-compatible extensions\&. Each line has five time and date fields, followed by a command, followed by a newline character (\*(Aq\en\*(Aq)\&. The system crontab (/etc/crontab) uses the same format, except that the username for the command is specified after the time and date fields and before the command\&. The fields may be separated by spaces or tabs\&. The maximum permitted length for the command field is 998 characters\&. .PP Commands are executed by -.IR cron (8) -when the minute, hour, and month of year fields match the current time, -.I and -when at least one of the two day fields (day of month, or day of week) -match the current time (see ``Note'' below). -.IR cron (8) -examines cron entries once every minute. -The time and date fields are: -.IP -.ta 1.5i -field allowed values -.br ------ -------------- -.br -minute 0-59 -.br -hour 0-23 -.br -day of month 0-31 -.br -month 0-12 (or names, see below) -.br -day of week 0-7 (0 or 7 is Sun, or use names) -.br +\fBcron\fR(8) +when the minute, hour, and month of year fields match the current time, and when at least one of the two day fields (day of month, or day of week) match the current time (see +\(lqNote\(rq +below)\&. +\fBcron\fR(8) +examines cron entries once every minute\&. The time and date fields are: +.TS +allbox tab(:); +lB lB. +T{ +field +T}:T{ +allowed values +T} +.T& +l l +l l +l l +l l +l l. +T{ +minute +T}:T{ +0\-59 +T} +T{ +hour +T}:T{ +0\-23 +T} +T{ +day of month +T}:T{ +0\-31 +T} +T{ +month +T}:T{ +0\-12 (or names, see below) +T} +T{ +day of week +T}:T{ +0\-7 (0 or 7 is Sun, or use names) +T} +.TE +.sp 1 +.PP +A field may be an asterisk (*), which always stands for +\(lqfirst\-last\(rq\&. +.PP +Ranges of numbers are allowed\&. Ranges are two numbers separated with a hyphen\&. The specified range is inclusive\&. For example, 8\-11 for an +\(lqhours\(rq +entry specifies execution at hours 8, 9, 10 and 11\&. +.PP +Lists are allowed\&. A list is a set of numbers (or ranges) separated by commas\&. Examples: +\(lq1,2,5,9\(rq, +\(lq0\-4,8\-12\(rq\&. +.PP +Step values can be used in conjunction with ranges\&. Following a range with +\(lq/<number>\(rq +specifies skips of the number\*(Aqs value through the range\&. For example, +\(lq0\-23/2\(rq +can be used in the hours field to specify command execution every other hour (the alternative in the V7 standard is +\(lq0,2,4,6,8,10,12,14,16,18,20,22\(rq)\&. Steps are also permitted after an asterisk, so if you want to say +\(lqevery two hours\(rq, just use +\(lq*/2\(rq\&. +.PP +Names can also be used for the +\(lqmonth\(rq +and +\(lqday of week\(rq +fields\&. Use the first three letters of the particular day or month (case doesn\*(Aqt matter)\&. Ranges or lists of names are not allowed\&. .PP -A field may be an asterisk (*), which always stands for ``first\-last''. -.PP -Ranges of numbers are allowed. Ranges are two numbers separated -with a hyphen. The specified range is inclusive. For example, -8-11 for an ``hours'' entry specifies execution at hours 8, 9, 10 -and 11. -.PP -Lists are allowed. A list is a set of numbers (or ranges) -separated by commas. Examples: ``1,2,5,9'', ``0-4,8-12''. -.PP -Step values can be used in conjunction with ranges. Following -a range with ``/<number>'' specifies skips of the number's value -through the range. For example, ``0-23/2'' can be used in the hours -field to specify command execution every other hour (the alternative -in the V7 standard is ``0,2,4,6,8,10,12,14,16,18,20,22''). Steps are -also permitted after an asterisk, so if you want to say ``every two -hours'', just use ``*/2''. -.PP -Names can also be used for the ``month'' and ``day of week'' -fields. Use the first three letters of the particular -day or month (case doesn't matter). Ranges or -lists of names are not allowed. -.PP -The ``sixth'' field (the rest of the line) specifies the command to be -run. -The entire command portion of the line, up to a newline or % -character, will be executed by /usr/bin/sh or by the shell -specified in the SHELL variable of the cronfile. -Percent-signs (%) in the command, unless escaped with backslash -(\\), will be changed into newline characters, and all data -after the first % will be sent to the command as standard -input. -.PP -Note: The day of a command's execution can be specified by two -fields \(em day of month, and day of week. If both fields are -restricted (i.e., aren't *), the command will be run when -.I either -field matches the current time. For example, -.br -``30 4 1,15 * 5'' -would cause a command to be run at 4:30 am on the 1st and 15th of each -month, plus every Friday. One can, however, achieve the desired result -by adding a test to the command (see the last example in EXAMPLE CRON FILE -below). +The +\(lqsixth\(rq +field (the rest of the line) specifies the command to be run\&. The entire command portion of the line, up to a newline or % character, will be executed by +\fB/usr/bin/sh\fR +or by the shell specified in the SHELL variable of the cronfile\&. Percent\-signs (%) in the command, unless escaped with backslash (\e), will be changed into newline charac\(hy ters, and all data after the first % will be sent to the command as standard input\&. .PP -Instead of the first five fields, one of eight special strings may appear: -.IP -.ta 1.5i -string meaning -.br ------- ------- -.br -@reboot Run once, at startup. -.br -@yearly Run once a year, "0 0 1 1 *". -.br -@annually (same as @yearly) -.br -@monthly Run once a month, "0 0 1 * *". -.br -@weekly Run once a week, "0 0 * * 0". -.br -@daily Run once a day, "0 0 * * *". -.br -@midnight (same as @daily) -.br -@hourly Run once an hour, "0 * * * *". -.br +Note: The day of a command\*(Aqs execution can be specified by two fields \(em day of month, and day of week\&. If both fields are restricted (i\&.e\&., aren\*(Aqt *), the command will be run when either field matches the current time\&. For example, +\(lq30 4 1,15 * 5\(rq +would cause a command to be run at 4:30 am on the 1st and 15th of each month, plus every Friday\&. One can, however, achieve the desired result by adding a test to the command (see the last example in EXAMPLE CRON FILE below)\&. .PP -Please note that startup, as far as @reboot is concerned, is the time when -the -.IR cron (8) -daemon startup. In particular, it may be before some system daemons, -or other facilities, were startup. This is due to the boot order -sequence of the machine. - -.SH EXAMPLE CRON FILE +Instead of the first five fields, one of eight special strings may appear: +.TS +allbox tab(:); +lB lB. +T{ +string +T}:T{ +meaning +T} +.T& +l l +l l +l l +l l +l l +l l +l l +l l. +T{ +@reboot +T}:T{ +Run once, at startup\&. +T} +T{ +@yearly +T}:T{ +Run once a year, "0 0 1 1 *"\&. +T} +T{ +@annually +T}:T{ +(same as @yearly) +T} +T{ +@monthly +T}:T{ +Run once a month, "0 0 1 * *"\&. +T} +T{ +@weekly +T}:T{ +Run once a week, "0 0 * * 0"\&. +T} +T{ +@daily +T}:T{ +Run once a day, "0 0 * * *"\&. +T} +T{ +@midnight +T}:T{ +(same as @daily) +T} +T{ +@hourly +T}:T{ +Run once an hour, "0 * * * *"\&. +T} +.TE +.sp 1 +.PP +Please note that startup, as far as @reboot is concerned, is the time when the +\fBcron\fR(8) +daemon startup\&. In particular, it may be before some system daemons, or other facilities, were startup\&. This is due to the boot order sequence of the machine\&. +.PP +.PP +.SH "EXAMPLE CRON FILE" +.PP +.if n \{\ +.RS 4 +.\} .nf - # use /usr/bin/sh to run commands, no matter what /etc/passwd says SHELL=/usr/bin/sh -# mail any output to `paul', no matter whose crontab this is +# mail any output to `paul\*(Aq, no matter whose crontab this is MAILTO=paul # # run five minutes after midnight, every day -5 0 * * * $HOME/bin/daily.job >> $HOME/tmp/out 2>&1 -# run at 2:15pm on the first of every month -- output mailed to paul +5 0 * * * $HOME/bin/daily\&.job >> $HOME/tmp/out 2>&1 +# run at 2:15pm on the first of every month \-\- output mailed to paul 15 14 1 * * $HOME/bin/monthly # run at 10 pm on weekdays, annoy Joe -0 22 * * 1\-5 mail \-s "It's 10pm" joe%Joe,%%Where are your kids?% -23 0\-23/2 * * * echo "run 23 minutes after midn, 2am, 4am ..., everyday" +0 22 * * 1\-5 mail \-s "It\*(Aqs 10pm" joe%Joe,%%Where are your kids?% +23 0\-23/2 * * * echo "run 23 minutes after midn, 2am, 4am \&.\&.\&., everyday" 5 4 * * sun echo "run at 5 after 4 every Sunday" 0 */4 1 * mon echo "run every 4th hour on the 1st and on every Monday" -0 0 */2 * sun echo "run at midn on every Sunday that's an uneven date" +0 0 */2 * sun echo "run at midn on every Sunday that\*(Aqs an uneven date" # Run on every second Saturday of the month 0 4 8\-14 * * test $(date +\e%u) \-eq 6 && echo "2nd Saturday" # Same thing, efficient too: -0 4 * * * Sat d=$(date +\%e) && test $d -ge 8 -a $d -le 14 && echo "2nd Saturday" +0 4 * * * Sat d=$(date +e) && test $d \-ge 8 \-a $d \-le 14 && echo "2nd Saturday" #Execute early the next morning following the first #Thursday of each month -57 2 * * 5 case $(date +\%d) in 0[2-8]) echo "After 1st Thursday"; esac +57 2 * * 5 case $(date +d) in 0[2\-8]) echo "After 1st Thursday"; esac + .fi - -.PP -All the above examples run non-interactive programs. If you wish to run a -program that interacts with the user's desktop you have to make sure the proper -environment variable -.I DISPLAY -is set. - -.\" Note: Based on some web searches, below example might not fully -.\" work in all systems, as notify-send might require also -.\" to have knowledge of the dbus session in use (through the environment) -.\" However, adding that code here is an overkill +.if n \{\ +.RE +.\} +.PP +All the above examples run non\-interactive programs\&. If you wish to run a program that interacts with the user\*(Aqs desktop you have to make sure the proper environment variable +\fIDISPLAY\fR +is set\&. +.sp +.if n \{\ +.RS 4 +.\} .nf # Execute a program and run a notification every day at 10:00 am -0 10 * * * $HOME/bin/program | DISPLAY=:0 notify-send "Program run" "$(cat)" +0 10 * * * $HOME/bin/program | DISPLAY=:0 notify\-send "Program run" "$(cat)" + .fi - -.SH EXAMPLE SYSTEM CRON FILE - -The following lists the content of a regular system-wide crontab file. Unlike a -user's crontab, this file has the username field, as used by /etc/crontab. - +.if n \{\ +.RE +.\} +.sp +.SH "EXAMPLE SYSTEM CRON FILE" +.PP +The following lists the content of a regular system\-wide crontab file\&. Unlike a user\*(Aqs crontab, this file has the username field, as used by +/etc/crontab\&. +.sp +.if n \{\ +.RS 4 +.\} .nf -# /etc/crontab: system-wide crontab -# Unlike any other crontab you don't have to run the `crontab' +# /etc/crontab: system\-wide crontab +# Unlike any other crontab you don\*(Aqt have to run the `crontab\*(Aq # command to install the new version when you edit this file -# and files in /etc/cron.d. These files also have username fields, -# that none of the other crontabs do. +# and files in /etc/cron\&.d\&. These files also have username fields, +# that none of the other crontabs do\&. SHELL=/bin/sh PATH=/usr/local/sbin:/usr/local/bin:/sbin:/bin:/usr/sbin:/usr/bin # Example of job definition: -# .---------------- minute (0 - 59) -# | .------------- hour (0 - 23) -# | | .---------- day of month (1 - 31) -# | | | .------- month (1 - 12) OR jan,feb,mar,apr ... -# | | | | .---- day of week (0 - 6) (Sunday=0 or 7) OR sun,mon,tue,wed,thu,fri,sat -# | | | | | -# m h dom mon dow user command -17 * * * * root cd / && run-parts \-\-report /etc/cron.hourly -25 6 * * * root test \-x /usr/sbin/anacron || ( cd / && run-parts \-\-report /etc/cron.daily ) -47 6 * * 7 root test \-x /usr/sbin/anacron || ( cd / && run-parts \-\-report /etc/cron.weekly ) -52 6 1 * * root test \-x /usr/sbin/anacron || ( cd / && run-parts \-\-report /etc/cron.monthly ) +# \&.\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- minute (0 \- 59) +# | \&.\-\-\-\-\-\-\-\-\-\-\-\-\- hour (0 \- 23) +# | | \&.\-\-\-\-\-\-\-\-\-\- day of month (1 \- 31) +# | | | \&.\-\-\-\-\-\-\- month (1 \- 12) OR jan,feb,mar,apr \&.\&.\&. +# | | | | \&.\-\-\-\- day of week (0 \- 6) (Sunday=0 or 7) OR sun,mon,tue,wed,thu,fri,sat +# m h dom mon dow usercommand +17 * * * * root cd / && run\-parts \-\-report /etc/cron\&.hourly +25 6 * * * root test \-x /usr/sbin/anacron || ( cd / && run\-parts \-\-report /etc/cron\&.daily ) +47 6 * * 7 root test \-x /usr/sbin/anacron || ( cd / && run\-parts \-\-report /etc/cron\&.weekly ) +52 6 1 * * root test \-x /usr/sbin/anacron || ( cd / && run\-parts \-\-report /etc/cron\&.monthly ) # + .fi - -Note that all the system-wide tasks will run, by default, from 6 am to 7 am. In -the case of systems that are not powered on during that period of time, only -the hourly tasks will be executed unless the defaults above are changed. - -.SH YET ANOTHER EXAMPLE - -In that example one can see that numbers can be prepended some 0, in order -to line up columns. - +.if n \{\ +.RE +.\} +.PP +Note that all the system\-wide tasks will run, by default, from 6 am to 7 am\&. In the case of systems that are not powered on during that period of time, only the hourly tasks will be executed unless the defaults above are changed\&. +.SH "YET ANOTHER EXAMPLE" +.PP +In that example one can see that numbers can be prepended some 0, in order to line up columns\&. +.sp +.if n \{\ +.RS 4 +.\} .nf -17 * * * * root cd / && run-parts --report /etc/cron.hourly -25 16 * * * root test -x /usr/sbin/anacron || ( cd / && run-parts --report /etc/cron.daily ) -47 06 * * 7 root test -x /usr/sbin/anacron || ( cd / && run-parts --report /etc/cron.weekly ) -52 06 1 * * root test -x /usr/sbin/anacron || ( cd / && run-parts --report /etc/cron.monthly ) +17 * * * * root cd / && run\-parts \-\-report /etc/cron\&.hourly +25 16 * * * root test \-x /usr/sbin/anacron || ( cd / && run\-parts \-\-report /etc/cron\&.daily ) +47 06 * * 7 root test \-x /usr/sbin/anacron || ( cd / && run\-parts \-\-report /etc/cron\&.weekly ) +52 06 1 * * root test \-x /usr/sbin/anacron || ( cd / && run\-parts \-\-report /etc/cron\&.monthly ) + .fi - -.SH SEE ALSO -cron(8), crontab(1) -.SH EXTENSIONS -When specifying day of week, both day 0 and day 7 will be considered Sunday. -BSD and AT&T seem to disagree about this. +.if n \{\ +.RE +.\} +.sp +.SH "SEE ALSO" +.PP +\fBcron\fR(8), +\fBcrontab\fR(1) +.SH "EXTENSIONS" +.PP +When specifying day of week, both day 0 and day 7 will be considered Sunday\&. BSD and AT&T seem to disagree about this\&. .PP -Lists and ranges are allowed to co-exist in the same field. "1-3,7-9" would -be rejected by AT&T or BSD cron -- they want to see "1-3" or "7,8,9" ONLY. +Lists and ranges are allowed to co\-exist in the same field\&. "1\-3,7\-9" would be rejected by AT&T or BSD cron \-\- they want to see "1\-3" or "7,8,9" ONLY\&. .PP -Ranges can include "steps", so "1-9/2" is the same as "1,3,5,7,9". +Ranges can include "steps", so "1\-9/2" is the same as "1,3,5,7,9"\&. .PP -Names of monts or days of the week can be specified by name. +Names of months or days of the week can be specified by name\&. .PP -Environment variables can be set in the crontab. In BSD or AT&T, the -environment handed to child processes is basically the one from /etc/rc. +Environment variables can be set in the crontab\&. In BSD or AT&T, the environment handed to child processes is basically the one from +/etc/rc\&. .PP -Command output is mailed to the crontab owner (BSD can't do this), can be -mailed to a person other than the crontab owner (SysV can't do this), or the -feature can be turned off and no mail will be sent at all (SysV can't do this -either). +Command output is mailed to the crontab owner (BSD can\*(Aqt do this), can be mailed to a person other than the crontab owner (SysV can\*(Aqt do this), or the feature can be turned off and no mail will be sent at all (SysV can\*(Aqt do this either)\&. +.PP +All of the +\(lq@\(rq +commands that can appear in place of the first five fields are extensions\&. +.SH "LIMITATIONS" .PP -All of the `@' commands that can appear in place of the first five fields -are extensions. -.SH LIMITATIONS The -.I cron -daemon runs with a defined timezone. It currently does not support -per-user timezones. All the tasks: system's and user's will be run based on the -configured timezone. Even if a user specifies the -.I TZ -environment variable in his -.I crontab -this will affect only the commands executed in the crontab, not the execution -of the crontab tasks themselves. If one wants to specify a particular -timezone for crontab tasks, one may check the date in the child script, -for example: - +\fBcron\fR +daemon runs with a defined timezone\&. It currently does not support per\-user timezones\&. All the tasks: system\*(Aqs and user\*(Aqs will be run based on the configured timezone\&. Even if a user specifies the +\fITZ\fR +environment variable in his crontab this will affect only the commands executed in the crontab, not the execution of the crontab tasks them\(hy selves\&. If one wants to specify a particular timezone for crontab tasks, one may check the date in the child script, for example: +.sp +.if n \{\ +.RS 4 +.\} .nf - # m h dom mon dow command +# m h dom mon dow command - TZ=UTC - 0 * * * * [ "$(date +\e%R)" = 00:00 ] && run_some_script +TZ=UTC +0 * * * * [ "$(date +\e%R)" = 00:00 ] && run_some_script + .fi - -POSIX specifies that the day of month and the day of week fields both need to -match the current time if either of them -.I is -a *. However, this implementation only checks if the -.I first character -is a *. This is why "0 0 */2 * sun" runs every Sunday that's an -uneven date while the POSIX standard would have it run every Sunday and on -every uneven date. - +.if n \{\ +.RE +.\} +.PP +POSIX specifies that the day of month and the day of week fields both need to match the current time if either of them +\fIis\fR +a *\&. However, this implementation only checks if the +\fIfirst character\fR +is a *\&. This is why "0 0 */2 * sun" runs every Sunday that\*(Aqs an uneven date while the POSIX standard would have it run every Sunday and on every uneven date\&. +.PP The -.I crontab -syntax does not make it possible to define all possible periods one can -imagine. For example, it is not straightforward to define the last -weekday of a month. -To have a task run in a time period that cannot be defined using -.I crontab -syntax, the best approach would be to have the program itself check the -date and time information and continue execution only if the period -matches the desired one. - -If the program itself cannot do the checks then a wrapper script would be -required. Useful tools that could be used for date analysis are -.I ncal +\fIcrontab\fR +syntax does not make it possible to define all possible periods one can imagine\&. For example, it is not straightforward to define the last weekday of a month\&. To have a task run in a time period that cannot be defined using +\fIcrontab\fR +syntax, the best approach would be to have the program itself check the date and time information and continue execution only if the period matches the desired one\&. +.PP +If the program itself cannot do the checks then a wrapper script would be required\&. Useful tools that could be used for date analysis are +\fIncal\fR or -.I calendar -For example, to run a program the last Saturday of every month you could use -the following wrapper code: - +\fIcalendar\fR\&. For example, to run a program the last Saturday of every month you could use the following wrapper code: +.sp +.if n \{\ +.RS 4 +.\} .nf -0 4 * * Sat [ "$(date +\e%e)" = "$(LANG=C ncal | sed \-n 's/^Sa .* \e([0\-9]\e+\e) *$/\e1/p')" ] && echo "Last Saturday" && program_to_run +0 4 * * Sat [ "$(date +\e%e)" = "$(LANG=C ncal | sed \-n \*(Aqs/^Sa \&.* \e([0\-9]\e+\e) *$/\e1/p\*(Aq)" ] && echo "Last Saturday" && program_to_run + .fi - -.SH USING EVAL TO WRAP MISC ENVIRONMENT SETTINGS +.if n \{\ +.RE +.\} +.sp +.SH "USING EVAL TO WRAP MISC ENVIRONMENT SETTINGS" +.PP The following tip is kindly provided by 積丹尼 Dan Jacobson: +.sp +.if n \{\ +.RS 4 +.\} +.nf +CONTENT_TYPE="text/plain; charset=UTF\-8" +d=eval LANG=zh_TW\&.UTF\-8 w3m \-dump +26 22 16 1\-12 * $d https://www\&.ptt\&.cc/bbs/transgender/index\&.html + +.fi +.if n \{\ +.RE +.\} +.PP +it won\*(Aqt work without the eval\&. Saying +.sp +.if n \{\ +.RS 4 +.\} +.nf +d=LANG=zh_TW\&.UTF\-8 w3m \-dump + +.fi +.if n \{\ +.RE +.\} +.PP +will get +.sp +.if n \{\ +.RS 4 +.\} +.nf +/bin/sh: LANG=zh_TW\&.UTF\-8: command not found + +.fi +.if n \{\ +.RE +.\} +.PP +.SH "DIAGNOSTICS" +.PP +cron requires that each entry in a crontab end in a newline character\&. If the last entry in a crontab is missing a newline (i\&.e\&. terminated by EOF), cron will consider the crontab (at least partially) broken\&. A warning will be written to syslog\&. +.SH "AUTHORS" +.PP +\fBPaul Vixie\fR <\&paul@vix\&.com\&> +.RS 4 +Wrote this manpage (1994)\&. +.RE +.PP +\fBSteve Greenland\fR <\&stevegr@debian\&.org\&> +.RS 4 +Maintained the package (1996\-2005)\&. +.RE +.PP +\fBJavier Fern\('andez\-Sanguino Pe\(~na\fR <\&jfs@debian\&.org\&> +.RS 4 +Maintained the package (2005\-2014)\&. +.RE +.PP +\fBChristian Kastner\fR <\&ckk@debian\&.org\&> +.RS 4 +Maintained the package (2010\-2016)\&. +.RE +.PP +\fBGeorges Khaznadar\fR <\&georgesk@debian\&.org\&> +.RS 4 +Maintained the package (2022\-2024)\&. +.RE +.SH "COPYRIGHT" +.br +Copyright \(co 1994 Paul Vixie +.br .PP - CONTENT_TYPE="text/plain; charset=UTF-8" - d=eval LANG=zh_TW.UTF-8 w3m -dump - 26 22 16 1-12 * $d https://www.ptt.cc/bbs/transgender/index.html +Distribute freely, except: don\*(Aqt remove my name from the source or documentation (don\*(Aqt take credit for my work), mark your changes (don\*(Aqt get me blamed for your possible bugs), don\*(Aqt alter or remove this notice\&. May be sold if buildable source is provided to buyer\&. No warranty of any kind, express or implied, is included with this software; use at your own risk, responsibility for damages (if any) to anyone resulting from the use of this software rests entirely with the user\&. .PP - it won't work without the eval. Saying - d=LANG=zh_TW.UTF-8 w3m -dump - will get - /bin/sh: LANG=zh_TW.UTF-8: command not found - -.SH DIAGNOSTICS -cron requires that each entry in a crontab end in a newline character. If the -last entry in a crontab is missing a newline (i.e.\& terminated by EOF), -cron will consider the crontab (at least partially) broken. -A warning will be written to syslog. - -.SH AUTHOR -Paul Vixie <paul@vix.com> is the author of -.I cron -and original creator of this manual page. This page has also been modified for -Debian by Steve Greenland, Javier Fernandez-Sanguino, Christian Kastner, -Christian Pekeler, Georges Khaznadar. +Since year 1994, many modifications were made in this manpage, authored by Debian Developers which maintained +cron; above is a short list, more information can be found in the file +/usr/share/doc/cron/copyright\&. +.sp diff --git a/upstream/debian-unstable/man5/crypttab.5 b/upstream/debian-unstable/man5/crypttab.5 index 729a3b43..a238a337 100644 --- a/upstream/debian-unstable/man5/crypttab.5 +++ b/upstream/debian-unstable/man5/crypttab.5 @@ -2,12 +2,12 @@ .\" Title: crypttab .\" Author: [see the "AUTHOR" section] .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> -.\" Date: 2024-02-26 +.\" Date: 2024-04-14 .\" Manual: cryptsetup manual -.\" Source: cryptsetup 2:2.7.0-1 +.\" Source: cryptsetup 2:2.7.2-2 .\" Language: English .\" -.TH "CRYPTTAB" "5" "2024\-02\-26" "cryptsetup 2:2\&.7\&.0\-1" "cryptsetup manual" +.TH "CRYPTTAB" "5" "2024\-04\-14" "cryptsetup 2:2\&.7\&.2\-2" "cryptsetup manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/upstream/debian-unstable/man5/depmod.d.5 b/upstream/debian-unstable/man5/depmod.d.5 index cde42fd2..3cae50d7 100644 --- a/upstream/debian-unstable/man5/depmod.d.5 +++ b/upstream/debian-unstable/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: 02/13/2024 +.\" Date: 05/26/2024 .\" Manual: depmod.d .\" Source: kmod .\" Language: English .\" -.TH "DEPMOD\&.D" "5" "02/13/2024" "kmod" "depmod.d" +.TH "DEPMOD\&.D" "5" "05/26/2024" "kmod" "depmod.d" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/upstream/debian-unstable/man5/dir_colors.5 b/upstream/debian-unstable/man5/dir_colors.5 index 3084d40a..a024d58e 100644 --- a/upstream/debian-unstable/man5/dir_colors.5 +++ b/upstream/debian-unstable/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 6.8" .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. @@ -380,12 +380,12 @@ System-wide configuration file. and thus Debian.) .TP .I \[ti]/.dir_colors -+.\" Rejected upstream +.\" Rejected upstream (Slackware, SuSE and RedHat only; ignored by GNU .BR dircolors (1) and thus Debian.) Per-user configuration file. -.PP +.P This page describes the .B dir_colors file format as used in the fileutils-4.1 package; @@ -395,7 +395,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. @@ -403,7 +403,7 @@ LEFTCODE \ee[ RIGHTCODE m .TE .RE -.PP +.P The default .B ENDCODE is undefined. diff --git a/upstream/debian-unstable/man5/dnssec-trust-anchors.d.5 b/upstream/debian-unstable/man5/dnssec-trust-anchors.d.5 index 4671d2f5..4f4eadf8 100644 --- a/upstream/debian-unstable/man5/dnssec-trust-anchors.d.5 +++ b/upstream/debian-unstable/man5/dnssec-trust-anchors.d.5 @@ -1,5 +1,5 @@ '\" t -.TH "DNSSEC\-TRUST\-ANCHORS\&.D" "5" "" "systemd 255" "dnssec-trust-anchors.d" +.TH "DNSSEC\-TRUST\-ANCHORS\&.D" "5" "" "systemd 256~rc3" "dnssec-trust-anchors.d" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -23,17 +23,24 @@ dnssec-trust-anchors.d, systemd.positive, systemd.negative \- DNSSEC trust anchor configuration files .SH "SYNOPSIS" .PP +.RS 4 /etc/dnssec\-trust\-anchors\&.d/*\&.positive -.PP +.RE +.RS 4 /run/dnssec\-trust\-anchors\&.d/*\&.positive -.PP +.RE +.RS 4 /usr/lib/dnssec\-trust\-anchors\&.d/*\&.positive -.PP +.RE +.RS 4 /etc/dnssec\-trust\-anchors\&.d/*\&.negative -.PP +.RE +.RS 4 /run/dnssec\-trust\-anchors\&.d/*\&.negative -.PP +.RE +.RS 4 /usr/lib/dnssec\-trust\-anchors\&.d/*\&.negative +.RE .SH "DESCRIPTION" .PP The DNSSEC trust anchor configuration files define positive and negative trust anchors @@ -185,10 +192,7 @@ setting in files\&. .SH "SEE ALSO" .PP -\fBsystemd\fR(1), -\fBsystemd-resolved.service\fR(8), -\fBresolved.conf\fR(5), -\fBsystemd.network\fR(5) +\fBsystemd\fR(1), \fBsystemd-resolved.service\fR(8), \fBresolved.conf\fR(5), \fBsystemd.network\fR(5) .SH "NOTES" .IP " 1." 4 RFC 4035, Section 4.4 diff --git a/upstream/debian-unstable/man5/e2fsck.conf.5 b/upstream/debian-unstable/man5/e2fsck.conf.5 index ad91762c..2a99ece7 100644 --- a/upstream/debian-unstable/man5/e2fsck.conf.5 +++ b/upstream/debian-unstable/man5/e2fsck.conf.5 @@ -2,7 +2,7 @@ .\" Copyright 2006 by Theodore Ts'o. All Rights Reserved. .\" This file may be copied under the terms of the GNU Public License. .\" -.TH e2fsck.conf 5 "February 2023" "E2fsprogs version 1.47.0" +.TH e2fsck.conf 5 "May 2024" "E2fsprogs version 1.47.1" .SH NAME e2fsck.conf \- Configuration file for e2fsck .SH DESCRIPTION diff --git a/upstream/debian-unstable/man5/elf.5 b/upstream/debian-unstable/man5/elf.5 index 6fa4ddf7..c7ea1312 100644 --- a/upstream/debian-unstable/man5/elf.5 +++ b/upstream/debian-unstable/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 6.8" .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/debian-unstable/man5/environment.d.5 b/upstream/debian-unstable/man5/environment.d.5 index 063bfb25..c54bd5c6 100644 --- a/upstream/debian-unstable/man5/environment.d.5 +++ b/upstream/debian-unstable/man5/environment.d.5 @@ -1,5 +1,5 @@ '\" t -.TH "ENVIRONMENT\&.D" "5" "" "systemd 255" "environment.d" +.TH "ENVIRONMENT\&.D" "5" "" "systemd 256~rc3" "environment.d" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -23,15 +23,21 @@ environment.d \- Definition of user service environment .SH "SYNOPSIS" .PP +.RS 4 ~/\&.config/environment\&.d/*\&.conf -.PP +.RE +.RS 4 /etc/environment\&.d/*\&.conf -.PP +.RE +.RS 4 /run/environment\&.d/*\&.conf -.PP +.RE +.RS 4 /usr/lib/environment\&.d/*\&.conf -.PP +.RE +.RS 4 /etc/environment +.RE .SH "DESCRIPTION" .PP Configuration files in the @@ -71,7 +77,12 @@ Packages should install their configuration files in /usr/local/lib/ (local installs)\&. Files in /etc/ -are reserved for the local administrator, who may use this logic to override the configuration files installed by vendor packages\&. It is recommended to prefix all filenames with a two\-digit number and a dash, to simplify the ordering of the files\&. +are reserved for the local administrator, who may use this logic to override the configuration files installed by vendor packages\&. It is recommended to prefix all filenames with a two\-digit number and a dash, to simplify the ordering of the files\&. It is recommended to use the range 10\-40 for configuration files in +/usr/ +and the range 60\-90 for configuration files in +/etc/ +and +/run/, to make sure that local and transient configuration files will always take priority over configuration files shipped by the OS vendor\&. .PP If the administrator wants to disable a configuration file supplied by the vendor, the recommended way is to place a symlink to /dev/null @@ -146,6 +157,4 @@ service builds an environment that is a combination of variables forwarded from or the underlying D\-Bus call\&. .SH "SEE ALSO" .PP -\fBsystemd\fR(1), -\fBsystemd-environment-d-generator\fR(8), -\fBsystemd.environment-generator\fR(7) +\fBsystemd\fR(1), \fBsystemd-environment-d-generator\fR(8), \fBsystemd.environment-generator\fR(7) diff --git a/upstream/debian-unstable/man5/erofs.5 b/upstream/debian-unstable/man5/erofs.5 index 97edfdcd..3b85c7dc 100644 --- a/upstream/debian-unstable/man5/erofs.5 +++ b/upstream/debian-unstable/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 6.8" .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/debian-unstable/man5/ext4.5 b/upstream/debian-unstable/man5/ext4.5 index 5be4c1d1..3c62c020 100644 --- a/upstream/debian-unstable/man5/ext4.5 +++ b/upstream/debian-unstable/man5/ext4.5 @@ -1,8 +1,9 @@ +'\" t .\" -*- nroff -*- .\" Copyright 1993, 1994, 1995 by Theodore Ts'o. All Rights Reserved. .\" This file may be copied under the terms of the GNU Public License. .\" -.TH EXT4 5 "February 2023" "E2fsprogs version 1.47.0" +.TH EXT4 5 "May 2024" "E2fsprogs version 1.47.1" .SH NAME ext2 \- the second extended file system .br diff --git a/upstream/debian-unstable/man5/filesystems.5 b/upstream/debian-unstable/man5/filesystems.5 index cc766992..6e7e2808 100644 --- a/upstream/debian-unstable/man5/filesystems.5 +++ b/upstream/debian-unstable/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 6.8" .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/debian-unstable/man5/fips_config.5ssl b/upstream/debian-unstable/man5/fips_config.5ssl index 61766ce6..2b75b138 100644 --- a/upstream/debian-unstable/man5/fips_config.5ssl +++ b/upstream/debian-unstable/man5/fips_config.5ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "FIPS_CONFIG 5SSL" -.TH FIPS_CONFIG 5SSL 2024-02-03 3.1.5 OpenSSL +.TH FIPS_CONFIG 5SSL 2024-04-04 3.2.2-dev OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -152,7 +152,7 @@ See \fBconfig\fR\|(5). This functionality was added in OpenSSL 3.0. .SH COPYRIGHT .IX Header "COPYRIGHT" -Copyright 2019\-2022 The OpenSSL Project Authors. All Rights Reserved. +Copyright 2019\-2021 The OpenSSL Project Authors. All Rights Reserved. .PP Licensed under the Apache License 2.0 (the "License"). You may not use this file except in compliance with the License. You can obtain a copy diff --git a/upstream/debian-unstable/man5/gai.conf.5 b/upstream/debian-unstable/man5/gai.conf.5 index bba44807..2a9d618f 100644 --- a/upstream/debian-unstable/man5/gai.conf.5 +++ b/upstream/debian-unstable/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 6.8" .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/debian-unstable/man5/groff_font.5 b/upstream/debian-unstable/man5/groff_font.5 index fa98de68..acf41b9c 100644 --- a/upstream/debian-unstable/man5/groff_font.5 +++ b/upstream/debian-unstable/man5/groff_font.5 @@ -1,4 +1,4 @@ -.TH groff_font 5 "16 October 2023" "groff 1.23.0" +.TH groff_font 5 "30 April 2024" "groff 1.23.0" .SH Name groff_font \- GNU .I roff diff --git a/upstream/debian-unstable/man5/groff_out.5 b/upstream/debian-unstable/man5/groff_out.5 index c7b7882d..a4267a68 100644 --- a/upstream/debian-unstable/man5/groff_out.5 +++ b/upstream/debian-unstable/man5/groff_out.5 @@ -1,4 +1,4 @@ -.TH groff_out 5 "16 October 2023" "groff 1.23.0" +.TH groff_out 5 "30 April 2024" "groff 1.23.0" .SH Name groff_out \- GNU .I roff diff --git a/upstream/debian-unstable/man5/groff_tmac.5 b/upstream/debian-unstable/man5/groff_tmac.5 index 8f657d7a..8463d883 100644 --- a/upstream/debian-unstable/man5/groff_tmac.5 +++ b/upstream/debian-unstable/man5/groff_tmac.5 @@ -1,4 +1,4 @@ -.TH groff_tmac 5 "16 October 2023" "groff 1.23.0" +.TH groff_tmac 5 "30 April 2024" "groff 1.23.0" .SH Name groff_tmac \- macro files in the GNU .I roff diff --git a/upstream/debian-unstable/man5/group.5 b/upstream/debian-unstable/man5/group.5 index d39f8434..c7453a80 100644 --- a/upstream/debian-unstable/man5/group.5 +++ b/upstream/debian-unstable/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 6.8" .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/debian-unstable/man5/hdparm.conf.5 b/upstream/debian-unstable/man5/hdparm.conf.5 index 08a25bc5..c4592087 100644 --- a/upstream/debian-unstable/man5/hdparm.conf.5 +++ b/upstream/debian-unstable/man5/hdparm.conf.5 @@ -18,7 +18,7 @@ Still one can re-apply settings from the config file by calling either .LP or by calling .LP -.B DEVNAME=/dev/<disk> /lib/udev/hdparm +.B DEVNAME=/dev/<disk> /usr/lib/udev/hdparm .LP Note that an in\-line comment is not supported. If a line consists of whitespace only (tabs, spaces, carriage return), it will be diff --git a/upstream/debian-unstable/man5/homed.conf.5 b/upstream/debian-unstable/man5/homed.conf.5 index af99d452..caf235e2 100644 --- a/upstream/debian-unstable/man5/homed.conf.5 +++ b/upstream/debian-unstable/man5/homed.conf.5 @@ -1,5 +1,5 @@ '\" t -.TH "HOMED\&.CONF" "5" "" "systemd 255" "homed.conf" +.TH "HOMED\&.CONF" "5" "" "systemd 256~rc3" "homed.conf" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -23,29 +23,40 @@ homed.conf, homed.conf.d \- Home area/user account manager configuration files .SH "SYNOPSIS" .PP +.RS 4 /etc/systemd/homed\&.conf -.PP +.RE +.RS 4 +/run/systemd/homed\&.conf +.RE +.RS 4 +/usr/lib/systemd/homed\&.conf +.RE +.RS 4 /etc/systemd/homed\&.conf\&.d/*\&.conf -.PP +.RE +.RS 4 /run/systemd/homed\&.conf\&.d/*\&.conf -.PP +.RE +.RS 4 /usr/lib/systemd/homed\&.conf\&.d/*\&.conf +.RE .SH "DESCRIPTION" .PP These configuration files control default parameters for home areas/user accounts created and managed by \fBsystemd-homed.service\fR(8)\&. .SH "CONFIGURATION DIRECTORIES AND PRECEDENCE" .PP -The default configuration is set during compilation, so configuration is only needed when it is necessary to deviate from those defaults\&. The main configuration file is either in -/usr/lib/systemd/ -or -/etc/systemd/ -and contains commented out entries showing the defaults as a guide to the administrator\&. Local overrides can be created by creating drop\-ins, as described below\&. The main configuration file can also be edited for this purpose (or a copy in +The default configuration is set during compilation, so configuration is only needed when it is necessary to deviate from those defaults\&. The main configuration file is loaded from one of the listed directories in order of priority, only the first file found is used: +/etc/systemd/, +/run/systemd/, +/usr/local/lib/systemd/, +/usr/lib/systemd/\&. The vendor version of the file contains commented out entries showing the defaults as a guide to the administrator\&. Local overrides can also be created by creating drop\-ins, as described below\&. The main configuration file can also be edited for this purpose (or a copy in /etc/ -if it\*(Aqs shipped in -/usr/) however using drop\-ins for local configuration is recommended over modifications to the main configuration file\&. +if it\*(Aqs shipped under +/usr/), however using drop\-ins for local configuration is recommended over modifications to the main configuration file\&. .PP -In addition to the "main" configuration file, drop\-in configuration snippets are read from +In addition to the main configuration file, drop\-in configuration snippets are read from /usr/lib/systemd/*\&.conf\&.d/, /usr/local/lib/systemd/*\&.conf\&.d/, and /etc/systemd/*\&.conf\&.d/\&. Those drop\-ins have higher precedence and override the main configuration file\&. Files in the @@ -55,7 +66,12 @@ configuration subdirectories are sorted by their filename in lexicographic order When packages need to customize the configuration, they can install drop\-ins under /usr/\&. Files in /etc/ -are reserved for the local administrator, who may use this logic to override the configuration files installed by vendor packages\&. Drop\-ins have to be used to override package drop\-ins, since the main configuration file has lower precedence\&. It is recommended to prefix all filenames in those subdirectories with a two\-digit number and a dash, to simplify the ordering of the files\&. This also defined a concept of drop\-in priority to allow distributions to ship drop\-ins within a specific range lower than the range used by users\&. This should lower the risk of package drop\-ins overriding accidentally drop\-ins defined by users\&. +are reserved for the local administrator, who may use this logic to override the configuration files installed by vendor packages\&. Drop\-ins have to be used to override package drop\-ins, since the main configuration file has lower precedence\&. It is recommended to prefix all filenames in those subdirectories with a two\-digit number and a dash, to simplify the ordering of the files\&. This also defines a concept of drop\-in priorities to allow OS vendors to ship drop\-ins within a specific range lower than the range used by users\&. This should lower the risk of package drop\-ins overriding accidentally drop\-ins defined by users\&. It is recommended to use the range 10\-40 for drop\-ins in +/usr/ +and the range 60\-90 for drop\-ins in +/etc/ +and +/run/, to make sure that local and transient drop\-ins take priority over drop\-ins shipped by the OS vendor\&. .PP To disable a configuration file supplied by the vendor, the recommended way is to place a symlink to /dev/null @@ -106,5 +122,4 @@ Added in version 246\&. .RE .SH "SEE ALSO" .PP -\fBsystemd\fR(1), -\fBsystemd-homed.service\fR(8) +\fBsystemd\fR(1), \fBsystemd-homed.service\fR(8) diff --git a/upstream/debian-unstable/man5/host.conf.5 b/upstream/debian-unstable/man5/host.conf.5 index 8f645512..ff22e375 100644 --- a/upstream/debian-unstable/man5/host.conf.5 +++ b/upstream/debian-unstable/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 6.8" .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/debian-unstable/man5/hostname.5 b/upstream/debian-unstable/man5/hostname.5 index ff5139a9..7226f5c4 100644 --- a/upstream/debian-unstable/man5/hostname.5 +++ b/upstream/debian-unstable/man5/hostname.5 @@ -1,5 +1,5 @@ '\" t -.TH "HOSTNAME" "5" "" "systemd 255" "hostname" +.TH "HOSTNAME" "5" "" "systemd 256~rc3" "hostname" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -113,15 +113,7 @@ The simple configuration file format of originates from Debian GNU/Linux\&. .SH "SEE ALSO" .PP -\fBsystemd\fR(1), -\fBsethostname\fR(2), -\fBhostname\fR(1), -\fBhostname\fR(7), -\fBmachine-id\fR(5), -\fBmachine-info\fR(5), -\fBhostnamectl\fR(1), -\fBsystemd-hostnamed.service\fR(8), -\fBsystemd-firstboot\fR(1) +\fBsystemd\fR(1), \fBsethostname\fR(2), \fBhostname\fR(1), \fBhostname\fR(7), \fBmachine-id\fR(5), \fBmachine-info\fR(5), \fBhostnamectl\fR(1), \fBsystemd-hostnamed.service\fR(8), \fBsystemd-firstboot\fR(1) .SH "NOTES" .IP " 1." 4 NetworkManager diff --git a/upstream/debian-unstable/man5/hosts.5 b/upstream/debian-unstable/man5/hosts.5 index 7e178149..bd7f5191 100644 --- a/upstream/debian-unstable/man5/hosts.5 +++ b/upstream/debian-unstable/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 6.8" .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/debian-unstable/man5/hosts.equiv.5 b/upstream/debian-unstable/man5/hosts.equiv.5 index a9521da3..21c806d8 100644 --- a/upstream/debian-unstable/man5/hosts.equiv.5 +++ b/upstream/debian-unstable/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 6.8" .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/debian-unstable/man5/icewm-env.5 b/upstream/debian-unstable/man5/icewm-env.5 index d7aeed96..936d19e9 100644 --- a/upstream/debian-unstable/man5/icewm-env.5 +++ b/upstream/debian-unstable/man5/icewm-env.5 @@ -1,4 +1,5 @@ -.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43) +.\" -*- mode: troff; coding: utf-8 -*- +.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== @@ -15,29 +16,12 @@ .ft R .fi .. -.\" Set up some character translations and predefined strings. \*(-- will -.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left -.\" double quote, and \*(R" will give a right double quote. \*(C+ will -.\" give a nicer C++. Capital omega is used to do unbreakable dashes and -.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, -.\" nothing in troff, for use with C<>. -.tr \(*W- -.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ -. ds -- \(*W- -. ds PI pi -. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch -. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch -. ds L" "" -. ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ -. ds -- \|\(em\| -. ds PI \(*p -. ds L" `` -. ds R" '' . ds C` . ds C' 'br\} @@ -68,82 +52,20 @@ . \} .\} .rr rF -.\" -.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). -.\" Fear. Run. Save yourself. No user-serviceable parts. -. \" fudge factors for nroff and troff -.if n \{\ -. ds #H 0 -. ds #V .8m -. ds #F .3m -. ds #[ \f1 -. ds #] \fP -.\} -.if t \{\ -. ds #H ((1u-(\\\\n(.fu%2u))*.13m) -. ds #V .6m -. ds #F 0 -. ds #[ \& -. ds #] \& -.\} -. \" simple accents for nroff and troff -.if n \{\ -. ds ' \& -. ds ` \& -. ds ^ \& -. ds , \& -. ds ~ ~ -. ds / -.\} -.if t \{\ -. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" -. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' -. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' -. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' -. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' -. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' -.\} -. \" troff and (daisy-wheel) nroff accents -.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' -.ds 8 \h'\*(#H'\(*b\h'-\*(#H' -.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] -.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' -.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' -.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] -.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] -.ds ae a\h'-(\w'a'u*4/10)'e -.ds Ae A\h'-(\w'A'u*4/10)'E -. \" corrections for vroff -.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' -.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' -. \" for low resolution devices (crt and lpr) -.if \n(.H>23 .if \n(.V>19 \ -\{\ -. ds : e -. ds 8 ss -. ds o a -. ds d- d\h'-1'\(ga -. ds D- D\h'-1'\(hy -. ds th \o'bp' -. ds Th \o'LP' -. ds ae ae -. ds Ae AE -.\} -.rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "ICEWM-ENV 5" -.TH ICEWM-ENV 5 "2023-12-31" "icewm\ 3.4.5" "Standards, Environments and Macros" +.TH ICEWM-ENV 5 2024-05-24 "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 .nh -.SS "\s-1NAME\s0" +.SS NAME .IX Subsection "NAME" .Vb 1 \& icewm\-env \- icewm environment configuration file .Ve -.SS "\s-1SYNOPSIS\s0" +.SS SYNOPSIS .IX Subsection "SYNOPSIS" .Vb 5 \& $ICEWM_PRIVCFG/env @@ -152,21 +74,21 @@ \& /etc/X11/icewm/env \& /usr/share/icewm/env .Ve -.SS "\s-1DESCRIPTION\s0" +.SS DESCRIPTION .IX Subsection "DESCRIPTION" \&\fBicewm\-session\fR\|(1) loads additional environment variables from the file \&\fIenv\fR before it does anything else. These variables are then propagated to all other processes, including \fBicewm\fR\|(1), via their environment. -.SS "\s-1FORMAT\s0" +.SS FORMAT .IX Subsection "FORMAT" -Each line is subjected to \s-1POSIX\s0 shell expansion by \fBwordexp\fR\|(3). +Each line is subjected to POSIX shell expansion by \fBwordexp\fR\|(3). Comment lines starting by a hash-sign (\f(CW\*(C`#\*(C'\fR) are ignored. \&\fBicewm\-session\fR\|(1) will load those expanded lines that contain a name, followed by an equals sign, followed by the value (which may be empty). .PP The word \fBunset\fR begins a line with names to be removed from the environment. -.SS "\s-1EXAMPLES\s0" +.SS EXAMPLES .IX Subsection "EXAMPLES" .Vb 2 \& # This is a comment. @@ -178,7 +100,7 @@ environment. \& START_DATE=\`date\` \& START_FROM=\`pwd\` .Ve -.SS "\s-1FILES\s0" +.SS FILES .IX Subsection "FILES" \&\fBicewm\-session\fR\|(1) looks for the \fIenv\fR file in the following locations: .PP @@ -192,15 +114,15 @@ environment. .PP The locations are searched in the order listed; the first file found is read and the remainder ignored. -.SS "\s-1SEE ALSO\s0" +.SS "SEE ALSO" .IX Subsection "SEE ALSO" \&\fBicewm\fR\|(1), \&\fBicewm\-session\fR\|(1), \&\fBicewm\-startup\fR\|(5). -.SS "\s-1AUTHOR\s0" +.SS AUTHOR .IX Subsection "AUTHOR" Brian Bidulock <mailto:bidulock@openss7.org>. -.SS "\s-1LICENSE\s0" +.SS LICENSE .IX Subsection "LICENSE" -\&\fBIceWM\fR is licensed under the \s-1GNU\s0 Library General Public License. -See the \fI\s-1COPYING\s0\fR file in the distribution. +\&\fBIceWM\fR is licensed under the GNU Library General Public License. +See the \fICOPYING\fR file in the distribution. diff --git a/upstream/debian-unstable/man5/icewm-focus_mode.5 b/upstream/debian-unstable/man5/icewm-focus_mode.5 index 3a8f367b..fc09da9e 100644 --- a/upstream/debian-unstable/man5/icewm-focus_mode.5 +++ b/upstream/debian-unstable/man5/icewm-focus_mode.5 @@ -1,4 +1,5 @@ -.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43) +.\" -*- mode: troff; coding: utf-8 -*- +.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== @@ -15,29 +16,12 @@ .ft R .fi .. -.\" Set up some character translations and predefined strings. \*(-- will -.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left -.\" double quote, and \*(R" will give a right double quote. \*(C+ will -.\" give a nicer C++. Capital omega is used to do unbreakable dashes and -.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, -.\" nothing in troff, for use with C<>. -.tr \(*W- -.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ -. ds -- \(*W- -. ds PI pi -. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch -. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch -. ds L" "" -. ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ -. ds -- \|\(em\| -. ds PI \(*p -. ds L" `` -. ds R" '' . ds C` . ds C' 'br\} @@ -68,82 +52,20 @@ . \} .\} .rr rF -.\" -.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). -.\" Fear. Run. Save yourself. No user-serviceable parts. -. \" fudge factors for nroff and troff -.if n \{\ -. ds #H 0 -. ds #V .8m -. ds #F .3m -. ds #[ \f1 -. ds #] \fP -.\} -.if t \{\ -. ds #H ((1u-(\\\\n(.fu%2u))*.13m) -. ds #V .6m -. ds #F 0 -. ds #[ \& -. ds #] \& -.\} -. \" simple accents for nroff and troff -.if n \{\ -. ds ' \& -. ds ` \& -. ds ^ \& -. ds , \& -. ds ~ ~ -. ds / -.\} -.if t \{\ -. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" -. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' -. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' -. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' -. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' -. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' -.\} -. \" troff and (daisy-wheel) nroff accents -.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' -.ds 8 \h'\*(#H'\(*b\h'-\*(#H' -.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] -.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' -.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' -.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] -.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] -.ds ae a\h'-(\w'a'u*4/10)'e -.ds Ae A\h'-(\w'A'u*4/10)'E -. \" corrections for vroff -.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' -.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' -. \" for low resolution devices (crt and lpr) -.if \n(.H>23 .if \n(.V>19 \ -\{\ -. ds : e -. ds 8 ss -. ds o a -. ds d- d\h'-1'\(ga -. ds D- D\h'-1'\(hy -. ds th \o'bp' -. ds Th \o'LP' -. ds ae ae -. ds Ae AE -.\} -.rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "ICEWM-FOCUS_MODE 5" -.TH ICEWM-FOCUS_MODE 5 "2023-12-31" "icewm\ 3.4.5" "Standards, Environments and Macros" +.TH ICEWM-FOCUS_MODE 5 2024-05-24 "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 .nh -.SS "\s-1NAME\s0" +.SS NAME .IX Subsection "NAME" .Vb 1 \& icewm\-focus_mode \- icewm focus mode configuration file .Ve -.SS "\s-1SYNOPSIS\s0" +.SS SYNOPSIS .IX Subsection "SYNOPSIS" .Vb 5 \& $ICEWM_PRIVCFG/focus_mode @@ -152,23 +74,23 @@ \& /etc/X11/icewm/focus_mode \& /usr/share/icewm/focus_mode .Ve -.SS "\s-1DESCRIPTION\s0" +.SS DESCRIPTION .IX Subsection "DESCRIPTION" Defines the initial value for \f(CW\*(C`FocusMode\*(C'\fR. Its default value is \&\f(CW\*(C`FocusMode=1\*(C'\fR (Click-to-focus). This can be changed via the menu. \&\fBicewm\fR will save the Focus menu choice in this file. -.SS "\s-1FORMAT\s0" +.SS FORMAT .IX Subsection "FORMAT" The file contains a single line containing the preferences assignment for \fBFocusMode\fR. -.SS "\s-1EXAMPLES\s0" +.SS EXAMPLES .IX Subsection "EXAMPLES" The following is my \fIfocus_mode\fR file: .PP .Vb 1 \& FocusMode=2 .Ve -.SS "\s-1FILES\s0" +.SS FILES .IX Subsection "FILES" Locations for the \fIfocus_mode\fR file are as follows: .PP @@ -182,14 +104,14 @@ Locations for the \fIfocus_mode\fR file are as follows: .PP The locations are searched in the order listed; the first file found is read and the remainder ignored. -.SS "\s-1SEE ALSO\s0" +.SS "SEE ALSO" .IX Subsection "SEE ALSO" \&\fBicewm\fR\|(1), \&\fBicewm\-preferences\fR\|(5). -.SS "\s-1AUTHOR\s0" +.SS AUTHOR .IX Subsection "AUTHOR" Brian Bidulock <mailto:bidulock@openss7.org>. -.SS "\s-1LICENSE\s0" +.SS LICENSE .IX Subsection "LICENSE" -\&\fBIceWM\fR is licensed under the \s-1GNU\s0 Library General Public License. -See the \fI\s-1COPYING\s0\fR file in the distribution. +\&\fBIceWM\fR is licensed under the GNU Library General Public License. +See the \fICOPYING\fR file in the distribution. diff --git a/upstream/debian-unstable/man5/icewm-keys.5 b/upstream/debian-unstable/man5/icewm-keys.5 index decc01f7..fab94e8e 100644 --- a/upstream/debian-unstable/man5/icewm-keys.5 +++ b/upstream/debian-unstable/man5/icewm-keys.5 @@ -1,4 +1,5 @@ -.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43) +.\" -*- mode: troff; coding: utf-8 -*- +.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== @@ -15,29 +16,12 @@ .ft R .fi .. -.\" Set up some character translations and predefined strings. \*(-- will -.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left -.\" double quote, and \*(R" will give a right double quote. \*(C+ will -.\" give a nicer C++. Capital omega is used to do unbreakable dashes and -.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, -.\" nothing in troff, for use with C<>. -.tr \(*W- -.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ -. ds -- \(*W- -. ds PI pi -. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch -. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch -. ds L" "" -. ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ -. ds -- \|\(em\| -. ds PI \(*p -. ds L" `` -. ds R" '' . ds C` . ds C' 'br\} @@ -68,82 +52,20 @@ . \} .\} .rr rF -.\" -.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). -.\" Fear. Run. Save yourself. No user-serviceable parts. -. \" fudge factors for nroff and troff -.if n \{\ -. ds #H 0 -. ds #V .8m -. ds #F .3m -. ds #[ \f1 -. ds #] \fP -.\} -.if t \{\ -. ds #H ((1u-(\\\\n(.fu%2u))*.13m) -. ds #V .6m -. ds #F 0 -. ds #[ \& -. ds #] \& -.\} -. \" simple accents for nroff and troff -.if n \{\ -. ds ' \& -. ds ` \& -. ds ^ \& -. ds , \& -. ds ~ ~ -. ds / -.\} -.if t \{\ -. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" -. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' -. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' -. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' -. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' -. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' -.\} -. \" troff and (daisy-wheel) nroff accents -.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' -.ds 8 \h'\*(#H'\(*b\h'-\*(#H' -.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] -.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' -.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' -.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] -.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] -.ds ae a\h'-(\w'a'u*4/10)'e -.ds Ae A\h'-(\w'A'u*4/10)'E -. \" corrections for vroff -.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' -.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' -. \" for low resolution devices (crt and lpr) -.if \n(.H>23 .if \n(.V>19 \ -\{\ -. ds : e -. ds 8 ss -. ds o a -. ds d- d\h'-1'\(ga -. ds D- D\h'-1'\(hy -. ds th \o'bp' -. ds Th \o'LP' -. ds ae ae -. ds Ae AE -.\} -.rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "ICEWM-KEYS 5" -.TH ICEWM-KEYS 5 "2023-12-31" "icewm\ 3.4.5" "Standards, Environments and Macros" +.TH ICEWM-KEYS 5 2024-05-24 "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 .nh -.SS "\s-1NAME\s0" +.SS NAME .IX Subsection "NAME" .Vb 1 \& icewm\-keys \- icewm keys configuration file .Ve -.SS "\s-1SYNOPSIS\s0" +.SS SYNOPSIS .IX Subsection "SYNOPSIS" .Vb 5 \& $ICEWM_PRIVCFG/keys @@ -152,7 +74,7 @@ \& /etc/X11/icewm/keys \& /usr/share/icewm/keys .Ve -.SS "\s-1DESCRIPTION\s0" +.SS DESCRIPTION .IX Subsection "DESCRIPTION" The \f(CW\*(C`keys\*(C'\fR file defines global keybindings to launch applications. A keybinding has three parts: the word \fBkey\fR, a double-quoted string @@ -180,24 +102,26 @@ 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 "\s-1FORMAT\s0" +.SS FORMAT .IX Subsection "FORMAT" The syntax of the \fIkeys\fR file is as follows: .RS 4 -.ie n .IP "\fBkey\fR \fB""\fR\fIkey_combination\fR\fB""\fR \fIprogram\fR \fIoptions\fR" 4 -.el .IP "\fBkey\fR \fB``\fR\fIkey_combination\fR\fB''\fR \fIprogram\fR \fIoptions\fR" 4 +.IP "\fBkey\fR \fB""\fR\fIkey_combination\fR\fB""\fR \fIprogram\fR \fIoptions\fR" 4 .IX Item "key ""key_combination"" program options" .RE .RS 4 .RE .PP Where, -.IP "\fBkey\fR" 4 +.IP \fBkey\fR 4 .IX Item "key" The word \fBkey\fR begins the definition of a keybinding. -.IP "\fIkey_combination\fR" 4 +.IP \fIkey_combination\fR 4 .IX Item "key_combination" A combination of modifiers and a key, like \f(CW\*(C`Ctrl+Alt+Delete\*(C'\fR. Valid modifiers are Alt, AltGr, Ctrl, Hyper, Meta, Shift, Super. @@ -211,12 +135,12 @@ Instead of a key, mouse pointer buttons can be specified by It may start with a tilde or an environment variable, which will be expanded. The \fIoptions\fR are passed as arguments to the \fIprogram\fR. -.IP "\fBswitchkey\fR" 4 +.IP \fBswitchkey\fR 4 .IX Item "switchkey" Is an alternative to \fBkey\fR. In this case the \fIprogram\fR must print on standard output the definition of a dynamic \fBicewm\-menu\fR\|(1). This menu will presented as a popup menu. -.SS "\s-1EXAMPLES\s0" +.SS EXAMPLES .IX Subsection "EXAMPLES" Following is the example \fIkeys\fR file that ships with \fBicewm\fR\|(1): .PP @@ -273,7 +197,7 @@ These are key bindings for single window tile operations to replace the \& key "Ctrl+Alt+KP_Left" icesh \-f sizeto 49% 100% top left \& key "Ctrl+Alt+KP_Begin" icesh \-f sizeto 49% 49% center .Ve -.SS "\s-1FILES\s0" +.SS FILES .IX Subsection "FILES" Locations for the \fIkeys\fR file are as follows: .PP @@ -287,13 +211,13 @@ Locations for the \fIkeys\fR file are as follows: .PP The locations are searched in the order listed; the first file found is read and the remainder ignored. -.SS "\s-1SEE ALSO\s0" +.SS "SEE ALSO" .IX Subsection "SEE ALSO" \&\fBicewm\fR\|(1). -.SS "\s-1AUTHOR\s0" +.SS AUTHOR .IX Subsection "AUTHOR" Brian Bidulock <mailto:bidulock@openss7.org>. -.SS "\s-1LICENSE\s0" +.SS LICENSE .IX Subsection "LICENSE" -\&\fBIceWM\fR is licensed under the \s-1GNU\s0 Library General Public License. -See the \fI\s-1COPYING\s0\fR file in the distribution. +\&\fBIceWM\fR is licensed under the GNU Library General Public License. +See the \fICOPYING\fR file in the distribution. diff --git a/upstream/debian-unstable/man5/icewm-menu.5 b/upstream/debian-unstable/man5/icewm-menu.5 index e1b772ed..fa727584 100644 --- a/upstream/debian-unstable/man5/icewm-menu.5 +++ b/upstream/debian-unstable/man5/icewm-menu.5 @@ -1,4 +1,5 @@ -.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43) +.\" -*- mode: troff; coding: utf-8 -*- +.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== @@ -15,29 +16,12 @@ .ft R .fi .. -.\" Set up some character translations and predefined strings. \*(-- will -.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left -.\" double quote, and \*(R" will give a right double quote. \*(C+ will -.\" give a nicer C++. Capital omega is used to do unbreakable dashes and -.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, -.\" nothing in troff, for use with C<>. -.tr \(*W- -.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ -. ds -- \(*W- -. ds PI pi -. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch -. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch -. ds L" "" -. ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ -. ds -- \|\(em\| -. ds PI \(*p -. ds L" `` -. ds R" '' . ds C` . ds C' 'br\} @@ -68,82 +52,20 @@ . \} .\} .rr rF -.\" -.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). -.\" Fear. Run. Save yourself. No user-serviceable parts. -. \" fudge factors for nroff and troff -.if n \{\ -. ds #H 0 -. ds #V .8m -. ds #F .3m -. ds #[ \f1 -. ds #] \fP -.\} -.if t \{\ -. ds #H ((1u-(\\\\n(.fu%2u))*.13m) -. ds #V .6m -. ds #F 0 -. ds #[ \& -. ds #] \& -.\} -. \" simple accents for nroff and troff -.if n \{\ -. ds ' \& -. ds ` \& -. ds ^ \& -. ds , \& -. ds ~ ~ -. ds / -.\} -.if t \{\ -. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" -. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' -. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' -. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' -. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' -. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' -.\} -. \" troff and (daisy-wheel) nroff accents -.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' -.ds 8 \h'\*(#H'\(*b\h'-\*(#H' -.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] -.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' -.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' -.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] -.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] -.ds ae a\h'-(\w'a'u*4/10)'e -.ds Ae A\h'-(\w'A'u*4/10)'E -. \" corrections for vroff -.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' -.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' -. \" for low resolution devices (crt and lpr) -.if \n(.H>23 .if \n(.V>19 \ -\{\ -. ds : e -. ds 8 ss -. ds o a -. ds d- d\h'-1'\(ga -. ds D- D\h'-1'\(hy -. ds th \o'bp' -. ds Th \o'LP' -. ds ae ae -. ds Ae AE -.\} -.rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "ICEWM-MENU 5" -.TH ICEWM-MENU 5 "2023-12-31" "icewm\ 3.4.5" "Standards, Environments and Macros" +.TH ICEWM-MENU 5 2024-05-24 "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 .nh -.SS "\s-1NAME\s0" +.SS NAME .IX Subsection "NAME" .Vb 1 \& icewm\-menu \- icewm menu configuration file .Ve -.SS "\s-1SYNOPSIS\s0" +.SS SYNOPSIS .IX Subsection "SYNOPSIS" .Vb 5 \& $ICEWM_PRIVCFG/menu @@ -152,7 +74,7 @@ \& /etc/X11/icewm/menu \& /usr/share/icewm/menu .Ve -.SS "\s-1DESCRIPTION\s0" +.SS DESCRIPTION .IX Subsection "DESCRIPTION" The \fImenu\fR file is responsible for configuring most of the \fBicewm\fR\|(1) root menu and start menu. @@ -161,53 +83,45 @@ A menu of applications; usually customized by the user. \fBicewm\fR provides the \fBicewm\-menu\-fdo\fR\|(1) program to generate a default menu. Similar programs are \fBxdg_menu\fR\|(1), \fBmmaker\fR\|(1) (MenuMaker), \&\fBxde\-menu\fR\|(1), \fBxdgmenumaker\fR\|(1). -.SS "\s-1FORMAT\s0" +.SS FORMAT .IX Subsection "FORMAT" The file contains lines with the following syntax: -.ie n .IP "\fBprog\fR [\fB""\fR]\fItitle\fR[\fB""\fR] \fIicon\fR \fIprogram\fR \fIoptions\fR" 4 -.el .IP "\fBprog\fR [\fB``\fR]\fItitle\fR[\fB''\fR] \fIicon\fR \fIprogram\fR \fIoptions\fR" 4 +.IP "\fBprog\fR [\fB""\fR]\fItitle\fR[\fB""\fR] \fIicon\fR \fIprogram\fR \fIoptions\fR" 4 .IX Item "prog [""]title[""] icon program options" Specifies a program to execute when the menu item is selected. -.ie n .IP "\fBrestart\fR [\fB""\fR]\fItitle\fR[\fB""\fR] \fIicon\fR \fIprogram\fR \fIoptions\fR" 4 -.el .IP "\fBrestart\fR [\fB``\fR]\fItitle\fR[\fB''\fR] \fIicon\fR \fIprogram\fR \fIoptions\fR" 4 +.IP "\fBrestart\fR [\fB""\fR]\fItitle\fR[\fB""\fR] \fIicon\fR \fIprogram\fR \fIoptions\fR" 4 .IX Item "restart [""]title[""] icon program options" Specifies a program to replace the window manager when the menu item is selected. This is for launching other window managers from within \&\fBicewm\fR\|(1). -.ie n .IP "\fBrunonce\fR [\fB""\fR]\fItitle\fR[\fB""\fR] \fIicon\fR \fB""\fR[\fIres_name\fR][\fB.\fR\fIres_class\fR]\fB""\fR \fIprogram\fR \fIoptions\fR" 4 -.el .IP "\fBrunonce\fR [\fB``\fR]\fItitle\fR[\fB''\fR] \fIicon\fR \fB``\fR[\fIres_name\fR][\fB.\fR\fIres_class\fR]\fB''\fR \fIprogram\fR \fIoptions\fR" 4 +.IP "\fBrunonce\fR [\fB""\fR]\fItitle\fR[\fB""\fR] \fIicon\fR \fB""\fR[\fIres_name\fR][\fB.\fR\fIres_class\fR]\fB""\fR \fIprogram\fR \fIoptions\fR" 4 .IX Item "runonce [""]title[""] icon ""[res_name][.res_class]"" program options" Specifies a program to execute when the menu item is selected; however, if a window of the specified \fIres_name\fR and \fIres_class\fR is present, the program will not be run again. -.ie n .IP "\fBmenu\fR [\fB""\fR]\fItitle\fR[\fB""\fR] \fIicon\fR \fB{\fR # contained items \fB}\fR" 4 -.el .IP "\fBmenu\fR [\fB``\fR]\fItitle\fR[\fB''\fR] \fIicon\fR \fB{\fR # contained items \fB}\fR" 4 +.IP "\fBmenu\fR [\fB""\fR]\fItitle\fR[\fB""\fR] \fIicon\fR \fB{\fR # contained items \fB}\fR" 4 .IX Item "menu [""]title[""] icon { # contained items }" Specifies a sub-menu. The lines that appear between the braces can be any menu item described here. -.ie n .IP "\fBmenufile\fR [\fB""\fR]\fItitle\fR[\fB""\fR] \fIicon\fR [\fB""\fR]\fIfilename\fR[\fB""\fR]" 4 -.el .IP "\fBmenufile\fR [\fB``\fR]\fItitle\fR[\fB''\fR] \fIicon\fR [\fB``\fR]\fIfilename\fR[\fB''\fR]" 4 +.IP "\fBmenufile\fR [\fB""\fR]\fItitle\fR[\fB""\fR] \fIicon\fR [\fB""\fR]\fIfilename\fR[\fB""\fR]" 4 .IX Item "menufile [""]title[""] icon [""]filename[""]" Specifies a file from which to collect sub-menu items (lines) and place them at this point in the menu. -.ie n .IP "\fBmenuprog\fR [\fB""\fR]\fItitle\fR[\fB""\fR] \fIicon\fR \fIprogram\fR \fIoptions\fR" 4 -.el .IP "\fBmenuprog\fR [\fB``\fR]\fItitle\fR[\fB''\fR] \fIicon\fR \fIprogram\fR \fIoptions\fR" 4 +.IP "\fBmenuprog\fR [\fB""\fR]\fItitle\fR[\fB""\fR] \fIicon\fR \fIprogram\fR \fIoptions\fR" 4 .IX Item "menuprog [""]title[""] icon program options" Specifies a program that will print sub-menu items on standard output, which will be collected and placed in the sub-menu at this point. -.ie n .IP "\fBmenuprogreload\fR [\fB""\fR]\fItitle\fR[\fB""\fR] \fIicon\fR \fItimeout\fR \fIprogram\fR \fIoptions\fR" 4 -.el .IP "\fBmenuprogreload\fR [\fB``\fR]\fItitle\fR[\fB''\fR] \fIicon\fR \fItimeout\fR \fIprogram\fR \fIoptions\fR" 4 +.IP "\fBmenuprogreload\fR [\fB""\fR]\fItitle\fR[\fB""\fR] \fIicon\fR \fItimeout\fR \fIprogram\fR \fIoptions\fR" 4 .IX Item "menuprogreload [""]title[""] icon timeout program options" Similar to \fBmenuprog\fR, but after at least \fItimeout\fR seconds the menu is regenerated. -.ie n .IP "\fBinclude\fR [\fB""\fR]\fIfilename\fR[\fB""\fR]" 4 -.el .IP "\fBinclude\fR [\fB``\fR]\fIfilename\fR[\fB''\fR]" 4 +.IP "\fBinclude\fR [\fB""\fR]\fIfilename\fR[\fB""\fR]" 4 .IX Item "include [""]filename[""]" Read additional entries from the file \fIfilename\fR .IP "\fBincludeprog\fR \fIprogram\fR \fIoptions\fR" 4 .IX Item "includeprog program options" Read additional entries from the output of \fIprogram\fR \fIoptions\fR. -.IP "\fBseparator\fR" 4 +.IP \fBseparator\fR 4 .IX Item "separator" A separator for menu items. .PP @@ -215,18 +129,16 @@ Where .IP "\fBprog\fR, \fBrestart\fR, \fBrunonce\fR, \fBmenu\fR, \fBmenufile\fR, \fBmenuprog\fR, \fBmenuprogreload\fR, \fBinclude\fR, \fBincludeprog\fR, \fBseparator\fR" 4 .IX Item "prog, restart, runonce, menu, menufile, menuprog, menuprogreload, include, includeprog, separator" These are literal string keywords. -.ie n .IP "[\fB""\fR]\fItitle\fR[\fB""\fR]" 4 -.el .IP "[\fB``\fR]\fItitle\fR[\fB''\fR]" 4 +.IP "[\fB""\fR]\fItitle\fR[\fB""\fR]" 4 .IX Item "[""]title[""]" This is the \fItitle\fR string associated with the menu item that is displayed in the menu. When the \fItitle\fR contains spaces, the title must be surrounded by double quotes (\f(CW\*(C`\*(C'\fR). -.IP "\fIicon\fR" 4 +.IP \fIicon\fR 4 .IX Item "icon" Is the name of the icon file (with or without extension) or the full path to an icon file. -.ie n .IP "\fB""\fR[\fIres_name\fR][\fB.\fR\fIres_class\fR]\fB""\fR" 4 -.el .IP "\fB``\fR[\fIres_name\fR][\fB.\fR\fIres_class\fR]\fB''\fR" 4 +.IP "\fB""\fR[\fIres_name\fR][\fB.\fR\fIres_class\fR]\fB""\fR" 4 .IX Item """[res_name][.res_class]""" \&\fIres_name\fR is the resource name of a window launched by \fIprogram\fR and \&\fIres_class\fR is the resource class of the window. Only one of @@ -242,13 +154,13 @@ standard output the contents of the menu and is used for dynamic menus. .Sp \&\fIoptions\fR are the options and arguments passed to the \fIprogram\fR verbatim. -.IP "\fIfilename\fR" 4 +.IP \fIfilename\fR 4 .IX Item "filename" \&\fIfilename\fR is the name of the file relative to one of the \fBicewm\fR\|(1) configuration directories, or the full path to a file. The file is used with the \fBmenufile\fR keyword and specifies the file from which to read further menu items. -.SS "\s-1EXAMPLES\s0" +.SS EXAMPLES .IX Subsection "EXAMPLES" Following is the example \fImenu\fR file that ships with \fBicewm\fR\|(1): .PP @@ -271,7 +183,7 @@ Following is the example \fImenu\fR file that ships with \fBicewm\fR\|(1): \& menufile Programs folder programs \& menufile Tool_bar folder toolbar .Ve -.SS "\s-1FILES\s0" +.SS FILES .IX Subsection "FILES" Locations for the \fImenu\fR file are as follows: .PP @@ -285,14 +197,14 @@ Locations for the \fImenu\fR file are as follows: .PP The locations are searched in the order listed; the first file found is read and the remainder ignored. -.SS "\s-1SEE ALSO\s0" +.SS "SEE ALSO" .IX Subsection "SEE ALSO" \&\fBicewm\fR\|(1), \&\fBicewm\-menu\-fdo\fR\|(1). -.SS "\s-1AUTHOR\s0" +.SS AUTHOR .IX Subsection "AUTHOR" Brian Bidulock <mailto:bidulock@openss7.org>. -.SS "\s-1LICENSE\s0" +.SS LICENSE .IX Subsection "LICENSE" -\&\fBIceWM\fR is licensed under the \s-1GNU\s0 Library General Public License. -See the \fI\s-1COPYING\s0\fR file in the distribution. +\&\fBIceWM\fR is licensed under the GNU Library General Public License. +See the \fICOPYING\fR file in the distribution. diff --git a/upstream/debian-unstable/man5/icewm-preferences.5 b/upstream/debian-unstable/man5/icewm-preferences.5 index e3228cbe..94761d7e 100644 --- a/upstream/debian-unstable/man5/icewm-preferences.5 +++ b/upstream/debian-unstable/man5/icewm-preferences.5 @@ -1,4 +1,5 @@ -.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43) +.\" -*- mode: troff; coding: utf-8 -*- +.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== @@ -15,29 +16,12 @@ .ft R .fi .. -.\" Set up some character translations and predefined strings. \*(-- will -.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left -.\" double quote, and \*(R" will give a right double quote. \*(C+ will -.\" give a nicer C++. Capital omega is used to do unbreakable dashes and -.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, -.\" nothing in troff, for use with C<>. -.tr \(*W- -.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ -. ds -- \(*W- -. ds PI pi -. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch -. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch -. ds L" "" -. ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ -. ds -- \|\(em\| -. ds PI \(*p -. ds L" `` -. ds R" '' . ds C` . ds C' 'br\} @@ -68,82 +52,20 @@ . \} .\} .rr rF -.\" -.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). -.\" Fear. Run. Save yourself. No user-serviceable parts. -. \" fudge factors for nroff and troff -.if n \{\ -. ds #H 0 -. ds #V .8m -. ds #F .3m -. ds #[ \f1 -. ds #] \fP -.\} -.if t \{\ -. ds #H ((1u-(\\\\n(.fu%2u))*.13m) -. ds #V .6m -. ds #F 0 -. ds #[ \& -. ds #] \& -.\} -. \" simple accents for nroff and troff -.if n \{\ -. ds ' \& -. ds ` \& -. ds ^ \& -. ds , \& -. ds ~ ~ -. ds / -.\} -.if t \{\ -. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" -. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' -. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' -. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' -. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' -. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' -.\} -. \" troff and (daisy-wheel) nroff accents -.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' -.ds 8 \h'\*(#H'\(*b\h'-\*(#H' -.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] -.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' -.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' -.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] -.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] -.ds ae a\h'-(\w'a'u*4/10)'e -.ds Ae A\h'-(\w'A'u*4/10)'E -. \" corrections for vroff -.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' -.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' -. \" for low resolution devices (crt and lpr) -.if \n(.H>23 .if \n(.V>19 \ -\{\ -. ds : e -. ds 8 ss -. ds o a -. ds d- d\h'-1'\(ga -. ds D- D\h'-1'\(hy -. ds th \o'bp' -. ds Th \o'LP' -. ds ae ae -. ds Ae AE -.\} -.rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "ICEWM-PREFERENCES 5" -.TH ICEWM-PREFERENCES 5 "2023-12-31" "icewm\ 3.4.5" "Standards, Environments and Macros" +.TH ICEWM-PREFERENCES 5 2024-05-24 "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 .nh -.SS "\s-1NAME\s0" +.SS NAME .IX Subsection "NAME" .Vb 1 \& icewm\-preferences \- icewm preferences configuration file .Ve -.SS "\s-1SYNOPSIS\s0" +.SS SYNOPSIS .IX Subsection "SYNOPSIS" .Vb 5 \& $ICEWM_PRIVCFG/preferences @@ -152,494 +74,489 @@ \& /etc/X11/icewm/preferences \& /usr/share/icewm/preferences .Ve -.SS "\s-1DESCRIPTION\s0" +.SS DESCRIPTION .IX Subsection "DESCRIPTION" Contains general settings like paths, colors and fonts, but also options to control the \fBicewm\fR focus behaviour and the applets that are started in the task bar. The \fBicewm\fR installation will provide a default \fIpreferences\fR file, that can be copied to the \fBicewm\fR user configuration directory and modified. -.SS "\s-1FORMAT\s0" +.SS FORMAT .IX Subsection "FORMAT" -.SS "\s-1FOCUS AND BEHAVIOR\s0" +.SS "FOCUS AND BEHAVIOR" .IX Subsection "FOCUS AND BEHAVIOR" The following preferences affect focus and general behavior of \&\fBicewm\fR\|(1): -.IP "\fBAlpha\fR=0" 4 +.IP \fBAlpha\fR=0 4 .IX Item "Alpha=0" Use a 32\-bit visual for alpha blending -.IP "\fBSynchronize\fR=0" 4 +.IP \fBSynchronize\fR=0 4 .IX Item "Synchronize=0" Synchronize X11 for debugging (slow) -.IP "\fBLogEvents\fR=0" 4 +.IP \fBLogEvents\fR=0 4 .IX Item "LogEvents=0" Enable event logging for debugging -.ie n .IP "\fBOutputFile\fR=""""" 4 -.el .IP "\fBOutputFile\fR=``''" 4 +.IP "\fBOutputFile\fR=""""" 4 .IX Item "OutputFile=""""" -Redirect all output to \fI\s-1FILE\s0\fR. +Redirect all output to \fIFILE\fR. A leading tilde or environment variable is expanded. -This file is truncated on startup if it exceeds 5 \s-1KB.\s0 -.ie n .IP "\fBSplash\fR=""""" 4 -.el .IP "\fBSplash\fR=``''" 4 +This file is truncated on startup if it exceeds 5 KB. +.IP "\fBSplash\fR=""""" 4 .IX Item "Splash=""""" Splash image on startup (IceWM.jpg) -.ie n .IP "\fBTrace\fR=""""" 4 -.el .IP "\fBTrace\fR=``''" 4 +.IP "\fBTrace\fR=""""" 4 .IX Item "Trace=""""" Enable tracing for the given list of modules. Modules that are traceable include \fBconf, font, icon, prog, systray\fR. -.IP "\fBClickToFocus\fR=1" 4 +.IP \fBClickToFocus\fR=1 4 .IX Item "ClickToFocus=1" Focus windows by clicking in them. -.IP "\fBFocusOnAppRaise\fR=0" 4 +.IP \fBFocusOnAppRaise\fR=0 4 .IX Item "FocusOnAppRaise=0" Focus windows when applications request that they be raised. -.IP "\fBRequestFocusOnAppRaise\fR=1" 4 +.IP \fBRequestFocusOnAppRaise\fR=1 4 .IX Item "RequestFocusOnAppRaise=1" Request focus (flashing in taskbar) when application requests raise. -.IP "\fBRaiseOnFocus\fR=1" 4 +.IP \fBRaiseOnFocus\fR=1 4 .IX Item "RaiseOnFocus=1" Raise windows when focused. -.IP "\fBFocusOnClickClient\fR=1" 4 +.IP \fBFocusOnClickClient\fR=1 4 .IX Item "FocusOnClickClient=1" Focus window when client area clicked. -.IP "\fBRaiseOnClickClient\fR=1" 4 +.IP \fBRaiseOnClickClient\fR=1 4 .IX Item "RaiseOnClickClient=1" Raise window when client area clicked. -.IP "\fBRaiseOnClickTitleBar\fR=1" 4 +.IP \fBRaiseOnClickTitleBar\fR=1 4 .IX Item "RaiseOnClickTitleBar=1" Raise window when title bar is clicked. -.IP "\fBRaiseOnClickButton\fR=1" 4 +.IP \fBRaiseOnClickButton\fR=1 4 .IX Item "RaiseOnClickButton=1" Raise window when frame button is clicked. -.IP "\fBRaiseOnClickFrame\fR=1" 4 +.IP \fBRaiseOnClickFrame\fR=1 4 .IX Item "RaiseOnClickFrame=1" Raise window when frame border is clicked. -.IP "\fBLowerOnClickWhenRaised\fR=0" 4 +.IP \fBLowerOnClickWhenRaised\fR=0 4 .IX Item "LowerOnClickWhenRaised=0" Lower the active window when clicked again. -.IP "\fBPassFirstClickToClient\fR=1" 4 +.IP \fBPassFirstClickToClient\fR=1 4 .IX Item "PassFirstClickToClient=1" Pass focusing click on client area to client. -.IP "\fBFocusChangesWorkspace\fR=0" 4 +.IP \fBFocusChangesWorkspace\fR=0 4 .IX Item "FocusChangesWorkspace=0" Change to the workspace of newly focused windows. -.IP "\fBFocusCurrentWorkspace\fR=0" 4 +.IP \fBFocusCurrentWorkspace\fR=0 4 .IX Item "FocusCurrentWorkspace=0" Move newly focused windows to current workspace. -.IP "\fBFocusOnMap\fR=1" 4 +.IP \fBFocusOnMap\fR=1 4 .IX Item "FocusOnMap=1" Focus normal window when initially mapped. -.IP "\fBFocusOnMapTransient\fR=0" 4 +.IP \fBFocusOnMapTransient\fR=0 4 .IX Item "FocusOnMapTransient=0" Focus dialog window when initially mapped. -.IP "\fBFocusOnMapTransientActive\fR=1" 4 +.IP \fBFocusOnMapTransientActive\fR=1 4 .IX Item "FocusOnMapTransientActive=1" Focus dialog window when initially mapped only if parent frame focused. -.IP "\fBMapInactiveOnTop\fR=1" 4 +.IP \fBMapInactiveOnTop\fR=1 4 .IX Item "MapInactiveOnTop=1" Put new windows on top even if not focusing them. -.IP "\fBPointerColormap\fR=1" 4 +.IP \fBPointerColormap\fR=1 4 .IX Item "PointerColormap=1" Colormap focus follows pointer. -.IP "\fBDontRotateMenuPointer\fR=1" 4 +.IP \fBDontRotateMenuPointer\fR=1 4 .IX Item "DontRotateMenuPointer=1" Don't rotate the cursor for popup menus. -.IP "\fBLimitSize\fR=1" 4 +.IP \fBLimitSize\fR=1 4 .IX Item "LimitSize=1" Limit size of windows to screen. -.IP "\fBLimitPosition\fR=1" 4 +.IP \fBLimitPosition\fR=1 4 .IX Item "LimitPosition=1" Limit position of windows to screen. -.IP "\fBLimitByDockLayer\fR=0" 4 +.IP \fBLimitByDockLayer\fR=0 4 .IX Item "LimitByDockLayer=0" -Let the Dock layer limit the workspace (incompatible with \s-1GNOME\s0 Panel). -.IP "\fBConsiderHBorder\fR=0" 4 +Let the Dock layer limit the workspace (incompatible with GNOME Panel). +.IP \fBConsiderHBorder\fR=0 4 .IX Item "ConsiderHBorder=0" Consider border frames when maximizing horizontally. -.IP "\fBConsiderVBorder\fR=0" 4 +.IP \fBConsiderVBorder\fR=0 4 .IX Item "ConsiderVBorder=0" Consider border frames when maximizing vertically. -.IP "\fBConsiderSizeHintsMaximized\fR=1" 4 +.IP \fBConsiderSizeHintsMaximized\fR=1 4 .IX Item "ConsiderSizeHintsMaximized=1" Consider XSizeHints if frame is maximized. Turning this off allows the titlebar to cover the width of the screen. -.IP "\fBCenterMaximizedWindows\fR=0" 4 +.IP \fBCenterMaximizedWindows\fR=0 4 .IX Item "CenterMaximizedWindows=0" Center maximized windows that can't fit the screen (like terminals). -.IP "\fBHideBordersMaximized\fR=0" 4 +.IP \fBHideBordersMaximized\fR=0 4 .IX Item "HideBordersMaximized=0" Hide window borders if window is maximized. -.IP "\fBSizeMaximized\fR=0" 4 +.IP \fBSizeMaximized\fR=0 4 .IX Item "SizeMaximized=0" Maximized windows can be resized. -.IP "\fBShowMoveSizeStatus\fR=1" 4 +.IP \fBShowMoveSizeStatus\fR=1 4 .IX Item "ShowMoveSizeStatus=1" Show position status window during move/resize. -.IP "\fBShowWorkspaceStatus\fR=1" 4 +.IP \fBShowWorkspaceStatus\fR=1 4 .IX Item "ShowWorkspaceStatus=1" Show name of current workspace while switching. -.IP "\fBMinimizeToDesktop\fR=0" 4 +.IP \fBMinimizeToDesktop\fR=0 4 .IX Item "MinimizeToDesktop=0" Display mini-icons on desktop for minimized windows. -.IP "\fBMiniIconsPlaceHorizontal\fR=0" 4 +.IP \fBMiniIconsPlaceHorizontal\fR=0 4 .IX Item "MiniIconsPlaceHorizontal=0" Place the mini-icons horizontal instead of vertical. -.IP "\fBMiniIconsRightToLeft\fR=0" 4 +.IP \fBMiniIconsRightToLeft\fR=0 4 .IX Item "MiniIconsRightToLeft=0" Place new mini-icons from right to left. -.IP "\fBMiniIconsBottomToTop\fR=0" 4 +.IP \fBMiniIconsBottomToTop\fR=0 4 .IX Item "MiniIconsBottomToTop=0" Place new mini-icons from bottom to top. -.IP "\fBStrongPointerFocus\fR=0" 4 +.IP \fBStrongPointerFocus\fR=0 4 .IX Item "StrongPointerFocus=0" Always maintain focus under mouse window. Makes some keyboard support non-functional or unreliable. -.IP "\fBOpaqueMove\fR=1" 4 +.IP \fBOpaqueMove\fR=1 4 .IX Item "OpaqueMove=1" Opaque window move. -.IP "\fBOpaqueResize\fR=1" 4 +.IP \fBOpaqueResize\fR=1 4 .IX Item "OpaqueResize=1" Opaque window resize. -.IP "\fBManualPlacement\fR=0" 4 +.IP \fBManualPlacement\fR=0 4 .IX Item "ManualPlacement=0" Windows initially placed manually by user. -.IP "\fBSmartPlacement\fR=1" 4 +.IP \fBSmartPlacement\fR=1 4 .IX Item "SmartPlacement=1" Smart window placement (minimal overlap). -.IP "\fBHideTitleBarWhenMaximized\fR=0" 4 +.IP \fBHideTitleBarWhenMaximized\fR=0 4 .IX Item "HideTitleBarWhenMaximized=0" Hide title bar when maximized. -.IP "\fBCenterLarge\fR=0" 4 +.IP \fBCenterLarge\fR=0 4 .IX Item "CenterLarge=0" Center large windows. -.IP "\fBCenterTransientsOnOwner\fR=1" 4 +.IP \fBCenterTransientsOnOwner\fR=1 4 .IX Item "CenterTransientsOnOwner=1" Center dialogs on owner window. -.IP "\fBMenuMouseTracking\fR=0" 4 +.IP \fBMenuMouseTracking\fR=0 4 .IX Item "MenuMouseTracking=0" Menus track mouse even with no mouse buttons held. -.IP "\fBAutoRaise\fR=0" 4 +.IP \fBAutoRaise\fR=0 4 .IX Item "AutoRaise=0" Raise windows when the mouse pointer enters, after a delay of \&\fIAutoRaiseDelay\fR milliseconds. Note that \f(CW\*(C`RaiseOnFocus=1\*(C'\fR may interfere. -.IP "\fBDelayPointerFocus\fR=1" 4 +.IP \fBDelayPointerFocus\fR=1 4 .IX Item "DelayPointerFocus=1" Delay pointer focusing when mouse moves. -.IP "\fBWin95Keys\fR=1" 4 +.IP \fBWin95Keys\fR=1 4 .IX Item "Win95Keys=1" Support the Windows/Super key modifier to activate special functions. The left Super key toggles the Start menu, while the right Super key toggles the Window list window. -.IP "\fBModSuperIsCtrlAlt\fR=0" 4 +.IP \fBModSuperIsCtrlAlt\fR=0 4 .IX Item "ModSuperIsCtrlAlt=0" Treat the Super/Win key modifier as a synonym for the Ctrl+Alt modifier combination. The default key bindings have many occurrences of Ctrl+Alt. If you enable this, then the Super modifier is an alternative way to activate them. -.IP "\fBUseMouseWheel\fR=0" 4 +.IP \fBUseMouseWheel\fR=0 4 .IX Item "UseMouseWheel=0" Support mouse wheel. When pressing Ctrl+Alt rotating the mouse wheel on the root window will cycle the focus over the windows. -.IP "\fBTaskBarTaskGrouping\fR=0" 4 +.IP \fBTaskBarTaskGrouping\fR=0 4 .IX Item "TaskBarTaskGrouping=0" Group applications with the same class name under a single task button. 0 disables it, 1 shows the number of windows, 2 shows bread crumbs, 3 shows a number + bread crumbs. -.IP "\fBShowPopupsAbovePointer\fR=0" 4 +.IP \fBShowPopupsAbovePointer\fR=0 4 .IX Item "ShowPopupsAbovePointer=0" Show popup menus above mouse pointer. -.IP "\fBReplayMenuCancelClick\fR=0" 4 +.IP \fBReplayMenuCancelClick\fR=0 4 .IX Item "ReplayMenuCancelClick=0" Send the clicks outside menus to target window. -.IP "\fBClientWindowMouseActions\fR=1" 4 +.IP \fBClientWindowMouseActions\fR=1 4 .IX Item "ClientWindowMouseActions=1" Allow mouse actions on client windows. This is buggy with some programs. -.IP "\fBGrabRootWindow\fR=1" 4 +.IP \fBGrabRootWindow\fR=1 4 .IX Item "GrabRootWindow=1" -Manage root window (\s-1EXPERIMENTAL\s0 \- normally enabled!). -.IP "\fBSnapMove\fR=1" 4 +Manage root window (EXPERIMENTAL \- normally enabled!). +.IP \fBSnapMove\fR=1 4 .IX Item "SnapMove=1" Snap to nearest screen edge/window when moving windows. .IP "\fBSnapDistance\fR=8 [0\-64]" 4 .IX Item "SnapDistance=8 [0-64]" Distance in pixels before windows snap together. -.IP "\fBArrangeWindowsOnScreenSizeChange\fR=1" 4 +.IP \fBArrangeWindowsOnScreenSizeChange\fR=1 4 .IX Item "ArrangeWindowsOnScreenSizeChange=1" Automatically arrange windows when screen size changes. -.IP "\fBAllowFullscreen\fR=1" 4 +.IP \fBAllowFullscreen\fR=1 4 .IX Item "AllowFullscreen=1" Allow to switch a window to fullscreen. -.IP "\fBFullscreenUseAllMonitors\fR=0" 4 +.IP \fBFullscreenUseAllMonitors\fR=0 4 .IX Item "FullscreenUseAllMonitors=0" Span over all available screens if window goes into fullscreen. .IP "\fBMsgBoxDefaultAction\fR=0 [0\-1]" 4 .IX Item "MsgBoxDefaultAction=0 [0-1]" -Preselect to Cancel (0) or the \s-1OK\s0 (1) button in message boxes. +Preselect to Cancel (0) or the OK (1) button in message boxes. .IP "\fBNetWorkAreaBehaviour\fR=0 [0\-2]" 4 .IX Item "NetWorkAreaBehaviour=0 [0-2]" -\&\s-1NET_WORKAREA\s0 behaviour: 0 (single/multi\-monitor with \s-1STRUT\s0 information, -like metacity), 1 (always full desktop), 2 (single monitor with \s-1STRUT,\s0 -multi-monitor without \s-1STRUT\s0). -.SS "\s-1QUICK SWITCH\s0" +NET_WORKAREA behaviour: 0 (single/multi\-monitor with STRUT information, +like metacity), 1 (always full desktop), 2 (single monitor with STRUT, +multi-monitor without STRUT). +.SS "QUICK SWITCH" .IX Subsection "QUICK SWITCH" -.IP "\fBQuickSwitch\fR=1" 4 +.IP \fBQuickSwitch\fR=1 4 .IX Item "QuickSwitch=1" Enable Alt+Tab window switching. -.IP "\fBQuickSwitchToMinimized\fR=1" 4 +.IP \fBQuickSwitchToMinimized\fR=1 4 .IX Item "QuickSwitchToMinimized=1" Enable Alt+Tab to minimized windows. -.IP "\fBQuickSwitchToHidden\fR=1" 4 +.IP \fBQuickSwitchToHidden\fR=1 4 .IX Item "QuickSwitchToHidden=1" Enable Alt+Tab to hidden windows. -.IP "\fBQuickSwitchToUrgent\fR=1" 4 +.IP \fBQuickSwitchToUrgent\fR=1 4 .IX Item "QuickSwitchToUrgent=1" Prioritize Alt+Tab to urgent windows. -.IP "\fBQuickSwitchToAllWorkspaces\fR=0" 4 +.IP \fBQuickSwitchToAllWorkspaces\fR=0 4 .IX Item "QuickSwitchToAllWorkspaces=0" Include windows from all workspaces in Alt+Tab. -.IP "\fBQuickSwitchGroupWorkspaces\fR=1" 4 +.IP \fBQuickSwitchGroupWorkspaces\fR=1 4 .IX Item "QuickSwitchGroupWorkspaces=1" Group windows by workspace together in Alt+Tab. -.IP "\fBQuickSwitchPersistence\fR=0" 4 +.IP \fBQuickSwitchPersistence\fR=0 4 .IX Item "QuickSwitchPersistence=0" Time in seconds to remember the state of Alt+Tab. -.IP "\fBQuickSwitchRaiseCandidate\fR=0" 4 +.IP \fBQuickSwitchRaiseCandidate\fR=0 4 .IX Item "QuickSwitchRaiseCandidate=0" Raise a selected window while Alt+Tabbing in the QuickSwitch. -.IP "\fBQuickSwitchAllIcons\fR=1" 4 +.IP \fBQuickSwitchAllIcons\fR=1 4 .IX Item "QuickSwitchAllIcons=1" Show all reachable icons when quick switching. -.IP "\fBQuickSwitchTextFirst\fR=0" 4 +.IP \fBQuickSwitchTextFirst\fR=0 4 .IX Item "QuickSwitchTextFirst=0" Show the window title above (all reachable) icons. -.IP "\fBQuickSwitchSmallWindow\fR=0" 4 +.IP \fBQuickSwitchSmallWindow\fR=0 4 .IX Item "QuickSwitchSmallWindow=0" Create a smaller QuickSwitch window of 1/3 screen width. -.IP "\fBQuickSwitchMaxWidth\fR=0" 4 +.IP \fBQuickSwitchMaxWidth\fR=0 4 .IX Item "QuickSwitchMaxWidth=0" Go trough all window titles and choose width of the longest one. -.IP "\fBQuickSwitchVertical\fR=1" 4 +.IP \fBQuickSwitchVertical\fR=1 4 .IX Item "QuickSwitchVertical=1" Place the icons and titles vertical instead of horizontal. -.IP "\fBQuickSwitchHugeIcon\fR=0" 4 +.IP \fBQuickSwitchHugeIcon\fR=0 4 .IX Item "QuickSwitchHugeIcon=0" Show the huge (48x48) of the window icon for the active window. -.IP "\fBQuickSwitchFillSelection\fR=0" 4 +.IP \fBQuickSwitchFillSelection\fR=0 4 .IX Item "QuickSwitchFillSelection=0" Fill the rectangle highlighting the current icon. -.SS "\s-1EDGE SWITCHING\s0" +.SS "EDGE SWITCHING" .IX Subsection "EDGE SWITCHING" -.IP "\fBEdgeSwitch\fR=0" 4 +.IP \fBEdgeSwitch\fR=0 4 .IX Item "EdgeSwitch=0" Workspace switches by moving mouse to left/right screen edge. -.IP "\fBHorizontalEdgeSwitch\fR=0" 4 +.IP \fBHorizontalEdgeSwitch\fR=0 4 .IX Item "HorizontalEdgeSwitch=0" Workspace switches by moving mouse to left/right screen edge. -.IP "\fBVerticalEdgeSwitch\fR=0" 4 +.IP \fBVerticalEdgeSwitch\fR=0 4 .IX Item "VerticalEdgeSwitch=0" Workspace switches by moving mouse to top/bottom screen edge. -.IP "\fBContinuousEdgeSwitch\fR=1" 4 +.IP \fBContinuousEdgeSwitch\fR=1 4 .IX Item "ContinuousEdgeSwitch=1" Workspace switches continuously when moving mouse to screen edge. .IP "\fBEdgeResistance\fR=32 [0\-10000]" 4 .IX Item "EdgeResistance=32 [0-10000]" Resistance in pixels when trying to move windows off the screen (10000 = infinite). -.SS "\s-1TASK BAR\s0" +.SS "TASK BAR" .IX Subsection "TASK BAR" The following preferences affect the \fBicewm\fR\|(1) task bar: -.IP "\fBShowTaskBar\fR=1" 4 +.IP \fBShowTaskBar\fR=1 4 .IX Item "ShowTaskBar=1" Show task bar. -.IP "\fBTaskBarAtTop\fR=0" 4 +.IP \fBTaskBarAtTop\fR=0 4 .IX Item "TaskBarAtTop=0" Task bar at top of the screen. -.IP "\fBTaskBarKeepBelow\fR=0" 4 +.IP \fBTaskBarKeepBelow\fR=0 4 .IX Item "TaskBarKeepBelow=0" Keep the task bar below regular windows. -.IP "\fBTaskBarAutoHide\fR=0" 4 +.IP \fBTaskBarAutoHide\fR=0 4 .IX Item "TaskBarAutoHide=0" Auto hide task bar after delay. -.IP "\fBTaskBarFullscreenAutoShow\fR=1" 4 +.IP \fBTaskBarFullscreenAutoShow\fR=1 4 .IX Item "TaskBarFullscreenAutoShow=1" Auto show task bar when fullscreen window active. -.IP "\fBTaskBarShowClock\fR=1" 4 +.IP \fBTaskBarShowClock\fR=1 4 .IX Item "TaskBarShowClock=1" Show clock on task bar. -.IP "\fBTaskBarShowAPMStatus\fR=0" 4 +.IP \fBTaskBarShowAPMStatus\fR=0 4 .IX Item "TaskBarShowAPMStatus=0" Show battery status monitor on task bar. -.IP "\fBTaskBarShowAPMAuto\fR=1" 4 +.IP \fBTaskBarShowAPMAuto\fR=1 4 .IX Item "TaskBarShowAPMAuto=1" Enable TaskBarShowAPMStatus if a battery is present. -.IP "\fBTaskBarShowAPMTime\fR=1" 4 +.IP \fBTaskBarShowAPMTime\fR=1 4 .IX Item "TaskBarShowAPMTime=1" Show battery status on task bar in time-format -.IP "\fBTaskBarShowAPMGraph\fR=1" 4 +.IP \fBTaskBarShowAPMGraph\fR=1 4 .IX Item "TaskBarShowAPMGraph=1" Show battery status in graph mode. -.IP "\fBTaskBarShowMailboxStatus\fR=1" 4 +.IP \fBTaskBarShowMailboxStatus\fR=1 4 .IX Item "TaskBarShowMailboxStatus=1" Show mailbox status on task bar. -.IP "\fBTaskBarMailboxStatusBeepOnNewMail\fR=0" 4 +.IP \fBTaskBarMailboxStatusBeepOnNewMail\fR=0 4 .IX Item "TaskBarMailboxStatusBeepOnNewMail=0" Beep when new mail arrives. -.IP "\fBTaskBarMailboxStatusCountMessages\fR=0" 4 +.IP \fBTaskBarMailboxStatusCountMessages\fR=0 4 .IX Item "TaskBarMailboxStatusCountMessages=0" Count messages in mailbox. -.IP "\fBTaskBarShowWorkspaces\fR=1" 4 +.IP \fBTaskBarShowWorkspaces\fR=1 4 .IX Item "TaskBarShowWorkspaces=1" Show workspace switching buttons on task bar. -.IP "\fBTaskBarShowWindows\fR=1" 4 +.IP \fBTaskBarShowWindows\fR=1 4 .IX Item "TaskBarShowWindows=1" Show windows on the taskbar. -.IP "\fBTaskBarShowShowDesktopButton\fR=1" 4 +.IP \fBTaskBarShowShowDesktopButton\fR=1 4 .IX Item "TaskBarShowShowDesktopButton=1" Show 'show desktop' button on taskbar. If set to 2, it will move the icon to the right side, after the clock. -.IP "\fBShowEllipsis\fR=1" 4 +.IP \fBShowEllipsis\fR=1 4 .IX Item "ShowEllipsis=1" Show Ellipsis in taskbar items. -.IP "\fBTaskBarShowTray\fR=1" 4 +.IP \fBTaskBarShowTray\fR=1 4 .IX Item "TaskBarShowTray=1" Show windows in the tray. -.IP "\fBTaskBarEnableSystemTray\fR=1" 4 +.IP \fBTaskBarEnableSystemTray\fR=1 4 .IX Item "TaskBarEnableSystemTray=1" Enable the system tray in the taskbar. -.IP "\fBTrayShowAllWindows\fR=1" 4 +.IP \fBTrayShowAllWindows\fR=1 4 .IX Item "TrayShowAllWindows=1" Show windows from all workspaces on tray. -.IP "\fBTaskBarShowTransientWindows\fR=1" 4 +.IP \fBTaskBarShowTransientWindows\fR=1 4 .IX Item "TaskBarShowTransientWindows=1" Show transient (dialogs, ...) windows on task bar. -.IP "\fBTaskBarShowAllWindows\fR=0" 4 +.IP \fBTaskBarShowAllWindows\fR=0 4 .IX Item "TaskBarShowAllWindows=0" Show windows from all workspaces on task bar. -.IP "\fBTaskBarShowWindowIcons\fR=1" 4 +.IP \fBTaskBarShowWindowIcons\fR=1 4 .IX Item "TaskBarShowWindowIcons=1" Show icons of windows on task buttons of the task bar. -.IP "\fBTaskBarShowWindowTitles\fR=1" 4 +.IP \fBTaskBarShowWindowTitles\fR=1 4 .IX Item "TaskBarShowWindowTitles=1" Show titles of windows on task buttons of the task bar. -.IP "\fBTaskBarShowStartMenu\fR=1" 4 +.IP \fBTaskBarShowStartMenu\fR=1 4 .IX Item "TaskBarShowStartMenu=1" Show 'Start' menu on task bar. -.IP "\fBTaskBarShowWindowListMenu\fR=1" 4 +.IP \fBTaskBarShowWindowListMenu\fR=1 4 .IX Item "TaskBarShowWindowListMenu=1" Show 'window list' menu on task bar. -.IP "\fBTaskBarShowCPUStatus\fR=1" 4 +.IP \fBTaskBarShowCPUStatus\fR=1 4 .IX Item "TaskBarShowCPUStatus=1" -Show \s-1CPU\s0 status on task bar (Linux & Solaris). -.IP "\fBCPUStatusShowRamUsage\fR=1" 4 +Show CPU status on task bar (Linux & Solaris). +.IP \fBCPUStatusShowRamUsage\fR=1 4 .IX Item "CPUStatusShowRamUsage=1" -Show \s-1RAM\s0 usage in \s-1CPU\s0 status tool tip. -.IP "\fBCPUStatusShowSwapUsage\fR=1" 4 +Show RAM usage in CPU status tool tip. +.IP \fBCPUStatusShowSwapUsage\fR=1 4 .IX Item "CPUStatusShowSwapUsage=1" -Show swap usage in \s-1CPU\s0 status tool tip. -.IP "\fBCPUStatusShowAcpiTemp\fR=1" 4 +Show swap usage in CPU status tool tip. +.IP \fBCPUStatusShowAcpiTemp\fR=1 4 .IX Item "CPUStatusShowAcpiTemp=1" -Show \s-1ACPI\s0 temperature in \s-1CPU\s0 status tool tip. -.IP "\fBCPUStatusShowAcpiTempInGraph\fR=0" 4 +Show ACPI temperature in CPU status tool tip. +.IP \fBCPUStatusShowAcpiTempInGraph\fR=0 4 .IX Item "CPUStatusShowAcpiTempInGraph=0" -Show \s-1ACPI\s0 temperature in \s-1CPU\s0 status bar. -.IP "\fBCPUStatusShowCpuFreq\fR=1" 4 +Show ACPI temperature in CPU status bar. +.IP \fBCPUStatusShowCpuFreq\fR=1 4 .IX Item "CPUStatusShowCpuFreq=1" -Show \s-1CPU\s0 frequency in \s-1CPU\s0 status tool tip. -.IP "\fBNetStatusShowOnlyRunning\fR=0" 4 +Show CPU frequency in CPU status tool tip. +.IP \fBNetStatusShowOnlyRunning\fR=0 4 .IX Item "NetStatusShowOnlyRunning=0" Show network status only for connected devices, such as an active Ethernet link or associated wireless interface. If false, any network interface that has been brought up will be displayed. -.IP "\fBTaskBarShowMEMStatus\fR=1" 4 +.IP \fBTaskBarShowMEMStatus\fR=1 4 .IX Item "TaskBarShowMEMStatus=1" Show memory usage status on task bar (Linux only). -.IP "\fBTaskBarShowNetStatus\fR=1" 4 +.IP \fBTaskBarShowNetStatus\fR=1 4 .IX Item "TaskBarShowNetStatus=1" Show network status on task bar (Linux only). -.IP "\fBTaskBarShowCollapseButton\fR=0" 4 +.IP \fBTaskBarShowCollapseButton\fR=0 4 .IX Item "TaskBarShowCollapseButton=0" Show a button to collapse the taskbar. -.IP "\fBTaskBarDoubleHeight\fR=0" 4 +.IP \fBTaskBarDoubleHeight\fR=0 4 .IX Item "TaskBarDoubleHeight=0" Use double-height task bar. -.IP "\fBTaskBarWorkspacesLeft\fR=1" 4 +.IP \fBTaskBarWorkspacesLeft\fR=1 4 .IX Item "TaskBarWorkspacesLeft=1" Place workspace pager on left, not right. -.IP "\fBTaskBarWorkspacesTop\fR=0" 4 +.IP \fBTaskBarWorkspacesTop\fR=0 4 .IX Item "TaskBarWorkspacesTop=0" Place workspace pager on top row when using dual-height taskbar. -.ie n .IP "\fBTaskBarWorkspacesLimit\fR=""""" 4 -.el .IP "\fBTaskBarWorkspacesLimit\fR=``''" 4 +.IP "\fBTaskBarWorkspacesLimit\fR=""""" 4 .IX Item "TaskBarWorkspacesLimit=""""" Limit the number of taskbar workspaces buttons that are shown on the workspaces pane of the taskbar. If the numeric value has a \f(CW\*(C`p\*(C'\fR suffix then the limitation is in pixels. A \f(CW\*(C`%\*(C'\fR suffix limits by percentage of desktop width. By default a \f(CW\*(C`B\*(C'\fR suffix is assumed for number of buttons. -.IP "\fBTaskBarUseMouseWheel\fR=1" 4 +.IP \fBTaskBarUseMouseWheel\fR=1 4 .IX Item "TaskBarUseMouseWheel=1" Enable mouse wheel cycling over workspaces and task buttons in taskbar. -.IP "\fBPagerShowPreview\fR=1" 4 +.IP \fBPagerShowPreview\fR=1 4 .IX Item "PagerShowPreview=1" Show a mini desktop preview on each workspace button. -.IP "\fBPagerShowWindowIcons\fR=1" 4 +.IP \fBPagerShowWindowIcons\fR=1 4 .IX Item "PagerShowWindowIcons=1" Draw window icons inside large enough preview windows on pager (if PagerShowPreview=1). -.IP "\fBPagerShowMinimized\fR=1" 4 +.IP \fBPagerShowMinimized\fR=1 4 .IX Item "PagerShowMinimized=1" Draw even minimized windows as unfilled rectangles (if PagerShowPreview=1). -.IP "\fBPagerShowBorders\fR=1" 4 +.IP \fBPagerShowBorders\fR=1 4 .IX Item "PagerShowBorders=1" Draw border around workspace buttons (if PagerShowPreview=1). -.IP "\fBPagerShowLabels\fR=1" 4 +.IP \fBPagerShowLabels\fR=1 4 .IX Item "PagerShowLabels=1" Show workspace name label on workspace button (if PagerShowPreview=1) -.IP "\fBPagerShowNumbers\fR=1" 4 +.IP \fBPagerShowNumbers\fR=1 4 .IX Item "PagerShowNumbers=1" Show number of workspace on workspace button (if PagerShowPreview=1). -.IP "\fBTaskBarLaunchOnSingleClick\fR=1" 4 +.IP \fBTaskBarLaunchOnSingleClick\fR=1 4 .IX Item "TaskBarLaunchOnSingleClick=1" Execute taskbar applet commands (like MailCommand, ClockCommand, ...) on single click. -.IP "\fBEnableAddressBar\fR=1" 4 +.IP \fBEnableAddressBar\fR=1 4 .IX Item "EnableAddressBar=1" Enable address bar functionality in taskbar. -.IP "\fBShowAddressBar\fR=1" 4 +.IP \fBShowAddressBar\fR=1 4 .IX Item "ShowAddressBar=1" Show address bar in task bar. -.IP "\fBMultiByte\fR=1" 4 +.IP \fBMultiByte\fR=1 4 .IX Item "MultiByte=1" Overrides automatic multiple byte detection. -.IP "\fBConfirmLogout\fR=1" 4 +.IP \fBConfirmLogout\fR=1 4 .IX Item "ConfirmLogout=1" Confirm logout. -.IP "\fBShapesProtectClientWindow\fR=1" 4 +.IP \fBShapesProtectClientWindow\fR=1 4 .IX Item "ShapesProtectClientWindow=1" Don't cut client windows by shapes set trough frame corner pixmap. -.IP "\fBDoubleBuffer\fR=1" 4 +.IP \fBDoubleBuffer\fR=1 4 .IX Item "DoubleBuffer=1" Use double buffering when redrawing the display. -.IP "\fBXRRDisable\fR=1" 4 +.IP \fBXRRDisable\fR=1 4 .IX Item "XRRDisable=1" -Disable use of new \s-1XRANDR API\s0 for dual head (nvidia workaround). -.IP "\fBPreferFreetypeFonts\fR=1" 4 +Disable use of new XRANDR API for dual head (nvidia workaround). +.IP \fBPreferFreetypeFonts\fR=1 4 .IX Item "PreferFreetypeFonts=1" Favour Xft fonts over core X11 fonts where possible. -.ie n .IP "\fBMailBoxPath\fR=""""" 4 -.el .IP "\fBMailBoxPath\fR=``''" 4 +.IP "\fBMailBoxPath\fR=""""" 4 .IX Item "MailBoxPath=""""" A colon separated list of paths of your mailboxes. If this is empty, \f(CW$MAILPATH\fR or \f(CW$MAIL\fR is used instead. .Sp -Path to a mbox file. Remote mail boxes are accessed by specifying an \s-1URL\s0 -using the Common Internet Scheme Syntax (\s-1RFC 1738\s0): +Path to a mbox file. Remote mail boxes are accessed by specifying an URL +using the Common Internet Scheme Syntax (RFC 1738): .Sp .Vb 1 \& \`scheme://[user[:password]@]server[:port][/path]\`. .Ve .Sp Supported schemes are \f(CW\*(C`pop3\*(C'\fR, \f(CW\*(C`imap\*(C'\fR and \f(CW\*(C`file\*(C'\fR. When the scheme is -omitted \fIfile://\fR is prepended silently. \s-1IMAP\s0 subfolders can be +omitted \fIfile://\fR is prepended silently. IMAP subfolders can be accessed by using the path component. Reserved characters like \&\fIslash\fR (\f(CW\*(C`/\*(C'\fR), \fIat\fR (\f(CW\*(C`@\*(C'\fR) and \fIcolon\fR (\f(CW\*(C`:\*(C'\fR) can be specified using escape sequences with a hexadecimal encoding like \f(CW%2f\fR for the slash @@ -650,44 +567,37 @@ or \f(CW%40\fR for the at sign. For example: \& pop3://markus:%2f%40%3a@maol.ch/ \& imap://mathias@localhost/INBOX.Maillisten.icewm\-user .Ve -.ie n .IP "\fBNetworkStatusDevice\fR=""eth0 wlan0""" 4 -.el .IP "\fBNetworkStatusDevice\fR=``eth0 wlan0''" 4 -.IX Item "NetworkStatusDevice=eth0 wlan0" +.IP "\fBNetworkStatusDevice\fR=""eth0 wlan0""" 4 +.IX Item "NetworkStatusDevice=""eth0 wlan0""" Network devices for which to show status. -.ie n .IP "\fBTimeFormat\fR=""%X""" 4 -.el .IP "\fBTimeFormat\fR=``%X''" 4 -.IX Item "TimeFormat=%X" +.IP "\fBTimeFormat\fR=""%X""" 4 +.IX Item "TimeFormat=""%X""" The clock time format. See the strftime manpage for the meaning of all the percent options. It is possible to define multiple clocks for different time zones in a single \fITimeFormat\fR. A new clock is defined by the beginning of the string, and by each time zone specification that starts with \f(CW\*(C`TZ=...\*(C'\fR, followed by a space. For example, \&\fBTimeFormat\fR=\f(CW\*(C`%X TZ=Asia/Aden %T TZ=Asia/Baku %T\*(C'\fR defines 3 clocks. -.ie n .IP "\fBTimeFormatAlt\fR=""""" 4 -.el .IP "\fBTimeFormatAlt\fR=``''" 4 +.IP "\fBTimeFormatAlt\fR=""""" 4 .IX Item "TimeFormatAlt=""""" Alternate Clock Time format shown every other second. -.ie n .IP "\fBDateFormat\fR=""%c""" 4 -.el .IP "\fBDateFormat\fR=``%c''" 4 -.IX Item "DateFormat=%c" +.IP "\fBDateFormat\fR=""%c""" 4 +.IX Item "DateFormat=""%c""" Clock Date format for tooltip (strftime format string). -.ie n .IP "\fBDockApps\fR=""right high desktop""" 4 -.el .IP "\fBDockApps\fR=``right high desktop''" 4 -.IX Item "DockApps=right high desktop" +.IP "\fBDockApps\fR=""right high desktop""" 4 +.IX Item "DockApps=""right high desktop""" Support DockApps (right, left, center, down, high, above, below, desktop, or empty to disable). Control with Ctrl+Mouse. -.ie n .IP "\fBXRRPrimaryScreenName\fR=""""" 4 -.el .IP "\fBXRRPrimaryScreenName\fR=``''" 4 +.IP "\fBXRRPrimaryScreenName\fR=""""" 4 .IX Item "XRRPrimaryScreenName=""""" Screen/output name of the primary screen. -.ie n .IP "\fBAcpiIgnoreBatteries\fR=""""" 4 -.el .IP "\fBAcpiIgnoreBatteries\fR=``''" 4 +.IP "\fBAcpiIgnoreBatteries\fR=""""" 4 .IX Item "AcpiIgnoreBatteries=""""" List of battery names (directories) in /proc/acpi/battery to ignore. Useful when more slots are built-in, but only one battery is used. .IP "\fBTaskBarCPUSamples\fR=20 [2\-1000]" 4 .IX Item "TaskBarCPUSamples=20 [2-1000]" -The width of the \s-1CPU\s0 Monitor applet in pixels. +The width of the CPU Monitor applet in pixels. .IP "\fBTaskBarMEMSamples\fR=20 [2\-1000]" 4 .IX Item "TaskBarMEMSamples=20 [2-1000]" The width of the Memory Monitor applet in pixels. @@ -700,9 +610,8 @@ Default number of tasks in taskbar. .IP "\fBTaskBarWidthPercentage\fR=100 [0\-100]" 4 .IX Item "TaskBarWidthPercentage=100 [0-100]" Task bar width as percentage of the screen width. -.ie n .IP "\fBTaskBarJustify\fR=""left""" 4 -.el .IP "\fBTaskBarJustify\fR=``left''" 4 -.IX Item "TaskBarJustify=left" +.IP "\fBTaskBarJustify\fR=""left""" 4 +.IX Item "TaskBarJustify=""left""" Taskbar justify left, right or center. .IP "\fBTaskBarApmGraphWidth\fR=10 [1\-1000]" 4 .IX Item "TaskBarApmGraphWidth=10 [1-1000]" @@ -710,8 +619,7 @@ Width of battery Monitor. .IP "\fBXineramaPrimaryScreen\fR=0 [0\-63]" 4 .IX Item "XineramaPrimaryScreen=0 [0-63]" Primary screen for xinerama (taskbar, ...). -.ie n .IP "\fBKeyboardLayouts\fR=""""" 4 -.el .IP "\fBKeyboardLayouts\fR=``''" 4 +.IP "\fBKeyboardLayouts\fR=""""" 4 .IX Item "KeyboardLayouts=""""" A comma-separated list of keyboard layouts. A layout may be enclosed in double quotes. @@ -724,39 +632,39 @@ Programs may have their own keyboard layout defined in the \fIwinoptions\fR file. The first two letters of a layout are used to locate an icon image file. -.SS "\s-1MENUS\s0" +.SS MENUS .IX Subsection "MENUS" -.IP "\fBAutoReloadMenus\fR=1" 4 +.IP \fBAutoReloadMenus\fR=1 4 .IX Item "AutoReloadMenus=1" Reload menu files automatically. -.IP "\fBShowProgramsMenu\fR=0" 4 +.IP \fBShowProgramsMenu\fR=0 4 .IX Item "ShowProgramsMenu=0" Show programs submenu. -.IP "\fBShowSettingsMenu\fR=1" 4 +.IP \fBShowSettingsMenu\fR=1 4 .IX Item "ShowSettingsMenu=1" Show settings submenu. -.IP "\fBShowFocusModeMenu\fR=1" 4 +.IP \fBShowFocusModeMenu\fR=1 4 .IX Item "ShowFocusModeMenu=1" Show focus mode submenu. -.IP "\fBShowThemesMenu\fR=1" 4 +.IP \fBShowThemesMenu\fR=1 4 .IX Item "ShowThemesMenu=1" Show themes submenu. -.IP "\fBShowLogoutMenu\fR=1" 4 +.IP \fBShowLogoutMenu\fR=1 4 .IX Item "ShowLogoutMenu=1" Show logout menu. -.IP "\fBShowHelp\fR=1" 4 +.IP \fBShowHelp\fR=1 4 .IX Item "ShowHelp=1" Show the help menu item. -.IP "\fBShowLogoutSubMenu\fR=1" 4 +.IP \fBShowLogoutSubMenu\fR=1 4 .IX Item "ShowLogoutSubMenu=1" Show logout submenu. -.IP "\fBShowAbout\fR=1" 4 +.IP \fBShowAbout\fR=1 4 .IX Item "ShowAbout=1" Show the about menu item. -.IP "\fBShowRun\fR=1" 4 +.IP \fBShowRun\fR=1 4 .IX Item "ShowRun=1" Show the run menu item. -.IP "\fBShowWindowList\fR=1" 4 +.IP \fBShowWindowList\fR=1 4 .IX Item "ShowWindowList=1" Show the window menu item. .IP "\fBMenuMaximalWidth\fR=0 [0\-16384]" 4 @@ -765,7 +673,7 @@ Maximal width of popup menus, 2/3 of the screen's width if set to zero. .IP "\fBNestedThemeMenuMinNumber\fR=25 [0\-1234]" 4 .IX Item "NestedThemeMenuMinNumber=25 [0-1234]" Minimal number of themes after which the Themes menu becomes nested (0=disabled). -.SS "\s-1TIMINGS\s0" +.SS TIMINGS .IX Subsection "TIMINGS" .IP "\fBDelayFuzziness\fR=10 (0\-100)" 4 .IX Item "DelayFuzziness=10 (0-100)" @@ -786,7 +694,7 @@ Delay before activating menu items. .IP "\fBSubmenuMenuActivateDelay\fR=300 [0\-5000]" 4 .IX Item "SubmenuMenuActivateDelay=300 [0-5000]" Delay before activating menu submenus. -.IP "\fBToolTipIcon\fR=1" 4 +.IP \fBToolTipIcon\fR=1 4 .IX Item "ToolTipIcon=1" Show an application icon in toolbar and tray tooltips. .IP "\fBToolTipDelay\fR=1000 [0\-5000]" 4 @@ -830,7 +738,7 @@ Time before workspace status window is hidden. Delay between new-mail checks. (seconds). .IP "\fBTaskBarCPUDelay\fR=500 [10\-3600000]" 4 .IX Item "TaskBarCPUDelay=500 [10-3600000]" -Delay between \s-1CPU\s0 Monitor samples in ms. +Delay between CPU Monitor samples in ms. .IP "\fBTaskBarMEMDelay\fR=500 [10\-3600000]" 4 .IX Item "TaskBarMEMDelay=500 [10-3600000]" Delay between Memory Monitor samples in ms. @@ -849,7 +757,7 @@ Delay between power status updates (seconds). .IP "\fBPingTimeout\fR=3 [0\-86400]" 4 .IX Item "PingTimeout=3 [0-86400]" Timeout in seconds for applications to respond to the _NET_WM_PING protocol. -.SS "\s-1BUTTONS AND KEYS\s0" +.SS "BUTTONS AND KEYS" .IX Subsection "BUTTONS AND KEYS" .IP "\fBUseRootButtons\fR=255 [0\-255]" 4 .IX Item "UseRootButtons=255 [0-255]" @@ -876,129 +784,104 @@ Press Alt+Shift to maximize only in the horizontal direction. .IX Item "TitleBarRollupButton=2 [0-5]" Title bar mouse-button double click to rollup the window. Press Shift to maximize in the horizontal direction. -.SS "\s-1WORKSPACES\s0" +.SS WORKSPACES .IX Subsection "WORKSPACES" -.ie n .IP "\fBWorkspaceNames\fR="" 1 "", "" 2 "", "" 3 "", "" 4 """ 4 -.el .IP "\fBWorkspaceNames\fR=`` 1 '', `` 2 '', `` 3 '', `` 4 ''" 4 -.IX Item "WorkspaceNames= 1 , 2 , 3 , 4 " +.IP "\fBWorkspaceNames\fR="" 1 "", "" 2 "", "" 3 "", "" 4 """ 4 +.IX Item "WorkspaceNames="" 1 "", "" 2 "", "" 3 "", "" 4 """ Create four workspaces with names \f(CW 1 \fR, \f(CW 2 \fR, \f(CW 3 \fR and \f(CW 4 \fR. -.SS "\s-1PATHS\s0" +.SS PATHS .IX Subsection "PATHS" -.ie n .IP "\fBIconPath\fR=""/usr/local/share/icons:/usr/local/share/pixmaps:/usr/share/icons:/usr/share/pixmaps""" 4 -.el .IP "\fBIconPath\fR=``/usr/local/share/icons:/usr/local/share/pixmaps:/usr/share/icons:/usr/share/pixmaps''" 4 -.IX Item "IconPath=/usr/local/share/icons:/usr/local/share/pixmaps:/usr/share/icons:/usr/share/pixmaps" +.IP "\fBIconPath\fR=""/usr/local/share/icons:/usr/local/share/pixmaps:/usr/share/icons:/usr/share/pixmaps""" 4 +.IX Item "IconPath=""/usr/local/share/icons:/usr/local/share/pixmaps:/usr/share/icons:/usr/share/pixmaps""" Icon search path (colon separated). Also, the icons/ subdirectory in IceWM resource folders are searched first. -.ie n .IP "\fBIconThemes\fR=""*:\-HighContrast""" 4 -.el .IP "\fBIconThemes\fR=``*:\-HighContrast''" 4 -.IX Item "IconThemes=*:-HighContrast" +.IP "\fBIconThemes\fR=""*:\-HighContrast""" 4 +.IX Item "IconThemes=""*:-HighContrast""" List of icon themes (colon separated), acting as additional filter of icon subdirectories in any of the \fBIconPath\fR folders. Expressions can be wildcards, also special wildcards (starting with \fB\-\fR) can exclude matched themes from selection. -.ie n .IP "\fBMailBoxPath\fR=""""" 4 -.el .IP "\fBMailBoxPath\fR=``''" 4 +.IP "\fBMailBoxPath\fR=""""" 4 .IX Item "MailBoxPath=""""" A colon separated list of paths of your mailboxes. If this is empty, \f(CW$MAILPATH\fR or \f(CW$MAIL\fR is used instead. -.SS "\s-1PROGRAMS\s0" +.SS PROGRAMS .IX Subsection "PROGRAMS" -.ie n .IP "\fBMailCommand\fR=""xterm \-name mutt \-e mutt""" 4 -.el .IP "\fBMailCommand\fR=``xterm \-name mutt \-e mutt''" 4 -.IX Item "MailCommand=xterm -name mutt -e mutt" +.IP "\fBMailCommand\fR=""xterm \-name mutt \-e mutt""" 4 +.IX Item "MailCommand=""xterm -name mutt -e mutt""" Command to run on mailbox. -.ie n .IP "\fBMailClassHint\fR=""mutt.XTerm""" 4 -.el .IP "\fBMailClassHint\fR=``mutt.XTerm''" 4 -.IX Item "MailClassHint=mutt.XTerm" -\&\fB\s-1WM_CLASS\s0\fR to allow \fBrunonce\fR for \fBMailCommand\fR. -.ie n .IP "\fBNewMailCommand\fR=""""" 4 -.el .IP "\fBNewMailCommand\fR=``''" 4 +.IP "\fBMailClassHint\fR=""mutt.XTerm""" 4 +.IX Item "MailClassHint=""mutt.XTerm""" +\&\fBWM_CLASS\fR to allow \fBrunonce\fR for \fBMailCommand\fR. +.IP "\fBNewMailCommand\fR=""""" 4 .IX Item "NewMailCommand=""""" Command to run when new mail arrives. -.ie n .IP "\fBLockCommand\fR=""""" 4 -.el .IP "\fBLockCommand\fR=``''" 4 +.IP "\fBLockCommand\fR=""""" 4 .IX Item "LockCommand=""""" Command to lock display/screensaver. -.ie n .IP "\fBClockCommand\fR=""xclock \-name icewm \-title Clock""" 4 -.el .IP "\fBClockCommand\fR=``xclock \-name icewm \-title Clock''" 4 -.IX Item "ClockCommand=xclock -name icewm -title Clock" +.IP "\fBClockCommand\fR=""xclock \-name icewm \-title Clock""" 4 +.IX Item "ClockCommand=""xclock -name icewm -title Clock""" Command to run on clock. -.ie n .IP "\fBClockClassHint\fR=""icewm.XClock""" 4 -.el .IP "\fBClockClassHint\fR=``icewm.XClock''" 4 -.IX Item "ClockClassHint=icewm.XClock" -\&\fB\s-1WM_CLASS\s0\fR to allow \fBrunonce\fR for \fBClockCommand\fR. -.ie n .IP "\fBRunCommand\fR=""""" 4 -.el .IP "\fBRunCommand\fR=``''" 4 +.IP "\fBClockClassHint\fR=""icewm.XClock""" 4 +.IX Item "ClockClassHint=""icewm.XClock""" +\&\fBWM_CLASS\fR to allow \fBrunonce\fR for \fBClockCommand\fR. +.IP "\fBRunCommand\fR=""""" 4 .IX Item "RunCommand=""""" Command to select and run a program. -.ie n .IP "\fBOpenCommand\fR=""""" 4 -.el .IP "\fBOpenCommand\fR=``''" 4 +.IP "\fBOpenCommand\fR=""""" 4 .IX Item "OpenCommand=""""" Open command. -.ie n .IP "\fBTerminalCommand\fR=""xterm""" 4 -.el .IP "\fBTerminalCommand\fR=``xterm''" 4 -.IX Item "TerminalCommand=xterm" +.IP "\fBTerminalCommand\fR=""xterm""" 4 +.IX Item "TerminalCommand=""xterm""" Terminal emulator must accept \-e option. -.ie n .IP "\fBLogoutCommand\fR=""""" 4 -.el .IP "\fBLogoutCommand\fR=``''" 4 +.IP "\fBLogoutCommand\fR=""""" 4 .IX Item "LogoutCommand=""""" Command to start logout. -.ie n .IP "\fBLogoutCancelCommand\fR=""""" 4 -.el .IP "\fBLogoutCancelCommand\fR=``''" 4 +.IP "\fBLogoutCancelCommand\fR=""""" 4 .IX Item "LogoutCancelCommand=""""" Command to cancel logout. -.ie n .IP "\fBShutdownCommand\fR=""/bin/sh \-c ""{ test \-e /run/systemd/system && systemctl poweroff || loginctl poweroff; }""""" 4 -.el .IP "\fBShutdownCommand\fR=``/bin/sh \-c ''{ test \-e /run/systemd/system && systemctl poweroff || loginctl poweroff; }``''" 4 -.IX Item "ShutdownCommand=/bin/sh -c { test -e /run/systemd/system && systemctl poweroff || loginctl poweroff; }""""" +.IP "\fBShutdownCommand\fR=""/bin/sh \-c ""{ test \-e /run/systemd/system && systemctl poweroff || loginctl poweroff; }""""" 4 +.IX Item "ShutdownCommand=""/bin/sh -c ""{ test -e /run/systemd/system && systemctl poweroff || loginctl poweroff; }""""" Command to shutdown the system. -.ie n .IP "\fBRebootCommand\fR=""/bin/sh \-c ""{ test \-e /run/systemd/system && systemctl reboot || loginctl reboot; }""""" 4 -.el .IP "\fBRebootCommand\fR=``/bin/sh \-c ''{ test \-e /run/systemd/system && systemctl reboot || loginctl reboot; }``''" 4 -.IX Item "RebootCommand=/bin/sh -c { test -e /run/systemd/system && systemctl reboot || loginctl reboot; }""""" +.IP "\fBRebootCommand\fR=""/bin/sh \-c ""{ test \-e /run/systemd/system && systemctl reboot || loginctl reboot; }""""" 4 +.IX Item "RebootCommand=""/bin/sh -c ""{ test -e /run/systemd/system && systemctl reboot || loginctl reboot; }""""" Command to reboot the system. -.ie n .IP "\fBSuspendCommand\fR=""test \-e /run/systemd/system && systemctl suspend || loginctl suspend""" 4 -.el .IP "\fBSuspendCommand\fR=``test \-e /run/systemd/system && systemctl suspend || loginctl suspend''" 4 -.IX Item "SuspendCommand=test -e /run/systemd/system && systemctl suspend || loginctl suspend" +.IP "\fBSuspendCommand\fR=""test \-e /run/systemd/system && systemctl suspend || loginctl suspend""" 4 +.IX Item "SuspendCommand=""test -e /run/systemd/system && systemctl suspend || loginctl suspend""" Command to send the system to standby mode -.ie n .IP "\fBSuspendCommand\fR=""test \-e /run/systemd/system && systemctl hibernate || loginctl hibernate""" 4 -.el .IP "\fBSuspendCommand\fR=``test \-e /run/systemd/system && systemctl hibernate || loginctl hibernate''" 4 -.IX Item "SuspendCommand=test -e /run/systemd/system && systemctl hibernate || loginctl hibernate" +.IP "\fBSuspendCommand\fR=""test \-e /run/systemd/system && systemctl hibernate || loginctl hibernate""" 4 +.IX Item "SuspendCommand=""test -e /run/systemd/system && systemctl hibernate || loginctl hibernate""" Command to hibernate the system. -.ie n .IP "\fBCPUStatusCommand\fR=""xterm \-name top \-title Process\e Status \-e top""" 4 -.el .IP "\fBCPUStatusCommand\fR=``xterm \-name top \-title Process\e Status \-e top''" 4 -.IX Item "CPUStatusCommand=xterm -name top -title Process Status -e top" -Command to run on \s-1CPU\s0 status. -.ie n .IP "\fBCPUStatusClassHint\fR=""top.XTerm""" 4 -.el .IP "\fBCPUStatusClassHint\fR=``top.XTerm''" 4 -.IX Item "CPUStatusClassHint=top.XTerm" -\&\fB\s-1WM_CLASS\s0\fR to allow \fBrunonce\fR for \fBCPUStatusCommand\fR. +.IP "\fBCPUStatusCommand\fR=""xterm \-name top \-title Process\e Status \-e top""" 4 +.IX Item "CPUStatusCommand=""xterm -name top -title Process Status -e top""" +Command to run on CPU status. +.IP "\fBCPUStatusClassHint\fR=""top.XTerm""" 4 +.IX Item "CPUStatusClassHint=""top.XTerm""" +\&\fBWM_CLASS\fR to allow \fBrunonce\fR for \fBCPUStatusCommand\fR. .IP "\fBCPUStatusCombine\fR=1 0/1" 4 .IX Item "CPUStatusCombine=1 0/1" Combine all CPUs to one. -.ie n .IP "\fBNetStatusCommand\fR=""xterm \-name netstat \-title 'Network Status' \-e netstat \-c""" 4 -.el .IP "\fBNetStatusCommand\fR=``xterm \-name netstat \-title 'Network Status' \-e netstat \-c''" 4 -.IX Item "NetStatusCommand=xterm -name netstat -title 'Network Status' -e netstat -c" +.IP "\fBNetStatusCommand\fR=""xterm \-name netstat \-title 'Network Status' \-e netstat \-c""" 4 +.IX Item "NetStatusCommand=""xterm -name netstat -title 'Network Status' -e netstat -c""" Command to run on Net status. -.ie n .IP "\fBNetStatusClassHint\fR=""netstat.XTerm""" 4 -.el .IP "\fBNetStatusClassHint\fR=``netstat.XTerm''" 4 -.IX Item "NetStatusClassHint=netstat.XTerm" -\&\fB\s-1WM_CLASS\s0\fR to allow \fBrunonce\fR for \fBNetStatusCommand\fR. -.ie n .IP "\fBAddressBarCommand\fR=""""" 4 -.el .IP "\fBAddressBarCommand\fR=``''" 4 +.IP "\fBNetStatusClassHint\fR=""netstat.XTerm""" 4 +.IX Item "NetStatusClassHint=""netstat.XTerm""" +\&\fBWM_CLASS\fR to allow \fBrunonce\fR for \fBNetStatusCommand\fR. +.IP "\fBAddressBarCommand\fR=""""" 4 .IX Item "AddressBarCommand=""""" Command to run for address bar entries. -.SS "\s-1WINDOW MENUS\s0" +.SS "WINDOW MENUS" .IX Subsection "WINDOW MENUS" -.ie n .IP "\fBWinMenuItems\fR=""rmsnxfhualytiecw""" 4 -.el .IP "\fBWinMenuItems\fR=``rmsnxfhualytiecw''" 4 -.IX Item "WinMenuItems=rmsnxfhualytiecw" +.IP "\fBWinMenuItems\fR=""rmsnxfhualytiecw""" 4 +.IX Item "WinMenuItems=""rmsnxfhualytiecw""" Items supported in menu window (rmsnxfhualytieckw) -.IP "\fBRolloverButtonsSupported\fR=0" 4 +.IP \fBRolloverButtonsSupported\fR=0 4 .IX Item "RolloverButtonsSupported=0" Does it support the 'O' title bar button images (for mouse rollover). .IP "\fBShowMenuButtonIcon\fR=1 # 0/1" 4 .IX Item "ShowMenuButtonIcon=1 # 0/1" Show application icon over menu button -.SS "\s-1THEME SETTINGS\s0" +.SS "THEME SETTINGS" .IX Subsection "THEME SETTINGS" The following sections show settings that can be set in theme files. They can also be set in the \fIpreferences\fR file, but themes will override @@ -1006,28 +889,24 @@ the values set there. To override the theme values, the settings should be set in \fIprefoverrides\fR file: see \fBicewm\-prefoverrides\fR\|(5). Default values are shown following the equal sign. .PP -\fI\s-1THEME DESCRIPTION\s0\fR +\fITHEME DESCRIPTION\fR .IX Subsection "THEME DESCRIPTION" -.ie n .IP "\fBThemeAuthor\fR=""""" 4 -.el .IP "\fBThemeAuthor\fR=``''" 4 +.IP "\fBThemeAuthor\fR=""""" 4 .IX Item "ThemeAuthor=""""" Theme author, e\-mail address, credits. -.ie n .IP "\fBThemeDescription\fR=""""" 4 -.el .IP "\fBThemeDescription\fR=``''" 4 +.IP "\fBThemeDescription\fR=""""" 4 .IX Item "ThemeDescription=""""" Description of the theme, credits. -.ie n .IP "\fBLook\fR=""nice""" 4 -.el .IP "\fBLook\fR=``nice''" 4 -.IX Item "Look=nice" +.IP "\fBLook\fR=""nice""" 4 +.IX Item "Look=""nice""" Choose a theme look from one of: -\&\*(L"win95\*(R", \*(L"motif\*(R", \*(L"warp3\*(R", \*(L"warp4\*(R", -\&\*(L"nice\*(R", \*(L"metal2\*(R", \*(L"gtk2\*(R", and some others. -.ie n .IP "\fBGradients\fR=""""" 4 -.el .IP "\fBGradients\fR=``''" 4 +"win95", "motif", "warp3", "warp4", +"nice", "metal2", "gtk2", and some others. +.IP "\fBGradients\fR=""""" 4 .IX Item "Gradients=""""" List of gradient pixmaps in the current theme. .PP -\fI\s-1THEME BORDERS, ICONS, MARGINS AND BUTTONS\s0\fR +\fITHEME BORDERS, ICONS, MARGINS AND BUTTONS\fR .IX Subsection "THEME BORDERS, ICONS, MARGINS AND BUTTONS" .IP "\fBBorderSizeX\fR=6 [0\-128]" 4 .IX Item "BorderSizeX=6 [0-128]" @@ -1095,17 +974,14 @@ Distance between the active icon and it's border. .IP "\fBQuickSwitchSeparatorSize\fR=6 [0\-64]" 4 .IX Item "QuickSwitchSeparatorSize=6 [0-64]" Height of the separator between (all reachable) icons and text, 0 to avoid it. -.ie n .IP "\fBTitleButtonsLeft\fR=""s""" 4 -.el .IP "\fBTitleButtonsLeft\fR=``s''" 4 -.IX Item "TitleButtonsLeft=s" +.IP "\fBTitleButtonsLeft\fR=""s""" 4 +.IX Item "TitleButtonsLeft=""s""" Titlebar buttons from left to right (x=close, m=max, i=min, h=hide, r=rollup, s=sysmenu, d=depth). -.ie n .IP "\fBTitleButtonsRight\fR=""xmir""" 4 -.el .IP "\fBTitleButtonsRight\fR=``xmir''" 4 -.IX Item "TitleButtonsRight=xmir" +.IP "\fBTitleButtonsRight\fR=""xmir""" 4 +.IX Item "TitleButtonsRight=""xmir""" Titlebar buttons from right to left (x=close, m=max, i=min, h=hide, r=rollup, s=sysmenu, d=depth). -.ie n .IP "\fBTitleButtonsSupported\fR=""xmis""" 4 -.el .IP "\fBTitleButtonsSupported\fR=``xmis''" 4 -.IX Item "TitleButtonsSupported=xmis" +.IP "\fBTitleButtonsSupported\fR=""xmis""" 4 +.IX Item "TitleButtonsSupported=""xmis""" Titlebar buttons supported by theme (x,m,i,r,h,s,d). .IP "\fBTitleBarCentered\fR=0 # 0/1" 4 .IX Item "TitleBarCentered=0 # 0/1" @@ -1118,10 +994,10 @@ Join title*S and title*T. Join title*T and title*B. .IP "\fBTaskBarClockLeds\fR=0 # 0/1" 4 .IX Item "TaskBarClockLeds=0 # 0/1" -Task bar clock/battery monitor uses nice pixmap \s-1LCD\s0 display (but then it +Task bar clock/battery monitor uses nice pixmap LCD display (but then it doesn't display correctly in many languages anymore, e.g., for Japanese and Korean it works only when a real font is used and not -the \s-1LCD\s0 pixmaps.) +the LCD pixmaps.) .IP "\fBTaskBarGraphHeight\fR=20 [16\-1000]" 4 .IX Item "TaskBarGraphHeight=20 [16-1000]" Height of taskbar monitoring applets. @@ -1138,533 +1014,408 @@ Maximum scaled height of tray icons. .IX Item "TrayDrawBevel=0 # 0/1" Surround the tray with plastic border. .PP -\fI\s-1THEME FONTS\s0\fR +\fITHEME FONTS\fR .IX Subsection "THEME FONTS" -.ie n .IP "\fBTitleFontName\fR=""\-*\-sans\-medium\-r\-*\-*\-*\-120\-*\-*\-*\-*\-*\-*""" 4 -.el .IP "\fBTitleFontName\fR=``\-*\-sans\-medium\-r\-*\-*\-*\-120\-*\-*\-*\-*\-*\-*''" 4 -.IX Item "TitleFontName=-*-sans-medium-r-*-*-*-120-*-*-*-*-*-*" +.IP "\fBTitleFontName\fR=""\-*\-sans\-medium\-r\-*\-*\-*\-120\-*\-*\-*\-*\-*\-*""" 4 +.IX Item "TitleFontName=""-*-sans-medium-r-*-*-*-120-*-*-*-*-*-*""" .PD 0 -.ie n .IP "\fBTitleFontNameXft\fR=""sans\-serif:size=12""" 4 -.el .IP "\fBTitleFontNameXft\fR=``sans\-serif:size=12''" 4 -.IX Item "TitleFontNameXft=sans-serif:size=12" +.IP "\fBTitleFontNameXft\fR=""sans\-serif:size=12""" 4 +.IX Item "TitleFontNameXft=""sans-serif:size=12""" .PD Name of the title bar font. -.ie n .IP "\fBMenuFontName\fR=""\-*\-sans\-bold\-r\-*\-*\-*\-100\-*\-*\-*\-*\-*\-*""" 4 -.el .IP "\fBMenuFontName\fR=``\-*\-sans\-bold\-r\-*\-*\-*\-100\-*\-*\-*\-*\-*\-*''" 4 -.IX Item "MenuFontName=-*-sans-bold-r-*-*-*-100-*-*-*-*-*-*" +.IP "\fBMenuFontName\fR=""\-*\-sans\-bold\-r\-*\-*\-*\-100\-*\-*\-*\-*\-*\-*""" 4 +.IX Item "MenuFontName=""-*-sans-bold-r-*-*-*-100-*-*-*-*-*-*""" .PD 0 -.ie n .IP "\fBMenuFontNameXft\fR=""sans\-serif:size=10:bold""" 4 -.el .IP "\fBMenuFontNameXft\fR=``sans\-serif:size=10:bold''" 4 -.IX Item "MenuFontNameXft=sans-serif:size=10:bold" +.IP "\fBMenuFontNameXft\fR=""sans\-serif:size=10:bold""" 4 +.IX Item "MenuFontNameXft=""sans-serif:size=10:bold""" .PD Name of the menu font. -.ie n .IP "\fBStatusFontName\fR=""\-*\-monospace\-bold\-r\-*\-*\-*\-120\-*\-*\-*\-*\-*\-*""" 4 -.el .IP "\fBStatusFontName\fR=``\-*\-monospace\-bold\-r\-*\-*\-*\-120\-*\-*\-*\-*\-*\-*''" 4 -.IX Item "StatusFontName=-*-monospace-bold-r-*-*-*-120-*-*-*-*-*-*" +.IP "\fBStatusFontName\fR=""\-*\-monospace\-bold\-r\-*\-*\-*\-120\-*\-*\-*\-*\-*\-*""" 4 +.IX Item "StatusFontName=""-*-monospace-bold-r-*-*-*-120-*-*-*-*-*-*""" .PD 0 -.ie n .IP "\fBStatusFontNameXft\fR=""monospace:size=12:bold""" 4 -.el .IP "\fBStatusFontNameXft\fR=``monospace:size=12:bold''" 4 -.IX Item "StatusFontNameXft=monospace:size=12:bold" +.IP "\fBStatusFontNameXft\fR=""monospace:size=12:bold""" 4 +.IX Item "StatusFontNameXft=""monospace:size=12:bold""" .PD Name of the status display font. -.ie n .IP "\fBQuickSwitchFontName\fR=""\-*\-monospace\-bold\-r\-*\-*\-*\-120\-*\-*\-*\-*\-*\-*""" 4 -.el .IP "\fBQuickSwitchFontName\fR=``\-*\-monospace\-bold\-r\-*\-*\-*\-120\-*\-*\-*\-*\-*\-*''" 4 -.IX Item "QuickSwitchFontName=-*-monospace-bold-r-*-*-*-120-*-*-*-*-*-*" +.IP "\fBQuickSwitchFontName\fR=""\-*\-monospace\-bold\-r\-*\-*\-*\-120\-*\-*\-*\-*\-*\-*""" 4 +.IX Item "QuickSwitchFontName=""-*-monospace-bold-r-*-*-*-120-*-*-*-*-*-*""" .PD 0 -.ie n .IP "\fBQuickSwitchFontNameXft\fR=""monospace:size=12:bold""" 4 -.el .IP "\fBQuickSwitchFontNameXft\fR=``monospace:size=12:bold''" 4 -.IX Item "QuickSwitchFontNameXft=monospace:size=12:bold" +.IP "\fBQuickSwitchFontNameXft\fR=""monospace:size=12:bold""" 4 +.IX Item "QuickSwitchFontNameXft=""monospace:size=12:bold""" .PD Name of the font for Alt+Tab switcher window. -.ie n .IP "\fBNormalButtonFontName\fR=""\-*\-sans\-medium\-r\-*\-*\-*\-120\-*\-*\-*\-*\-*\-*""" 4 -.el .IP "\fBNormalButtonFontName\fR=``\-*\-sans\-medium\-r\-*\-*\-*\-120\-*\-*\-*\-*\-*\-*''" 4 -.IX Item "NormalButtonFontName=-*-sans-medium-r-*-*-*-120-*-*-*-*-*-*" +.IP "\fBNormalButtonFontName\fR=""\-*\-sans\-medium\-r\-*\-*\-*\-120\-*\-*\-*\-*\-*\-*""" 4 +.IX Item "NormalButtonFontName=""-*-sans-medium-r-*-*-*-120-*-*-*-*-*-*""" .PD 0 -.ie n .IP "\fBNormalButtonFontNameXft\fR=""sans\-serif:size=12""" 4 -.el .IP "\fBNormalButtonFontNameXft\fR=``sans\-serif:size=12''" 4 -.IX Item "NormalButtonFontNameXft=sans-serif:size=12" +.IP "\fBNormalButtonFontNameXft\fR=""sans\-serif:size=12""" 4 +.IX Item "NormalButtonFontNameXft=""sans-serif:size=12""" .PD Name of the normal button font. -.ie n .IP "\fBActiveButtonFontName\fR=""\-*\-sans\-bold\-r\-*\-*\-*\-120\-*\-*\-*\-*\-*\-*""" 4 -.el .IP "\fBActiveButtonFontName\fR=``\-*\-sans\-bold\-r\-*\-*\-*\-120\-*\-*\-*\-*\-*\-*''" 4 -.IX Item "ActiveButtonFontName=-*-sans-bold-r-*-*-*-120-*-*-*-*-*-*" +.IP "\fBActiveButtonFontName\fR=""\-*\-sans\-bold\-r\-*\-*\-*\-120\-*\-*\-*\-*\-*\-*""" 4 +.IX Item "ActiveButtonFontName=""-*-sans-bold-r-*-*-*-120-*-*-*-*-*-*""" .PD 0 -.ie n .IP "\fBActiveButtonFontNameXft\fR=""sans\-serif:size=12:bold""" 4 -.el .IP "\fBActiveButtonFontNameXft\fR=``sans\-serif:size=12:bold''" 4 -.IX Item "ActiveButtonFontNameXft=sans-serif:size=12:bold" +.IP "\fBActiveButtonFontNameXft\fR=""sans\-serif:size=12:bold""" 4 +.IX Item "ActiveButtonFontNameXft=""sans-serif:size=12:bold""" .PD Name of the active button font. -.ie n .IP "\fBNormalTaskBarFontName\fR=""\-*\-sans\-medium\-r\-*\-*\-*\-120\-*\-*\-*\-*\-*\-*""" 4 -.el .IP "\fBNormalTaskBarFontName\fR=``\-*\-sans\-medium\-r\-*\-*\-*\-120\-*\-*\-*\-*\-*\-*''" 4 -.IX Item "NormalTaskBarFontName=-*-sans-medium-r-*-*-*-120-*-*-*-*-*-*" +.IP "\fBNormalTaskBarFontName\fR=""\-*\-sans\-medium\-r\-*\-*\-*\-120\-*\-*\-*\-*\-*\-*""" 4 +.IX Item "NormalTaskBarFontName=""-*-sans-medium-r-*-*-*-120-*-*-*-*-*-*""" .PD 0 -.ie n .IP "\fBNormalTaskBarFontNameXft\fR=""sans\-serif:size=12""" 4 -.el .IP "\fBNormalTaskBarFontNameXft\fR=``sans\-serif:size=12''" 4 -.IX Item "NormalTaskBarFontNameXft=sans-serif:size=12" +.IP "\fBNormalTaskBarFontNameXft\fR=""sans\-serif:size=12""" 4 +.IX Item "NormalTaskBarFontNameXft=""sans-serif:size=12""" .PD Name of the normal task bar item font. -.ie n .IP "\fBActiveTaskBarFontName\fR=""\-*\-sans\-bold\-r\-*\-*\-*\-120\-*\-*\-*\-*\-*\-*""" 4 -.el .IP "\fBActiveTaskBarFontName\fR=``\-*\-sans\-bold\-r\-*\-*\-*\-120\-*\-*\-*\-*\-*\-*''" 4 -.IX Item "ActiveTaskBarFontName=-*-sans-bold-r-*-*-*-120-*-*-*-*-*-*" +.IP "\fBActiveTaskBarFontName\fR=""\-*\-sans\-bold\-r\-*\-*\-*\-120\-*\-*\-*\-*\-*\-*""" 4 +.IX Item "ActiveTaskBarFontName=""-*-sans-bold-r-*-*-*-120-*-*-*-*-*-*""" .PD 0 -.ie n .IP "\fBActiveTaskBarFontNameXft\fR=""sans\-serif:size=12:bold""" 4 -.el .IP "\fBActiveTaskBarFontNameXft\fR=``sans\-serif:size=12:bold''" 4 -.IX Item "ActiveTaskBarFontNameXft=sans-serif:size=12:bold" +.IP "\fBActiveTaskBarFontNameXft\fR=""sans\-serif:size=12:bold""" 4 +.IX Item "ActiveTaskBarFontNameXft=""sans-serif:size=12:bold""" .PD Name of the active task bar item font. -.ie n .IP "\fBToolButtonFontName\fR=""\-*\-sans\-medium\-r\-*\-*\-*\-120\-*\-*\-*\-*\-*\-*""" 4 -.el .IP "\fBToolButtonFontName\fR=``\-*\-sans\-medium\-r\-*\-*\-*\-120\-*\-*\-*\-*\-*\-*''" 4 -.IX Item "ToolButtonFontName=-*-sans-medium-r-*-*-*-120-*-*-*-*-*-*" +.IP "\fBToolButtonFontName\fR=""\-*\-sans\-medium\-r\-*\-*\-*\-120\-*\-*\-*\-*\-*\-*""" 4 +.IX Item "ToolButtonFontName=""-*-sans-medium-r-*-*-*-120-*-*-*-*-*-*""" .PD 0 -.ie n .IP "\fBToolButtonFontNameXft\fR=""sans\-serif:size=12""" 4 -.el .IP "\fBToolButtonFontNameXft\fR=``sans\-serif:size=12''" 4 -.IX Item "ToolButtonFontNameXft=sans-serif:size=12" +.IP "\fBToolButtonFontNameXft\fR=""sans\-serif:size=12""" 4 +.IX Item "ToolButtonFontNameXft=""sans-serif:size=12""" .PD Name of the tool button font (fallback: NormalButtonFontName). -.ie n .IP "\fBNormalWorkspaceFontName\fR=""\-*\-sans\-medium\-r\-*\-*\-*\-120\-*\-*\-*\-*\-*\-*""" 4 -.el .IP "\fBNormalWorkspaceFontName\fR=``\-*\-sans\-medium\-r\-*\-*\-*\-120\-*\-*\-*\-*\-*\-*''" 4 -.IX Item "NormalWorkspaceFontName=-*-sans-medium-r-*-*-*-120-*-*-*-*-*-*" +.IP "\fBNormalWorkspaceFontName\fR=""\-*\-sans\-medium\-r\-*\-*\-*\-120\-*\-*\-*\-*\-*\-*""" 4 +.IX Item "NormalWorkspaceFontName=""-*-sans-medium-r-*-*-*-120-*-*-*-*-*-*""" .PD 0 -.ie n .IP "\fBNormalWorkspaceFontNameXft\fR=""sans\-serif:size=12""" 4 -.el .IP "\fBNormalWorkspaceFontNameXft\fR=``sans\-serif:size=12''" 4 -.IX Item "NormalWorkspaceFontNameXft=sans-serif:size=12" +.IP "\fBNormalWorkspaceFontNameXft\fR=""sans\-serif:size=12""" 4 +.IX Item "NormalWorkspaceFontNameXft=""sans-serif:size=12""" .PD Name of the normal workspace button font (fallback: NormalButtonFontName). -.ie n .IP "\fBActiveWorkspaceFontName\fR=""\-*\-sans\-medium\-r\-*\-*\-*\-120\-*\-*\-*\-*\-*\-*""" 4 -.el .IP "\fBActiveWorkspaceFontName\fR=``\-*\-sans\-medium\-r\-*\-*\-*\-120\-*\-*\-*\-*\-*\-*''" 4 -.IX Item "ActiveWorkspaceFontName=-*-sans-medium-r-*-*-*-120-*-*-*-*-*-*" +.IP "\fBActiveWorkspaceFontName\fR=""\-*\-sans\-medium\-r\-*\-*\-*\-120\-*\-*\-*\-*\-*\-*""" 4 +.IX Item "ActiveWorkspaceFontName=""-*-sans-medium-r-*-*-*-120-*-*-*-*-*-*""" .PD 0 -.ie n .IP "\fBActiveWorkspaceFontNameXft\fR=""sans\-serif:size=12""" 4 -.el .IP "\fBActiveWorkspaceFontNameXft\fR=``sans\-serif:size=12''" 4 -.IX Item "ActiveWorkspaceFontNameXft=sans-serif:size=12" +.IP "\fBActiveWorkspaceFontNameXft\fR=""sans\-serif:size=12""" 4 +.IX Item "ActiveWorkspaceFontNameXft=""sans-serif:size=12""" .PD Name of the active workspace button font (fallback: ActiveButtonFontName). -.ie n .IP "\fBMinimizedWindowFontName\fR=""\-*\-sans\-medium\-r\-*\-*\-*\-120\-*\-*\-*\-*\-*\-*""" 4 -.el .IP "\fBMinimizedWindowFontName\fR=``\-*\-sans\-medium\-r\-*\-*\-*\-120\-*\-*\-*\-*\-*\-*''" 4 -.IX Item "MinimizedWindowFontName=-*-sans-medium-r-*-*-*-120-*-*-*-*-*-*" +.IP "\fBMinimizedWindowFontName\fR=""\-*\-sans\-medium\-r\-*\-*\-*\-120\-*\-*\-*\-*\-*\-*""" 4 +.IX Item "MinimizedWindowFontName=""-*-sans-medium-r-*-*-*-120-*-*-*-*-*-*""" .PD 0 -.ie n .IP "\fBMinimizedWindowFontNameXft\fR=""sans\-serif:size=12""" 4 -.el .IP "\fBMinimizedWindowFontNameXft\fR=``sans\-serif:size=12''" 4 -.IX Item "MinimizedWindowFontNameXft=sans-serif:size=12" +.IP "\fBMinimizedWindowFontNameXft\fR=""sans\-serif:size=12""" 4 +.IX Item "MinimizedWindowFontNameXft=""sans-serif:size=12""" .PD Name of the mini-window font. -.ie n .IP "\fBListBoxFontName\fR=""\-*\-sans\-medium\-r\-*\-*\-*\-120\-*\-*\-*\-*\-*\-*""" 4 -.el .IP "\fBListBoxFontName\fR=``\-*\-sans\-medium\-r\-*\-*\-*\-120\-*\-*\-*\-*\-*\-*''" 4 -.IX Item "ListBoxFontName=-*-sans-medium-r-*-*-*-120-*-*-*-*-*-*" +.IP "\fBListBoxFontName\fR=""\-*\-sans\-medium\-r\-*\-*\-*\-120\-*\-*\-*\-*\-*\-*""" 4 +.IX Item "ListBoxFontName=""-*-sans-medium-r-*-*-*-120-*-*-*-*-*-*""" .PD 0 -.ie n .IP "\fBListBoxFontNameXft\fR=""sans\-serif:size=12""" 4 -.el .IP "\fBListBoxFontNameXft\fR=``sans\-serif:size=12''" 4 -.IX Item "ListBoxFontNameXft=sans-serif:size=12" +.IP "\fBListBoxFontNameXft\fR=""sans\-serif:size=12""" 4 +.IX Item "ListBoxFontNameXft=""sans-serif:size=12""" .PD Name of the window list font. -.ie n .IP "\fBToolTipFontName\fR=""\-*\-sans\-medium\-r\-*\-*\-*\-120\-*\-*\-*\-*\-*\-*""" 4 -.el .IP "\fBToolTipFontName\fR=``\-*\-sans\-medium\-r\-*\-*\-*\-120\-*\-*\-*\-*\-*\-*''" 4 -.IX Item "ToolTipFontName=-*-sans-medium-r-*-*-*-120-*-*-*-*-*-*" +.IP "\fBToolTipFontName\fR=""\-*\-sans\-medium\-r\-*\-*\-*\-120\-*\-*\-*\-*\-*\-*""" 4 +.IX Item "ToolTipFontName=""-*-sans-medium-r-*-*-*-120-*-*-*-*-*-*""" .PD 0 -.ie n .IP "\fBToolTipFontNameXft\fR=""sans\-serif:size=12""" 4 -.el .IP "\fBToolTipFontNameXft\fR=``sans\-serif:size=12''" 4 -.IX Item "ToolTipFontNameXft=sans-serif:size=12" +.IP "\fBToolTipFontNameXft\fR=""sans\-serif:size=12""" 4 +.IX Item "ToolTipFontNameXft=""sans-serif:size=12""" .PD Name of the tool tip font. -.ie n .IP "\fBClockFontName\fR=""\-*\-monospace\-medium\-r\-*\-*\-*\-140\-*\-*\-*\-*\-*\-*""" 4 -.el .IP "\fBClockFontName\fR=``\-*\-monospace\-medium\-r\-*\-*\-*\-140\-*\-*\-*\-*\-*\-*''" 4 -.IX Item "ClockFontName=-*-monospace-medium-r-*-*-*-140-*-*-*-*-*-*" +.IP "\fBClockFontName\fR=""\-*\-monospace\-medium\-r\-*\-*\-*\-140\-*\-*\-*\-*\-*\-*""" 4 +.IX Item "ClockFontName=""-*-monospace-medium-r-*-*-*-140-*-*-*-*-*-*""" .PD 0 -.ie n .IP "\fBClockFontNameXft\fR=""monospace:size=12""" 4 -.el .IP "\fBClockFontNameXft\fR=``monospace:size=12''" 4 -.IX Item "ClockFontNameXft=monospace:size=12" +.IP "\fBClockFontNameXft\fR=""monospace:size=12""" 4 +.IX Item "ClockFontNameXft=""monospace:size=12""" .PD Name of the task bar clock font. -.ie n .IP "\fBTempFontName\fR=""\-*\-monospace\-medium\-r\-*\-*\-*\-140\-*\-*\-*\-*\-*\-*""" 4 -.el .IP "\fBTempFontName\fR=``\-*\-monospace\-medium\-r\-*\-*\-*\-140\-*\-*\-*\-*\-*\-*''" 4 -.IX Item "TempFontName=-*-monospace-medium-r-*-*-*-140-*-*-*-*-*-*" +.IP "\fBTempFontName\fR=""\-*\-monospace\-medium\-r\-*\-*\-*\-140\-*\-*\-*\-*\-*\-*""" 4 +.IX Item "TempFontName=""-*-monospace-medium-r-*-*-*-140-*-*-*-*-*-*""" .PD 0 -.ie n .IP "\fBTempFontNameXft\fR=""monospace:size=12""" 4 -.el .IP "\fBTempFontNameXft\fR=``monospace:size=12''" 4 -.IX Item "TempFontNameXft=monospace:size=12" +.IP "\fBTempFontNameXft\fR=""monospace:size=12""" 4 +.IX Item "TempFontNameXft=""monospace:size=12""" .PD Name of the task bar temperature font. -.ie n .IP "\fBApmFontName\fR=""\-*\-monospace\-medium\-r\-*\-*\-*\-140\-*\-*\-*\-*\-*\-*""" 4 -.el .IP "\fBApmFontName\fR=``\-*\-monospace\-medium\-r\-*\-*\-*\-140\-*\-*\-*\-*\-*\-*''" 4 -.IX Item "ApmFontName=-*-monospace-medium-r-*-*-*-140-*-*-*-*-*-*" +.IP "\fBApmFontName\fR=""\-*\-monospace\-medium\-r\-*\-*\-*\-140\-*\-*\-*\-*\-*\-*""" 4 +.IX Item "ApmFontName=""-*-monospace-medium-r-*-*-*-140-*-*-*-*-*-*""" .PD 0 -.ie n .IP "\fBApmFontNameXft\fR=""monospace:size=12""" 4 -.el .IP "\fBApmFontNameXft\fR=``monospace:size=12''" 4 -.IX Item "ApmFontNameXft=monospace:size=12" +.IP "\fBApmFontNameXft\fR=""monospace:size=12""" 4 +.IX Item "ApmFontNameXft=""monospace:size=12""" .PD Name of the task bar battery font. -.ie n .IP "\fBInputFontName\fR=""\-*\-monospace\-medium\-r\-*\-*\-*\-140\-*\-*\-*\-*\-*\-*""" 4 -.el .IP "\fBInputFontName\fR=``\-*\-monospace\-medium\-r\-*\-*\-*\-140\-*\-*\-*\-*\-*\-*''" 4 -.IX Item "InputFontName=-*-monospace-medium-r-*-*-*-140-*-*-*-*-*-*" +.IP "\fBInputFontName\fR=""\-*\-monospace\-medium\-r\-*\-*\-*\-140\-*\-*\-*\-*\-*\-*""" 4 +.IX Item "InputFontName=""-*-monospace-medium-r-*-*-*-140-*-*-*-*-*-*""" .PD 0 -.ie n .IP "\fBInputFontNameXft\fR=""monospace:size=12""" 4 -.el .IP "\fBInputFontNameXft\fR=``monospace:size=12''" 4 -.IX Item "InputFontNameXft=monospace:size=12" +.IP "\fBInputFontNameXft\fR=""monospace:size=12""" 4 +.IX Item "InputFontNameXft=""monospace:size=12""" .PD Name of the input field font. -.ie n .IP "\fBLabelFontName\fR=""\-*\-sans\-medium\-r\-*\-*\-*\-140\-*\-*\-*\-*\-*\-*""" 4 -.el .IP "\fBLabelFontName\fR=``\-*\-sans\-medium\-r\-*\-*\-*\-140\-*\-*\-*\-*\-*\-*''" 4 -.IX Item "LabelFontName=-*-sans-medium-r-*-*-*-140-*-*-*-*-*-*" +.IP "\fBLabelFontName\fR=""\-*\-sans\-medium\-r\-*\-*\-*\-140\-*\-*\-*\-*\-*\-*""" 4 +.IX Item "LabelFontName=""-*-sans-medium-r-*-*-*-140-*-*-*-*-*-*""" .PD 0 -.ie n .IP "\fBLabelFontNameXft\fR=""sans\-serif:size=12""" 4 -.el .IP "\fBLabelFontNameXft\fR=``sans\-serif:size=12''" 4 -.IX Item "LabelFontNameXft=sans-serif:size=12" +.IP "\fBLabelFontNameXft\fR=""sans\-serif:size=12""" 4 +.IX Item "LabelFontNameXft=""sans-serif:size=12""" .PD Name of the label font. .PP -\fI\s-1THEME COLORS\s0\fR +\fITHEME COLORS\fR .IX Subsection "THEME COLORS" -.ie n .IP "\fBColorDialog\fR = ""rgb:C0/C0/C0""" 4 -.el .IP "\fBColorDialog\fR = ``rgb:C0/C0/C0''" 4 -.IX Item "ColorDialog = rgb:C0/C0/C0" +.IP "\fBColorDialog\fR = ""rgb:C0/C0/C0""" 4 +.IX Item "ColorDialog = ""rgb:C0/C0/C0""" Background of dialog windows. -.ie n .IP "\fBColorNormalBorder\fR = ""rgb:C0/C0/C0""" 4 -.el .IP "\fBColorNormalBorder\fR = ``rgb:C0/C0/C0''" 4 -.IX Item "ColorNormalBorder = rgb:C0/C0/C0" +.IP "\fBColorNormalBorder\fR = ""rgb:C0/C0/C0""" 4 +.IX Item "ColorNormalBorder = ""rgb:C0/C0/C0""" Border of inactive windows. -.ie n .IP "\fBColorActiveBorder\fR = ""rgb:C0/C0/C0""" 4 -.el .IP "\fBColorActiveBorder\fR = ``rgb:C0/C0/C0''" 4 -.IX Item "ColorActiveBorder = rgb:C0/C0/C0" +.IP "\fBColorActiveBorder\fR = ""rgb:C0/C0/C0""" 4 +.IX Item "ColorActiveBorder = ""rgb:C0/C0/C0""" Border of active windows. -.ie n .IP "\fBColorNormalButton\fR = ""rgb:C0/C0/C0""" 4 -.el .IP "\fBColorNormalButton\fR = ``rgb:C0/C0/C0''" 4 -.IX Item "ColorNormalButton = rgb:C0/C0/C0" +.IP "\fBColorNormalButton\fR = ""rgb:C0/C0/C0""" 4 +.IX Item "ColorNormalButton = ""rgb:C0/C0/C0""" Background of regular buttons. -.ie n .IP "\fBColorNormalButtonText\fR = ""rgb:00/00/00""" 4 -.el .IP "\fBColorNormalButtonText\fR = ``rgb:00/00/00''" 4 -.IX Item "ColorNormalButtonText = rgb:00/00/00" +.IP "\fBColorNormalButtonText\fR = ""rgb:00/00/00""" 4 +.IX Item "ColorNormalButtonText = ""rgb:00/00/00""" Text color of regular buttons. -.ie n .IP "\fBColorActiveButton\fR = ""rgb:E0/E0/E0""" 4 -.el .IP "\fBColorActiveButton\fR = ``rgb:E0/E0/E0''" 4 -.IX Item "ColorActiveButton = rgb:E0/E0/E0" +.IP "\fBColorActiveButton\fR = ""rgb:E0/E0/E0""" 4 +.IX Item "ColorActiveButton = ""rgb:E0/E0/E0""" Background of pressed buttons. -.ie n .IP "\fBColorActiveButtonText\fR = ""rgb:00/00/00""" 4 -.el .IP "\fBColorActiveButtonText\fR = ``rgb:00/00/00''" 4 -.IX Item "ColorActiveButtonText = rgb:00/00/00" +.IP "\fBColorActiveButtonText\fR = ""rgb:00/00/00""" 4 +.IX Item "ColorActiveButtonText = ""rgb:00/00/00""" Text color of pressed buttons. -.ie n .IP "\fBColorNormalTitleButton\fR = ""rgb:C0/C0/C0""" 4 -.el .IP "\fBColorNormalTitleButton\fR = ``rgb:C0/C0/C0''" 4 -.IX Item "ColorNormalTitleButton = rgb:C0/C0/C0" +.IP "\fBColorNormalTitleButton\fR = ""rgb:C0/C0/C0""" 4 +.IX Item "ColorNormalTitleButton = ""rgb:C0/C0/C0""" Background of titlebar buttons. -.ie n .IP "\fBColorNormalTitleButtonText\fR = ""rgb:00/00/00""" 4 -.el .IP "\fBColorNormalTitleButtonText\fR = ``rgb:00/00/00''" 4 -.IX Item "ColorNormalTitleButtonText = rgb:00/00/00" +.IP "\fBColorNormalTitleButtonText\fR = ""rgb:00/00/00""" 4 +.IX Item "ColorNormalTitleButtonText = ""rgb:00/00/00""" Text color of titlebar buttons. -.ie n .IP "\fBColorToolButton\fR = """"" 4 -.el .IP "\fBColorToolButton\fR = ``''" 4 +.IP "\fBColorToolButton\fR = """"" 4 .IX Item "ColorToolButton = """"" Background of toolbar buttons, ColorNormalButton is used if empty. -.ie n .IP "\fBColorToolButtonText\fR = """"" 4 -.el .IP "\fBColorToolButtonText\fR = ``''" 4 +.IP "\fBColorToolButtonText\fR = """"" 4 .IX Item "ColorToolButtonText = """"" Text color of toolbar buttons, ColorNormalButtonText is used if empty. -.ie n .IP "\fBColorNormalWorkspaceButton\fR = """"" 4 -.el .IP "\fBColorNormalWorkspaceButton\fR = ``''" 4 +.IP "\fBColorNormalWorkspaceButton\fR = """"" 4 .IX Item "ColorNormalWorkspaceButton = """"" Background of workspace buttons, ColorNormalButton is used if empty. -.ie n .IP "\fBColorNormalWorkspaceButtonText\fR = """"" 4 -.el .IP "\fBColorNormalWorkspaceButtonText\fR = ``''" 4 +.IP "\fBColorNormalWorkspaceButtonText\fR = """"" 4 .IX Item "ColorNormalWorkspaceButtonText = """"" Text color of workspace buttons, ColorNormalButtonText is used if empty. -.ie n .IP "\fBColorActiveWorkspaceButton\fR = """"" 4 -.el .IP "\fBColorActiveWorkspaceButton\fR = ``''" 4 +.IP "\fBColorActiveWorkspaceButton\fR = """"" 4 .IX Item "ColorActiveWorkspaceButton = """"" Background of the active workspace button, ColorActiveButton is used if empty. -.ie n .IP "\fBColorActiveWorkspaceButtonText\fR = """"" 4 -.el .IP "\fBColorActiveWorkspaceButtonText\fR = ``''" 4 +.IP "\fBColorActiveWorkspaceButtonText\fR = """"" 4 .IX Item "ColorActiveWorkspaceButtonText = """"" Text color of the active workspace button, ColorActiveButtonText is used if empty. -.ie n .IP "\fBColorNormalTitleBar\fR = ""rgb:80/80/80""" 4 -.el .IP "\fBColorNormalTitleBar\fR = ``rgb:80/80/80''" 4 -.IX Item "ColorNormalTitleBar = rgb:80/80/80" +.IP "\fBColorNormalTitleBar\fR = ""rgb:80/80/80""" 4 +.IX Item "ColorNormalTitleBar = ""rgb:80/80/80""" Background of the titlebar of regular windows. -.ie n .IP "\fBColorNormalTitleBarText\fR = ""rgb:00/00/00""" 4 -.el .IP "\fBColorNormalTitleBarText\fR = ``rgb:00/00/00''" 4 -.IX Item "ColorNormalTitleBarText = rgb:00/00/00" +.IP "\fBColorNormalTitleBarText\fR = ""rgb:00/00/00""" 4 +.IX Item "ColorNormalTitleBarText = ""rgb:00/00/00""" Text color of the titlebar of regular windows. -.ie n .IP "\fBColorNormalTitleBarShadow\fR = """"" 4 -.el .IP "\fBColorNormalTitleBarShadow\fR = ``''" 4 +.IP "\fBColorNormalTitleBarShadow\fR = """"" 4 .IX Item "ColorNormalTitleBarShadow = """"" Text shadow of the titlebar of regular windows. -.ie n .IP "\fBColorActiveTitleBar\fR = ""rgb:00/00/A0""" 4 -.el .IP "\fBColorActiveTitleBar\fR = ``rgb:00/00/A0''" 4 -.IX Item "ColorActiveTitleBar = rgb:00/00/A0" +.IP "\fBColorActiveTitleBar\fR = ""rgb:00/00/A0""" 4 +.IX Item "ColorActiveTitleBar = ""rgb:00/00/A0""" Background of the titlebar of active windows. -.ie n .IP "\fBColorActiveTitleBarText\fR = ""rgb:FF/FF/FF""" 4 -.el .IP "\fBColorActiveTitleBarText\fR = ``rgb:FF/FF/FF''" 4 -.IX Item "ColorActiveTitleBarText = rgb:FF/FF/FF" +.IP "\fBColorActiveTitleBarText\fR = ""rgb:FF/FF/FF""" 4 +.IX Item "ColorActiveTitleBarText = ""rgb:FF/FF/FF""" Text color of the titlebar of active windows. -.ie n .IP "\fBColorActiveTitleBarShadow\fR = """"" 4 -.el .IP "\fBColorActiveTitleBarShadow\fR = ``''" 4 +.IP "\fBColorActiveTitleBarShadow\fR = """"" 4 .IX Item "ColorActiveTitleBarShadow = """"" Text shadow of the titlebar of active windows. -.ie n .IP "\fBColorNormalMinimizedWindow\fR = ""rgb:C0/C0/C0""" 4 -.el .IP "\fBColorNormalMinimizedWindow\fR = ``rgb:C0/C0/C0''" 4 -.IX Item "ColorNormalMinimizedWindow = rgb:C0/C0/C0" +.IP "\fBColorNormalMinimizedWindow\fR = ""rgb:C0/C0/C0""" 4 +.IX Item "ColorNormalMinimizedWindow = ""rgb:C0/C0/C0""" Background for mini icons of regular windows. -.ie n .IP "\fBColorNormalMinimizedWindowText\fR = ""rgb:00/00/00""" 4 -.el .IP "\fBColorNormalMinimizedWindowText\fR = ``rgb:00/00/00''" 4 -.IX Item "ColorNormalMinimizedWindowText = rgb:00/00/00" +.IP "\fBColorNormalMinimizedWindowText\fR = ""rgb:00/00/00""" 4 +.IX Item "ColorNormalMinimizedWindowText = ""rgb:00/00/00""" Text color for mini icons of regular windows. -.ie n .IP "\fBColorActiveMinimizedWindow\fR = ""rgb:E0/E0/E0""" 4 -.el .IP "\fBColorActiveMinimizedWindow\fR = ``rgb:E0/E0/E0''" 4 -.IX Item "ColorActiveMinimizedWindow = rgb:E0/E0/E0" +.IP "\fBColorActiveMinimizedWindow\fR = ""rgb:E0/E0/E0""" 4 +.IX Item "ColorActiveMinimizedWindow = ""rgb:E0/E0/E0""" Background for mini icons of active windows. -.ie n .IP "\fBColorActiveMinimizedWindowText\fR = ""rgb:00/00/00""" 4 -.el .IP "\fBColorActiveMinimizedWindowText\fR = ``rgb:00/00/00''" 4 -.IX Item "ColorActiveMinimizedWindowText = rgb:00/00/00" +.IP "\fBColorActiveMinimizedWindowText\fR = ""rgb:00/00/00""" 4 +.IX Item "ColorActiveMinimizedWindowText = ""rgb:00/00/00""" Text color for mini icons of active windows. -.ie n .IP "\fBColorNormalMenu\fR = ""rgb:C0/C0/C0""" 4 -.el .IP "\fBColorNormalMenu\fR = ``rgb:C0/C0/C0''" 4 -.IX Item "ColorNormalMenu = rgb:C0/C0/C0" +.IP "\fBColorNormalMenu\fR = ""rgb:C0/C0/C0""" 4 +.IX Item "ColorNormalMenu = ""rgb:C0/C0/C0""" Background of pop-up menus. -.ie n .IP "\fBColorNormalMenuItemText\fR = ""rgb:00/00/00""" 4 -.el .IP "\fBColorNormalMenuItemText\fR = ``rgb:00/00/00''" 4 -.IX Item "ColorNormalMenuItemText = rgb:00/00/00" +.IP "\fBColorNormalMenuItemText\fR = ""rgb:00/00/00""" 4 +.IX Item "ColorNormalMenuItemText = ""rgb:00/00/00""" Text color of regular menu items. -.ie n .IP "\fBColorActiveMenuItem\fR = ""rgb:A0/A0/A0""" 4 -.el .IP "\fBColorActiveMenuItem\fR = ``rgb:A0/A0/A0''" 4 -.IX Item "ColorActiveMenuItem = rgb:A0/A0/A0" +.IP "\fBColorActiveMenuItem\fR = ""rgb:A0/A0/A0""" 4 +.IX Item "ColorActiveMenuItem = ""rgb:A0/A0/A0""" Background of selected menu item, leave empty to force transparency. -.ie n .IP "\fBColorActiveMenuItemText\fR = ""rgb:00/00/00""" 4 -.el .IP "\fBColorActiveMenuItemText\fR = ``rgb:00/00/00''" 4 -.IX Item "ColorActiveMenuItemText = rgb:00/00/00" +.IP "\fBColorActiveMenuItemText\fR = ""rgb:00/00/00""" 4 +.IX Item "ColorActiveMenuItemText = ""rgb:00/00/00""" Text color of selected menu items. -.ie n .IP "\fBColorDisabledMenuItemText\fR = ""rgb:80/80/80""" 4 -.el .IP "\fBColorDisabledMenuItemText\fR = ``rgb:80/80/80''" 4 -.IX Item "ColorDisabledMenuItemText = rgb:80/80/80" +.IP "\fBColorDisabledMenuItemText\fR = ""rgb:80/80/80""" 4 +.IX Item "ColorDisabledMenuItemText = ""rgb:80/80/80""" Text color of disabled menu items. -.ie n .IP "\fBColorDisabledMenuItemShadow\fR = """"" 4 -.el .IP "\fBColorDisabledMenuItemShadow\fR = ``''" 4 +.IP "\fBColorDisabledMenuItemShadow\fR = """"" 4 .IX Item "ColorDisabledMenuItemShadow = """"" Shadow of regular menu items. -.ie n .IP "\fBColorMoveSizeStatus\fR = ""rgb:C0/C0/C0""" 4 -.el .IP "\fBColorMoveSizeStatus\fR = ``rgb:C0/C0/C0''" 4 -.IX Item "ColorMoveSizeStatus = rgb:C0/C0/C0" +.IP "\fBColorMoveSizeStatus\fR = ""rgb:C0/C0/C0""" 4 +.IX Item "ColorMoveSizeStatus = ""rgb:C0/C0/C0""" Background of move/resize status window. -.ie n .IP "\fBColorMoveSizeStatusText\fR = ""rgb:00/00/00""" 4 -.el .IP "\fBColorMoveSizeStatusText\fR = ``rgb:00/00/00''" 4 -.IX Item "ColorMoveSizeStatusText = rgb:00/00/00" +.IP "\fBColorMoveSizeStatusText\fR = ""rgb:00/00/00""" 4 +.IX Item "ColorMoveSizeStatusText = ""rgb:00/00/00""" Text color of move/resize status window. -.ie n .IP "\fBColorQuickSwitch\fR = ""rgb:C0/C0/C0""" 4 -.el .IP "\fBColorQuickSwitch\fR = ``rgb:C0/C0/C0''" 4 -.IX Item "ColorQuickSwitch = rgb:C0/C0/C0" +.IP "\fBColorQuickSwitch\fR = ""rgb:C0/C0/C0""" 4 +.IX Item "ColorQuickSwitch = ""rgb:C0/C0/C0""" Background of the quick switch window. -.ie n .IP "\fBColorQuickSwitchText\fR = ""rgb:00/00/00""" 4 -.el .IP "\fBColorQuickSwitchText\fR = ``rgb:00/00/00''" 4 -.IX Item "ColorQuickSwitchText = rgb:00/00/00" +.IP "\fBColorQuickSwitchText\fR = ""rgb:00/00/00""" 4 +.IX Item "ColorQuickSwitchText = ""rgb:00/00/00""" Text color in the quick switch window. -.ie n .IP "\fBColorQuickSwitchActive\fR = """"" 4 -.el .IP "\fBColorQuickSwitchActive\fR = ``''" 4 +.IP "\fBColorQuickSwitchActive\fR = """"" 4 .IX Item "ColorQuickSwitchActive = """"" Rectangle around the active icon in the quick switch window. -.ie n .IP "\fBColorDefaultTaskBar\fR = ""rgb:C0/C0/C0""" 4 -.el .IP "\fBColorDefaultTaskBar\fR = ``rgb:C0/C0/C0''" 4 -.IX Item "ColorDefaultTaskBar = rgb:C0/C0/C0" +.IP "\fBColorDefaultTaskBar\fR = ""rgb:C0/C0/C0""" 4 +.IX Item "ColorDefaultTaskBar = ""rgb:C0/C0/C0""" Background of the taskbar. -.ie n .IP "\fBColorNormalTaskBarApp\fR = ""rgb:C0/C0/C0""" 4 -.el .IP "\fBColorNormalTaskBarApp\fR = ``rgb:C0/C0/C0''" 4 -.IX Item "ColorNormalTaskBarApp = rgb:C0/C0/C0" +.IP "\fBColorNormalTaskBarApp\fR = ""rgb:C0/C0/C0""" 4 +.IX Item "ColorNormalTaskBarApp = ""rgb:C0/C0/C0""" Background for task buttons of regular windows. -.ie n .IP "\fBColorNormalTaskBarAppText\fR = ""rgb:00/00/00""" 4 -.el .IP "\fBColorNormalTaskBarAppText\fR = ``rgb:00/00/00''" 4 -.IX Item "ColorNormalTaskBarAppText = rgb:00/00/00" +.IP "\fBColorNormalTaskBarAppText\fR = ""rgb:00/00/00""" 4 +.IX Item "ColorNormalTaskBarAppText = ""rgb:00/00/00""" Text color for task buttons of regular windows. -.ie n .IP "\fBColorActiveTaskBarApp\fR = ""rgb:E0/E0/E0""" 4 -.el .IP "\fBColorActiveTaskBarApp\fR = ``rgb:E0/E0/E0''" 4 -.IX Item "ColorActiveTaskBarApp = rgb:E0/E0/E0" +.IP "\fBColorActiveTaskBarApp\fR = ""rgb:E0/E0/E0""" 4 +.IX Item "ColorActiveTaskBarApp = ""rgb:E0/E0/E0""" Background for task buttons of the active window. -.ie n .IP "\fBColorActiveTaskBarAppText\fR = ""rgb:00/00/00""" 4 -.el .IP "\fBColorActiveTaskBarAppText\fR = ``rgb:00/00/00''" 4 -.IX Item "ColorActiveTaskBarAppText = rgb:00/00/00" +.IP "\fBColorActiveTaskBarAppText\fR = ""rgb:00/00/00""" 4 +.IX Item "ColorActiveTaskBarAppText = ""rgb:00/00/00""" Text color for task buttons of the active window. -.ie n .IP "\fBColorMinimizedTaskBarApp\fR = ""rgb:A0/A0/A0""" 4 -.el .IP "\fBColorMinimizedTaskBarApp\fR = ``rgb:A0/A0/A0''" 4 -.IX Item "ColorMinimizedTaskBarApp = rgb:A0/A0/A0" +.IP "\fBColorMinimizedTaskBarApp\fR = ""rgb:A0/A0/A0""" 4 +.IX Item "ColorMinimizedTaskBarApp = ""rgb:A0/A0/A0""" Background for task buttons of minimized windows. -.ie n .IP "\fBColorMinimizedTaskBarAppText\fR = ""rgb:00/00/00""" 4 -.el .IP "\fBColorMinimizedTaskBarAppText\fR = ``rgb:00/00/00''" 4 -.IX Item "ColorMinimizedTaskBarAppText = rgb:00/00/00" +.IP "\fBColorMinimizedTaskBarAppText\fR = ""rgb:00/00/00""" 4 +.IX Item "ColorMinimizedTaskBarAppText = ""rgb:00/00/00""" Text color for task buttons of minimized windows. -.ie n .IP "\fBColorInvisibleTaskBarApp\fR = ""rgb:80/80/80""" 4 -.el .IP "\fBColorInvisibleTaskBarApp\fR = ``rgb:80/80/80''" 4 -.IX Item "ColorInvisibleTaskBarApp = rgb:80/80/80" +.IP "\fBColorInvisibleTaskBarApp\fR = ""rgb:80/80/80""" 4 +.IX Item "ColorInvisibleTaskBarApp = ""rgb:80/80/80""" Background for task buttons of windows on other workspaces. -.ie n .IP "\fBColorInvisibleTaskBarAppText\fR = ""rgb:00/00/00""" 4 -.el .IP "\fBColorInvisibleTaskBarAppText\fR = ``rgb:00/00/00''" 4 -.IX Item "ColorInvisibleTaskBarAppText = rgb:00/00/00" +.IP "\fBColorInvisibleTaskBarAppText\fR = ""rgb:00/00/00""" 4 +.IX Item "ColorInvisibleTaskBarAppText = ""rgb:00/00/00""" Text color for task buttons of windows on other workspaces. -.ie n .IP "\fBColorScrollBar\fR = ""rgb:A0/A0/A0""" 4 -.el .IP "\fBColorScrollBar\fR = ``rgb:A0/A0/A0''" 4 -.IX Item "ColorScrollBar = rgb:A0/A0/A0" +.IP "\fBColorScrollBar\fR = ""rgb:A0/A0/A0""" 4 +.IX Item "ColorScrollBar = ""rgb:A0/A0/A0""" Scrollbar background (sliding area). -.ie n .IP "\fBColorScrollBarSlider\fR = ""rgb:C0/C0/C0""" 4 -.el .IP "\fBColorScrollBarSlider\fR = ``rgb:C0/C0/C0''" 4 -.IX Item "ColorScrollBarSlider = rgb:C0/C0/C0" +.IP "\fBColorScrollBarSlider\fR = ""rgb:C0/C0/C0""" 4 +.IX Item "ColorScrollBarSlider = ""rgb:C0/C0/C0""" Background of the slider button in scrollbars. -.ie n .IP "\fBColorScrollBarButton\fR = ""rgb:C0/C0/C0""" 4 -.el .IP "\fBColorScrollBarButton\fR = ``rgb:C0/C0/C0''" 4 -.IX Item "ColorScrollBarButton = rgb:C0/C0/C0" +.IP "\fBColorScrollBarButton\fR = ""rgb:C0/C0/C0""" 4 +.IX Item "ColorScrollBarButton = ""rgb:C0/C0/C0""" Background of the arrow buttons in scrollbars. -.ie n .IP "\fBColorScrollBarArrow\fR = ""rgb:C0/C0/C0""" 4 -.el .IP "\fBColorScrollBarArrow\fR = ``rgb:C0/C0/C0''" 4 -.IX Item "ColorScrollBarArrow = rgb:C0/C0/C0" +.IP "\fBColorScrollBarArrow\fR = ""rgb:C0/C0/C0""" 4 +.IX Item "ColorScrollBarArrow = ""rgb:C0/C0/C0""" Background of the arrow buttons in scrollbars (obsolete). -.ie n .IP "\fBColorScrollBarButtonArrow\fR = ""rgb:00/00/00""" 4 -.el .IP "\fBColorScrollBarButtonArrow\fR = ``rgb:00/00/00''" 4 -.IX Item "ColorScrollBarButtonArrow = rgb:00/00/00" +.IP "\fBColorScrollBarButtonArrow\fR = ""rgb:00/00/00""" 4 +.IX Item "ColorScrollBarButtonArrow = ""rgb:00/00/00""" Color of active arrows on scrollbar buttons. -.ie n .IP "\fBColorScrollBarInactiveArrow\fR = ""rgb:80/80/80""" 4 -.el .IP "\fBColorScrollBarInactiveArrow\fR = ``rgb:80/80/80''" 4 -.IX Item "ColorScrollBarInactiveArrow = rgb:80/80/80" +.IP "\fBColorScrollBarInactiveArrow\fR = ""rgb:80/80/80""" 4 +.IX Item "ColorScrollBarInactiveArrow = ""rgb:80/80/80""" Color of inactive arrows on scrollbar buttons. -.ie n .IP "\fBColorListBox\fR = ""rgb:C0/C0/C0""" 4 -.el .IP "\fBColorListBox\fR = ``rgb:C0/C0/C0''" 4 -.IX Item "ColorListBox = rgb:C0/C0/C0" +.IP "\fBColorListBox\fR = ""rgb:C0/C0/C0""" 4 +.IX Item "ColorListBox = ""rgb:C0/C0/C0""" Background of listboxes. -.ie n .IP "\fBColorListBoxText\fR = ""rgb:00/00/00""" 4 -.el .IP "\fBColorListBoxText\fR = ``rgb:00/00/00''" 4 -.IX Item "ColorListBoxText = rgb:00/00/00" +.IP "\fBColorListBoxText\fR = ""rgb:00/00/00""" 4 +.IX Item "ColorListBoxText = ""rgb:00/00/00""" Text color in listboxes. -.ie n .IP "\fBColorListBoxSelection\fR = ""rgb:80/80/80""" 4 -.el .IP "\fBColorListBoxSelection\fR = ``rgb:80/80/80''" 4 -.IX Item "ColorListBoxSelection = rgb:80/80/80" +.IP "\fBColorListBoxSelection\fR = ""rgb:80/80/80""" 4 +.IX Item "ColorListBoxSelection = ""rgb:80/80/80""" Background of selected listbox items. -.ie n .IP "\fBColorListBoxSelectionText\fR = ""rgb:00/00/00""" 4 -.el .IP "\fBColorListBoxSelectionText\fR = ``rgb:00/00/00''" 4 -.IX Item "ColorListBoxSelectionText = rgb:00/00/00" +.IP "\fBColorListBoxSelectionText\fR = ""rgb:00/00/00""" 4 +.IX Item "ColorListBoxSelectionText = ""rgb:00/00/00""" Text color of selected listbox items. -.ie n .IP "\fBColorToolTip\fR = ""rgb:E0/E0/00""" 4 -.el .IP "\fBColorToolTip\fR = ``rgb:E0/E0/00''" 4 -.IX Item "ColorToolTip = rgb:E0/E0/00" +.IP "\fBColorToolTip\fR = ""rgb:E0/E0/00""" 4 +.IX Item "ColorToolTip = ""rgb:E0/E0/00""" Background of tooltips. -.ie n .IP "\fBColorToolTipText\fR = ""rgb:00/00/00""" 4 -.el .IP "\fBColorToolTipText\fR = ``rgb:00/00/00''" 4 -.IX Item "ColorToolTipText = rgb:00/00/00" +.IP "\fBColorToolTipText\fR = ""rgb:00/00/00""" 4 +.IX Item "ColorToolTipText = ""rgb:00/00/00""" Text color of tooltips. -.ie n .IP "\fBColorLabel\fR = ""rgb:C0/C0/C0""" 4 -.el .IP "\fBColorLabel\fR = ``rgb:C0/C0/C0''" 4 -.IX Item "ColorLabel = rgb:C0/C0/C0" +.IP "\fBColorLabel\fR = ""rgb:C0/C0/C0""" 4 +.IX Item "ColorLabel = ""rgb:C0/C0/C0""" Background of labels, leave empty to force transparency. -.ie n .IP "\fBColorLabelText\fR = ""rgb:00/00/00""" 4 -.el .IP "\fBColorLabelText\fR = ``rgb:00/00/00''" 4 -.IX Item "ColorLabelText = rgb:00/00/00" +.IP "\fBColorLabelText\fR = ""rgb:00/00/00""" 4 +.IX Item "ColorLabelText = ""rgb:00/00/00""" Text color of labels. -.ie n .IP "\fBColorInput\fR = ""rgb:FF/FF/FF""" 4 -.el .IP "\fBColorInput\fR = ``rgb:FF/FF/FF''" 4 -.IX Item "ColorInput = rgb:FF/FF/FF" +.IP "\fBColorInput\fR = ""rgb:FF/FF/FF""" 4 +.IX Item "ColorInput = ""rgb:FF/FF/FF""" Background of text entry fields (e.g., the addressbar). -.ie n .IP "\fBColorInputText\fR = ""rgb:00/00/00""" 4 -.el .IP "\fBColorInputText\fR = ``rgb:00/00/00''" 4 -.IX Item "ColorInputText = rgb:00/00/00" +.IP "\fBColorInputText\fR = ""rgb:00/00/00""" 4 +.IX Item "ColorInputText = ""rgb:00/00/00""" Text color of text entry fields (e.g., the addressbar). -.ie n .IP "\fBColorInputSelection\fR = ""rgb:80/80/80""" 4 -.el .IP "\fBColorInputSelection\fR = ``rgb:80/80/80''" 4 -.IX Item "ColorInputSelection = rgb:80/80/80" +.IP "\fBColorInputSelection\fR = ""rgb:80/80/80""" 4 +.IX Item "ColorInputSelection = ""rgb:80/80/80""" Background of selected text in an entry field. -.ie n .IP "\fBColorInputSelectionText\fR = ""rgb:00/00/00""" 4 -.el .IP "\fBColorInputSelectionText\fR = ``rgb:00/00/00''" 4 -.IX Item "ColorInputSelectionText = rgb:00/00/00" +.IP "\fBColorInputSelectionText\fR = ""rgb:00/00/00""" 4 +.IX Item "ColorInputSelectionText = ""rgb:00/00/00""" Selected text in an entry field. -.ie n .IP "\fBColorClock\fR = ""rgb:00/00/00""" 4 -.el .IP "\fBColorClock\fR = ``rgb:00/00/00''" 4 -.IX Item "ColorClock = rgb:00/00/00" +.IP "\fBColorClock\fR = ""rgb:00/00/00""" 4 +.IX Item "ColorClock = ""rgb:00/00/00""" Background of non-LCD clock, leave empty to force transparency. -.ie n .IP "\fBColorClockText\fR = ""rgb:00/FF/00""" 4 -.el .IP "\fBColorClockText\fR = ``rgb:00/FF/00''" 4 -.IX Item "ColorClockText = rgb:00/FF/00" +.IP "\fBColorClockText\fR = ""rgb:00/FF/00""" 4 +.IX Item "ColorClockText = ""rgb:00/FF/00""" Text color of non-LCD clock. -.ie n .IP "\fBColorKeyboardLayoutText\fR = """"" 4 -.el .IP "\fBColorKeyboardLayoutText\fR = ``''" 4 +.IP "\fBColorKeyboardLayoutText\fR = """"" 4 .IX Item "ColorKeyboardLayoutText = """"" Color of keyboard layout indicator. -.ie n .IP "\fBColorApm\fR = ""rgb:00/00/00""" 4 -.el .IP "\fBColorApm\fR = ``rgb:00/00/00''" 4 -.IX Item "ColorApm = rgb:00/00/00" +.IP "\fBColorApm\fR = ""rgb:00/00/00""" 4 +.IX Item "ColorApm = ""rgb:00/00/00""" Background of battery monitor, leave empty to force transparency. -.ie n .IP "\fBColorApmText\fR = ""rgb:00/FF/00""" 4 -.el .IP "\fBColorApmText\fR = ``rgb:00/FF/00''" 4 -.IX Item "ColorApmText = rgb:00/FF/00" +.IP "\fBColorApmText\fR = ""rgb:00/FF/00""" 4 +.IX Item "ColorApmText = ""rgb:00/FF/00""" Text color of battery monitor. -.ie n .IP "\fBColorApmBattery\fR = ""rgb:FF/FF/00""" 4 -.el .IP "\fBColorApmBattery\fR = ``rgb:FF/FF/00''" 4 -.IX Item "ColorApmBattery = rgb:FF/FF/00" +.IP "\fBColorApmBattery\fR = ""rgb:FF/FF/00""" 4 +.IX Item "ColorApmBattery = ""rgb:FF/FF/00""" Color of battery monitor when discharging. -.ie n .IP "\fBColorApmLine\fR = ""rgb:00/FF/00""" 4 -.el .IP "\fBColorApmLine\fR = ``rgb:00/FF/00''" 4 -.IX Item "ColorApmLine = rgb:00/FF/00" +.IP "\fBColorApmLine\fR = ""rgb:00/FF/00""" 4 +.IX Item "ColorApmLine = ""rgb:00/FF/00""" Color of battery monitor when charging. -.ie n .IP "\fBColorApmGraphBg\fR = ""rgb:00/00/00""" 4 -.el .IP "\fBColorApmGraphBg\fR = ``rgb:00/00/00''" 4 -.IX Item "ColorApmGraphBg = rgb:00/00/00" +.IP "\fBColorApmGraphBg\fR = ""rgb:00/00/00""" 4 +.IX Item "ColorApmGraphBg = ""rgb:00/00/00""" Background color for graph mode. -.ie n .IP "\fBColorCPUStatusUser\fR = ""rgb:00/FF/00""" 4 -.el .IP "\fBColorCPUStatusUser\fR = ``rgb:00/FF/00''" 4 -.IX Item "ColorCPUStatusUser = rgb:00/FF/00" -User load on the \s-1CPU\s0 monitor. -.ie n .IP "\fBColorCPUStatusSystem\fR = ""rgb:FF/00/00""" 4 -.el .IP "\fBColorCPUStatusSystem\fR = ``rgb:FF/00/00''" 4 -.IX Item "ColorCPUStatusSystem = rgb:FF/00/00" -System load on the \s-1CPU\s0 monitor. -.ie n .IP "\fBColorCPUStatusInterrupts\fR = ""rgb:FF/FF/00""" 4 -.el .IP "\fBColorCPUStatusInterrupts\fR = ``rgb:FF/FF/00''" 4 -.IX Item "ColorCPUStatusInterrupts = rgb:FF/FF/00" -Interrupts on the \s-1CPU\s0 monitor. -.ie n .IP "\fBColorCPUStatusIoWait\fR = ""rgb:60/00/60""" 4 -.el .IP "\fBColorCPUStatusIoWait\fR = ``rgb:60/00/60''" 4 -.IX Item "ColorCPUStatusIoWait = rgb:60/00/60" -\&\s-1IO\s0 Wait on the \s-1CPU\s0 monitor. -.ie n .IP "\fBColorCPUStatusSoftIrq\fR = ""rgb:00/FF/FF""" 4 -.el .IP "\fBColorCPUStatusSoftIrq\fR = ``rgb:00/FF/FF''" 4 -.IX Item "ColorCPUStatusSoftIrq = rgb:00/FF/FF" -Soft Interrupts on the \s-1CPU\s0 monitor. -.ie n .IP "\fBColorCPUStatusNice\fR = ""rgb:00/00/FF""" 4 -.el .IP "\fBColorCPUStatusNice\fR = ``rgb:00/00/FF''" 4 -.IX Item "ColorCPUStatusNice = rgb:00/00/FF" -Nice load on the \s-1CPU\s0 monitor. -.ie n .IP "\fBColorCPUStatusIdle\fR = ""rgb:00/00/00""" 4 -.el .IP "\fBColorCPUStatusIdle\fR = ``rgb:00/00/00''" 4 -.IX Item "ColorCPUStatusIdle = rgb:00/00/00" -Idle (non) load on the \s-1CPU\s0 monitor, leave empty to force +.IP "\fBColorCPUStatusUser\fR = ""rgb:00/FF/00""" 4 +.IX Item "ColorCPUStatusUser = ""rgb:00/FF/00""" +User load on the CPU monitor. +.IP "\fBColorCPUStatusSystem\fR = ""rgb:FF/00/00""" 4 +.IX Item "ColorCPUStatusSystem = ""rgb:FF/00/00""" +System load on the CPU monitor. +.IP "\fBColorCPUStatusInterrupts\fR = ""rgb:FF/FF/00""" 4 +.IX Item "ColorCPUStatusInterrupts = ""rgb:FF/FF/00""" +Interrupts on the CPU monitor. +.IP "\fBColorCPUStatusIoWait\fR = ""rgb:60/00/60""" 4 +.IX Item "ColorCPUStatusIoWait = ""rgb:60/00/60""" +IO Wait on the CPU monitor. +.IP "\fBColorCPUStatusSoftIrq\fR = ""rgb:00/FF/FF""" 4 +.IX Item "ColorCPUStatusSoftIrq = ""rgb:00/FF/FF""" +Soft Interrupts on the CPU monitor. +.IP "\fBColorCPUStatusNice\fR = ""rgb:00/00/FF""" 4 +.IX Item "ColorCPUStatusNice = ""rgb:00/00/FF""" +Nice load on the CPU monitor. +.IP "\fBColorCPUStatusIdle\fR = ""rgb:00/00/00""" 4 +.IX Item "ColorCPUStatusIdle = ""rgb:00/00/00""" +Idle (non) load on the CPU monitor, leave empty to force transparency. -.ie n .IP "\fBColorCPUStatusSteal\fR = ""rgb:FF/8A/91""" 4 -.el .IP "\fBColorCPUStatusSteal\fR = ``rgb:FF/8A/91''" 4 -.IX Item "ColorCPUStatusSteal = rgb:FF/8A/91" -Involuntary Wait on the \s-1CPU\s0 monitor. -.ie n .IP "\fBColorCPUStatusTemp\fR = ""rgb:60/60/C0""" 4 -.el .IP "\fBColorCPUStatusTemp\fR = ``rgb:60/60/C0''" 4 -.IX Item "ColorCPUStatusTemp = rgb:60/60/C0" -Temperature of the \s-1CPU.\s0 -.ie n .IP "\fBColorMEMStatusUser\fR = ""rgb:40/40/80""" 4 -.el .IP "\fBColorMEMStatusUser\fR = ``rgb:40/40/80''" 4 -.IX Item "ColorMEMStatusUser = rgb:40/40/80" +.IP "\fBColorCPUStatusSteal\fR = ""rgb:FF/8A/91""" 4 +.IX Item "ColorCPUStatusSteal = ""rgb:FF/8A/91""" +Involuntary Wait on the CPU monitor. +.IP "\fBColorCPUStatusTemp\fR = ""rgb:60/60/C0""" 4 +.IX Item "ColorCPUStatusTemp = ""rgb:60/60/C0""" +Temperature of the CPU. +.IP "\fBColorMEMStatusUser\fR = ""rgb:40/40/80""" 4 +.IX Item "ColorMEMStatusUser = ""rgb:40/40/80""" User program usage in the memory monitor. -.ie n .IP "\fBColorMEMStatusBuffers\fR = ""rgb:60/60/C0""" 4 -.el .IP "\fBColorMEMStatusBuffers\fR = ``rgb:60/60/C0''" 4 -.IX Item "ColorMEMStatusBuffers = rgb:60/60/C0" -\&\s-1OS\s0 buffers usage in the memory monitor. -.ie n .IP "\fBColorMEMStatusCached\fR = ""rgb:80/80/FF""" 4 -.el .IP "\fBColorMEMStatusCached\fR = ``rgb:80/80/FF''" 4 -.IX Item "ColorMEMStatusCached = rgb:80/80/FF" -\&\s-1OS\s0 cached usage in the memory monitor. -.ie n .IP "\fBColorMEMStatusFree\fR = ""rgb:00/00/00""" 4 -.el .IP "\fBColorMEMStatusFree\fR = ``rgb:00/00/00''" 4 -.IX Item "ColorMEMStatusFree = rgb:00/00/00" +.IP "\fBColorMEMStatusBuffers\fR = ""rgb:60/60/C0""" 4 +.IX Item "ColorMEMStatusBuffers = ""rgb:60/60/C0""" +OS buffers usage in the memory monitor. +.IP "\fBColorMEMStatusCached\fR = ""rgb:80/80/FF""" 4 +.IX Item "ColorMEMStatusCached = ""rgb:80/80/FF""" +OS cached usage in the memory monitor. +.IP "\fBColorMEMStatusFree\fR = ""rgb:00/00/00""" 4 +.IX Item "ColorMEMStatusFree = ""rgb:00/00/00""" Free memory in the memory monitor. -.ie n .IP "\fBColorNetSend\fR = ""rgb:FF/FF/00""" 4 -.el .IP "\fBColorNetSend\fR = ``rgb:FF/FF/00''" 4 -.IX Item "ColorNetSend = rgb:FF/FF/00" +.IP "\fBColorNetSend\fR = ""rgb:FF/FF/00""" 4 +.IX Item "ColorNetSend = ""rgb:FF/FF/00""" Outgoing load on the network monitor. -.ie n .IP "\fBColorNetReceive\fR = ""rgb:FF/00/FF""" 4 -.el .IP "\fBColorNetReceive\fR = ``rgb:FF/00/FF''" 4 -.IX Item "ColorNetReceive = rgb:FF/00/FF" +.IP "\fBColorNetReceive\fR = ""rgb:FF/00/FF""" 4 +.IX Item "ColorNetReceive = ""rgb:FF/00/FF""" Incoming load on the network monitor. -.ie n .IP "\fBColorNetIdle\fR = ""rgb:00/00/00""" 4 -.el .IP "\fBColorNetIdle\fR = ``rgb:00/00/00''" 4 -.IX Item "ColorNetIdle = rgb:00/00/00" +.IP "\fBColorNetIdle\fR = ""rgb:00/00/00""" 4 +.IX Item "ColorNetIdle = ""rgb:00/00/00""" Idle (non) load on the network monitor, leave empty to force transparency. .PP -\fI\s-1DESKTOP BACKGROUND\s0\fR +\fIDESKTOP BACKGROUND\fR .IX Subsection "DESKTOP BACKGROUND" .PP The following themeable preferences are read by \fBicewmbg\fR\|(1): @@ -1674,12 +1425,10 @@ Display desktop background centered and not tiled. .IP "\fBDesktopBackgroundScaled\fR=0 0/1" 4 .IX Item "DesktopBackgroundScaled=0 0/1" Resize desktop background to full screen. -.ie n .IP "\fBDesktopBackgroundColor\fR=""""" 4 -.el .IP "\fBDesktopBackgroundColor\fR=``''" 4 +.IP "\fBDesktopBackgroundColor\fR=""""" 4 .IX Item "DesktopBackgroundColor=""""" A comma-separated list of zero or more desktop background colors. -.ie n .IP "\fBDesktopBackgroundImage\fR=""""" 4 -.el .IP "\fBDesktopBackgroundImage\fR=``''" 4 +.IP "\fBDesktopBackgroundImage\fR=""""" 4 .IX Item "DesktopBackgroundImage=""""" A comma-separated list of zero or more desktop background images. Each image may be a path with a \fBglob\fR\|(7) pattern, or start with a @@ -1690,22 +1439,20 @@ Choose a random selection from the list of background images. .IP "\fBSupportSemitransparency\fR=1 0/1" 4 .IX Item "SupportSemitransparency=1 0/1" Support for semitransparent terminals like Eterm or gnome-terminal. -.ie n .IP "\fBDesktopTransparencyColor\fR=""""" 4 -.el .IP "\fBDesktopTransparencyColor\fR=``''" 4 +.IP "\fBDesktopTransparencyColor\fR=""""" 4 .IX Item "DesktopTransparencyColor=""""" Color(s) to announce for semitransparent windows. -.ie n .IP "\fBDesktopTransparencyImage\fR=""""" 4 -.el .IP "\fBDesktopTransparencyImage\fR=``''" 4 +.IP "\fBDesktopTransparencyImage\fR=""""" 4 .IX Item "DesktopTransparencyImage=""""" Image(s) to announce for semitransparent windows. This is a list similar to \fBDesktopBackgroundImage\fR. .IP "\fBDesktopBackgroundMultihead\fR=0 0/1" 4 .IX Item "DesktopBackgroundMultihead=0 0/1" Paint the background image over all multihead monitors combined. -.IP "\fBCycleBackgroundsPeriod\fR=0" 4 +.IP \fBCycleBackgroundsPeriod\fR=0 4 .IX Item "CycleBackgroundsPeriod=0" Seconds between cycling over all background images, default zero is off. -.SS "\s-1EXAMPLES\s0" +.SS EXAMPLES .IX Subsection "EXAMPLES" .Vb 10 \& Alpha=1 @@ -1734,7 +1481,7 @@ Seconds between cycling over all background images, default zero is off. .PP The above example shows how to tell \fBicewm\fR to not bind a specific key: \&\fIKeySysWinMenu\fR in this case. -.SS "\s-1FILES\s0" +.SS FILES .IX Subsection "FILES" Locations for the \fIpreferences\fR file are as follows: .PP @@ -1748,14 +1495,14 @@ Locations for the \fIpreferences\fR file are as follows: .PP The locations are searched in the order listed; the first file found is read and the remainder ignored. -.SS "\s-1SEE ALSO\s0" +.SS "SEE ALSO" .IX Subsection "SEE ALSO" \&\fBicewm\fR\|(1), \&\fBicewm\-prefoverride\fR\|(5). -.SS "\s-1AUTHOR\s0" +.SS AUTHOR .IX Subsection "AUTHOR" Brian Bidulock <mailto:bidulock@openss7.org>. -.SS "\s-1LICENSE\s0" +.SS LICENSE .IX Subsection "LICENSE" -\&\fBIceWM\fR is licensed under the \s-1GNU\s0 Library General Public License. -See the \fI\s-1COPYING\s0\fR file in the distribution. +\&\fBIceWM\fR is licensed under the GNU Library General Public License. +See the \fICOPYING\fR file in the distribution. diff --git a/upstream/debian-unstable/man5/icewm-prefoverride.5 b/upstream/debian-unstable/man5/icewm-prefoverride.5 index 4ec82ade..d0275848 100644 --- a/upstream/debian-unstable/man5/icewm-prefoverride.5 +++ b/upstream/debian-unstable/man5/icewm-prefoverride.5 @@ -1,4 +1,5 @@ -.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43) +.\" -*- mode: troff; coding: utf-8 -*- +.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== @@ -15,29 +16,12 @@ .ft R .fi .. -.\" Set up some character translations and predefined strings. \*(-- will -.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left -.\" double quote, and \*(R" will give a right double quote. \*(C+ will -.\" give a nicer C++. Capital omega is used to do unbreakable dashes and -.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, -.\" nothing in troff, for use with C<>. -.tr \(*W- -.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ -. ds -- \(*W- -. ds PI pi -. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch -. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch -. ds L" "" -. ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ -. ds -- \|\(em\| -. ds PI \(*p -. ds L" `` -. ds R" '' . ds C` . ds C' 'br\} @@ -68,82 +52,20 @@ . \} .\} .rr rF -.\" -.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). -.\" Fear. Run. Save yourself. No user-serviceable parts. -. \" fudge factors for nroff and troff -.if n \{\ -. ds #H 0 -. ds #V .8m -. ds #F .3m -. ds #[ \f1 -. ds #] \fP -.\} -.if t \{\ -. ds #H ((1u-(\\\\n(.fu%2u))*.13m) -. ds #V .6m -. ds #F 0 -. ds #[ \& -. ds #] \& -.\} -. \" simple accents for nroff and troff -.if n \{\ -. ds ' \& -. ds ` \& -. ds ^ \& -. ds , \& -. ds ~ ~ -. ds / -.\} -.if t \{\ -. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" -. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' -. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' -. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' -. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' -. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' -.\} -. \" troff and (daisy-wheel) nroff accents -.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' -.ds 8 \h'\*(#H'\(*b\h'-\*(#H' -.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] -.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' -.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' -.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] -.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] -.ds ae a\h'-(\w'a'u*4/10)'e -.ds Ae A\h'-(\w'A'u*4/10)'E -. \" corrections for vroff -.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' -.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' -. \" for low resolution devices (crt and lpr) -.if \n(.H>23 .if \n(.V>19 \ -\{\ -. ds : e -. ds 8 ss -. ds o a -. ds d- d\h'-1'\(ga -. ds D- D\h'-1'\(hy -. ds th \o'bp' -. ds Th \o'LP' -. ds ae ae -. ds Ae AE -.\} -.rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "ICEWM-PREFOVERRIDE 5" -.TH ICEWM-PREFOVERRIDE 5 "2023-12-31" "icewm\ 3.4.5" "Standards, Environments and Macros" +.TH ICEWM-PREFOVERRIDE 5 2024-05-24 "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 .nh -.SS "\s-1NAME\s0" +.SS NAME .IX Subsection "NAME" .Vb 1 \& icewm\-prefoverride \- override themable preferences file .Ve -.SS "\s-1SYNOPSIS\s0" +.SS SYNOPSIS .IX Subsection "SYNOPSIS" .Vb 5 \& $ICEWM_PRIVCFG/prefoverride @@ -152,7 +74,7 @@ \& /etc/X11/icewm/prefoverride \& /usr/share/icewm/prefoverride .Ve -.SS "\s-1DESCRIPTION\s0" +.SS DESCRIPTION .IX Subsection "DESCRIPTION" Settings that override the settings from a theme. Some of the \fBicewm\fR preferences that control the look may be set by the theme. @@ -160,7 +82,7 @@ However, the settings in this \fIprefoverride\fR file override that. It is safe to leave this file empty initially. Note that this file is meant for themable preferences and a few icewm startup settings cannot be set here, like \f(CW\*(C`Splash\*(C'\fR. -.SS "\s-1FILES\s0" +.SS FILES .IX Subsection "FILES" Locations for the \fIprefoverride\fR file are as follows: .PP @@ -174,14 +96,14 @@ Locations for the \fIprefoverride\fR file are as follows: .PP The locations are searched in the order listed; the first file found is read and the remainder ignored. -.SS "\s-1SEE ALSO\s0" +.SS "SEE ALSO" .IX Subsection "SEE ALSO" \&\fBicewm\fR\|(1), \&\fBicewm\-preferences\fR\|(5). -.SS "\s-1AUTHOR\s0" +.SS AUTHOR .IX Subsection "AUTHOR" Brian Bidulock <mailto:bidulock@openss7.org>. -.SS "\s-1LICENSE\s0" +.SS LICENSE .IX Subsection "LICENSE" -\&\fBIceWM\fR is licensed under the \s-1GNU\s0 Library General Public License. -See the \fI\s-1COPYING\s0\fR file in the distribution. +\&\fBIceWM\fR is licensed under the GNU Library General Public License. +See the \fICOPYING\fR file in the distribution. diff --git a/upstream/debian-unstable/man5/icewm-programs.5 b/upstream/debian-unstable/man5/icewm-programs.5 index a0d769e2..04202775 100644 --- a/upstream/debian-unstable/man5/icewm-programs.5 +++ b/upstream/debian-unstable/man5/icewm-programs.5 @@ -1,4 +1,5 @@ -.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43) +.\" -*- mode: troff; coding: utf-8 -*- +.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== @@ -15,29 +16,12 @@ .ft R .fi .. -.\" Set up some character translations and predefined strings. \*(-- will -.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left -.\" double quote, and \*(R" will give a right double quote. \*(C+ will -.\" give a nicer C++. Capital omega is used to do unbreakable dashes and -.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, -.\" nothing in troff, for use with C<>. -.tr \(*W- -.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ -. ds -- \(*W- -. ds PI pi -. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch -. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch -. ds L" "" -. ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ -. ds -- \|\(em\| -. ds PI \(*p -. ds L" `` -. ds R" '' . ds C` . ds C' 'br\} @@ -68,82 +52,20 @@ . \} .\} .rr rF -.\" -.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). -.\" Fear. Run. Save yourself. No user-serviceable parts. -. \" fudge factors for nroff and troff -.if n \{\ -. ds #H 0 -. ds #V .8m -. ds #F .3m -. ds #[ \f1 -. ds #] \fP -.\} -.if t \{\ -. ds #H ((1u-(\\\\n(.fu%2u))*.13m) -. ds #V .6m -. ds #F 0 -. ds #[ \& -. ds #] \& -.\} -. \" simple accents for nroff and troff -.if n \{\ -. ds ' \& -. ds ` \& -. ds ^ \& -. ds , \& -. ds ~ ~ -. ds / -.\} -.if t \{\ -. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" -. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' -. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' -. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' -. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' -. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' -.\} -. \" troff and (daisy-wheel) nroff accents -.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' -.ds 8 \h'\*(#H'\(*b\h'-\*(#H' -.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] -.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' -.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' -.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] -.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] -.ds ae a\h'-(\w'a'u*4/10)'e -.ds Ae A\h'-(\w'A'u*4/10)'E -. \" corrections for vroff -.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' -.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' -. \" for low resolution devices (crt and lpr) -.if \n(.H>23 .if \n(.V>19 \ -\{\ -. ds : e -. ds 8 ss -. ds o a -. ds d- d\h'-1'\(ga -. ds D- D\h'-1'\(hy -. ds th \o'bp' -. ds Th \o'LP' -. ds ae ae -. ds Ae AE -.\} -.rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "ICEWM-PROGRAMS 5" -.TH ICEWM-PROGRAMS 5 "2023-12-31" "icewm\ 3.4.5" "Standards, Environments and Macros" +.TH ICEWM-PROGRAMS 5 2024-05-24 "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 .nh -.SS "\s-1NAME\s0" +.SS NAME .IX Subsection "NAME" .Vb 1 \& icewm\-programs \- icewm programs configuration file .Ve -.SS "\s-1SYNOPSIS\s0" +.SS SYNOPSIS .IX Subsection "SYNOPSIS" .Vb 5 \& $ICEWM_PRIVCFG/programs @@ -152,59 +74,51 @@ \& /etc/X11/icewm/programs \& /usr/share/icewm/programs .Ve -.SS "\s-1DESCRIPTION\s0" +.SS DESCRIPTION .IX Subsection "DESCRIPTION" The \fIprograms\fR file is an automatically generated menu configuration file of installed programs. This file should be automatically generated by xdg_menu, wmconfig (Redhat), menu (Debian), or icewm-menu-fdo, perhaps as part of the login or X startup sequence. -.SS "\s-1FORMAT\s0" +.SS FORMAT .IX Subsection "FORMAT" The format of the file contains one of the following line syntax: -.ie n .IP "\fBprog\fR [\fB""\fR]\fItitle\fR[\fB""\fR] \fIicon\fR \fIprogram\fR \fIoptions\fR" 4 -.el .IP "\fBprog\fR [\fB``\fR]\fItitle\fR[\fB''\fR] \fIicon\fR \fIprogram\fR \fIoptions\fR" 4 +.IP "\fBprog\fR [\fB""\fR]\fItitle\fR[\fB""\fR] \fIicon\fR \fIprogram\fR \fIoptions\fR" 4 .IX Item "prog [""]title[""] icon program options" Specifies a program to execute when the menu item is selected. -.ie n .IP "\fBrestart\fR [\fB""\fR]\fItitle\fR[\fB""\fR] \fIicon\fR \fIprogram\fR \fIoptions\fR" 4 -.el .IP "\fBrestart\fR [\fB``\fR]\fItitle\fR[\fB''\fR] \fIicon\fR \fIprogram\fR \fIoptions\fR" 4 +.IP "\fBrestart\fR [\fB""\fR]\fItitle\fR[\fB""\fR] \fIicon\fR \fIprogram\fR \fIoptions\fR" 4 .IX Item "restart [""]title[""] icon program options" Specifies a program to replace the window manager when the menu item is selected. This is for launching other window managers from within \&\fBicewm\fR\|(1). -.ie n .IP "\fBrunonce\fR [\fB""\fR]\fItitle\fR[\fB""\fR] \fIicon\fR \fB""\fR[\fIres_name\fR][\fB.\fR\fIres_class\fR]\fB""\fR \fIprogram\fR \fIoptions\fR" 4 -.el .IP "\fBrunonce\fR [\fB``\fR]\fItitle\fR[\fB''\fR] \fIicon\fR \fB``\fR[\fIres_name\fR][\fB.\fR\fIres_class\fR]\fB''\fR \fIprogram\fR \fIoptions\fR" 4 +.IP "\fBrunonce\fR [\fB""\fR]\fItitle\fR[\fB""\fR] \fIicon\fR \fB""\fR[\fIres_name\fR][\fB.\fR\fIres_class\fR]\fB""\fR \fIprogram\fR \fIoptions\fR" 4 .IX Item "runonce [""]title[""] icon ""[res_name][.res_class]"" program options" Specifies a program to execute when the menu item is selected; however, if a window of the specified \fIres_name\fR and \fIres_class\fR is present, the program will not be run again. -.ie n .IP "\fBmenu\fR [\fB""\fR]\fItitle\fR[\fB""\fR] \fIicon\fR \fB{\fR # contained items \fB}\fR" 4 -.el .IP "\fBmenu\fR [\fB``\fR]\fItitle\fR[\fB''\fR] \fIicon\fR \fB{\fR # contained items \fB}\fR" 4 +.IP "\fBmenu\fR [\fB""\fR]\fItitle\fR[\fB""\fR] \fIicon\fR \fB{\fR # contained items \fB}\fR" 4 .IX Item "menu [""]title[""] icon { # contained items }" Specifies a sub-menu. The lines that appear between the braces can be any menu item described here. -.ie n .IP "\fBmenufile\fR [\fB""\fR]\fItitle\fR[\fB""\fR] \fIicon\fR [\fB""\fR]\fIfilename\fR[\fB""\fR]" 4 -.el .IP "\fBmenufile\fR [\fB``\fR]\fItitle\fR[\fB''\fR] \fIicon\fR [\fB``\fR]\fIfilename\fR[\fB''\fR]" 4 +.IP "\fBmenufile\fR [\fB""\fR]\fItitle\fR[\fB""\fR] \fIicon\fR [\fB""\fR]\fIfilename\fR[\fB""\fR]" 4 .IX Item "menufile [""]title[""] icon [""]filename[""]" Specifies a file from which to collect sub-menu items (lines) and place them at this point in the menu. -.ie n .IP "\fBmenuprog\fR [\fB""\fR]\fItitle\fR[\fB""\fR] \fIicon\fR \fIprogram\fR \fIoptions\fR" 4 -.el .IP "\fBmenuprog\fR [\fB``\fR]\fItitle\fR[\fB''\fR] \fIicon\fR \fIprogram\fR \fIoptions\fR" 4 +.IP "\fBmenuprog\fR [\fB""\fR]\fItitle\fR[\fB""\fR] \fIicon\fR \fIprogram\fR \fIoptions\fR" 4 .IX Item "menuprog [""]title[""] icon program options" Specifies a program that will print sub-menu items on standard output and will be collected and placed in the sub-menu at this point. -.ie n .IP "\fBmenuprogreload\fR [\fB""\fR]\fItitle\fR[\fB""\fR] \fIicon\fR \fItimeout\fR \fIprogram\fR \fIoptions\fR" 4 -.el .IP "\fBmenuprogreload\fR [\fB``\fR]\fItitle\fR[\fB''\fR] \fIicon\fR \fItimeout\fR \fIprogram\fR \fIoptions\fR" 4 +.IP "\fBmenuprogreload\fR [\fB""\fR]\fItitle\fR[\fB""\fR] \fIicon\fR \fItimeout\fR \fIprogram\fR \fIoptions\fR" 4 .IX Item "menuprogreload [""]title[""] icon timeout program options" Similar to \fBmenuprog\fR, but after at least \fItimeout\fR seconds the menu is regenerated. -.ie n .IP "\fBinclude\fR [\fB""\fR]\fIfilename\fR[\fB""\fR]" 4 -.el .IP "\fBinclude\fR [\fB``\fR]\fIfilename\fR[\fB''\fR]" 4 +.IP "\fBinclude\fR [\fB""\fR]\fIfilename\fR[\fB""\fR]" 4 .IX Item "include [""]filename[""]" Read additional entries from the file \fIfilename\fR .IP "\fBincludeprog\fR \fIprogram\fR \fIoptions\fR" 4 .IX Item "includeprog program options" Read additional entries from the output of \fIprogram\fR \fIoptions\fR. -.IP "\fBseparator\fR" 4 +.IP \fBseparator\fR 4 .IX Item "separator" A separator for menu items. .PP @@ -212,19 +126,17 @@ Where .IP "\fBprog\fR, \fBrestart\fR, \fBrunonce\fR, \fBmenu\fR, \fBmenufile\fR, \fBmenuprog\fR, \fBmenuprogreload\fR, \fBinclude\fR, \fBincludeprog\fR, \fBseparator\fR" 4 .IX Item "prog, restart, runonce, menu, menufile, menuprog, menuprogreload, include, includeprog, separator" These are literal string keywords. -.ie n .IP "[\fB""\fR]\fItitle\fR[\fB""\fR]" 4 -.el .IP "[\fB``\fR]\fItitle\fR[\fB''\fR]" 4 +.IP "[\fB""\fR]\fItitle\fR[\fB""\fR]" 4 .IX Item "[""]title[""]" This is the \fItitle\fR string associated with the menu item that is displayed in the menu. When the \fItitle\fR contains spaces, the title must be surrounded by double quotes (\f(CW\*(C`"\*(C'\fR), although the \fItitle\fR may always be surrounded by double quotes if preferred. -.IP "\fIicon\fR" 4 +.IP \fIicon\fR 4 .IX Item "icon" Is the name of the icon file (with or without extension) or the full path to an icon file. -.ie n .IP "\fB""\fR[\fIres_name\fR][\fB.\fR\fIres_class\fR]\fB""\fR" 4 -.el .IP "\fB``\fR[\fIres_name\fR][\fB.\fR\fIres_class\fR]\fB''\fR" 4 +.IP "\fB""\fR[\fIres_name\fR][\fB.\fR\fIres_class\fR]\fB""\fR" 4 .IX Item """[res_name][.res_class]""" \&\fIres_name\fR is the resource name of a window launched by \fIprogram\fR and \&\fIres_class\fR is the resource class of the window. Only one of @@ -240,13 +152,13 @@ contents of the menu and is used for dynamic menus. .Sp \&\fIoptions\fR is the options and arguments passed to the \fIprogram\fR verbatim. -.IP "\fIfilename\fR" 4 +.IP \fIfilename\fR 4 .IX Item "filename" \&\fIfilename\fR is the name of the file relative to one of the \fBicewm\fR\|(1) configuration directories, or the full path to a file. The file is used with the \fBmenufile\fR keyword and specifies the file from which to read further menu items. -.SS "\s-1EXAMPLES\s0" +.SS EXAMPLES .IX Subsection "EXAMPLES" Following is the example \fIprograms\fR file that ships with \fBicewm\fR\|(1): .PP @@ -322,7 +234,7 @@ Following is the example \fIprograms\fR file that ships with \fBicewm\fR\|(1): \& restart sawfish2 \- sawfish2 \& } .Ve -.SS "\s-1FILES\s0" +.SS FILES .IX Subsection "FILES" Locations for the \fIprograms\fR file are as follows: .PP @@ -336,15 +248,15 @@ Locations for the \fIprograms\fR file are as follows: .PP The locations are searched in the order listed; the first file found is read and the remainder ignored. -.SS "\s-1SEE ALSO\s0" +.SS "SEE ALSO" .IX Subsection "SEE ALSO" \&\fBicewm\fR\|(1), \&\fBicewm\-menu\fR\|(5), \&\fBicewm\-menu\-fdo\fR\|(1). -.SS "\s-1AUTHOR\s0" +.SS AUTHOR .IX Subsection "AUTHOR" Brian Bidulock <mailto:bidulock@openss7.org>. -.SS "\s-1LICENSE\s0" +.SS LICENSE .IX Subsection "LICENSE" -\&\fBIceWM\fR is licensed under the \s-1GNU\s0 Library General Public License. -See the \fI\s-1COPYING\s0\fR file in the distribution. +\&\fBIceWM\fR is licensed under the GNU Library General Public License. +See the \fICOPYING\fR file in the distribution. diff --git a/upstream/debian-unstable/man5/icewm-shutdown.5 b/upstream/debian-unstable/man5/icewm-shutdown.5 index 19185fdb..66bc5c0b 100644 --- a/upstream/debian-unstable/man5/icewm-shutdown.5 +++ b/upstream/debian-unstable/man5/icewm-shutdown.5 @@ -1,4 +1,5 @@ -.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43) +.\" -*- mode: troff; coding: utf-8 -*- +.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== @@ -15,29 +16,12 @@ .ft R .fi .. -.\" Set up some character translations and predefined strings. \*(-- will -.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left -.\" double quote, and \*(R" will give a right double quote. \*(C+ will -.\" give a nicer C++. Capital omega is used to do unbreakable dashes and -.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, -.\" nothing in troff, for use with C<>. -.tr \(*W- -.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ -. ds -- \(*W- -. ds PI pi -. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch -. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch -. ds L" "" -. ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ -. ds -- \|\(em\| -. ds PI \(*p -. ds L" `` -. ds R" '' . ds C` . ds C' 'br\} @@ -68,82 +52,20 @@ . \} .\} .rr rF -.\" -.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). -.\" Fear. Run. Save yourself. No user-serviceable parts. -. \" fudge factors for nroff and troff -.if n \{\ -. ds #H 0 -. ds #V .8m -. ds #F .3m -. ds #[ \f1 -. ds #] \fP -.\} -.if t \{\ -. ds #H ((1u-(\\\\n(.fu%2u))*.13m) -. ds #V .6m -. ds #F 0 -. ds #[ \& -. ds #] \& -.\} -. \" simple accents for nroff and troff -.if n \{\ -. ds ' \& -. ds ` \& -. ds ^ \& -. ds , \& -. ds ~ ~ -. ds / -.\} -.if t \{\ -. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" -. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' -. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' -. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' -. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' -. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' -.\} -. \" troff and (daisy-wheel) nroff accents -.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' -.ds 8 \h'\*(#H'\(*b\h'-\*(#H' -.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] -.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' -.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' -.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] -.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] -.ds ae a\h'-(\w'a'u*4/10)'e -.ds Ae A\h'-(\w'A'u*4/10)'E -. \" corrections for vroff -.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' -.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' -. \" for low resolution devices (crt and lpr) -.if \n(.H>23 .if \n(.V>19 \ -\{\ -. ds : e -. ds 8 ss -. ds o a -. ds d- d\h'-1'\(ga -. ds D- D\h'-1'\(hy -. ds th \o'bp' -. ds Th \o'LP' -. ds ae ae -. ds Ae AE -.\} -.rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "ICEWM-SHUTDOWN 5" -.TH ICEWM-SHUTDOWN 5 "2023-12-31" "icewm\ 3.4.5" "Standards, Environments and Macros" +.TH ICEWM-SHUTDOWN 5 2024-05-24 "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 .nh -.SS "\s-1NAME\s0" +.SS NAME .IX Subsection "NAME" .Vb 1 \& icewm\-shutdown \- icewm shutdown configuration file .Ve -.SS "\s-1SYNOPSIS\s0" +.SS SYNOPSIS .IX Subsection "SYNOPSIS" .Vb 5 \& $ICEWM_PRIVCFG/shutdown @@ -152,14 +74,14 @@ \& /etc/X11/icewm/shutdown \& /usr/share/icewm/shutdown .Ve -.SS "\s-1DESCRIPTION\s0" +.SS DESCRIPTION .IX Subsection "DESCRIPTION" Contains commands to be executed on \fBicewm\fR shutdown. This is an executable script with commands to be executed in the last stage of \&\fBicewm\fR termination. Typically they may undo some of the effects of the \fIstartup\fR script. It is run by \fBicewm\-session\fR\|(1) when \fBicewm\fR terminates. -.SS "\s-1FILES\s0" +.SS FILES .IX Subsection "FILES" Locations for the \fIshutdown\fR file are as follows: .PP @@ -173,14 +95,14 @@ Locations for the \fIshutdown\fR file are as follows: .PP The locations are searched in the order listed; the first file found is read and the remainder ignored. -.SS "\s-1SEE ALSO\s0" +.SS "SEE ALSO" .IX Subsection "SEE ALSO" \&\fBicewm\-session\fR\|(1), \&\fBicewm\-startup\fR\|(5). -.SS "\s-1AUTHOR\s0" +.SS AUTHOR .IX Subsection "AUTHOR" Brian Bidulock <mailto:bidulock@openss7.org>. -.SS "\s-1LICENSE\s0" +.SS LICENSE .IX Subsection "LICENSE" -\&\fBIceWM\fR is licensed under the \s-1GNU\s0 Library General Public License. -See the \fI\s-1COPYING\s0\fR file in the distribution. +\&\fBIceWM\fR is licensed under the GNU Library General Public License. +See the \fICOPYING\fR file in the distribution. diff --git a/upstream/debian-unstable/man5/icewm-startup.5 b/upstream/debian-unstable/man5/icewm-startup.5 index 5d13125d..9e7444ee 100644 --- a/upstream/debian-unstable/man5/icewm-startup.5 +++ b/upstream/debian-unstable/man5/icewm-startup.5 @@ -1,4 +1,5 @@ -.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43) +.\" -*- mode: troff; coding: utf-8 -*- +.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== @@ -15,29 +16,12 @@ .ft R .fi .. -.\" Set up some character translations and predefined strings. \*(-- will -.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left -.\" double quote, and \*(R" will give a right double quote. \*(C+ will -.\" give a nicer C++. Capital omega is used to do unbreakable dashes and -.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, -.\" nothing in troff, for use with C<>. -.tr \(*W- -.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ -. ds -- \(*W- -. ds PI pi -. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch -. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch -. ds L" "" -. ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ -. ds -- \|\(em\| -. ds PI \(*p -. ds L" `` -. ds R" '' . ds C` . ds C' 'br\} @@ -68,82 +52,20 @@ . \} .\} .rr rF -.\" -.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). -.\" Fear. Run. Save yourself. No user-serviceable parts. -. \" fudge factors for nroff and troff -.if n \{\ -. ds #H 0 -. ds #V .8m -. ds #F .3m -. ds #[ \f1 -. ds #] \fP -.\} -.if t \{\ -. ds #H ((1u-(\\\\n(.fu%2u))*.13m) -. ds #V .6m -. ds #F 0 -. ds #[ \& -. ds #] \& -.\} -. \" simple accents for nroff and troff -.if n \{\ -. ds ' \& -. ds ` \& -. ds ^ \& -. ds , \& -. ds ~ ~ -. ds / -.\} -.if t \{\ -. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" -. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' -. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' -. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' -. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' -. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' -.\} -. \" troff and (daisy-wheel) nroff accents -.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' -.ds 8 \h'\*(#H'\(*b\h'-\*(#H' -.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] -.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' -.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' -.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] -.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] -.ds ae a\h'-(\w'a'u*4/10)'e -.ds Ae A\h'-(\w'A'u*4/10)'E -. \" corrections for vroff -.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' -.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' -. \" for low resolution devices (crt and lpr) -.if \n(.H>23 .if \n(.V>19 \ -\{\ -. ds : e -. ds 8 ss -. ds o a -. ds d- d\h'-1'\(ga -. ds D- D\h'-1'\(hy -. ds th \o'bp' -. ds Th \o'LP' -. ds ae ae -. ds Ae AE -.\} -.rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "ICEWM-STARTUP 5" -.TH ICEWM-STARTUP 5 "2023-12-31" "icewm\ 3.4.5" "Standards, Environments and Macros" +.TH ICEWM-STARTUP 5 2024-05-24 "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 .nh -.SS "\s-1NAME\s0" +.SS NAME .IX Subsection "NAME" .Vb 1 \& icewm\-startup \- icewm startup configuration file .Ve -.SS "\s-1SYNOPSIS\s0" +.SS SYNOPSIS .IX Subsection "SYNOPSIS" .Vb 5 \& $ICEWM_PRIVCFG/startup @@ -152,13 +74,13 @@ \& /etc/X11/icewm/startup \& /usr/share/icewm/startup .Ve -.SS "\s-1DESCRIPTION\s0" +.SS DESCRIPTION .IX Subsection "DESCRIPTION" The \fIstartup\fR file contains commands to be executed on \fBicewm\fR startup. This is an executable script. Typically the commands tweak X11 settings and launch some applications that always need to be active. It is run by \fBicewm\-session\fR\|(1) when \fBicewm\fR starts. -.SS "\s-1EXAMPLES\s0" +.SS EXAMPLES .IX Subsection "EXAMPLES" .Vb 6 \& #!/bin/bash @@ -172,7 +94,7 @@ It is run by \fBicewm\-session\fR\|(1) when \fBicewm\fR starts. Remember to \f(CW\*(C`chmod +x ~/.icewm/startup\*(C'\fR. The first line must be a hash-bang, followed by the path of your script interpreter or shell. -.SS "\s-1FILES\s0" +.SS FILES .IX Subsection "FILES" Locations for the \fIstartup\fR file are as follows: .PP @@ -186,14 +108,14 @@ Locations for the \fIstartup\fR file are as follows: .PP The locations are searched in the order listed; the first file found is executed and the remainder ignored. -.SS "\s-1SEE ALSO\s0" +.SS "SEE ALSO" .IX Subsection "SEE ALSO" \&\fBicewm\-session\fR\|(1), \&\fBicewm\-shutdown\fR\|(5). -.SS "\s-1AUTHOR\s0" +.SS AUTHOR .IX Subsection "AUTHOR" Brian Bidulock <mailto:bidulock@openss7.org>. -.SS "\s-1LICENSE\s0" +.SS LICENSE .IX Subsection "LICENSE" -\&\fBIceWM\fR is licensed under the \s-1GNU\s0 Library General Public License. -See the \fI\s-1COPYING\s0\fR file in the distribution. +\&\fBIceWM\fR is licensed under the GNU Library General Public License. +See the \fICOPYING\fR file in the distribution. diff --git a/upstream/debian-unstable/man5/icewm-theme.5 b/upstream/debian-unstable/man5/icewm-theme.5 index 720e584a..f709cdb7 100644 --- a/upstream/debian-unstable/man5/icewm-theme.5 +++ b/upstream/debian-unstable/man5/icewm-theme.5 @@ -1,4 +1,5 @@ -.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43) +.\" -*- mode: troff; coding: utf-8 -*- +.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== @@ -15,29 +16,12 @@ .ft R .fi .. -.\" Set up some character translations and predefined strings. \*(-- will -.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left -.\" double quote, and \*(R" will give a right double quote. \*(C+ will -.\" give a nicer C++. Capital omega is used to do unbreakable dashes and -.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, -.\" nothing in troff, for use with C<>. -.tr \(*W- -.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ -. ds -- \(*W- -. ds PI pi -. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch -. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch -. ds L" "" -. ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ -. ds -- \|\(em\| -. ds PI \(*p -. ds L" `` -. ds R" '' . ds C` . ds C' 'br\} @@ -68,82 +52,20 @@ . \} .\} .rr rF -.\" -.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). -.\" Fear. Run. Save yourself. No user-serviceable parts. -. \" fudge factors for nroff and troff -.if n \{\ -. ds #H 0 -. ds #V .8m -. ds #F .3m -. ds #[ \f1 -. ds #] \fP -.\} -.if t \{\ -. ds #H ((1u-(\\\\n(.fu%2u))*.13m) -. ds #V .6m -. ds #F 0 -. ds #[ \& -. ds #] \& -.\} -. \" simple accents for nroff and troff -.if n \{\ -. ds ' \& -. ds ` \& -. ds ^ \& -. ds , \& -. ds ~ ~ -. ds / -.\} -.if t \{\ -. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" -. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' -. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' -. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' -. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' -. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' -.\} -. \" troff and (daisy-wheel) nroff accents -.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' -.ds 8 \h'\*(#H'\(*b\h'-\*(#H' -.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] -.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' -.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' -.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] -.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] -.ds ae a\h'-(\w'a'u*4/10)'e -.ds Ae A\h'-(\w'A'u*4/10)'E -. \" corrections for vroff -.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' -.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' -. \" for low resolution devices (crt and lpr) -.if \n(.H>23 .if \n(.V>19 \ -\{\ -. ds : e -. ds 8 ss -. ds o a -. ds d- d\h'-1'\(ga -. ds D- D\h'-1'\(hy -. ds th \o'bp' -. ds Th \o'LP' -. ds ae ae -. ds Ae AE -.\} -.rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "ICEWM-THEME 5" -.TH ICEWM-THEME 5 "2023-12-31" "icewm\ 3.4.5" "Standards, Environments and Macros" +.TH ICEWM-THEME 5 2024-05-24 "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 .nh -.SS "\s-1NAME\s0" +.SS NAME .IX Subsection "NAME" .Vb 1 \& icewm\-theme \- icewm theme configuration file .Ve -.SS "\s-1SYNOPSIS\s0" +.SS SYNOPSIS .IX Subsection "SYNOPSIS" .Vb 5 \& $ICEWM_PRIVCFG/theme @@ -152,14 +74,14 @@ \& /etc/X11/icewm/theme \& /usr/share/icewm/theme .Ve -.SS "\s-1DESCRIPTION\s0" +.SS DESCRIPTION .IX Subsection "DESCRIPTION" The \fItheme\fR file contains the name of the default theme. On startup \&\fBicewm\fR reads this file to obtain the theme name, unless \fBicewm\fR was started with the \fB\-\-theme\fR option. Whenever a different theme is selected from the \fBicewm\fR Menu then the theme file is overwritten with the name of the selected theme. -.SS "\s-1FORMAT\s0" +.SS FORMAT .IX Subsection "FORMAT" This theme file contains the keyword \f(CW\*(C`Theme\*(C'\fR, followed by an equals sign, followed by a double-quoted string with the theme name. The theme @@ -172,7 +94,7 @@ specified in their own \fI.theme\fR file, which replaces \fIdefault.theme\fR. .PP If no theme file exists then \fBicewm\fR will use the default setting of \&\f(CW\*(C`Theme="default/default.theme"\*(C'\fR. -.SS "\s-1EXAMPLES\s0" +.SS EXAMPLES .IX Subsection "EXAMPLES" Following is my current \fItheme\fR file. You can see from the comments that \fBicewm\fR\|(1) keeps a history of the previous ten theme settings. @@ -190,7 +112,7 @@ that \fBicewm\fR\|(1) keeps a history of the previous ten theme settings. \& #########Theme="default/default.theme" \& ##########Theme="yellowmotif/default.theme" .Ve -.SS "\s-1FILES\s0" +.SS FILES .IX Subsection "FILES" Locations for the \fItheme\fR file are as follows: .PP @@ -204,15 +126,15 @@ Locations for the \fItheme\fR file are as follows: .PP The locations are searched in the order listed; the first file found is read and the remainder ignored. -.SS "\s-1SEE ALSO\s0" +.SS "SEE ALSO" .IX Subsection "SEE ALSO" \&\fBicewm\fR\|(1), \&\fBicewm\-preferences\fR\|(5), \&\fBicewm\-prefoverride\fR\|(5). -.SS "\s-1AUTHOR\s0" +.SS AUTHOR .IX Subsection "AUTHOR" Brian Bidulock <mailto:bidulock@openss7.org>. -.SS "\s-1LICENSE\s0" +.SS LICENSE .IX Subsection "LICENSE" -\&\fBIceWM\fR is licensed under the \s-1GNU\s0 Library General Public License. -See the \fI\s-1COPYING\s0\fR file in the distribution. +\&\fBIceWM\fR is licensed under the GNU Library General Public License. +See the \fICOPYING\fR file in the distribution. diff --git a/upstream/debian-unstable/man5/icewm-toolbar.5 b/upstream/debian-unstable/man5/icewm-toolbar.5 index 1f46cce1..ea1e1a3a 100644 --- a/upstream/debian-unstable/man5/icewm-toolbar.5 +++ b/upstream/debian-unstable/man5/icewm-toolbar.5 @@ -1,4 +1,5 @@ -.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43) +.\" -*- mode: troff; coding: utf-8 -*- +.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== @@ -15,29 +16,12 @@ .ft R .fi .. -.\" Set up some character translations and predefined strings. \*(-- will -.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left -.\" double quote, and \*(R" will give a right double quote. \*(C+ will -.\" give a nicer C++. Capital omega is used to do unbreakable dashes and -.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, -.\" nothing in troff, for use with C<>. -.tr \(*W- -.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ -. ds -- \(*W- -. ds PI pi -. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch -. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch -. ds L" "" -. ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ -. ds -- \|\(em\| -. ds PI \(*p -. ds L" `` -. ds R" '' . ds C` . ds C' 'br\} @@ -68,82 +52,20 @@ . \} .\} .rr rF -.\" -.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). -.\" Fear. Run. Save yourself. No user-serviceable parts. -. \" fudge factors for nroff and troff -.if n \{\ -. ds #H 0 -. ds #V .8m -. ds #F .3m -. ds #[ \f1 -. ds #] \fP -.\} -.if t \{\ -. ds #H ((1u-(\\\\n(.fu%2u))*.13m) -. ds #V .6m -. ds #F 0 -. ds #[ \& -. ds #] \& -.\} -. \" simple accents for nroff and troff -.if n \{\ -. ds ' \& -. ds ` \& -. ds ^ \& -. ds , \& -. ds ~ ~ -. ds / -.\} -.if t \{\ -. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" -. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' -. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' -. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' -. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' -. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' -.\} -. \" troff and (daisy-wheel) nroff accents -.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' -.ds 8 \h'\*(#H'\(*b\h'-\*(#H' -.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] -.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' -.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' -.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] -.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] -.ds ae a\h'-(\w'a'u*4/10)'e -.ds Ae A\h'-(\w'A'u*4/10)'E -. \" corrections for vroff -.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' -.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' -. \" for low resolution devices (crt and lpr) -.if \n(.H>23 .if \n(.V>19 \ -\{\ -. ds : e -. ds 8 ss -. ds o a -. ds d- d\h'-1'\(ga -. ds D- D\h'-1'\(hy -. ds th \o'bp' -. ds Th \o'LP' -. ds ae ae -. ds Ae AE -.\} -.rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "ICEWM-TOOLBAR 5" -.TH ICEWM-TOOLBAR 5 "2023-12-31" "icewm\ 3.4.5" "Standards, Environments and Macros" +.TH ICEWM-TOOLBAR 5 2024-05-24 "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 .nh -.SS "\s-1NAME\s0" +.SS NAME .IX Subsection "NAME" .Vb 1 \& icewm\-toolbar \- icewm toolbar configuration file .Ve -.SS "\s-1SYNOPSIS\s0" +.SS SYNOPSIS .IX Subsection "SYNOPSIS" .Vb 5 \& $ICEWM_PRIVCFG/toolbar @@ -152,7 +74,7 @@ \& /etc/X11/icewm/toolbar \& /usr/share/icewm/toolbar .Ve -.SS "\s-1DESCRIPTION\s0" +.SS DESCRIPTION .IX Subsection "DESCRIPTION" The \fItoolbar\fR file is responsible for configuring quick launch application icons that are placed on the \fBicewm\fR\|(1) panel. It @@ -170,7 +92,7 @@ with the \fIfirefox\fR icon which launches \fBfirefox\fR\|(1) when clicked: .Vb 1 \& prog "Mozilla Firefox" firefox /usr/bin/firefox \-\-private\-window .Ve -.SS "\s-1FORMAT\s0" +.SS FORMAT .IX Subsection "FORMAT" The format of the file contains one of the following line syntax: .Sp @@ -179,30 +101,29 @@ The format of the file contains one of the following line syntax: .RE .PP Where, -.IP "\fBprog\fR" 4 +.IP \fBprog\fR 4 .IX Item "prog" The literal string \fBprog\fR. -.ie n .IP "\fB""\fR\fItitle\fR\fB""\fR" 4 -.el .IP "\fB``\fR\fItitle\fR\fB''\fR" 4 +.IP "\fB""\fR\fItitle\fR\fB""\fR" 4 .IX Item """title""" The title of the toolbar item, which will appear as a tool-tip for the program button, enclosed in double quotes (\f(CW\*(C`"\*(C'\fR). -.IP "\fIicon\fR" 4 +.IP \fIicon\fR 4 .IX Item "icon" The icon to display on the toolbar button. May be specified as a single dash (\f(CW\*(C`\-\*(C'\fR) when no icon is provided. When no icon is provided, the \&\fItitle\fR text will be displayed on the button in place of the icon. -.IP "\fIprogram\fR" 4 +.IP \fIprogram\fR 4 .IX Item "program" The executable program (full path or executable name) to run when the button is pressed. -.IP "\fIoptions\fR" 4 +.IP \fIoptions\fR 4 .IX Item "options" Options and arguments that are passed to \fIprogram\fR. .PP Lines beginning with a hash (\f(CW\*(C`#\*(C'\fR) are comment lines. Comment lines and blank lines are ignored. -.SS "\s-1EXAMPLES\s0" +.SS EXAMPLES .IX Subsection "EXAMPLES" Following is an example that places a number of toolbar buttons on the \&\fBicewm\fR\|(1) panel: @@ -217,7 +138,7 @@ Following is an example that places a number of toolbar buttons on the \& prog "Network" gtk\-network.png pcmanfm ~/Network \& prog "Logout" system\-log\-out.png xde\-logout .Ve -.SS "\s-1FILES\s0" +.SS FILES .IX Subsection "FILES" Locations for the \fItoolbar\fR file are as follows: .PP @@ -231,16 +152,16 @@ Locations for the \fItoolbar\fR file are as follows: .PP The locations are searched in the order listed; the first file found is read and the remainder ignored. -.SS "\s-1SEE ALSO\s0" +.SS "SEE ALSO" .IX Subsection "SEE ALSO" \&\fBicewm\fR\|(1), \&\fBicewm\-programs\fR\|(5), \&\fBicewm\-menu\fR\|(5), \&\fBicewm\-menu\-fdo\fR\|(1). -.SS "\s-1AUTHOR\s0" +.SS AUTHOR .IX Subsection "AUTHOR" Brian Bidulock <mailto:bidulock@openss7.org>. -.SS "\s-1LICENSE\s0" +.SS LICENSE .IX Subsection "LICENSE" -\&\fBIceWM\fR is licensed under the \s-1GNU\s0 Library General Public License. -See the \fI\s-1COPYING\s0\fR file in the distribution. +\&\fBIceWM\fR is licensed under the GNU Library General Public License. +See the \fICOPYING\fR file in the distribution. diff --git a/upstream/debian-unstable/man5/icewm-winoptions.5 b/upstream/debian-unstable/man5/icewm-winoptions.5 index f823eb76..ea9b07e3 100644 --- a/upstream/debian-unstable/man5/icewm-winoptions.5 +++ b/upstream/debian-unstable/man5/icewm-winoptions.5 @@ -1,4 +1,5 @@ -.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43) +.\" -*- mode: troff; coding: utf-8 -*- +.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== @@ -15,29 +16,12 @@ .ft R .fi .. -.\" Set up some character translations and predefined strings. \*(-- will -.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left -.\" double quote, and \*(R" will give a right double quote. \*(C+ will -.\" give a nicer C++. Capital omega is used to do unbreakable dashes and -.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, -.\" nothing in troff, for use with C<>. -.tr \(*W- -.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ -. ds -- \(*W- -. ds PI pi -. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch -. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch -. ds L" "" -. ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ -. ds -- \|\(em\| -. ds PI \(*p -. ds L" `` -. ds R" '' . ds C` . ds C' 'br\} @@ -68,82 +52,20 @@ . \} .\} .rr rF -.\" -.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). -.\" Fear. Run. Save yourself. No user-serviceable parts. -. \" fudge factors for nroff and troff -.if n \{\ -. ds #H 0 -. ds #V .8m -. ds #F .3m -. ds #[ \f1 -. ds #] \fP -.\} -.if t \{\ -. ds #H ((1u-(\\\\n(.fu%2u))*.13m) -. ds #V .6m -. ds #F 0 -. ds #[ \& -. ds #] \& -.\} -. \" simple accents for nroff and troff -.if n \{\ -. ds ' \& -. ds ` \& -. ds ^ \& -. ds , \& -. ds ~ ~ -. ds / -.\} -.if t \{\ -. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" -. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' -. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' -. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' -. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' -. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' -.\} -. \" troff and (daisy-wheel) nroff accents -.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' -.ds 8 \h'\*(#H'\(*b\h'-\*(#H' -.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] -.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' -.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' -.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] -.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] -.ds ae a\h'-(\w'a'u*4/10)'e -.ds Ae A\h'-(\w'A'u*4/10)'E -. \" corrections for vroff -.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' -.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' -. \" for low resolution devices (crt and lpr) -.if \n(.H>23 .if \n(.V>19 \ -\{\ -. ds : e -. ds 8 ss -. ds o a -. ds d- d\h'-1'\(ga -. ds D- D\h'-1'\(hy -. ds th \o'bp' -. ds Th \o'LP' -. ds ae ae -. ds Ae AE -.\} -.rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "ICEWM-WINOPTIONS 5" -.TH ICEWM-WINOPTIONS 5 "2023-12-31" "icewm\ 3.4.5" "Standards, Environments and Macros" +.TH ICEWM-WINOPTIONS 5 2024-05-24 "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 .nh -.SS "\s-1NAME\s0" +.SS NAME .IX Subsection "NAME" .Vb 1 \& icewm\-winoptions \- IceWM window options configuration file .Ve -.SS "\s-1SYNOPSIS\s0" +.SS SYNOPSIS .IX Subsection "SYNOPSIS" .Vb 5 \& $ICEWM_PRIVCFG/winoptions @@ -152,7 +74,7 @@ \& /etc/X11/icewm/winoptions \& /usr/share/icewm/winoptions .Ve -.SS "\s-1DESCRIPTION\s0" +.SS DESCRIPTION .IX Subsection "DESCRIPTION" The IceWM \fIwinoptions\fR file contains settings to control \&\fIapplication specific\fR window appearance and behavior. @@ -165,60 +87,60 @@ they can be overridden later using \fBicesh\fR\|(1) or \fBicewmhint\fR\|(1). The command \f(CW\*(C`icesh winoptions\*(C'\fR instructs icewm to reload the \&\fIwinoptions\fR file, while \fIicewmhint\fR tunes a specific application instance when it starts. -.SS "\s-1FORMAT\s0" +.SS FORMAT .IX Subsection "FORMAT" Each line in the file must be in one of the following formats: .RS 4 -.IP "\fI\s-1NAME\s0\fR\fB.\fR\fI\s-1CLASS\s0\fR\fB.\fR\fI\s-1OPTION\s0\fR\fB:\fR \fI\s-1VALUE\s0\fR" 4 +.IP "\fINAME\fR\fB.\fR\fICLASS\fR\fB.\fR\fIOPTION\fR\fB:\fR \fIVALUE\fR" 4 .IX Item "NAME.CLASS.OPTION: VALUE" .PD 0 -.IP "\fI\s-1CLASS\s0\fR\fB.\fR\fI\s-1ROLE\s0\fR\fB.\fR\fI\s-1OPTION\s0\fR\fB:\fR \fI\s-1VALUE\s0\fR" 4 +.IP "\fICLASS\fR\fB.\fR\fIROLE\fR\fB.\fR\fIOPTION\fR\fB:\fR \fIVALUE\fR" 4 .IX Item "CLASS.ROLE.OPTION: VALUE" -.IP "\fI\s-1NAME\s0\fR\fB.\fR\fI\s-1ROLE\s0\fR\fB.\fR\fI\s-1OPTION\s0\fR\fB:\fR \fI\s-1VALUE\s0\fR" 4 +.IP "\fINAME\fR\fB.\fR\fIROLE\fR\fB.\fR\fIOPTION\fR\fB:\fR \fIVALUE\fR" 4 .IX Item "NAME.ROLE.OPTION: VALUE" -.IP "\fI\s-1CLASS\s0\fR\fB.\fR\fI\s-1OPTION\s0\fR\fB:\fR \fI\s-1VALUE\s0\fR" 4 +.IP "\fICLASS\fR\fB.\fR\fIOPTION\fR\fB:\fR \fIVALUE\fR" 4 .IX Item "CLASS.OPTION: VALUE" -.IP "\fI\s-1NAME\s0\fR\fB.\fR\fI\s-1OPTION\s0\fR\fB:\fR \fI\s-1VALUE\s0\fR" 4 +.IP "\fINAME\fR\fB.\fR\fIOPTION\fR\fB:\fR \fIVALUE\fR" 4 .IX Item "NAME.OPTION: VALUE" -.IP "\fI\s-1ROLE\s0\fR\fB.\fR\fI\s-1OPTION\s0\fR\fB:\fR \fI\s-1VALUE\s0\fR" 4 +.IP "\fIROLE\fR\fB.\fR\fIOPTION\fR\fB:\fR \fIVALUE\fR" 4 .IX Item "ROLE.OPTION: VALUE" -.IP "\fB.\fR\fI\s-1OPTION\s0\fR\fB:\fR \fI\s-1VALUE\s0\fR" 4 +.IP "\fB.\fR\fIOPTION\fR\fB:\fR \fIVALUE\fR" 4 .IX Item ".OPTION: VALUE" .RE .RS 4 .RE .PD .PP -Here \fI\s-1NAME\s0\fR and \fI\s-1CLASS\s0\fR are from the \fB\s-1WM_CLASS\s0\fR property of the +Here \fINAME\fR and \fICLASS\fR are from the \fBWM_CLASS\fR property of the window. This can be found in the output of \f(CW\*(C`icesh \-a getClass\*(C'\fR. .PP -While \fI\s-1ROLE\s0\fR refers to the \fB\s-1WM_WINDOW_ROLE\s0\fR property of the window, +While \fIROLE\fR refers to the \fBWM_WINDOW_ROLE\fR property of the window, which is the application instance specific name. Only a minority of windows have it. See the output of \f(CW\*(C`icesh \-a list prop WM_WINDOW_ROLE\*(C'\fR. .PP In rare cases, a name, class or role may contain a period. If it does, the period should be escaped by a single backslash. .PP -Lastly, the \fI\s-1OPTION: VALUE\s0\fR pair refer to the options and values +Lastly, the \fIOPTION: VALUE\fR pair refer to the options and values described below. A line with just a dot, followed by an option/value pair, applies to all windows. -.SS "\s-1OPTIONS\s0" +.SS OPTIONS .IX Subsection "OPTIONS" There are four categories: \fIgeneral\fR, \fIfunction\fR, \fIdecor\fR and \&\fIfeature\fR. -.SS "\s-1GENERAL OPTIONS\s0" +.SS "GENERAL OPTIONS" .IX Subsection "GENERAL OPTIONS" These control general characteristics of windows: -.IP "\fBicon\fR: \fI\s-1NAME\s0\fR (default: none)" 4 +.IP "\fBicon\fR: \fINAME\fR (default: none)" 4 .IX Item "icon: NAME (default: none)" -Specifies the icon name for the window. \fI\s-1NAME\s0\fR is the icon name, like +Specifies the icon name for the window. \fINAME\fR is the icon name, like \&\fIutilities-terminal\fR. It can also be a file, like \fIxterm.png\fR, a full path, or a prefix of a path without sizes or suffix. -.IP "\fBworkspace\fR: \fI\s-1WORKSPACE\s0\fR (default: current)" 4 +.IP "\fBworkspace\fR: \fIWORKSPACE\fR (default: current)" 4 .IX Item "workspace: WORKSPACE (default: current)" -Specifies the default workspace for the window. \fI\s-1WORKSPACE\s0\fR is the +Specifies the default workspace for the window. \fIWORKSPACE\fR is the workspace number counting from zero (0). -.IP "\fBlayer\fR: {\fI\s-1LAYER\s0\fR|\fI\s-1NUMBER\s0\fR} (default: Normal)" 4 +.IP "\fBlayer\fR: {\fILAYER\fR|\fINUMBER\fR} (default: Normal)" 4 .IX Item "layer: {LAYER|NUMBER} (default: Normal)" Specifies the default layer for the window. Layer can be one of the following names or a number from zero to fifteen: @@ -234,7 +156,7 @@ following names or a number from zero to fifteen: \& Fullscreen (14) When fullscreen and focused. \& AboveAll (15) Always above anything. .Ve -.IP "\fBgeometry\fR \fIgeometry\fR (default: \s-1WM_SIZE_HINTS\s0 property)" 4 +.IP "\fBgeometry\fR \fIgeometry\fR (default: WM_SIZE_HINTS property)" 4 .IX Item "geometry geometry (default: WM_SIZE_HINTS property)" The default geometry for the window. This geometry should be specified in a format that can be parsed by \fBXParseGeometry\fR\|(3): @@ -243,10 +165,10 @@ in a format that can be parsed by \fBXParseGeometry\fR\|(3): \& [=][<width>{xX}<height>][{+\-}<xoffset>{+\-}<yoffset>] .Ve .Sp -The default geometry is taken from the \s-1WM_SIZE_HINTS\s0 property of the +The default geometry is taken from the WM_SIZE_HINTS property of the window or else from the initial window geometry. This option overrides the default. -.IP "\fBtray\fR: {\fBIgnore\fR|\fBMinimized\fR|\fBExclusive\fR|\fI\s-1NUMBER\s0\fR} (default: 0)" 4 +.IP "\fBtray\fR: {\fBIgnore\fR|\fBMinimized\fR|\fBExclusive\fR|\fINUMBER\fR} (default: 0)" 4 .IX Item "tray: {Ignore|Minimized|Exclusive|NUMBER} (default: 0)" The default tray option for the window. This affects both the tray and the task pane. Tray can be one of the following three strings or a number @@ -257,15 +179,15 @@ from zero (0) to two (2): \& Minimized (1) Add to tray, no task when minimized. \& Exclusive (2) Add to tray, no task button. .Ve -.IP "\fBorder\fR: \fI\s-1NUMBER\s0\fR (default: 0)" 4 +.IP "\fBorder\fR: \fINUMBER\fR (default: 0)" 4 .IX Item "order: NUMBER (default: 0)" The sorting order for task buttons, tray icons, quick switch and window list. The default value is zero. Increasing positive values go right, while decreasing negative values go left. -.IP "\fBopacity\fR: \fI\s-1NUMBER\s0\fR (default: 0)" 4 +.IP "\fBopacity\fR: \fINUMBER\fR (default: 0)" 4 .IX Item "opacity: NUMBER (default: 0)" -Set the _NET_WM_WINDOW_OPACITY property if \fI\s-1NUMBER\s0\fR is a value between -1 and 100. \fI\s-1NUMBER\s0\fR is interpreted as percentage of maximum opaqueness. +Set the _NET_WM_WINDOW_OPACITY property if \fINUMBER\fR is a value between +1 and 100. \fINUMBER\fR is interpreted as percentage of maximum opaqueness. .IP "\fBkeyboard\fR: \fIlayout\fR (default: none)" 4 .IX Item "keyboard: layout (default: none)" Specifies the keyboard layout to use for this window. @@ -277,7 +199,7 @@ a default keyboard layout in \fIpreferences\fR. .IP "\fBframe\fR: \fIlabel\fR (default: none)" 4 .IX Item "frame: label (default: none)" All windows with the same frame label become tabs in a single frame. -.SS "\s-1FUNCTION OPTIONS\s0" +.SS "FUNCTION OPTIONS" .IX Subsection "FUNCTION OPTIONS" Function options enable/disable (1/0) the ability to take an action on the window. The normal default for all options is enabled (1) unless @@ -292,7 +214,7 @@ overridden by the application: \& fResize: {0|1} can be resized. (default: 1) \& fRollup: {0|1} can be shaded. (default: 1) .Ve -.SS "\s-1DECOR OPTIONS\s0" +.SS "DECOR OPTIONS" .IX Subsection "DECOR OPTIONS" Decor options enable/disable (1/0) decorations on the window. The normal default for all options is enabled (1) unless overridden by the @@ -310,7 +232,7 @@ application or the theme: \& dSysMenu: {0|1} has window menu. (default: 1) \& dTitleBar: {0|1} has title bar. (default: 1) .Ve -.SS "\s-1FEATURE OPTIONS\s0" +.SS "FEATURE OPTIONS" .IX Subsection "FEATURE OPTIONS" Feature options enable/disable (1/0) additional features of the window. The normal default for all options is disabled (0) unless overridden by @@ -343,9 +265,9 @@ the application: \& startMaximizedVert: {1|0} start maximized vertical. \& startMinimized: {1|0} start minimized. .Ve -.SS "\s-1EXAMPLES\s0" +.SS EXAMPLES .IX Subsection "EXAMPLES" -This example uses the \s-1WM_WINDOW_ROLE\s0 property value \f(CW\*(C`pop\-up\*(C'\fR to deny +This example uses the WM_WINDOW_ROLE property value \f(CW\*(C`pop\-up\*(C'\fR to deny input focus to \fIChrome\fR pop-ups and asks to close them immediately. .PP .Vb 9 @@ -392,7 +314,7 @@ without titlebar and minimal functionality. \& xeyes.dMinimize: 0 \& xeyes.dMaximize: 0 .Ve -.SS "\s-1FILES\s0" +.SS FILES .IX Subsection "FILES" Locations for the \fIwinoptions\fR file are as follows: .PP @@ -406,17 +328,17 @@ Locations for the \fIwinoptions\fR file are as follows: .PP The locations are searched in the order listed; the first file found is read and the remainder ignored. -.SS "\s-1SEE ALSO\s0" +.SS "SEE ALSO" .IX Subsection "SEE ALSO" \&\fBicewm\fR\|(1), \&\fBicesh\fR\|(1), \&\fBicewmhint\fR\|(1), \&\fBsetxkbmap\fR\|(1), \&\fBXParseGeometry\fR\|(3). -.SS "\s-1AUTHOR\s0" +.SS AUTHOR .IX Subsection "AUTHOR" Brian Bidulock <mailto:bidulock@openss7.org>. -.SS "\s-1LICENSE\s0" +.SS LICENSE .IX Subsection "LICENSE" -\&\fBIceWM\fR is licensed under the \s-1GNU\s0 Library General Public License. -See the \fI\s-1COPYING\s0\fR file in the distribution. +\&\fBIceWM\fR is licensed under the GNU Library General Public License. +See the \fICOPYING\fR file in the distribution. diff --git a/upstream/debian-unstable/man5/integritytab.5 b/upstream/debian-unstable/man5/integritytab.5 index 1272444a..d29162af 100644 --- a/upstream/debian-unstable/man5/integritytab.5 +++ b/upstream/debian-unstable/man5/integritytab.5 @@ -1,5 +1,5 @@ '\" t -.TH "INTEGRITYTAB" "5" "" "systemd 255" "integritytab" +.TH "INTEGRITYTAB" "5" "" "systemd 256~rc3" "integritytab" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -81,7 +81,7 @@ Added in version 250\&. .PP \fBmode=(journal|bitmap|direct)\fR .RS 4 -Enable journaled, bitmapped or direct (passthrough) mode\&. Journaled mode is the default when this option is not specified\&. It provides safety against crashes, but can be slow because all data has to be written twice\&. Bitmap mode is more efficient since it requires only a single write, but it is less reliable because if data corruption happens when the machine crashes, it may not be detected\&. Direct mode disables the journal and the bitmap\&. Corresponds to the "direct writes" mode documented in +Enable journaled, bitmapped or direct (passthrough) mode\&. Journaled mode is the default when this option is not specified\&. It provides safety against crashes, but can be slow because all data has to be written twice\&. Bitmap mode is more efficient since it requires only a single write, but it is less reliable because if data corruption happens when the machine crashes, it might not be detected\&. Direct mode disables the journal and the bitmap\&. Corresponds to the "direct writes" mode documented in \m[blue]\fBthe dm\-integrity documentation\fR\m[]\&\s-2\u[1]\d\s+2\&. Note that without a journal, if there is a crash, it is possible that the integrity tags and data will not match\&. If used, the journal\-* options below will have no effect if passed\&. .sp Added in version 254\&. @@ -177,10 +177,7 @@ home PARTUUID=4973d0b8\-1b15\-c449\-96ec\-94bab7f6a7b8 /etc/hmac\&.key .\} .SH "SEE ALSO" .PP -\fBsystemd\fR(1), -\fBsystemd-integritysetup@.service\fR(8), -\fBsystemd-integritysetup-generator\fR(8), -\fBintegritysetup\fR(8), +\fBsystemd\fR(1), \fBsystemd-integritysetup@.service\fR(8), \fBsystemd-integritysetup-generator\fR(8), \fBintegritysetup\fR(8) .SH "NOTES" .IP " 1." 4 the dm-integrity documentation diff --git a/upstream/debian-unstable/man5/intro.5 b/upstream/debian-unstable/man5/intro.5 index d30e194c..e0ad3580 100644 --- a/upstream/debian-unstable/man5/intro.5 +++ b/upstream/debian-unstable/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 6.8" .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/debian-unstable/man5/iocost.conf.5 b/upstream/debian-unstable/man5/iocost.conf.5 index 112f047f..94dafcef 100644 --- a/upstream/debian-unstable/man5/iocost.conf.5 +++ b/upstream/debian-unstable/man5/iocost.conf.5 @@ -1,5 +1,5 @@ '\" t -.TH "IOCOST\&.CONF" "5" "" "systemd 255" "iocost.conf" +.TH "IOCOST\&.CONF" "5" "" "systemd 256~rc3" "iocost.conf" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -38,16 +38,16 @@ The qos and model values are calculated based on benchmarks collected on the project and turned into a set of solutions that go from most to least isolated\&. Isolation allows the system to remain responsive in face of high I/O load\&. Which solutions are available for a device can be queried from the udev metadata attached to it\&. By default the naive solution is used, which provides the most bandwidth\&. .SH "CONFIGURATION DIRECTORIES AND PRECEDENCE" .PP -The default configuration is set during compilation, so configuration is only needed when it is necessary to deviate from those defaults\&. The main configuration file is either in -/usr/lib/systemd/ -or -/etc/systemd/ -and contains commented out entries showing the defaults as a guide to the administrator\&. Local overrides can be created by creating drop\-ins, as described below\&. The main configuration file can also be edited for this purpose (or a copy in +The default configuration is set during compilation, so configuration is only needed when it is necessary to deviate from those defaults\&. The main configuration file is loaded from one of the listed directories in order of priority, only the first file found is used: +/etc/systemd/, +/run/systemd/, +/usr/local/lib/systemd/, +/usr/lib/systemd/\&. The vendor version of the file contains commented out entries showing the defaults as a guide to the administrator\&. Local overrides can also be created by creating drop\-ins, as described below\&. The main configuration file can also be edited for this purpose (or a copy in /etc/ -if it\*(Aqs shipped in -/usr/) however using drop\-ins for local configuration is recommended over modifications to the main configuration file\&. +if it\*(Aqs shipped under +/usr/), however using drop\-ins for local configuration is recommended over modifications to the main configuration file\&. .PP -In addition to the "main" configuration file, drop\-in configuration snippets are read from +In addition to the main configuration file, drop\-in configuration snippets are read from /usr/lib/systemd/*\&.conf\&.d/, /usr/local/lib/systemd/*\&.conf\&.d/, and /etc/systemd/*\&.conf\&.d/\&. Those drop\-ins have higher precedence and override the main configuration file\&. Files in the @@ -57,7 +57,12 @@ configuration subdirectories are sorted by their filename in lexicographic order When packages need to customize the configuration, they can install drop\-ins under /usr/\&. Files in /etc/ -are reserved for the local administrator, who may use this logic to override the configuration files installed by vendor packages\&. Drop\-ins have to be used to override package drop\-ins, since the main configuration file has lower precedence\&. It is recommended to prefix all filenames in those subdirectories with a two\-digit number and a dash, to simplify the ordering of the files\&. This also defined a concept of drop\-in priority to allow distributions to ship drop\-ins within a specific range lower than the range used by users\&. This should lower the risk of package drop\-ins overriding accidentally drop\-ins defined by users\&. +are reserved for the local administrator, who may use this logic to override the configuration files installed by vendor packages\&. Drop\-ins have to be used to override package drop\-ins, since the main configuration file has lower precedence\&. It is recommended to prefix all filenames in those subdirectories with a two\-digit number and a dash, to simplify the ordering of the files\&. This also defines a concept of drop\-in priorities to allow OS vendors to ship drop\-ins within a specific range lower than the range used by users\&. This should lower the risk of package drop\-ins overriding accidentally drop\-ins defined by users\&. It is recommended to use the range 10\-40 for drop\-ins in +/usr/ +and the range 60\-90 for drop\-ins in +/etc/ +and +/run/, to make sure that local and transient drop\-ins take priority over drop\-ins shipped by the OS vendor\&. .PP To disable a configuration file supplied by the vendor, the recommended way is to place a symlink to /dev/null @@ -80,9 +85,7 @@ Added in version 254\&. .RE .SH "SEE ALSO" .PP -\fBudevadm\fR(8), -\m[blue]\fBThe iocost\-benchmarks github project\fR\m[]\&\s-2\u[1]\d\s+2, -\m[blue]\fBThe resctl\-bench documentation details how the values are obtained\fR\m[]\&\s-2\u[2]\d\s+2 +\fBudevadm\fR(8), \m[blue]\fBThe iocost\-benchmarks github project\fR\m[]\&\s-2\u[1]\d\s+2, \m[blue]\fBThe resctl\-bench documentation details how the values are obtained\fR\m[]\&\s-2\u[2]\d\s+2 .SH "NOTES" .IP " 1." 4 iocost-benchmark diff --git a/upstream/debian-unstable/man5/issue.5 b/upstream/debian-unstable/man5/issue.5 index 98dfe68e..258ea1bc 100644 --- a/upstream/debian-unstable/man5/issue.5 +++ b/upstream/debian-unstable/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 6.8" .SH NAME issue \- prelogin message and identification file .SH DESCRIPTION diff --git a/upstream/debian-unstable/man5/journal-remote.conf.5 b/upstream/debian-unstable/man5/journal-remote.conf.5 index a2619006..4bfe1487 100644 --- a/upstream/debian-unstable/man5/journal-remote.conf.5 +++ b/upstream/debian-unstable/man5/journal-remote.conf.5 @@ -1,5 +1,5 @@ '\" t -.TH "JOURNAL\-REMOTE\&.CONF" "5" "" "systemd 255" "journal-remote.conf" +.TH "JOURNAL\-REMOTE\&.CONF" "5" "" "systemd 256~rc3" "journal-remote.conf" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -23,13 +23,24 @@ journal-remote.conf, journal-remote.conf.d \- Configuration files for the service accepting remote journal uploads .SH "SYNOPSIS" .PP +.RS 4 /etc/systemd/journal\-remote\&.conf -.PP +.RE +.RS 4 +/run/systemd/journal\-remote\&.conf +.RE +.RS 4 +/usr/lib/systemd/journal\-remote\&.conf +.RE +.RS 4 /etc/systemd/journal\-remote\&.conf\&.d/*\&.conf -.PP +.RE +.RS 4 /run/systemd/journal\-remote\&.conf\&.d/*\&.conf -.PP +.RE +.RS 4 /usr/lib/systemd/journal\-remote\&.conf\&.d/*\&.conf +.RE .SH "DESCRIPTION" .PP These files configure various parameters of @@ -38,16 +49,16 @@ These files configure various parameters of for a general description of the syntax\&. .SH "CONFIGURATION DIRECTORIES AND PRECEDENCE" .PP -The default configuration is set during compilation, so configuration is only needed when it is necessary to deviate from those defaults\&. The main configuration file is either in -/usr/lib/systemd/ -or -/etc/systemd/ -and contains commented out entries showing the defaults as a guide to the administrator\&. Local overrides can be created by creating drop\-ins, as described below\&. The main configuration file can also be edited for this purpose (or a copy in +The default configuration is set during compilation, so configuration is only needed when it is necessary to deviate from those defaults\&. The main configuration file is loaded from one of the listed directories in order of priority, only the first file found is used: +/etc/systemd/, +/run/systemd/, +/usr/local/lib/systemd/, +/usr/lib/systemd/\&. The vendor version of the file contains commented out entries showing the defaults as a guide to the administrator\&. Local overrides can also be created by creating drop\-ins, as described below\&. The main configuration file can also be edited for this purpose (or a copy in /etc/ -if it\*(Aqs shipped in -/usr/) however using drop\-ins for local configuration is recommended over modifications to the main configuration file\&. +if it\*(Aqs shipped under +/usr/), however using drop\-ins for local configuration is recommended over modifications to the main configuration file\&. .PP -In addition to the "main" configuration file, drop\-in configuration snippets are read from +In addition to the main configuration file, drop\-in configuration snippets are read from /usr/lib/systemd/*\&.conf\&.d/, /usr/local/lib/systemd/*\&.conf\&.d/, and /etc/systemd/*\&.conf\&.d/\&. Those drop\-ins have higher precedence and override the main configuration file\&. Files in the @@ -57,7 +68,12 @@ configuration subdirectories are sorted by their filename in lexicographic order When packages need to customize the configuration, they can install drop\-ins under /usr/\&. Files in /etc/ -are reserved for the local administrator, who may use this logic to override the configuration files installed by vendor packages\&. Drop\-ins have to be used to override package drop\-ins, since the main configuration file has lower precedence\&. It is recommended to prefix all filenames in those subdirectories with a two\-digit number and a dash, to simplify the ordering of the files\&. This also defined a concept of drop\-in priority to allow distributions to ship drop\-ins within a specific range lower than the range used by users\&. This should lower the risk of package drop\-ins overriding accidentally drop\-ins defined by users\&. +are reserved for the local administrator, who may use this logic to override the configuration files installed by vendor packages\&. Drop\-ins have to be used to override package drop\-ins, since the main configuration file has lower precedence\&. It is recommended to prefix all filenames in those subdirectories with a two\-digit number and a dash, to simplify the ordering of the files\&. This also defines a concept of drop\-in priorities to allow OS vendors to ship drop\-ins within a specific range lower than the range used by users\&. This should lower the risk of package drop\-ins overriding accidentally drop\-ins defined by users\&. It is recommended to use the range 10\-40 for drop\-ins in +/usr/ +and the range 60\-90 for drop\-ins in +/etc/ +and +/run/, to make sure that local and transient drop\-ins take priority over drop\-ins shipped by the OS vendor\&. .PP To disable a configuration file supplied by the vendor, the recommended way is to place a symlink to /dev/null @@ -134,7 +150,4 @@ Added in version 253\&. .RE .SH "SEE ALSO" .PP -\fBjournald.conf\fR(5), -\fBsystemd\fR(1), -\fBsystemd-journal-remote.service\fR(8), -\fBsystemd-journald.service\fR(8) +\fBjournald.conf\fR(5), \fBsystemd\fR(1), \fBsystemd-journal-remote.service\fR(8), \fBsystemd-journald.service\fR(8) diff --git a/upstream/debian-unstable/man5/journal-upload.conf.5 b/upstream/debian-unstable/man5/journal-upload.conf.5 index 73889f48..c2e0c90f 100644 --- a/upstream/debian-unstable/man5/journal-upload.conf.5 +++ b/upstream/debian-unstable/man5/journal-upload.conf.5 @@ -1,5 +1,5 @@ '\" t -.TH "JOURNAL\-UPLOAD\&.CONF" "5" "" "systemd 255" "journal-upload.conf" +.TH "JOURNAL\-UPLOAD\&.CONF" "5" "" "systemd 256~rc3" "journal-upload.conf" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -25,6 +25,10 @@ journal-upload.conf, journal-upload.conf.d \- Configuration files for the journa .PP /etc/systemd/journal\-upload\&.conf .PP +/run/systemd/journal\-upload\&.conf +.PP +/usr/lib/systemd/journal\-upload\&.conf +.PP /etc/systemd/journal\-upload\&.conf\&.d/*\&.conf .PP /run/systemd/journal\-upload\&.conf\&.d/*\&.conf @@ -38,16 +42,16 @@ These files configure various parameters of for a general description of the syntax\&. .SH "CONFIGURATION DIRECTORIES AND PRECEDENCE" .PP -The default configuration is set during compilation, so configuration is only needed when it is necessary to deviate from those defaults\&. The main configuration file is either in -/usr/lib/systemd/ -or -/etc/systemd/ -and contains commented out entries showing the defaults as a guide to the administrator\&. Local overrides can be created by creating drop\-ins, as described below\&. The main configuration file can also be edited for this purpose (or a copy in +The default configuration is set during compilation, so configuration is only needed when it is necessary to deviate from those defaults\&. The main configuration file is loaded from one of the listed directories in order of priority, only the first file found is used: +/etc/systemd/, +/run/systemd/, +/usr/local/lib/systemd/, +/usr/lib/systemd/\&. The vendor version of the file contains commented out entries showing the defaults as a guide to the administrator\&. Local overrides can also be created by creating drop\-ins, as described below\&. The main configuration file can also be edited for this purpose (or a copy in /etc/ -if it\*(Aqs shipped in -/usr/) however using drop\-ins for local configuration is recommended over modifications to the main configuration file\&. +if it\*(Aqs shipped under +/usr/), however using drop\-ins for local configuration is recommended over modifications to the main configuration file\&. .PP -In addition to the "main" configuration file, drop\-in configuration snippets are read from +In addition to the main configuration file, drop\-in configuration snippets are read from /usr/lib/systemd/*\&.conf\&.d/, /usr/local/lib/systemd/*\&.conf\&.d/, and /etc/systemd/*\&.conf\&.d/\&. Those drop\-ins have higher precedence and override the main configuration file\&. Files in the @@ -57,7 +61,12 @@ configuration subdirectories are sorted by their filename in lexicographic order When packages need to customize the configuration, they can install drop\-ins under /usr/\&. Files in /etc/ -are reserved for the local administrator, who may use this logic to override the configuration files installed by vendor packages\&. Drop\-ins have to be used to override package drop\-ins, since the main configuration file has lower precedence\&. It is recommended to prefix all filenames in those subdirectories with a two\-digit number and a dash, to simplify the ordering of the files\&. This also defined a concept of drop\-in priority to allow distributions to ship drop\-ins within a specific range lower than the range used by users\&. This should lower the risk of package drop\-ins overriding accidentally drop\-ins defined by users\&. +are reserved for the local administrator, who may use this logic to override the configuration files installed by vendor packages\&. Drop\-ins have to be used to override package drop\-ins, since the main configuration file has lower precedence\&. It is recommended to prefix all filenames in those subdirectories with a two\-digit number and a dash, to simplify the ordering of the files\&. This also defines a concept of drop\-in priorities to allow OS vendors to ship drop\-ins within a specific range lower than the range used by users\&. This should lower the risk of package drop\-ins overriding accidentally drop\-ins defined by users\&. It is recommended to use the range 10\-40 for drop\-ins in +/usr/ +and the range 60\-90 for drop\-ins in +/etc/ +and +/run/, to make sure that local and transient drop\-ins take priority over drop\-ins shipped by the OS vendor\&. .PP To disable a configuration file supplied by the vendor, the recommended way is to place a symlink to /dev/null @@ -110,6 +119,4 @@ Added in version 249\&. .RE .SH "SEE ALSO" .PP -\fBsystemd-journal-upload.service\fR(8), -\fBsystemd\fR(1), -\fBsystemd-journald.service\fR(8) +\fBsystemd-journal-upload.service\fR(8), \fBsystemd\fR(1), \fBsystemd-journald.service\fR(8) diff --git a/upstream/debian-unstable/man5/journald.conf.5 b/upstream/debian-unstable/man5/journald.conf.5 index 911b6cdf..212b7e97 100644 --- a/upstream/debian-unstable/man5/journald.conf.5 +++ b/upstream/debian-unstable/man5/journald.conf.5 @@ -1,5 +1,5 @@ '\" t -.TH "JOURNALD\&.CONF" "5" "" "systemd 255" "journald.conf" +.TH "JOURNALD\&.CONF" "5" "" "systemd 256~rc3" "journald.conf" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -23,21 +23,36 @@ journald.conf, journald.conf.d, journald@.conf \- Journal service configuration files .SH "SYNOPSIS" .PP +.RS 4 /etc/systemd/journald\&.conf -.PP +.RE +.RS 4 +/run/systemd/journald\&.conf +.RE +.RS 4 +/usr/lib/systemd/journald\&.conf +.RE +.RS 4 /etc/systemd/journald\&.conf\&.d/*\&.conf -.PP +.RE +.RS 4 /run/systemd/journald\&.conf\&.d/*\&.conf -.PP +.RE +.RS 4 /usr/lib/systemd/journald\&.conf\&.d/*\&.conf -.PP +.RE +.RS 4 /etc/systemd/journald@\fINAMESPACE\fR\&.conf -.PP +.RE +.RS 4 /etc/systemd/journald@\fINAMESPACE\fR\&.conf\&.d/*\&.conf -.PP +.RE +.RS 4 /run/systemd/journald@\fINAMESPACE\fR\&.conf\&.d/*\&.conf -.PP +.RE +.RS 4 /usr/lib/systemd/journald@\fINAMESPACE\fR\&.conf\&.d/*\&.conf +.RE .SH "DESCRIPTION" .PP These files configure various parameters of the systemd journal service, @@ -56,16 +71,16 @@ and associated drop\-ins with the namespace identifier filled in\&. This allows for details about journal namespaces\&. .SH "CONFIGURATION DIRECTORIES AND PRECEDENCE" .PP -The default configuration is set during compilation, so configuration is only needed when it is necessary to deviate from those defaults\&. The main configuration file is either in -/usr/lib/systemd/ -or -/etc/systemd/ -and contains commented out entries showing the defaults as a guide to the administrator\&. Local overrides can be created by creating drop\-ins, as described below\&. The main configuration file can also be edited for this purpose (or a copy in +The default configuration is set during compilation, so configuration is only needed when it is necessary to deviate from those defaults\&. The main configuration file is loaded from one of the listed directories in order of priority, only the first file found is used: +/etc/systemd/, +/run/systemd/, +/usr/local/lib/systemd/, +/usr/lib/systemd/\&. The vendor version of the file contains commented out entries showing the defaults as a guide to the administrator\&. Local overrides can also be created by creating drop\-ins, as described below\&. The main configuration file can also be edited for this purpose (or a copy in /etc/ -if it\*(Aqs shipped in -/usr/) however using drop\-ins for local configuration is recommended over modifications to the main configuration file\&. +if it\*(Aqs shipped under +/usr/), however using drop\-ins for local configuration is recommended over modifications to the main configuration file\&. .PP -In addition to the "main" configuration file, drop\-in configuration snippets are read from +In addition to the main configuration file, drop\-in configuration snippets are read from /usr/lib/systemd/*\&.conf\&.d/, /usr/local/lib/systemd/*\&.conf\&.d/, and /etc/systemd/*\&.conf\&.d/\&. Those drop\-ins have higher precedence and override the main configuration file\&. Files in the @@ -75,7 +90,12 @@ configuration subdirectories are sorted by their filename in lexicographic order When packages need to customize the configuration, they can install drop\-ins under /usr/\&. Files in /etc/ -are reserved for the local administrator, who may use this logic to override the configuration files installed by vendor packages\&. Drop\-ins have to be used to override package drop\-ins, since the main configuration file has lower precedence\&. It is recommended to prefix all filenames in those subdirectories with a two\-digit number and a dash, to simplify the ordering of the files\&. This also defined a concept of drop\-in priority to allow distributions to ship drop\-ins within a specific range lower than the range used by users\&. This should lower the risk of package drop\-ins overriding accidentally drop\-ins defined by users\&. +are reserved for the local administrator, who may use this logic to override the configuration files installed by vendor packages\&. Drop\-ins have to be used to override package drop\-ins, since the main configuration file has lower precedence\&. It is recommended to prefix all filenames in those subdirectories with a two\-digit number and a dash, to simplify the ordering of the files\&. This also defines a concept of drop\-in priorities to allow OS vendors to ship drop\-ins within a specific range lower than the range used by users\&. This should lower the risk of package drop\-ins overriding accidentally drop\-ins defined by users\&. It is recommended to use the range 10\-40 for drop\-ins in +/usr/ +and the range 60\-90 for drop\-ins in +/etc/ +and +/run/, to make sure that local and transient drop\-ins take priority over drop\-ins shipped by the OS vendor\&. .PP To disable a configuration file supplied by the vendor, the recommended way is to place a symlink to /dev/null @@ -151,6 +171,10 @@ Note that per\-user journal files are not supported unless persistent storage is \fBjournalctl \-\-user\fR unavailable\&. .sp +The storage to use can also be specified via the +"journal\&.storage" +credential\&. Values configured via configuration files take priority over values configured via the credential\&. +.sp Added in version 186\&. .RE .PP @@ -364,9 +388,11 @@ The timeout before synchronizing journal files to disk\&. After syncing, journal Added in version 199\&. .RE .PP -\fIForwardToSyslog=\fR, \fIForwardToKMsg=\fR, \fIForwardToConsole=\fR, \fIForwardToWall=\fR +\fIForwardToSyslog=\fR, \fIForwardToKMsg=\fR, \fIForwardToConsole=\fR, \fIForwardToWall=\fR, \fIForwardToSocket=\fR .RS 4 -Control whether log messages received by the journal daemon shall be forwarded to a traditional syslog daemon, to the kernel log buffer (kmsg), to the system console, or sent as wall messages to all logged\-in users\&. These options take boolean arguments\&. If forwarding to syslog is enabled but nothing reads messages from the socket, forwarding to syslog has no effect\&. By default, only forwarding to wall is enabled\&. These settings may be overridden at boot time with the kernel command line options +Control whether log messages received by the journal daemon shall be forwarded to a traditional syslog daemon, to the kernel log buffer (kmsg), to the system console, sent as wall messages to all logged\-in users or sent over a socket\&. These options take boolean arguments except for +"ForwardToSocket=" +which takes an address instead\&. If forwarding to syslog is enabled but nothing reads messages from the socket, forwarding to syslog has no effect\&. By default, only forwarding to wall is enabled\&. These settings may be overridden at boot time with the kernel command line options "systemd\&.journald\&.forward_to_syslog", "systemd\&.journald\&.forward_to_kmsg", "systemd\&.journald\&.forward_to_console", and @@ -374,6 +400,11 @@ Control whether log messages received by the journal daemon shall be forwarded t "=" and the following argument, true is assumed\&. Otherwise, the argument is parsed as a boolean\&. .sp +The socket forwarding address can be specified with the credential +"journal\&.forward_to_socket"\&. The following socket types are supported: +.sp +\fBAF_INET\fR (e\&.g\&. "192\&.168\&.0\&.11:4444"), \fBAF_INET6\fR (e\&.g\&. "[2001:db8::ff00:42:8329]:4444"), \fBAF_UNIX\fR (e\&.g\&. "/run/host/journal/socket"), \fBAF_VSOCK\fR (e\&.g\&. "vsock:2:1234") +.sp When forwarding to the console, the TTY to log to can be changed with \fITTYPath=\fR, described below\&. .sp @@ -383,15 +414,30 @@ to the kernel command line\&. \fBsystemd\fR will automatically disable kernel\*(Aqs rate\-limiting applied to userspace processes (equivalent to setting "printk\&.devkmsg=on")\&. -.PP +.sp +When forwarding over a socket the +\m[blue]\fBJournal Export Format\fR\m[]\&\s-2\u[3]\d\s+2 +is used when sending over the wire\&. Notably this includes the metadata field +\fI__REALTIME_TIMESTAMP\fR +so that +\fBsystemd\-journal\-remote\fR +(see +\fBsystemd-journal-remote.service\fR(8)) can be used to receive the forwarded journal entries\&. +.sp Note: Forwarding is performed synchronously within journald, and may significantly affect its performance\&. This is particularly relevant when using ForwardToConsole=yes in cloud environments, where the console is often a slow, virtual serial port\&. Since journald is implemented as a conventional single\-process daemon, forwarding to a completely hung console will block journald\&. This can have a cascading effect resulting in any services synchronously logging to the blocked journal also becoming blocked\&. Unless actively debugging/developing something, it\*(Aqs generally preferable to setup a \fBjournalctl \-\-follow\fR style service redirected to the console, instead of ForwardToConsole=yes, for production use\&. +.PP +Note: Using +\fIForwardToSocket=\fR +over IPv4/IPv6 links can be very slow due to the synchronous nature of the sockets\&. Take care to ensure your link is a low\-latency local link if possible\&. Typically IP networking is not available everywhere journald runs, e\&.g\&. in the initrd during boot\&. Consider using +\fBAF_VSOCK\fR/\fBAF_UNIX\fR +sockets for this if possible\&. .RE .PP -\fIMaxLevelStore=\fR, \fIMaxLevelSyslog=\fR, \fIMaxLevelKMsg=\fR, \fIMaxLevelConsole=\fR, \fIMaxLevelWall=\fR +\fIMaxLevelStore=\fR, \fIMaxLevelSyslog=\fR, \fIMaxLevelKMsg=\fR, \fIMaxLevelConsole=\fR, \fIMaxLevelWall=\fR, \fIMaxLevelSocket=\fR .RS 4 -Controls the maximum log level of messages that are stored in the journal, forwarded to syslog, kmsg, the console or wall (if that is enabled, see above)\&. As argument, takes one of +Controls the maximum log level of messages that are stored in the journal, forwarded to syslog, kmsg, the console, the wall, or a socket (if that is enabled, see above)\&. As argument, takes one of "emerg", "alert", "crit", @@ -402,9 +448,10 @@ Controls the maximum log level of messages that are stored in the journal, forwa "debug", or integer values in the range of 0\(en7 (corresponding to the same levels)\&. Messages equal or below the log level specified are stored/forwarded, messages above are dropped\&. Defaults to "debug" for -\fIMaxLevelStore=\fR +\fIMaxLevelStore=\fR, +\fIMaxLevelSyslog=\fR and -\fIMaxLevelSyslog=\fR, to ensure that the all messages are stored in the journal and forwarded to syslog\&. Defaults to +\fIMaxLevelSocket=\fR, to ensure that the all messages are stored in the journal, forwarded to syslog and the socket if one exists\&. Defaults to "notice" for \fIMaxLevelKMsg=\fR, @@ -418,7 +465,8 @@ for "systemd\&.journald\&.max_level_syslog=", "systemd\&.journald\&.max_level_kmsg=", "systemd\&.journald\&.max_level_console=", -"systemd\&.journald\&.max_level_wall="\&. +"systemd\&.journald\&.max_level_wall=", +"systemd\&.journald\&.max_level_socket="\&. .sp Added in version 185\&. .RE @@ -491,11 +539,7 @@ option, and not the option, is relevant for them\&. .SH "SEE ALSO" .PP -\fBsystemd\fR(1), -\fBsystemd-journald.service\fR(8), -\fBjournalctl\fR(1), -\fBsystemd.journal-fields\fR(7), -\fBsystemd-system.conf\fR(5) +\fBsystemd\fR(1), \fBsystemd-journald.service\fR(8), \fBjournalctl\fR(1), \fBsystemd.journal-fields\fR(7), \fBsystemd-system.conf\fR(5) .SH "NOTES" .IP " 1." 4 Seekable Sequential Key Generators @@ -507,3 +551,8 @@ Users, Groups, UIDs and GIDs on systemd systems .RS 4 \%https://systemd.io/UIDS-GIDS .RE +.IP " 3." 4 +Journal Export Format +.RS 4 +\%https://systemd.io/JOURNAL_EXPORT_FORMATS/#journal-export-format +.RE diff --git a/upstream/debian-unstable/man5/lmhosts.5 b/upstream/debian-unstable/man5/lmhosts.5 index 64fe76e2..cf0d0e6b 100644 --- a/upstream/debian-unstable/man5/lmhosts.5 +++ b/upstream/debian-unstable/man5/lmhosts.5 @@ -2,12 +2,12 @@ .\" Title: lmhosts .\" Author: [see the "AUTHOR" section] .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> -.\" Date: 02/19/2024 +.\" Date: 05/29/2024 .\" Manual: File Formats and Conventions -.\" Source: Samba 4.19.5-Debian +.\" Source: Samba 4.20.1-Debian .\" Language: English .\" -.TH "LMHOSTS" "5" "02/19/2024" "Samba 4\&.19\&.5\-Debian" "File Formats and Conventions" +.TH "LMHOSTS" "5" "05/29/2024" "Samba 4\&.20\&.1\-Debian" "File Formats and Conventions" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -112,7 +112,7 @@ or /usr/local/samba/lib\&. .SH "VERSION" .PP -This man page is part of version 4\&.19\&.5\-Debian of the Samba suite\&. +This man page is part of version 4\&.20\&.1\-Debian of the Samba suite\&. .SH "SEE ALSO" .PP \fBsmbclient\fR(1), diff --git a/upstream/debian-unstable/man5/loader.conf.5 b/upstream/debian-unstable/man5/loader.conf.5 index 7272f7c5..e42133ff 100644 --- a/upstream/debian-unstable/man5/loader.conf.5 +++ b/upstream/debian-unstable/man5/loader.conf.5 @@ -1,5 +1,5 @@ '\" t -.TH "LOADER\&.CONF" "5" "" "systemd 255" "loader.conf" +.TH "LOADER\&.CONF" "5" "" "systemd 256~rc3" "loader.conf" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -397,8 +397,7 @@ The menu will not be shown by default (the menu can still be shown by pressing a will be selected by default\&. If more than one entry matches, the one with the highest priority will be selected (generally the one with the highest version number)\&. The editor will be disabled, so it is not possible to alter the kernel command line\&. .SH "SEE ALSO" .PP -\fBsystemd-boot\fR(7), -\fBbootctl\fR(1) +\fBsystemd-boot\fR(7), \fBbootctl\fR(1) .SH "NOTES" .IP " 1." 4 Boot Loader Specification diff --git a/upstream/debian-unstable/man5/locale.5 b/upstream/debian-unstable/man5/locale.5 index 051e5edf..521def75 100644 --- a/upstream/debian-unstable/man5/locale.5 +++ b/upstream/debian-unstable/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 6.8" .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/debian-unstable/man5/locale.conf.5 b/upstream/debian-unstable/man5/locale.conf.5 index 531a8d8f..c3c2148c 100644 --- a/upstream/debian-unstable/man5/locale.conf.5 +++ b/upstream/debian-unstable/man5/locale.conf.5 @@ -1,5 +1,5 @@ '\" t -.TH "LOCALE\&.CONF" "5" "" "systemd 255" "locale.conf" +.TH "LOCALE\&.CONF" "5" "" "systemd 256~rc3" "locale.conf" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -108,8 +108,4 @@ LC_MESSAGES=en_US\&.UTF\-8 .\} .SH "SEE ALSO" .PP -\fBsystemd\fR(1), -\fBlocale\fR(7), -\fBlocalectl\fR(1), -\fBsystemd-localed.service\fR(8), -\fBsystemd-firstboot\fR(1) +\fBsystemd\fR(1), \fBlocale\fR(7), \fBlocalectl\fR(1), \fBsystemd-localed.service\fR(8), \fBsystemd-firstboot\fR(1) diff --git a/upstream/debian-unstable/man5/localtime.5 b/upstream/debian-unstable/man5/localtime.5 index 091dfcc0..9b8a0ed3 100644 --- a/upstream/debian-unstable/man5/localtime.5 +++ b/upstream/debian-unstable/man5/localtime.5 @@ -1,5 +1,5 @@ '\" t -.TH "LOCALTIME" "5" "" "systemd 255" "localtime" +.TH "LOCALTIME" "5" "" "systemd 256~rc3" "localtime" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -59,9 +59,4 @@ to change the settings of this file from the command line during runtime\&. Use to initialize the time zone on mounted (but not booted) system images\&. .SH "SEE ALSO" .PP -\fBsystemd\fR(1), -\fBtzset\fR(3), -\fBlocaltime\fR(3), -\fBtimedatectl\fR(1), -\fBsystemd-timedated.service\fR(8), -\fBsystemd-firstboot\fR(1) +\fBsystemd\fR(1), \fBtzset\fR(3), \fBlocaltime\fR(3), \fBtimedatectl\fR(1), \fBsystemd-timedated.service\fR(8), \fBsystemd-firstboot\fR(1) diff --git a/upstream/debian-unstable/man5/logind.conf.5 b/upstream/debian-unstable/man5/logind.conf.5 index 5089cb9c..0572aa17 100644 --- a/upstream/debian-unstable/man5/logind.conf.5 +++ b/upstream/debian-unstable/man5/logind.conf.5 @@ -1,5 +1,5 @@ '\" t -.TH "LOGIND\&.CONF" "5" "" "systemd 255" "logind.conf" +.TH "LOGIND\&.CONF" "5" "" "systemd 256~rc3" "logind.conf" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -23,13 +23,24 @@ logind.conf, logind.conf.d \- Login manager configuration files .SH "SYNOPSIS" .PP +.RS 4 /etc/systemd/logind\&.conf -.PP +.RE +.RS 4 +/run/systemd/logind\&.conf +.RE +.RS 4 +/usr/lib/systemd/logind\&.conf +.RE +.RS 4 /etc/systemd/logind\&.conf\&.d/*\&.conf -.PP +.RE +.RS 4 /run/systemd/logind\&.conf\&.d/*\&.conf -.PP +.RE +.RS 4 /usr/lib/systemd/logind\&.conf\&.d/*\&.conf +.RE .SH "DESCRIPTION" .PP These files configure various parameters of the systemd login manager, @@ -38,16 +49,16 @@ These files configure various parameters of the systemd login manager, for a general description of the syntax\&. .SH "CONFIGURATION DIRECTORIES AND PRECEDENCE" .PP -The default configuration is set during compilation, so configuration is only needed when it is necessary to deviate from those defaults\&. The main configuration file is either in -/usr/lib/systemd/ -or -/etc/systemd/ -and contains commented out entries showing the defaults as a guide to the administrator\&. Local overrides can be created by creating drop\-ins, as described below\&. The main configuration file can also be edited for this purpose (or a copy in +The default configuration is set during compilation, so configuration is only needed when it is necessary to deviate from those defaults\&. The main configuration file is loaded from one of the listed directories in order of priority, only the first file found is used: +/etc/systemd/, +/run/systemd/, +/usr/local/lib/systemd/, +/usr/lib/systemd/\&. The vendor version of the file contains commented out entries showing the defaults as a guide to the administrator\&. Local overrides can also be created by creating drop\-ins, as described below\&. The main configuration file can also be edited for this purpose (or a copy in /etc/ -if it\*(Aqs shipped in -/usr/) however using drop\-ins for local configuration is recommended over modifications to the main configuration file\&. +if it\*(Aqs shipped under +/usr/), however using drop\-ins for local configuration is recommended over modifications to the main configuration file\&. .PP -In addition to the "main" configuration file, drop\-in configuration snippets are read from +In addition to the main configuration file, drop\-in configuration snippets are read from /usr/lib/systemd/*\&.conf\&.d/, /usr/local/lib/systemd/*\&.conf\&.d/, and /etc/systemd/*\&.conf\&.d/\&. Those drop\-ins have higher precedence and override the main configuration file\&. Files in the @@ -57,7 +68,12 @@ configuration subdirectories are sorted by their filename in lexicographic order When packages need to customize the configuration, they can install drop\-ins under /usr/\&. Files in /etc/ -are reserved for the local administrator, who may use this logic to override the configuration files installed by vendor packages\&. Drop\-ins have to be used to override package drop\-ins, since the main configuration file has lower precedence\&. It is recommended to prefix all filenames in those subdirectories with a two\-digit number and a dash, to simplify the ordering of the files\&. This also defined a concept of drop\-in priority to allow distributions to ship drop\-ins within a specific range lower than the range used by users\&. This should lower the risk of package drop\-ins overriding accidentally drop\-ins defined by users\&. +are reserved for the local administrator, who may use this logic to override the configuration files installed by vendor packages\&. Drop\-ins have to be used to override package drop\-ins, since the main configuration file has lower precedence\&. It is recommended to prefix all filenames in those subdirectories with a two\-digit number and a dash, to simplify the ordering of the files\&. This also defines a concept of drop\-in priorities to allow OS vendors to ship drop\-ins within a specific range lower than the range used by users\&. This should lower the risk of package drop\-ins overriding accidentally drop\-ins defined by users\&. It is recommended to use the range 10\-40 for drop\-ins in +/usr/ +and the range 60\-90 for drop\-ins in +/etc/ +and +/run/, to make sure that local and transient drop\-ins take priority over drop\-ins shipped by the OS vendor\&. .PP To disable a configuration file supplied by the vendor, the recommended way is to place a symlink to /dev/null @@ -158,7 +174,8 @@ Configures the action to take when the system is idle\&. Takes one of "suspend", "hibernate", "hybrid\-sleep", -"suspend\-then\-hibernate", and +"suspend\-then\-hibernate", +"sleep", and "lock"\&. Defaults to "ignore"\&. .sp @@ -196,6 +213,28 @@ the per\-user service for a user is never terminated again after first login, an Added in version 240\&. .RE .PP +\fISleepOperation=\fR +.RS 4 +Takes a list of sleep operations\&. Possible values are +"suspend", +"hibernate", +"hybrid\-sleep", and +"suspend\-then\-hibernate"\&. Controls the candidate sleep operations for the +"sleep" +action\&. When +"sleep" +action is performed, the specified sleep operations are checked in a fixed order ("suspend\-then\-hibernate" +→ +"hybrid\-sleep" +→ +"suspend" +→ +"hibernate"), and the first one supported by the machine is used to put the system into sleep\&. Defaults to +"suspend\-then\-hibernate suspend hibernate"\&. +.sp +Added in version 256\&. +.RE +.PP \fIHandlePowerKey=\fR, \fIHandlePowerKeyLongPress=\fR, \fIHandleRebootKey=\fR, \fIHandleRebootKeyLongPress=\fR, \fIHandleSuspendKey=\fR, \fIHandleSuspendKeyLongPress=\fR, \fIHandleHibernateKey=\fR, \fIHandleHibernateKeyLongPress=\fR, \fIHandleLidSwitch=\fR, \fIHandleLidSwitchExternalPower=\fR, \fIHandleLidSwitchDocked=\fR .RS 4 Controls how logind shall handle the system power, reboot and sleep keys and the lid switch to trigger actions such as system power\-off, reboot or suspend\&. Can be one of @@ -208,6 +247,7 @@ Controls how logind shall handle the system power, reboot and sleep keys and the "hibernate", "hybrid\-sleep", "suspend\-then\-hibernate", +"sleep", "lock", and "factory\-reset"\&. If "ignore", @@ -354,7 +394,11 @@ Added in version 212\&. .RS 4 Specifies a timeout in seconds, or a time span value after which systemd\-logind -checks the idle state of all sessions\&. Every session that is idle for longer then the timeout will be stopped\&. Defaults to +checks the idle state of all sessions\&. Every session that is idle for longer than the timeout will be stopped\&. Note that this option doesn\*(Aqt apply to +"greeter" +or +"lock\-screen" +sessions\&. Defaults to "infinity" (systemd\-logind is not checking the idle state of sessions)\&. For details about the syntax of time spans, see @@ -364,7 +408,4 @@ Added in version 252\&. .RE .SH "SEE ALSO" .PP -\fBsystemd\fR(1), -\fBsystemd-logind.service\fR(8), -\fBloginctl\fR(1), -\fBsystemd-system.conf\fR(5) +\fBsystemd\fR(1), \fBsystemd-logind.service\fR(8), \fBloginctl\fR(1), \fBsystemd-system.conf\fR(5) diff --git a/upstream/debian-unstable/man5/machine-id.5 b/upstream/debian-unstable/man5/machine-id.5 index 5fabdd19..10d5cd55 100644 --- a/upstream/debian-unstable/man5/machine-id.5 +++ b/upstream/debian-unstable/man5/machine-id.5 @@ -1,5 +1,5 @@ '\" t -.TH "MACHINE\-ID" "5" "" "systemd 255" "machine-id" +.TH "MACHINE\-ID" "5" "" "systemd 256~rc3" "machine-id" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -232,15 +232,7 @@ file introduced by D\-Bus\&. In fact, this latter file might be a symlink to /etc/machine\-id\&. .SH "SEE ALSO" .PP -\fBsystemd\fR(1), -\fBsystemd-machine-id-setup\fR(1), -\fBgethostid\fR(3), -\fBhostname\fR(5), -\fBmachine-info\fR(5), -\fBos-release\fR(5), -\fBsd-id128\fR(3), -\fBsd_id128_get_machine\fR(3), -\fBsystemd-firstboot\fR(1) +\fBsystemd\fR(1), \fBsystemd-machine-id-setup\fR(1), \fBgethostid\fR(3), \fBhostname\fR(5), \fBmachine-info\fR(5), \fBos-release\fR(5), \fBsd-id128\fR(3), \fBsd_id128_get_machine\fR(3), \fBsystemd-firstboot\fR(1) .SH "NOTES" .IP " 1." 4 Safely Building Images diff --git a/upstream/debian-unstable/man5/machine-info.5 b/upstream/debian-unstable/man5/machine-info.5 index f77dc12b..105e38cc 100644 --- a/upstream/debian-unstable/man5/machine-info.5 +++ b/upstream/debian-unstable/man5/machine-info.5 @@ -1,5 +1,5 @@ '\" t -.TH "MACHINE\-INFO" "5" "" "systemd 255" "machine-info" +.TH "MACHINE\-INFO" "5" "" "systemd 256~rc3" "machine-info" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -143,12 +143,7 @@ DEPLOYMENT=production .\} .SH "SEE ALSO" .PP -\fBsystemd\fR(1), -\fBos-release\fR(5), -\fBhostname\fR(5), -\fBmachine-id\fR(5), -\fBhostnamectl\fR(1), -\fBsystemd-hostnamed.service\fR(8) +\fBsystemd\fR(1), \fBos-release\fR(5), \fBhostname\fR(5), \fBmachine-id\fR(5), \fBhostnamectl\fR(1), \fBsystemd-hostnamed.service\fR(8) .SH "NOTES" .IP " 1." 4 XDG Icon Naming Specification diff --git a/upstream/debian-unstable/man5/mke2fs.conf.5 b/upstream/debian-unstable/man5/mke2fs.conf.5 index 04a1aca1..af2a5006 100644 --- a/upstream/debian-unstable/man5/mke2fs.conf.5 +++ b/upstream/debian-unstable/man5/mke2fs.conf.5 @@ -2,7 +2,7 @@ .\" Copyright 2006 by Theodore Ts'o. All Rights Reserved. .\" This file may be copied under the terms of the GNU Public License. .\" -.TH mke2fs.conf 5 "February 2023" "E2fsprogs version 1.47.0" +.TH mke2fs.conf 5 "May 2024" "E2fsprogs version 1.47.1" .SH NAME mke2fs.conf \- Configuration file for mke2fs .SH DESCRIPTION diff --git a/upstream/debian-unstable/man5/modprobe.d.5 b/upstream/debian-unstable/man5/modprobe.d.5 index 4e3f0823..4ab451b0 100644 --- a/upstream/debian-unstable/man5/modprobe.d.5 +++ b/upstream/debian-unstable/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: 02/13/2024 +.\" Date: 05/26/2024 .\" Manual: modprobe.d .\" Source: kmod .\" Language: English .\" -.TH "MODPROBE\&.D" "5" "02/13/2024" "kmod" "modprobe.d" +.TH "MODPROBE\&.D" "5" "05/26/2024" "kmod" "modprobe.d" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -144,6 +144,15 @@ argument, \fBsoftdep\fR takes precedence\&. .RE +.PP +weakdep \fImodulename\fR \fImodules\&.\&.\&.\fR +.RS 4 +The +\fBweakdep\fR +command allows you to specify weak module dependencies\&. Those are similar to pre softdep, with the difference that userspace doesn\*(Aqt attempt to load that dependency before the specified module\&. Instead the kernel may request one or multiple of them during module probe, depending on the hardware it\*(Aqs binding to\&. The purpose of weak module is to allow a driver to specify that a certain dependency may be needed, so it should be present in the filesystem (e\&.g\&. in initramfs) when that module is probed\&. +.sp +Example: Assume "weakdep c a b"\&. A program creating an initramfs knows it should add a, b, and c to the filesystem since a and b may be required/desired at runtime\&. When c is loaded and is being probed, it may issue calls to request_module() causing a or b to also be loaded\&. +.RE .SH "COMPATIBILITY" .PP A future version of kmod will come with a strong warning to avoid use of the diff --git a/upstream/debian-unstable/man5/modules-load.d.5 b/upstream/debian-unstable/man5/modules-load.d.5 index 1570e788..1b0af433 100644 --- a/upstream/debian-unstable/man5/modules-load.d.5 +++ b/upstream/debian-unstable/man5/modules-load.d.5 @@ -1,5 +1,5 @@ '\" t -.TH "MODULES\-LOAD\&.D" "5" "" "systemd 255" "modules-load.d" +.TH "MODULES\-LOAD\&.D" "5" "" "systemd 256~rc3" "modules-load.d" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -23,11 +23,15 @@ modules-load.d \- Configure kernel modules to load at boot .SH "SYNOPSIS" .PP +.RS 4 /etc/modules\-load\&.d/*\&.conf -.PP +.RE +.RS 4 /run/modules\-load\&.d/*\&.conf -.PP +.RE +.RS 4 /usr/lib/modules\-load\&.d/*\&.conf +.RE .SH "DESCRIPTION" .PP \fBsystemd-modules-load.service\fR(8) @@ -62,7 +66,12 @@ Packages should install their configuration files in /usr/local/lib/ (local installs)\&. Files in /etc/ -are reserved for the local administrator, who may use this logic to override the configuration files installed by vendor packages\&. It is recommended to prefix all filenames with a two\-digit number and a dash, to simplify the ordering of the files\&. +are reserved for the local administrator, who may use this logic to override the configuration files installed by vendor packages\&. It is recommended to prefix all filenames with a two\-digit number and a dash, to simplify the ordering of the files\&. It is recommended to use the range 10\-40 for configuration files in +/usr/ +and the range 60\-90 for configuration files in +/etc/ +and +/run/, to make sure that local and transient configuration files will always take priority over configuration files shipped by the OS vendor\&. .PP If the administrator wants to disable a configuration file supplied by the vendor, the recommended way is to place a symlink to /dev/null @@ -84,7 +93,4 @@ virtio\-net .\} .SH "SEE ALSO" .PP -\fBsystemd\fR(1), -\fBsystemd-modules-load.service\fR(8), -\fBsystemd-delta\fR(1), -\fBmodprobe\fR(8) +\fBsystemd\fR(1), \fBsystemd-modules-load.service\fR(8), \fBsystemd-delta\fR(1), \fBmodprobe\fR(8) diff --git a/upstream/debian-unstable/man5/modules.dep.5 b/upstream/debian-unstable/man5/modules.dep.5 index 4c010136..3b866559 100644 --- a/upstream/debian-unstable/man5/modules.dep.5 +++ b/upstream/debian-unstable/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: 02/13/2024 +.\" Date: 05/26/2024 .\" Manual: modules.dep .\" Source: kmod .\" Language: English .\" -.TH "MODULES\&.DEP" "5" "02/13/2024" "kmod" "modules.dep" +.TH "MODULES\&.DEP" "5" "05/26/2024" "kmod" "modules.dep" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/upstream/debian-unstable/man5/motd.5 b/upstream/debian-unstable/man5/motd.5 index 27a0f4ce..3e24d88a 100644 --- a/upstream/debian-unstable/man5/motd.5 +++ b/upstream/debian-unstable/man5/motd.5 @@ -5,7 +5,7 @@ .\" .\" Modified Sat Jul 24 17:08:16 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 motd 5 2022-10-30 "Linux man-pages 6.05.01" +.TH motd 5 2024-05-02 "Linux man-pages 6.8" .SH NAME motd \- message of the day .SH DESCRIPTION @@ -16,22 +16,18 @@ are displayed by .BR pam_motd (8) .\" End of patch .\" .BR login (1) -.BR login (1) after a successful login but just before it executes the login shell. -.PP +.P The abbreviation "motd" stands for "message of the day", and this file has been traditionally used for exactly that (it requires much less disk space than mail to all users). -.PP +.P On Debian GNU/Linux, dynamic content configured at .I /etc/pam.d/login is also displayed by -.IR pam_exec . +.I pam_exec .SH FILES .I /etc/motd -.br -.I /etc/pam.d/login .SH SEE ALSO .BR login (1), .BR issue (5) -.BR pam_motd (8) diff --git a/upstream/debian-unstable/man5/nanorc.5 b/upstream/debian-unstable/man5/nanorc.5 index 4416b7dd..672f6e16 100644 --- a/upstream/debian-unstable/man5/nanorc.5 +++ b/upstream/debian-unstable/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/debian-unstable/man5/networkd.conf.5 b/upstream/debian-unstable/man5/networkd.conf.5 index caead9da..9064e702 100644 --- a/upstream/debian-unstable/man5/networkd.conf.5 +++ b/upstream/debian-unstable/man5/networkd.conf.5 @@ -1,5 +1,5 @@ '\" t -.TH "NETWORKD\&.CONF" "5" "" "systemd 255" "networkd.conf" +.TH "NETWORKD\&.CONF" "5" "" "systemd 256~rc3" "networkd.conf" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -23,26 +23,39 @@ networkd.conf, networkd.conf.d \- Global Network configuration files .SH "SYNOPSIS" .PP +.RS 4 /etc/systemd/networkd\&.conf -.PP +.RE +.RS 4 +/run/systemd/networkd\&.conf +.RE +.RS 4 +/usr/lib/systemd/networkd\&.conf +.RE +.RS 4 /etc/systemd/networkd\&.conf\&.d/*\&.conf -.PP +.RE +.RS 4 +/run/systemd/networkd\&.conf\&.d/*\&.conf +.RE +.RS 4 /usr/lib/systemd/networkd\&.conf\&.d/*\&.conf +.RE .SH "DESCRIPTION" .PP -These configuration files control global network parameters\&. Currently the DHCP Unique Identifier (DUID)\&. +These configuration files control global network parameters\&. .SH "CONFIGURATION DIRECTORIES AND PRECEDENCE" .PP -The default configuration is set during compilation, so configuration is only needed when it is necessary to deviate from those defaults\&. The main configuration file is either in -/usr/lib/systemd/ -or -/etc/systemd/ -and contains commented out entries showing the defaults as a guide to the administrator\&. Local overrides can be created by creating drop\-ins, as described below\&. The main configuration file can also be edited for this purpose (or a copy in +The default configuration is set during compilation, so configuration is only needed when it is necessary to deviate from those defaults\&. The main configuration file is loaded from one of the listed directories in order of priority, only the first file found is used: +/etc/systemd/, +/run/systemd/, +/usr/local/lib/systemd/, +/usr/lib/systemd/\&. The vendor version of the file contains commented out entries showing the defaults as a guide to the administrator\&. Local overrides can also be created by creating drop\-ins, as described below\&. The main configuration file can also be edited for this purpose (or a copy in /etc/ -if it\*(Aqs shipped in -/usr/) however using drop\-ins for local configuration is recommended over modifications to the main configuration file\&. +if it\*(Aqs shipped under +/usr/), however using drop\-ins for local configuration is recommended over modifications to the main configuration file\&. .PP -In addition to the "main" configuration file, drop\-in configuration snippets are read from +In addition to the main configuration file, drop\-in configuration snippets are read from /usr/lib/systemd/*\&.conf\&.d/, /usr/local/lib/systemd/*\&.conf\&.d/, and /etc/systemd/*\&.conf\&.d/\&. Those drop\-ins have higher precedence and override the main configuration file\&. Files in the @@ -52,7 +65,12 @@ configuration subdirectories are sorted by their filename in lexicographic order When packages need to customize the configuration, they can install drop\-ins under /usr/\&. Files in /etc/ -are reserved for the local administrator, who may use this logic to override the configuration files installed by vendor packages\&. Drop\-ins have to be used to override package drop\-ins, since the main configuration file has lower precedence\&. It is recommended to prefix all filenames in those subdirectories with a two\-digit number and a dash, to simplify the ordering of the files\&. This also defined a concept of drop\-in priority to allow distributions to ship drop\-ins within a specific range lower than the range used by users\&. This should lower the risk of package drop\-ins overriding accidentally drop\-ins defined by users\&. +are reserved for the local administrator, who may use this logic to override the configuration files installed by vendor packages\&. Drop\-ins have to be used to override package drop\-ins, since the main configuration file has lower precedence\&. It is recommended to prefix all filenames in those subdirectories with a two\-digit number and a dash, to simplify the ordering of the files\&. This also defines a concept of drop\-in priorities to allow OS vendors to ship drop\-ins within a specific range lower than the range used by users\&. This should lower the risk of package drop\-ins overriding accidentally drop\-ins defined by users\&. It is recommended to use the range 10\-40 for drop\-ins in +/usr/ +and the range 60\-90 for drop\-ins in +/etc/ +and +/run/, to make sure that local and transient drop\-ins take priority over drop\-ins shipped by the OS vendor\&. .PP To disable a configuration file supplied by the vendor, the recommended way is to place a symlink to /dev/null @@ -111,6 +129,16 @@ is true or Added in version 246\&. .RE .PP +\fIManageForeignNextHops=\fR +.RS 4 +A boolean\&. When true, +\fBsystemd\-networkd\fR +will remove nexthops that are not configured in \&.network files (except for routes with protocol +"kernel")\&. When false, it will not remove any foreign nexthops, keeping them even if they are not configured in a \&.network file\&. Defaults to yes\&. +.sp +Added in version 256\&. +.RE +.PP \fIRouteTable=\fR .RS 4 Defines the route table name\&. Takes a whitespace\-separated list of the pairs of route table name and number\&. The route table name and number in each pair are separated with a colon, i\&.e\&., @@ -122,6 +150,31 @@ Defines the route table name\&. Takes a whitespace\-separated list of the pairs Added in version 248\&. .RE .PP +\fIIPv4Forwarding=\fR +.RS 4 +Configures IPv4 packet forwarding for the system\&. Takes a boolean value\&. This controls the +net\&.ipv4\&.conf\&.default\&.forwarding +and +net\&.ipv4\&.conf\&.all\&.forwardingsysctl options\&. See +\m[blue]\fBIP Sysctl\fR\m[]\&\s-2\u[1]\d\s+2 +for more details about the sysctl options\&. Defaults to unset and the sysctl options will not be changed\&. +.sp +Added in version 256\&. +.RE +.PP +\fIIPv6Forwarding=\fR +.RS 4 +Configures IPv6 packet forwarding for the system\&. Takes a boolean value\&. This controls the +net\&.ipv6\&.conf\&.default\&.forwarding +and +net\&.ipv6\&.conf\&.all\&.forwarding +sysctl options\&. See +\m[blue]\fBIP Sysctl\fR\m[]\&\s-2\u[1]\d\s+2 +for more details about the sysctl options\&. Defaults to unset and the sysctl options will not be changed\&. +.sp +Added in version 256\&. +.RE +.PP \fIIPv6PrivacyExtensions=\fR .RS 4 Specifies the default value for per\-network @@ -134,6 +187,30 @@ and .sp Added in version 254\&. .RE +.PP +\fIUseDomains=\fR +.RS 4 +Specifies the network\- and protocol\-independent default value for the same settings in [IPv6AcceptRA], [DHCPv4], and [DHCPv6] sections below\&. Takes a boolean, or the special value +\fBroute\fR\&. See the same setting in +\fBsystemd.network\fR(5)\&. Defaults to +"no"\&. +.sp +Added in version 256\&. +.RE +.SH "[IPV6ACCEPTRA] SECTION OPTIONS" +.PP +This section configures the default setting of the Neighbor Discovery\&. The following options are available in the [IPv6AcceptRA] section: +.PP +\fIUseDomains=\fR +.RS 4 +Specifies the network\-independent default value for the same setting in the [IPv6AcceptRA] section in +\fBsystemd.network\fR(5)\&. Takes a boolean, or the special value +\fBroute\fR\&. When unspecified, the value specified in the [Network] section in +\fBnetworkd.conf\fR(5), which defaults to +"no", will be used\&. +.sp +Added in version 256\&. +.RE .SH "[DHCPV4] SECTION OPTIONS" .PP This section configures the DHCP Unique Identifier (DUID) value used by DHCP protocol\&. DHCPv4 client protocol sends IAID and DUID to the DHCP server when acquiring a dynamic IPv4 address if @@ -145,7 +222,7 @@ The following options are understood: \fIDUIDType=\fR .RS 4 Specifies how the DUID should be generated\&. See -\m[blue]\fBRFC 3315\fR\m[]\&\s-2\u[1]\d\s+2 +\m[blue]\fBRFC 3315\fR\m[]\&\s-2\u[2]\d\s+2 for a description of all the options\&. .sp This takes an integer in the range 0\&...65535, or one of the following string values: @@ -209,8 +286,8 @@ The DUID value specified here overrides the DUID that \fBsystemd-networkd.service\fR(8) generates from the machine ID\&. To configure DUID per\-network, see \fBsystemd.network\fR(5)\&. The configured DHCP DUID should conform to the specification in -\m[blue]\fBRFC 3315\fR\m[]\&\s-2\u[2]\d\s+2, -\m[blue]\fBRFC 6355\fR\m[]\&\s-2\u[3]\d\s+2\&. To configure IAID, see +\m[blue]\fBRFC 3315\fR\m[]\&\s-2\u[3]\d\s+2, +\m[blue]\fBRFC 6355\fR\m[]\&\s-2\u[4]\d\s+2\&. To configure IAID, see \fBsystemd.network\fR(5)\&. .PP \fBExample\ \&1.\ \&A DUIDType=vendor with a custom value\fR @@ -231,6 +308,13 @@ This specifies a 14 byte DUID, with the type DUID\-EN ("00:02"), enterprise numb Added in version 230\&. .RE +.PP +\fIUseDomains=\fR +.RS 4 +Same as the one in the [IPv6AcceptRA] section, but applied for DHCPv4 protocol\&. +.sp +Added in version 256\&. +.RE .SH "[DHCPV6] SECTION OPTIONS" .PP This section configures the DHCP Unique Identifier (DUID) value used by DHCPv6 protocol\&. DHCPv6 client protocol sends the DHCP Unique Identifier and the interface Identity Association Identifier (IAID) to a DHCPv6 server when acquiring a dynamic IPv6 address\&. IAID and DUID allows a DHCPv6 server to uniquely identify the machine and the interface requesting a DHCP IP address\&. To configure IAID, see @@ -244,25 +328,43 @@ As in the [DHCPv4] section\&. .sp Added in version 249\&. .RE +.PP +\fIUseDomains=\fR +.RS 4 +As in the [DHCPv4] section\&. +.sp +Added in version 256\&. +.RE +.SH "[DHCPSERVER] SECTION OPTIONS" +.PP +This section configures the default setting of the DHCP server\&. The following options are available in the [DHCPServer] section: +.PP +\fIUseDomains=\fR +.RS 4 +Same as the one in the [IPv6AcceptRA] section, but applied for DHCPv4 protocol\&. +.sp +Added in version 256\&. +.RE .SH "SEE ALSO" .PP -\fBsystemd\fR(1), -\fBsystemd.network\fR(5), -\fBsystemd-networkd.service\fR(8), -\fBmachine-id\fR(5), -\fBsd_id128_get_machine_app_specific\fR(3) +\fBsystemd\fR(1), \fBsystemd.network\fR(5), \fBsystemd-networkd.service\fR(8), \fBmachine-id\fR(5), \fBsd_id128_get_machine_app_specific\fR(3) .SH "NOTES" .IP " 1." 4 +IP Sysctl +.RS 4 +\%https://docs.kernel.org/networking/ip-sysctl.html +.RE +.IP " 2." 4 RFC 3315 .RS 4 \%https://tools.ietf.org/html/rfc3315#section-9 .RE -.IP " 2." 4 +.IP " 3." 4 RFC 3315 .RS 4 \%http://tools.ietf.org/html/rfc3315#section-9 .RE -.IP " 3." 4 +.IP " 4." 4 RFC 6355 .RS 4 \%http://tools.ietf.org/html/rfc6355 diff --git a/upstream/debian-unstable/man5/networks.5 b/upstream/debian-unstable/man5/networks.5 index cf660e34..5fbf41eb 100644 --- a/upstream/debian-unstable/man5/networks.5 +++ b/upstream/debian-unstable/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 6.8" .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/debian-unstable/man5/nologin.5 b/upstream/debian-unstable/man5/nologin.5 index af006f52..c90aee41 100644 --- a/upstream/debian-unstable/man5/nologin.5 +++ b/upstream/debian-unstable/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 6.8" .SH NAME nologin \- prevent unprivileged users from logging into the system .SH DESCRIPTION diff --git a/upstream/debian-unstable/man5/nss.5 b/upstream/debian-unstable/man5/nss.5 index d53e1cd5..d40b1081 100644 --- a/upstream/debian-unstable/man5/nss.5 +++ b/upstream/debian-unstable/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 6.8" .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/debian-unstable/man5/nsswitch.conf.5 b/upstream/debian-unstable/man5/nsswitch.conf.5 index eb690ed8..6f355c0f 100644 --- a/upstream/debian-unstable/man5/nsswitch.conf.5 +++ b/upstream/debian-unstable/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 6.8" .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 @@ -296,7 +296,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: @@ -317,7 +317,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 @@ -360,7 +360,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 @@ -414,7 +414,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/debian-unstable/man5/oomd.conf.5 b/upstream/debian-unstable/man5/oomd.conf.5 index b6b0b1a8..706775a8 100644 --- a/upstream/debian-unstable/man5/oomd.conf.5 +++ b/upstream/debian-unstable/man5/oomd.conf.5 @@ -1,5 +1,5 @@ '\" t -.TH "OOMD\&.CONF" "5" "" "systemd 255" "oomd.conf" +.TH "OOMD\&.CONF" "5" "" "systemd 256~rc3" "oomd.conf" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -23,11 +23,24 @@ oomd.conf, oomd.conf.d \- Global \fBsystemd\-oomd\fR configuration files .SH "SYNOPSIS" .PP +.RS 4 /etc/systemd/oomd\&.conf -.PP +.RE +.RS 4 +/run/systemd/oomd\&.conf +.RE +.RS 4 +/usr/lib/systemd/oomd\&.conf +.RE +.RS 4 /etc/systemd/oomd\&.conf\&.d/*\&.conf -.PP +.RE +.RS 4 +/run/systemd/oomd\&.conf\&.d/*\&.conf +.RE +.RS 4 /usr/lib/systemd/oomd\&.conf\&.d/*\&.conf +.RE .SH "DESCRIPTION" .PP These files configure the various parameters of the @@ -38,16 +51,16 @@ userspace out\-of\-memory (OOM) killer, for a general description of the syntax\&. .SH "CONFIGURATION DIRECTORIES AND PRECEDENCE" .PP -The default configuration is set during compilation, so configuration is only needed when it is necessary to deviate from those defaults\&. The main configuration file is either in -/usr/lib/systemd/ -or -/etc/systemd/ -and contains commented out entries showing the defaults as a guide to the administrator\&. Local overrides can be created by creating drop\-ins, as described below\&. The main configuration file can also be edited for this purpose (or a copy in +The default configuration is set during compilation, so configuration is only needed when it is necessary to deviate from those defaults\&. The main configuration file is loaded from one of the listed directories in order of priority, only the first file found is used: +/etc/systemd/, +/run/systemd/, +/usr/local/lib/systemd/, +/usr/lib/systemd/\&. The vendor version of the file contains commented out entries showing the defaults as a guide to the administrator\&. Local overrides can also be created by creating drop\-ins, as described below\&. The main configuration file can also be edited for this purpose (or a copy in /etc/ -if it\*(Aqs shipped in -/usr/) however using drop\-ins for local configuration is recommended over modifications to the main configuration file\&. +if it\*(Aqs shipped under +/usr/), however using drop\-ins for local configuration is recommended over modifications to the main configuration file\&. .PP -In addition to the "main" configuration file, drop\-in configuration snippets are read from +In addition to the main configuration file, drop\-in configuration snippets are read from /usr/lib/systemd/*\&.conf\&.d/, /usr/local/lib/systemd/*\&.conf\&.d/, and /etc/systemd/*\&.conf\&.d/\&. Those drop\-ins have higher precedence and override the main configuration file\&. Files in the @@ -57,7 +70,12 @@ configuration subdirectories are sorted by their filename in lexicographic order When packages need to customize the configuration, they can install drop\-ins under /usr/\&. Files in /etc/ -are reserved for the local administrator, who may use this logic to override the configuration files installed by vendor packages\&. Drop\-ins have to be used to override package drop\-ins, since the main configuration file has lower precedence\&. It is recommended to prefix all filenames in those subdirectories with a two\-digit number and a dash, to simplify the ordering of the files\&. This also defined a concept of drop\-in priority to allow distributions to ship drop\-ins within a specific range lower than the range used by users\&. This should lower the risk of package drop\-ins overriding accidentally drop\-ins defined by users\&. +are reserved for the local administrator, who may use this logic to override the configuration files installed by vendor packages\&. Drop\-ins have to be used to override package drop\-ins, since the main configuration file has lower precedence\&. It is recommended to prefix all filenames in those subdirectories with a two\-digit number and a dash, to simplify the ordering of the files\&. This also defines a concept of drop\-in priorities to allow OS vendors to ship drop\-ins within a specific range lower than the range used by users\&. This should lower the risk of package drop\-ins overriding accidentally drop\-ins defined by users\&. It is recommended to use the range 10\-40 for drop\-ins in +/usr/ +and the range 60\-90 for drop\-ins in +/etc/ +and +/run/, to make sure that local and transient drop\-ins take priority over drop\-ins shipped by the OS vendor\&. .PP To disable a configuration file supplied by the vendor, the recommended way is to place a symlink to /dev/null @@ -108,7 +126,4 @@ Added in version 248\&. .RE .SH "SEE ALSO" .PP -\fBsystemd\fR(1), -\fBsystemd.resource-control\fR(5), -\fBsystemd-oomd.service\fR(8), -\fBoomctl\fR(1) +\fBsystemd\fR(1), \fBsystemd.resource-control\fR(5), \fBsystemd-oomd.service\fR(8), \fBoomctl\fR(1) diff --git a/upstream/debian-unstable/man5/org.freedesktop.LogControl1.5 b/upstream/debian-unstable/man5/org.freedesktop.LogControl1.5 index 70733a8e..30ea304e 100644 --- a/upstream/debian-unstable/man5/org.freedesktop.LogControl1.5 +++ b/upstream/debian-unstable/man5/org.freedesktop.LogControl1.5 @@ -1,5 +1,5 @@ '\" t -.TH "ORG\&.FREEDESKTOP\&.LOGCONTROL1" "5" "" "systemd 255" "org.freedesktop.LogControl1" +.TH "ORG\&.FREEDESKTOP\&.LOGCONTROL1" "5" "" "systemd 256~rc3" "org.freedesktop.LogControl1" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -181,13 +181,10 @@ for details about #define _cleanup_(f) __attribute__((cleanup(f))) -#define check(log_level, x) ({ \e - int _r = (x); \e - errno = _r < 0 ? \-_r : 0; \e - sd_journal_print((log_level), #x ": %m"); \e - if (_r < 0) \e - return EXIT_FAILURE; \e - }) +static int log_error(int log_level, int error, const char *str) { + sd_journal_print(log_level, "%s failed: %s", str, strerror(\-error)); + return error; +} typedef enum LogTarget { LOG_TARGET_JOURNAL, @@ -265,7 +262,8 @@ static int property_set( return r; if (strcmp(property, "LogLevel") == 0) { - for (int i = 0; i < LOG_DEBUG + 1; i++) + int i; + for (i = 0; i < LOG_DEBUG + 1; i++) if (strcmp(value, log_level_table[i]) == 0) { o\->log_level = i; setlogmask(LOG_UPTO(i)); @@ -279,7 +277,8 @@ static int property_set( } if (strcmp(property, "LogTarget") == 0) { - for (LogTarget i = 0; i < _LOG_TARGET_MAX; i++) + LogTarget i; + for (i = 0; i < _LOG_TARGET_MAX; i++) if (strcmp(value, log_target_table[i]) == 0) { o\->log_target = i; return 0; @@ -331,6 +330,7 @@ int main(int argc, char **argv) { \&.log_target = LOG_TARGET_JOURNAL, \&.syslog_identifier = "example", }; + int r; /* https://man7\&.org/linux/man\-pages/man3/setlogmask\&.3\&.html * Programs using syslog() instead of sd_journal can use this API to cut logs @@ -341,37 +341,49 @@ int main(int argc, char **argv) { /* Acquire a connection to the bus, letting the library work out the details\&. * https://www\&.freedesktop\&.org/software/systemd/man/sd_bus_default\&.html */ - check(o\&.log_level, sd_bus_default(&bus)); + r = sd_bus_default(&bus); + if (r < 0) + return log_error(o\&.log_level, r, "sd_bus_default()"); /* Publish an interface on the bus, specifying our well\-known object access * path and public interface name\&. * https://www\&.freedesktop\&.org/software/systemd/man/sd_bus_add_object\&.html * https://dbus\&.freedesktop\&.org/doc/dbus\-tutorial\&.html */ - check(o\&.log_level, sd_bus_add_object_vtable(bus, NULL, - "/org/freedesktop/LogControl1", - "org\&.freedesktop\&.LogControl1", - vtable, - &o)); + r = sd_bus_add_object_vtable(bus, NULL, + "/org/freedesktop/LogControl1", + "org\&.freedesktop\&.LogControl1", + vtable, + &o); + if (r < 0) + return log_error(o\&.log_level, r, "sd_bus_add_object_vtable()"); /* By default the service is assigned an ephemeral name\&. Also add a fixed * one, so that clients know whom to call\&. * https://www\&.freedesktop\&.org/software/systemd/man/sd_bus_request_name\&.html */ - check(o\&.log_level, sd_bus_request_name(bus, "org\&.freedesktop\&.Example", 0)); + r = sd_bus_request_name(bus, "org\&.freedesktop\&.Example", 0); + if (r < 0) + return log_error(o\&.log_level, r, "sd_bus_request_name()"); for (;;) { /* https://www\&.freedesktop\&.org/software/systemd/man/sd_bus_wait\&.html */ - check(o\&.log_level, sd_bus_wait(bus, UINT64_MAX)); + r = sd_bus_wait(bus, UINT64_MAX); + if (r < 0) + return log_error(o\&.log_level, r, "sd_bus_wait()"); /* https://www\&.freedesktop\&.org/software/systemd/man/sd_bus_process\&.html */ - check(o\&.log_level, sd_bus_process(bus, NULL)); + r = sd_bus_process(bus, NULL); + if (r < 0) + return log_error(o\&.log_level, r, "sd_bus_process()"); } /* https://www\&.freedesktop\&.org/software/systemd/man/sd_bus_release_name\&.html */ - check(o\&.log_level, sd_bus_release_name(bus, "org\&.freedesktop\&.Example")); + r = sd_bus_release_name(bus, "org\&.freedesktop\&.Example"); + if (r < 0) + return log_error(o\&.log_level, r, "sd_bus_release_name()"); return 0; } @@ -384,8 +396,4 @@ This creates a simple server on the bus\&. It implements the LogControl1 interfa \fBsd_journal_print\fR(3)\&. .SH "SEE ALSO" .PP -\fBsystemd\fR(1), -\fBjournalctl\fR(1), -\fBsystemctl\fR(1), -\fBsystemd.service\fR(5), -\fBsyslog\fR(3) +\fBsystemd\fR(1), \fBjournalctl\fR(1), \fBsystemctl\fR(1), \fBsystemd.service\fR(5), \fBsyslog\fR(3) diff --git a/upstream/debian-unstable/man5/org.freedesktop.home1.5 b/upstream/debian-unstable/man5/org.freedesktop.home1.5 index b91e1d7e..fc16afb4 100644 --- a/upstream/debian-unstable/man5/org.freedesktop.home1.5 +++ b/upstream/debian-unstable/man5/org.freedesktop.home1.5 @@ -1,5 +1,5 @@ '\" t -.TH "ORG\&.FREEDESKTOP\&.HOME1" "5" "" "systemd 255" "org.freedesktop.home1" +.TH "ORG\&.FREEDESKTOP\&.HOME1" "5" "" "systemd 256~rc3" "org.freedesktop.home1" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -61,14 +61,18 @@ node /org/freedesktop/home1 { out b incomplete, out o bus_path); ListHomes(out a(susussso) home_areas); - @org\&.freedesktop\&.systemd1\&.Privileged("true") ActivateHome(in s user_name, in s secret); + ActivateHomeIfReferenced(in s user_name, + in s secret); @org\&.freedesktop\&.systemd1\&.Privileged("true") DeactivateHome(in s user_name); RegisterHome(in s user_record); UnregisterHome(in s user_name); CreateHome(in s user_record); + CreateHomeEx(in s user_record, + in a{sh} blobs, + in t flags); RealizeHome(in s user_name, in s secret); RemoveHome(in s user_name); @@ -78,6 +82,9 @@ node /org/freedesktop/home1 { AuthenticateHome(in s user_name, in s secret); UpdateHome(in s user_record); + UpdateHomeEx(in s user_record, + in a{sh} blobs, + in t flags); ResizeHome(in s user_name, in t size, in s secret); @@ -98,6 +105,10 @@ node /org/freedesktop/home1 { in b please_suspend, out h send_fd); @org\&.freedesktop\&.systemd1\&.Privileged("true") + RefHomeUnrestricted(in s user_name, + in b please_suspend, + out h send_fd); + @org\&.freedesktop\&.systemd1\&.Privileged("true") ReleaseHome(in s user_name); @org\&.freedesktop\&.systemd1\&.Privileged("true") LockAllHomes(); @@ -144,6 +155,10 @@ node /org/freedesktop/home1 { + + + + .SS "Methods" .PP \fBGetHomeByName()\fR @@ -151,7 +166,7 @@ returns basic user information (a minimal subset of the full user record), provi \fBgetpwnam\fR(3) returns: the numeric UID and GID, the real name, home directory and shell\&. In addition it returns a state identifier describing the state the user\*(Aqs home directory is in, as well as a bus path referring to the bus object encapsulating the user record and home directory\&. This object implements the org\&.freedesktop\&.home1\&.Home -interface documented below\&. +interface documented below\&. This method, and most others in this interface that take user names, will try to use the caller\*(Aqs home area if the specified user name is an empty string\&. .PP \fBGetHomeByUID()\fR is similar to @@ -190,6 +205,11 @@ method on the org\&.freedesktop\&.home1\&.Home interface documented below, but may be called on the manager object and takes a user name as additional argument, instead\&. .PP +\fBActivateHomeIfReferenced()\fR +is identical to +\fBActivateHome()\fR\&. However, the call only succeeds if the home directory is currently referenced\&. Useful in conjunction with +\fBRefHomeUnrestricted()\fR, which allows creating a reference to a home directory even if the home directory is not active\&. +.PP \fBDeactivateHome()\fR deactivates (i\&.e\&. unmounts) the home directory of the specified user\&. It is equivalent to the \fBDeactivate()\fR @@ -222,6 +242,21 @@ registers and creates a new home directory\&. This takes a fully specified JSON "secret" section)\&. This registers the user record locally and creates a home directory matching it, depending on the settings specified in the record in combination with local configuration\&. .PP +\fBCreateHomeEx()\fR +is like +\fBCreateHome()\fR, but it allows the home directory to be created with a pre\-populated blob directory (see +\m[blue]\fBUser Record Blob Directories\fR\m[]\&\s-2\u[2]\d\s+2 +for more info)\&. This can be done via the dictionary passed as the +\fIblobs\fR +argument to this method: the values are open file descriptors to regular files, and the keys are the filenames that should contain their respective file\*(Aqs data in the blob directory\&. Note that for security reasons, the file descriptors passed into this method must have enough privileges to read their target file and thus cannot be +"O_PATH"; this is done to ensure the caller is actually permitted to read the file they are asking to publish in the blob directories\&. If the user record passed as the first argument contains a +"blobManifest" +field it will be enforced; otherwise, a +"blobManifest" +field will be generated and inserted into the record\&. The +\fIflags\fR +argument may be used for future expansion, but for now pass 0\&. +.PP \fBRealizeHome()\fR creates a home directory whose user record is already registered locally\&. This takes a user name plus a user record consisting only of the "secret" @@ -268,7 +303,7 @@ org\&.freedesktop\&.home1\&.Home interface\&. .PP \fBUpdateHome()\fR -updates a locally registered user record\&. Takes a fully specified JSON user record as argument (including the +updates a locally registered user record\&. Takes a fully specified JSON user record as argument (possibly including the "secret" section)\&. A user with a matching name and realm must be registered locally already, and the last change timestamp of the newly supplied record must be newer than the previously existing user record\&. Note this operation updates the user record only, it does not propagate passwords/authentication tokens from the user record to the storage back\-end, or resizes the storage back\-end\&. Typically a home directory is first updated, and then the password of the underlying storage updated using \fBChangePasswordHome()\fR @@ -279,10 +314,40 @@ on the org\&.freedesktop\&.home1\&.Home interface\&. .PP +\fBUpdateHomeEx()\fR +is like +\fBUpdateHome()\fR, but it allows for changes to the blob directory (see +\m[blue]\fBUser Record Blob Directories\fR\m[]\&\s-2\u[2]\d\s+2 +for more info)\&. The +\fIblobs\fR +argument works in the same way as +\fBCreateHomeEx()\fR, so check there for details\&. The new blob directory contents passed into this method will completely replace the user\*(Aqs existing blob directory\&. The +\fIflags\fR +argument can be used to further customize the behavior of this method via flags defined as follows: +.sp +.if n \{\ +.RS 4 +.\} +.nf +#define SD_HOMED_UPDATE_OFFLINE (UINT64_C(1) << 0) + +.fi +.if n \{\ +.RE +.\} +.PP +When +\fBSD_HOMED_UPDATE_OFFLINE\fR +(0x01) is set, no attempt is made to update the copies of the user record and blob directory that are embedded into the home directory\&. Changes will be stored, however, and may be propagated into the home directory the next time it is reconciled (most likely when the user next logs in)\&. Note that any changes made with this flag set may be lost if the home area has a newer record, which can happen if the home area is updated on another machine after this method call\&. This method is equivalent to +\fBUpdateEx()\fR +on the +org\&.freedesktop\&.home1\&.Home +interface\&. +.PP \fBResizeHome()\fR -resizes the storage associated with a user record\&. Takes a user name, a disk size in bytes and a user record consisting only of the +resizes the storage associated with a user record\&. Takes a user name, a disk size in bytes, and optionally a user record consisting only of the "secret" -section as argument\&. If the size is specified as +section as arguments\&. If the size is specified as \fBUINT64_MAX\fR the storage is resized to the size already specified in the user record\&. Typically, if the user record is updated using \fBUpdateHome()\fR @@ -306,7 +371,7 @@ org\&.freedesktop\&.home1\&.Home interface\&. .PP \fBLockHome()\fR -temporarily suspends access to a home directory, flushing out any cryptographic keys from memory\&. This is only supported on some back\-ends, and usually done during system suspend, in order to effectively secure home directories while the system is sleeping\&. Takes a user name as single argument\&. If an application attempts to access a home directory while it is locked it will typically freeze until the home directory is unlocked again\&. This method is equivalent to +temporarily suspends access to a home directory, flushing out any cryptographic keys from memory\&. This is only supported on some back\-ends, and is usually done during system suspend, in order to effectively secure home directories while the system is sleeping\&. Takes a user name as single argument\&. If an application attempts to access a home directory while it is locked it will typically freeze until the home directory is unlocked again\&. This method is equivalent to \fBLock()\fR on the org\&.freedesktop\&.home1\&.Home @@ -342,6 +407,12 @@ on the org\&.freedesktop\&.home1\&.Home interface\&. .PP +\fBRefHomeUnrestricted()\fR +is identical to +\fBRefHome()\fR +but succeeds even if the home area is not active currently\&. This is useful on conjunction with +\fBActivateHomeIfReferenced()\fR\&. +.PP \fBReleaseHome()\fR releases a home directory again, if all file descriptors referencing it are already closed, that where acquired through \fBAcquireHome()\fR @@ -375,8 +446,8 @@ field set are listed here, with the seat name they are associated with\&. A disp node /org/freedesktop/home1/home { interface org\&.freedesktop\&.home1\&.Home { methods: - @org\&.freedesktop\&.systemd1\&.Privileged("true") Activate(in s secret); + ActivateIfReferenced(in s secret); @org\&.freedesktop\&.systemd1\&.Privileged("true") Deactivate(); Unregister(); @@ -386,6 +457,9 @@ node /org/freedesktop/home1/home { Fixate(in s secret); Authenticate(in s secret); Update(in s user_record); + UpdateEx(in s user_record, + in a{sh} blobs, + in t flags); Resize(in t size, in s secret); ChangePassword(in s new_secret, @@ -402,6 +476,9 @@ node /org/freedesktop/home1/home { Ref(in b please_suspend, out h send_fd); @org\&.freedesktop\&.systemd1\&.Privileged("true") + RefUnrestricted(in b please_suspend, + out h send_fd); + @org\&.freedesktop\&.systemd1\&.Privileged("true") Release(); properties: @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const") @@ -446,9 +523,13 @@ node /org/freedesktop/home1/home { + + + .SS "Methods" .PP \fBActivate()\fR, +\fBActivateIfReferenced()\fR, \fBDeactivate()\fR, \fBUnregister()\fR, \fBRealize()\fR, @@ -456,16 +537,17 @@ node /org/freedesktop/home1/home { \fBFixate()\fR, \fBAuthenticate()\fR, \fBUpdate()\fR, +\fBUpdateEx()\fR, \fBResize()\fR, \fBChangePassword()\fR, \fBLock()\fR, \fBUnlock()\fR, \fBAcquire()\fR, \fBRef()\fR, -\fBRelease()\fR -operate like their matching counterparts on the +\fBRefUnrestricted()\fR, +\fBRelease()\fR, operate like their matching counterparts on the org\&.freedesktop\&.home1\&.Manager -interface (see above)\&. The main difference is that they are methods of the home directory objects, and hence carry no additional user name parameter\&. Which of the two flavors of methods to call depends on the handles to the user known on the client side: if only the user name is known, it\*(Aqs preferable to use the methods on the manager object since they operate with user names only\&. If however the home object path was already acquired some way it is preferable to operate on the +interface (see above)\&. The main difference is that they are methods of the home directory objects, and hence carry no additional user name parameter\&. Which of the two flavors of methods to call depends on the handles to the user known on the client side: if only the user name is known, it\*(Aqs preferable to use the methods on the manager object since they operate with user names only\&. Clients can also easily operate on their own home area by using the methods on the manager object with an empty string as the user name\&. If the client has the home\*(Aqs object path already acquired in some way, however, it is preferable to operate on the org\&.freedesktop\&.home1\&.Home objects instead\&. .SS "Properties" @@ -489,12 +571,24 @@ contains the full JSON user record string of the user account\&. .SH "VERSIONING" .PP These D\-Bus interfaces follow -\m[blue]\fBthe usual interface versioning guidelines\fR\m[]\&\s-2\u[2]\d\s+2\&. +\m[blue]\fBthe usual interface versioning guidelines\fR\m[]\&\s-2\u[3]\d\s+2\&. +.SH "HISTORY" +.SS "The Manager Object" +.PP +\fBActivateHomeIfReferenced()\fR, +\fBRefHomeUnrestricted()\fR, +\fBCreateHomeEx()\fR, and +\fBUpdateHomeEx()\fR +were added in version 256\&. +.SS "Home Objects" +.PP +\fBActivateIfReferenced()\fR, +\fBRefUnrestricted()\fR, and +\fBUpdateEx()\fR +were added in version 256\&. .SH "SEE ALSO" .PP -\fBsystemd\fR(1), -\fBsystemd-homed.service\fR(8), -\fBhomectl\fR(1) +\fBsystemd\fR(1), \fBsystemd-homed.service\fR(8), \fBhomectl\fR(1) .SH "NOTES" .IP " 1." 4 JSON User Records @@ -502,6 +596,11 @@ JSON User Records \%https://systemd.io/USER_RECORD .RE .IP " 2." 4 +User Record Blob Directories +.RS 4 +\%https://systemd.io/USER_RECORD_BLOB_DIRS +.RE +.IP " 3." 4 the usual interface versioning guidelines .RS 4 \%https://0pointer.de/blog/projects/versioning-dbus.html diff --git a/upstream/debian-unstable/man5/org.freedesktop.hostname1.5 b/upstream/debian-unstable/man5/org.freedesktop.hostname1.5 index b0d8da1f..fb7782bc 100644 --- a/upstream/debian-unstable/man5/org.freedesktop.hostname1.5 +++ b/upstream/debian-unstable/man5/org.freedesktop.hostname1.5 @@ -1,5 +1,5 @@ '\" t -.TH "ORG\&.FREEDESKTOP\&.HOSTNAME1" "5" "" "systemd 255" "org.freedesktop.hostname1" +.TH "ORG\&.FREEDESKTOP\&.HOSTNAME1" "5" "" "systemd 256~rc3" "org.freedesktop.hostname1" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -93,6 +93,8 @@ node /org/freedesktop/hostname1 { readonly ay MachineID = [\&.\&.\&.]; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const") readonly ay BootID = [\&.\&.\&.]; + @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const") + readonly u VSockCID = \&.\&.\&.; }; interface org\&.freedesktop\&.DBus\&.Peer { \&.\&.\&. }; interface org\&.freedesktop\&.DBus\&.Introspectable { \&.\&.\&. }; @@ -138,6 +140,7 @@ node /org/freedesktop/hostname1 { + .PP Whenever the hostname or other metadata is changed via the daemon, \fBPropertyChanged\fR @@ -260,6 +263,42 @@ and \fIHOME_URL=\fR fields from \fBos-release\fR(5)\&. The purpose of those properties is to allow remote clients to access this information over D\-Bus\&. Local clients can access the information directly\&. +.PP +\fIMachineID\fR +expose the 128bit machine ID, see +\fBmachine-id\fR(5) +for details\&. +.PP +\fIBootID\fR +expose the 128bit boot ID, as per +/proc/sys/kernel/random/boot_id\&. +.PP +\fIVSockCID\fR +exposes the system\*(Aqs local +\fBAF_VSOCK\fR +CID (Context Identifier, i\&.e\&. address) for the system, if one is available in the virtual machine environment\&. Set to +\fBUINT32_MAX\fR +otherwise\&. See +\fBvsock\fR(7) +for details\&. +.PP +\fIOperatingSystemSupportEnd\fR +exposes when the OS\*(Aq vendor support ends, if this information is known\&. It\*(Aqs an unsigned 64bit value, in \(mcs since the UNIX epoch, UTC\&. If this information is not known carries the value 2^64\-1, i\&.e\&. +\fBUINT64_MAX\fR\&. +.PP +\fIHardwareVendor\fR +and +\fIHardwareModel\fR +expose information about the vendor of the hardware of the system\&. If no such information can be determined these properties are set to empty strings\&. +.PP +\fIFirmwareVersion\fR +and +\fIFirmwareVendor\fR +expose information about the system\*(Aqs firmware, i\&.e\&. a version string and a vendor name\&. If no such information can be determined these properties are set to empty strings\&. +.PP +\fIFirmwareDate\fR +exposes the firmware build date, if that information is known\&. It\*(Aqs an unsigned 64bit value, in \(mcs since the UNIX epoch, UTC\&. If not known +\fBUNIT64_MAX\fR\&. .SS "Methods" .PP \fBSetHostname()\fR @@ -307,6 +346,9 @@ for the semantics of those settings\&. returns the "product UUID" as exposed by the kernel based on DMI information in /sys/class/dmi/id/product_uuid\&. Reading the file directly requires root privileges, and this method allows access to unprivileged clients through the polkit framework\&. .PP +\fBGetHardwareSerial()\fR +returns the "hardware serial" as exposed by the kernel based on DMI information\&. Reading the file directly requires root privileges, and this method allows access to unprivileged clients through the polkit framework\&. +.PP \fBDescribe()\fR returns a JSON representation of all properties in one\&. .SS "Security" @@ -597,8 +639,10 @@ were added in version 251\&. \fIFirmwareDate\fR were added in version 253\&. .PP -\fIMachineID\fR, and +\fIMachineID\fR, \fIBootID\fR +and +\fIVSockCID\fR were added in version 256\&. .SH "NOTES" .IP " 1." 4 diff --git a/upstream/debian-unstable/man5/org.freedesktop.import1.5 b/upstream/debian-unstable/man5/org.freedesktop.import1.5 index cbea124e..19745bde 100644 --- a/upstream/debian-unstable/man5/org.freedesktop.import1.5 +++ b/upstream/debian-unstable/man5/org.freedesktop.import1.5 @@ -1,5 +1,5 @@ '\" t -.TH "ORG\&.FREEDESKTOP\&.IMPORT1" "5" "" "systemd 255" "org.freedesktop.import1" +.TH "ORG\&.FREEDESKTOP\&.IMPORT1" "5" "" "systemd 256~rc3" "org.freedesktop.import1" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -24,11 +24,11 @@ org.freedesktop.import1 \- The D\-Bus interface of systemd\-importd .SH "INTRODUCTION" .PP \fBsystemd-importd.service\fR(8) -is a system service which may be used to import, export and download additional system images\&. These images can be used by tools such as +is a system service which may be used to import, export and download disk images\&. These images can be used by tools such as \fBsystemd-nspawn\fR(1) to run local containers\&. The service is used as the backend for -\fBmachinectl pull\-raw\fR, -\fBmachinectl pull\-tar\fR +\fBimportctl pull\-raw\fR, +\fBimportctl pull\-tar\fR and related commands\&. This page describes the D\-Bus interface\&. .PP Note that @@ -55,42 +55,94 @@ node /org/freedesktop/import1 { in b read_only, out u transfer_id, out o transfer_path); + ImportTarEx(in h fd, + in s local_name, + in s class, + in t flags, + out u transfer_id, + out o transfer_path); ImportRaw(in h fd, in s local_name, in b force, in b read_only, out u transfer_id, out o transfer_path); + ImportRawEx(in h fd, + in s local_name, + in s class, + in t flags, + out u transfer_id, + out o transfer_path); ImportFileSystem(in h fd, in s local_name, in b force, in b read_only, out u transfer_id, out o transfer_path); + ImportFileSystemEx(in h fd, + in s local_name, + in s class, + in t flags, + out u transfer_id, + out o transfer_path); ExportTar(in s local_name, in h fd, in s format, out u transfer_id, out o transfer_path); + ExportTarEx(in s local_name, + in s class, + in h fd, + in s format, + in t flags, + out u transfer_id, + out o transfer_path); ExportRaw(in s local_name, in h fd, in s format, out u transfer_id, out o transfer_path); + ExportRawEx(in s local_name, + in s class, + in h fd, + in s format, + in t flags, + out u transfer_id, + out o transfer_path); PullTar(in s url, in s local_name, in s verify_mode, in b force, out u transfer_id, out o transfer_path); + PullTarEx(in s url, + in s local_name, + in s class, + in s verify_mode, + in t flags, + out u transfer_id, + out o transfer_path); PullRaw(in s url, in s local_name, in s verify_mode, in b force, out u transfer_id, out o transfer_path); + PullRawEx(in s url, + in s local_name, + in s class, + in s verify_mode, + in t flags, + out u transfer_id, + out o transfer_path); ListTransfers(out a(usssdo) transfers); + ListTransfersEx(in s class, + in t flags, + out a(ussssdo) transfers); CancelTransfer(in u transfer_id); + ListImages(in s class, + in t flags, + out a(ssssbtttttt) images); signals: TransferNew(u transfer_id, o transfer_path); @@ -119,68 +171,86 @@ node /org/freedesktop/import1 { + + + + + + + + + .SS "Methods" .PP -\fBImportTar()\fR +\fBImportTar()\fR/\fBImportTarEx()\fR and -\fBImportRaw()\fR -import a system image and place it into -/var/lib/machines/\&. The first argument should be a file descriptor (opened for reading) referring to the tar or raw file to import\&. It should reference a file on disk, a pipe or a socket\&. When -\fBImportTar()\fR +\fBImportRaw()\fR/\fBImportRawEx()\fR +import a disk image and place it into the image directory\&. The first argument should be a file descriptor (opened for reading) referring to the tar or raw file to import\&. It should reference a file on disk, a pipe or a socket\&. When +\fBImportTar()\fR/\fBImportTarEx()\fR is used the file descriptor should refer to a tar file, optionally compressed with \fBgzip\fR(1), \fBbzip2\fR(1), or \fBxz\fR(1)\&. \fBsystemd\-importd\fR will detect the used compression scheme (if any) automatically\&. When -\fBImportRaw()\fR +\fBImportRaw()\fR/\fBImportRawEx()\fR is used the file descriptor should refer to a raw or qcow2 disk image containing an MBR or GPT disk label, also optionally compressed with gzip, bzip2 or xz\&. In either case, if the file is specified as a file descriptor on disk, progress information is generated for the import operation (as in that case we know the total size on disk)\&. If a socket or pipe is specified, progress information is not available\&. The file descriptor argument is followed by a local name for the image\&. This should be a name suitable as a hostname and will be used to name the imported image below /var/lib/machines/\&. A tar import is placed as a directory tree or a \fBbtrfs\fR(8) -subvolume below -/var/lib/machines/ -under the specified name with no suffix appended\&. A raw import is placed as a file in -/var/lib/machines/ -with the +subvolume below the image directory under the specified name with no suffix appended\&. A raw import is placed as a file in the image directory with the \&.raw -suffix appended\&. If the +suffix appended\&. In case of +\fBImportTar()\fR/\fBImportRaw()\fR, if the \fBforce\fR -argument is true, any pre\-existing image with the same name is removed before starting the operation\&. Otherwise, the operation fails if an image with the same name already exists\&. Finally, the +argument is true, any pre\-existing image with the same name is removed before starting the operation\&. Otherwise, the operation fails if an image with the same name already exists\&. The \fBread_only\fR -argument controls whether to create a writable or read\-only image\&. Both methods return immediately after starting the import, with the import transfer ongoing\&. They return a pair of transfer identifier and object path, which may be used to retrieve progress information about the transfer or to cancel it\&. The transfer identifier is a simple numeric identifier, the object path references an +argument controls whether to create a writable or read\-only image\&. In case of +\fBImportTarEx()\fR/\fBImportRawEx()\fR +these boolean flags are provided via a 64bit flags parameter instead, with bit 0 mapping to the +\fBforce\fR +parameter, and bit 1 mapping to +\fBread_only\fR\&. The +\fBclass\fR +parameter specifies the image class, and takes one of +"machine", +"portable", +"sysext", +"confext"\&. All four methods return immediately after starting the import, with the import transfer ongoing\&. They return a pair of transfer identifier and object path, which may be used to retrieve progress information about the transfer or to cancel it\&. The transfer identifier is a simple numeric identifier, the object path references an org\&.freedesktop\&.import1\&.Transfer object, see below\&. Listen for a -\fBTransferRemoved\fR +\fBTransferRemoved()\fR signal for the transfer ID in order to detect when a transfer is complete\&. The returned transfer object is useful to determine the current progress or log output of the ongoing import operation\&. .PP -\fBExportTar()\fR +\fBExportTar()\fR/\fBExportTarEx()\fR and -\fBExportRaw()\fR +\fBExportRaw()\fR/\fBExportRaw()\fR implement the reverse operation, and may be used to export a system image in order to place it in a tar or raw image\&. They take the machine name to export as their first parameter, followed by a file descriptor (opened for writing) where the tar or raw file will be written\&. It may either reference a file on disk or a pipe/socket\&. The third argument specifies in which compression format to write the image\&. It takes one of "uncompressed", "xz", "bzip2" or "gzip", depending on which compression scheme is required\&. The image written to the specified file descriptor will be a tar file in case of -\fBExportTar()\fR +\fBExportTar()\fR/\fBExportTarEx()\fR or a raw disk image in case of -\fBExportRaw()\fR\&. Note that currently raw disk images may not be exported as tar files, and vice versa\&. This restriction might be lifted eventually\&. The method returns a transfer identifier and object path for cancelling or tracking the export operation, similarly to -\fBImportTar()\fR +\fBExportRaw()\fR/\fBExportRawEx()\fR\&. Note that currently raw disk images may not be exported as tar files, and vice versa\&. This restriction might be lifted eventually\&. The method returns a transfer identifier and object path for cancelling or tracking the export operation, similarly to +\fBImportTar()\fR/\fBImportTarEx()\fR or -\fBImportRaw()\fR +\fBImportRaw()\fR/\fBImportRawEx()\fR as described above\&. +\fBExportTarEx()\fR/\fBExportRawEx()\fR +expect the image class as additional parameter, as well as a 64bit flags parameter that currently must be specified as zero\&. .PP -\fBPullTar()\fR +\fBPullTar()\fR/\fBPullTarEx()\fR and -\fBPullRaw()\fR +\fBPullRaw()\fR/\fBPullRawEx()\fR may be used to download, verify and import a system image from a URL\&. They take a URL argument which should point to a tar or raw file on the "http://" or "https://" protocols, possibly compressed with xz, bzip2 or gzip\&. The second argument is a local name for the image\&. It should be suitable as a hostname, similarly to the matching argument of the -\fBImportTar()\fR +\fBImportTar()\fR/\fBImportTarEx()\fR and -\fBImportRaw()\fR +\fBImportRaw()\fR/\fBImportRawEx()\fR methods above\&. The third argument indicates the verification mode for the image\&. It may be one of "no", "checksum", @@ -196,30 +266,55 @@ does the same but also tries to authenticate the SHA256SUM file via \fBgpg\fR(8) -first\&. The last argument indicates whether to replace a possibly pre\-existing image with the same local name (if +first\&. In case of +\fBPullTar()\fR/\fBPullRaw()\fR +the last argument indicates whether to replace a possibly pre\-existing image with the same local name (if "true"), or whether to fail (if -"false")\&. Like the import and export calls above, these calls return a pair of transfer identifier and object path for the ongoing download\&. +"false")\&. In case of +\fBPullTarEx()\fR/\fBPullRawEx()\fR +the last argument is a 64bit flags parameter, where bit 0 controls the +"force" +flag, bit 1 is a +"read_only" +flag that controls whether the created image shall be marked read\-only, and bit 2 is a +"keep_download" +flag that indicates whether a pristine, read\-only copy of the downloaded image shell be kept, in addition for the local copy of the image\&. The +\fB\&..._Ex()\fR +variants also expect an image class string (as above)\&. Like the import and export calls above, these calls return a pair of transfer identifier and object path for the ongoing download\&. +.PP +\fBImportFileSystem()\fR/\fBImportFileSystemEx()\fR +are similar to +\fBImportTar()\fR/\fBImportTarEx()\fR +but import a directory tree\&. The first argument must refer to a directory file descriptor for the source hierarchy to import\&. .PP -\fBListTransfers()\fR -returns a list of ongoing import, export or download operations as created with the six calls described above\&. It returns an array of structures which consist of the numeric transfer identifier, a string indicating the operation (one of +\fBListTransfers()\fR/\fBListTransfersEx()\fR +return a list of ongoing import, export or download operations as created with the six calls described above\&. They return an array of structures which consist of the numeric transfer identifier, a string indicating the operation (one of "import\-tar", "import\-raw", "export\-tar", "export\-raw", "pull\-tar" or -"pull\-raw"), a string describing the remote file (in case of download operations this is the source URL, in case of import/export operations this is a short string describing the file descriptor passed in), a string with the local machine image name, a progress value between 0\&.0 (for 0%) and 1\&.0 (for 100%), as well as the transfer object path\&. +"pull\-raw"), a string describing the remote file (in case of download operations this is the source URL, in case of import/export operations this is a short string describing the file descriptor passed in), a string with the local machine image name, the image class (only in case of +\fBListTransfersEx()\fR; one of +"machine", +"portable", +"sysext", +"confext"), a progress value between 0\&.0 (for 0%) and 1\&.0 (for 100%), as well as the transfer object path\&. .PP \fBCancelTransfer()\fR may be used to cancel an ongoing import, export or download operation\&. Simply specify the transfer identifier to cancel the ongoing operation\&. +.PP +\fBListImages()\fR +returns a list of currently installed images\&. It takes a image class string and a flags parameter\&. The image class is either the empty string or specifies one of the four image classes, by which it will then filter\&. The flags parameter must be zero at this time\&. It returns an array of items, each describing one image\&. The item fields are in order: the image class, the local image name, the image type, the image path, the read\-only flag, the creation and modification times (in microseconds since the UNIX epoch), as well as the current disk usage in bytes (both overall, and exclusive), as well as any size limit in bytes set on the image (both overall and exclusive)\&. .SS "Signals" .PP The -\fBTransferNew\fR +\fBTransferNew()\fR signal is generated each time a new transfer is started with the import, export or download calls described above\&. It carries the transfer ID and object path that have just been created\&. .PP The -\fBTransferRemoved\fR +\fBTransferRemoved()\fR signal is sent each time a transfer finishes, is canceled or fails\&. It also carries the transfer ID and object path, followed by a string indicating the result of the operation, which is one of "done" (on success), @@ -239,6 +334,7 @@ node /org/freedesktop/import1/transfer/_1 { signals: LogMessage(u priority, s line); + ProgressUpdate(d progress); properties: @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const") readonly u Id = \&.\&.\&.; @@ -271,6 +367,7 @@ node /org/freedesktop/import1/transfer/_1 { + .SS "Methods" .PP The @@ -304,6 +401,15 @@ property exposes the selected verification setting and is only defined for downl The \fIProgress\fR property exposes the current progress of the transfer as a value between 0\&.0 and 1\&.0\&. To show a progress bar on screen we recommend to query this value in regular intervals, for example every 500\ \&ms or so\&. +.SS "Signals" +.PP +The +\fBLogMessage()\fR +signal is emitted for log messages generated by a transfer\&. It carries a pair of syslog log level integer and log string\&. +.PP +The +\fBProgressUpdate()\fR +signal is emitted in regular intervals when new download progress information is available for a transfer\&. It carries a double precision floating pointer number between 0\&.0 and 1\&.0 indicating the transfer progress\&. .SH "EXAMPLES" .PP \fBExample\ \&1.\ \&Introspect org\&.freedesktop\&.import1\&.Manager on the bus\fR @@ -339,6 +445,23 @@ $ 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 "The Manager Object" +.PP +\fBImportTarEx()\fR, +\fBImportRawEx()\fR, +\fBImportFileSystemEx()\fR, +\fBExportTarEx()\fR, +\fBExportRawEx()\fR, +\fBPullTarEx()\fR, +\fBPullRawEx()\fR, +\fBListTransfersEx()\fR, +\fBListImages()\fR +were added in version 256\&. +.SS "Transfer Objects" +.PP +\fBProgressUpdate()\fR +was added in version 256\&. .SH "NOTES" .IP " 1." 4 the usual interface versioning guidelines diff --git a/upstream/debian-unstable/man5/org.freedesktop.locale1.5 b/upstream/debian-unstable/man5/org.freedesktop.locale1.5 index 4644366b..790618ee 100644 --- a/upstream/debian-unstable/man5/org.freedesktop.locale1.5 +++ b/upstream/debian-unstable/man5/org.freedesktop.locale1.5 @@ -1,5 +1,5 @@ '\" t -.TH "ORG\&.FREEDESKTOP\&.LOCALE1" "5" "" "systemd 255" "org.freedesktop.locale1" +.TH "ORG\&.FREEDESKTOP\&.LOCALE1" "5" "" "systemd 256~rc3" "org.freedesktop.locale1" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/upstream/debian-unstable/man5/org.freedesktop.login1.5 b/upstream/debian-unstable/man5/org.freedesktop.login1.5 index 135cb69b..fc4cda5b 100644 --- a/upstream/debian-unstable/man5/org.freedesktop.login1.5 +++ b/upstream/debian-unstable/man5/org.freedesktop.login1.5 @@ -1,5 +1,5 @@ '\" t -.TH "ORG\&.FREEDESKTOP\&.LOGIN1" "5" "" "systemd 255" "org.freedesktop.login1" +.TH "ORG\&.FREEDESKTOP\&.LOGIN1" "5" "" "systemd 256~rc3" "org.freedesktop.login1" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -50,6 +50,7 @@ node /org/freedesktop/login1 { GetSeat(in s seat_id, out o object_path); ListSessions(out a(susso) sessions); + ListSessionsEx(out a(sussussbto) sessions); ListUsers(out a(uso) users); ListSeats(out a(so) seats); ListInhibitors(out a(ssssuu) inhibitors); @@ -100,7 +101,6 @@ node /org/freedesktop/login1 { 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, @@ -138,6 +138,7 @@ node /org/freedesktop/login1 { HybridSleepWithFlags(in t flags); SuspendThenHibernate(in b interactive); SuspendThenHibernateWithFlags(in t flags); + Sleep(in t flags); CanPowerOff(out s result); CanReboot(out s result); CanHalt(out s result); @@ -145,6 +146,7 @@ node /org/freedesktop/login1 { CanHibernate(out s result); CanHybridSleep(out s result); CanSuspendThenHibernate(out s result); + CanSleep(out s result); ScheduleShutdown(in s type, in t usec); CancelScheduledShutdown(out b cancelled); @@ -215,6 +217,8 @@ node /org/freedesktop/login1 { @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const") readonly t UserStopDelayUSec = \&.\&.\&.; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const") + readonly as SleepOperation = [\*(Aq\&.\&.\&.\*(Aq, \&.\&.\&.]; + @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const") readonly s HandlePowerKey = \*(Aq\&.\&.\&.\*(Aq; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const") readonly s HandlePowerKeyLongPress = \*(Aq\&.\&.\&.\*(Aq; @@ -394,6 +398,10 @@ node /org/freedesktop/login1 { + + + + .SS "Methods" .PP \fBGetSession()\fR @@ -408,7 +416,30 @@ and get the session/user object the specified PID belongs to if there is any\&. .PP \fBListSessions()\fR -returns an array of all current sessions\&. The structures in the array consist of the following fields: session id, user id, user name, seat id, session object path\&. If a session does not have a seat attached, the seat id field will be an empty string\&. +returns an array of all current sessions\&. The structures in the array consist of the following fields: +\fIsession id\fR, +\fIuser id\fR, +\fIuser name\fR, +\fIseat id\fR, and +\fIsession object path\fR\&. If a session does not have a seat attached, the seat id field will be an empty string\&. +.PP +\fBListSessionsEx()\fR +returns an array of all current sessions with more metadata than +\fBListSessions()\fR\&. The structures in the array consist of the following fields: +\fIsession id\fR, +\fIuser id\fR, +\fIuser name\fR, +\fIseat id\fR, +\fIleader pid\fR, +\fIsession class\fR, +\fItty name\fR, +\fIidle hint\fR, +\fIidle hint monotonic timestamp\fR, and +\fIsession object path\fR\&. +\fItty\fR +and +\fIseat id\fR +fields could be empty, if the session has no associated tty or session has no seat attached, respectively\&. .PP \fBListUsers()\fR returns an array of all currently logged in users\&. The structures in the array consist of the following fields: user id, user name, user object path\&. @@ -501,16 +532,21 @@ results in the system entering a hybrid\-sleep mode, i\&.e\&. the system is both \fBSuspendThenHibernate()\fR results in the system being suspended, then later woken using an RTC timer and hibernated\&. The only argument is the polkit interactivity boolean \fIinteractive\fR -(see below)\&. The main purpose of these calls is that they enforce polkit policy and hence allow powering off/rebooting/suspending/hibernating even by unprivileged users\&. They also enforce inhibition locks for non\-privileged users\&. UIs should expose these calls as the primary mechanism to poweroff/reboot/suspend/hibernate the machine\&. Methods +(see below)\&. The main purpose of these calls is that they enforce polkit policy and hence allow powering off/rebooting/suspending/hibernating even by unprivileged users\&. They also enforce inhibition locks for non\-privileged users\&. +\fBSleep()\fR +automatically selects the most suitable sleep operation supported by the machine\&. The candidate sleep operations to check for support can be configured through +\fISleepOperation=\fR +setting in +\fBlogind.conf\fR(5)\&. UIs should expose these calls as the primary mechanism to poweroff/reboot/suspend/hibernate the machine\&. Methods \fBPowerOffWithFlags()\fR, \fBRebootWithFlags()\fR, \fBHaltWithFlags()\fR, \fBSuspendWithFlags()\fR, \fBHibernateWithFlags()\fR, -\fBHybridSleepWithFlags()\fR -and -\fBSuspendThenHibernateWithFlags()\fR -add +\fBHybridSleepWithFlags()\fR, +\fBSuspendThenHibernateWithFlags()\fR, and +\fBSleep()\fR +take \fIflags\fR to allow for extendability, defined as follows: .sp @@ -572,6 +608,7 @@ for the corresponding command line interface\&. \fBCanHibernate()\fR, \fBCanHybridSleep()\fR, \fBCanSuspendThenHibernate()\fR, +\fBCanSleep()\fR, \fBCanRebootParameter()\fR, \fBCanRebootToFirmwareSetup()\fR, \fBCanRebootToBootLoaderMenu()\fR, and @@ -653,18 +690,18 @@ Whenever the inhibition state or idle hint changes, signals are sent out to which clients can subscribe\&. .PP The -\fBSessionNew\fR, -\fBSessionRemoved\fR, -\fBUserNew\fR, -\fBUserRemoved\fR, -\fBSeatNew\fR, and -\fBSeatRemoved\fR +\fBSessionNew()\fR, +\fBSessionRemoved()\fR, +\fBUserNew()\fR, +\fBUserRemoved()\fR, +\fBSeatNew()\fR, and +\fBSeatRemoved()\fR 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, -\fBPrepareForShutdownWithMetadata\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 @@ -679,7 +716,7 @@ string which defines the type of shutdown\&. The type can be one of "kexec" or "soft\-reboot"\&. This signal is sent first, followed by -\fBPrepareForShutdown\fR +\fBPrepareForShutdown()\fR (for backward compatibility)\&. .SS "Properties" .PP @@ -746,9 +783,9 @@ The and \fIPreparingForSleep\fR boolean properties are true during the interval between the two -\fBPrepareForShutdown\fR +\fBPrepareForShutdown()\fR and -\fBPrepareForSleep\fR +\fBPrepareForSleep()\fR signals respectively\&. Note that these properties do not send out \fBPropertyChanged\fR signals\&. @@ -768,9 +805,9 @@ method described above\&. \fIRebootToBootLoaderMenu\fR, and \fIRebootToBootLoaderEntry\fR are true when the resprective post\-reboot operation was selected with -\fBSetRebootToFirmwareSetup\fR, -\fBSetRebootToBootLoaderMenu\fR, or -\fBSetRebootToBootLoaderEntry\fR\&. +\fBSetRebootToFirmwareSetup()\fR, +\fBSetRebootToBootLoaderMenu()\fR, or +\fBSetRebootToBootLoaderEntry()\fR\&. .PP The \fIWallMessage\fR @@ -826,23 +863,25 @@ and \fBSuspendThenHibernate()\fR use the same privileges as \fBHibernate()\fR\&. +\fBSleep()\fR +uses the inhibits of the auto\-selected sleep operation\&. \fBSetRebootParameter()\fR requires org\&.freedesktop\&.login1\&.set\-reboot\-parameter\&. .PP -\fBSetRebootToFirmwareSetup\fR +\fBSetRebootToFirmwareSetup()\fR requires org\&.freedesktop\&.login1\&.set\-reboot\-to\-firmware\-setup\&. -\fBSetRebootToBootLoaderMenu\fR +\fBSetRebootToBootLoaderMenu()\fR requires org\&.freedesktop\&.login1\&.set\-reboot\-to\-boot\-loader\-menu\&. -\fBSetRebootToBootLoaderEntry\fR +\fBSetRebootToBootLoaderEntry()\fR requires org\&.freedesktop\&.login1\&.set\-reboot\-to\-boot\-loader\-entry\&. .PP -\fBScheduleShutdown\fR +\fBScheduleShutdown()\fR and -\fBCancelScheduledShutdown\fR +\fBCancelScheduledShutdown()\fR require the same privileges (listed above) as the immediate poweroff/reboot/halt operations\&. .PP \fBInhibit()\fR @@ -1125,6 +1164,7 @@ node /org/freedesktop/login1/session/1 { TakeControl(in b force); ReleaseControl(); SetType(in s type); + SetClass(in s class); SetDisplay(in s display); SetTTY(in h tty_fd); TakeDevice(in u major, @@ -1181,7 +1221,6 @@ node /org/freedesktop/login1/session/1 { @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const") readonly u Audit = \&.\&.\&.; readonly s Type = \*(Aq\&.\&.\&.\*(Aq; - @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const") readonly s Class = \*(Aq\&.\&.\&.\*(Aq; readonly b Active = \&.\&.\&.; readonly s State = \*(Aq\&.\&.\&.\*(Aq; @@ -1245,6 +1284,7 @@ node /org/freedesktop/login1/session/1 { + .SS "Methods" .PP \fBTerminate()\fR, @@ -1279,6 +1319,14 @@ or closing the D\-Bus connection\&. This should help prevent a session from ente \fItype\fR is the new session type\&. .PP +\fBSetClass()\fR +allows the caller to change the class of the session dynamically\&. It may only be called by session\*(Aqs owening user\&. Currently, this call may be exclusively used to change the class from +"user\-incomplete" +to +"user"\&. The call is synchronous, and will return only once the user\*(Aqs service manager has successfully been started, if necessary\&. The only argument +\fItype\fR +is the new session type\&. +.PP \fBSetDisplay()\fR allows the display name of the graphical session to be changed\&. This is useful if the display server is started as part of the session\&. It can only be called by session\*(Aqs current controller\&. If \fBTakeControl()\fR @@ -1339,23 +1387,23 @@ parameter specifies the brightness\&. The range is defined by individual drivers .SS "Signals" .PP The active session controller exclusively gets -\fBPauseDevice\fR +\fBPauseDevice()\fR and -\fBResumeDevice\fR +\fBResumeDevice()\fR events for any device it requested via \fBTakeDevice()\fR\&. They notify the controller whenever a device is paused or resumed\&. A device is never resumed if its session is inactive\&. Also note that -\fBPauseDevice\fR +\fBPauseDevice()\fR signals are sent before the \fBPropertyChanged\fR signal for the \fBActive\fR state\&. The inverse is true for -\fBResumeDevice\fR\&. A device may remain paused for unknown reasons even though the +\fBResumeDevice()\fR\&. A device may remain paused for unknown reasons even though the Session is active\&. .PP A -\fBPauseDevice\fR +\fBPauseDevice()\fR signal carries the major and minor numbers and a string describing the type as arguments\&. \fBforce\fR means the device was already paused by @@ -1368,7 +1416,7 @@ grants you a limited amount of time to pause the device\&. You must respond to t \fBPauseDeviceComplete()\fR\&. This synchronous pausing mechanism is used for backwards\-compatibility to VTs and systemd\-logind is free to not make use of it\&. It is also free to send a forced -\fBPauseDevice\fR +\fBPauseDevice()\fR if you don\*(Aqt respond in a timely manner (or for any other reason)\&. \fBgone\fR means the device was unplugged from the system and you will no longer get any notifications about it\&. There is no need to call @@ -1376,7 +1424,7 @@ means the device was unplugged from the system and you will no longer get any no \fBTakeDevice()\fR again if a new device is assigned the major+minor combination\&. .PP -\fBResumeDevice\fR +\fBResumeDevice()\fR is sent whenever a session is active and a device is resumed\&. It carries the major/minor numbers as arguments and provides a new open file descriptor\&. You should switch to the new descriptor and close the old one\&. They are not guaranteed to have the same underlying open file descriptor in the kernel (except for a limited set of device types)\&. .PP Whenever @@ -1385,7 +1433,7 @@ or the idle state changes, \fBPropertyChanged\fR signals are sent out to which clients can subscribe\&. .PP -\fBLock\fR/\fBUnlock\fR +\fBLock()\fR/\fBUnlock()\fR is sent when the session is asked to be screen\-locked/unlocked\&. A session manager of the session should listen to this signal and act accordingly\&. This signal is sent out as a result of the \fBLock()\fR and @@ -1615,10 +1663,16 @@ were added in version 251\&. \fIStopIdleSessionUSec\fR was added in version 252\&. .PP -\fBPrepareForShutdownWithMetadata\fR +\fBPrepareForShutdownWithMetadata()\fR and \fBCreateSessionWithPIDFD()\fR were added in version 255\&. +.PP +\fBSleep()\fR, +\fBCanSleep()\fR, +\fISleepOperation\fR, and +\fBListSessionsEx()\fR +were added in version 256\&. .SS "Session Objects" .PP \fBSetDisplay()\fR @@ -1626,6 +1680,9 @@ was added in version 252\&. .PP \fBSetTTY()\fR was added in version 254\&. +.PP +\fBSetClass()\fR +was added in version 256\&. .SH "NOTES" .IP " 1." 4 polkit diff --git a/upstream/debian-unstable/man5/org.freedesktop.machine1.5 b/upstream/debian-unstable/man5/org.freedesktop.machine1.5 index a63a4960..3b35991c 100644 --- a/upstream/debian-unstable/man5/org.freedesktop.machine1.5 +++ b/upstream/debian-unstable/man5/org.freedesktop.machine1.5 @@ -1,5 +1,5 @@ '\" t -.TH "ORG\&.FREEDESKTOP\&.MACHINE1" "5" "" "systemd 255" "org.freedesktop.machine1" +.TH "ORG\&.FREEDESKTOP\&.MACHINE1" "5" "" "systemd 256~rc3" "org.freedesktop.machine1" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -87,6 +87,9 @@ node /org/freedesktop/machine1 { in i signal); GetMachineAddresses(in s name, out a(iay) addresses); + GetMachineSSHInfo(in s name, + out s ssh_address, + out s ssh_private_key_path); GetMachineOSRelease(in s name, out a{ss} fields); @org\&.freedesktop\&.systemd1\&.Privileged("true") @@ -228,6 +231,7 @@ node /org/freedesktop/machine1 { + .SS "Methods" .PP \fBGetMachine()\fR @@ -300,6 +304,9 @@ retrieves the IP addresses of a container\&. This method returns an array of pai or \fBAF_INET6\fR) and a byte array containing the addresses\&. This is only supported for containers that make use of network namespacing\&. .PP +\fBGetMachineSSHInfo()\fR +retrieves the SSH information of a machine\&. This method returns two strings, the SSH address which can be used to tell SSH where to connect, and the path to the SSH private key required for the connection to succeed\&. +.PP \fBGetMachineOSRelease()\fR retrieves the OS release information of a container\&. This method returns an array of key value pairs read from the \fBos-release\fR(5) @@ -324,7 +331,7 @@ copies files or directories from a container into the host\&. It takes a contain does the opposite and copies files from a source directory on the host into a destination directory in the container\&. \fBCopyFromMachineWithFlags()\fR and -\fBCopyToMachineWithFlags\fR +\fBCopyToMachineWithFlags()\fR do the same but take an additional flags argument\&. .PP \fBRemoveImage()\fR @@ -352,9 +359,9 @@ sets a per\-image quota limit\&. may be used to map UIDs/GIDs from the host user namespace to a container user namespace or vice versa\&. .SS "Signals" .PP -\fBMachineNew\fR +\fBMachineNew()\fR and -\fBMachineRemoved\fR +\fBMachineRemoved()\fR are sent whenever a new machine is registered or removed\&. These signals carry the machine name and the object path to the corresponding org\&.freedesktop\&.machine1\&.Machine interface (see below)\&. @@ -381,6 +388,8 @@ node /org/freedesktop/machine1/machine/rawhide { Kill(in s who, in i signal); GetAddresses(out a(iay) addresses); + GetSSHInfo(out s ssh_address, + out s ssh_private_key_path); GetOSRelease(out a{ss} fields); GetUIDShift(out u shift); OpenPTY(out h pty, @@ -429,6 +438,12 @@ node /org/freedesktop/machine1/machine/rawhide { readonly s RootDirectory = \*(Aq\&.\&.\&.\*(Aq; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const") readonly ai NetworkInterfaces = [\&.\&.\&.]; + @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const") + readonly u VSockCID = \&.\&.\&.; + @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const") + readonly s SSHAddress = \*(Aq\&.\&.\&.\*(Aq; + @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const") + readonly s SSHPrivateKeyPath = \*(Aq\&.\&.\&.\*(Aq; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") readonly s State = \*(Aq\&.\&.\&.\*(Aq; }; @@ -467,6 +482,10 @@ node /org/freedesktop/machine1/machine/rawhide { + + + + .SS "Methods" .PP \fBTerminate()\fR @@ -478,11 +497,13 @@ and \fBKillMachine()\fR on the Manager interface, respectively\&. .PP -\fBGetAddresses()\fR +\fBGetAddresses()\fR, +\fBGetSSHInfo()\fR and \fBGetOSRelease()\fR -get the IP address and OS release information from the machine\&. These methods take the same arguments as -\fBGetMachineAddresses()\fR +get the IP address, SSH connection and OS release information from the machine\&. These methods take the same arguments as +\fBGetMachineAddresses()\fR, +\fBGetMachineSSHInfo()\fR and \fBGetMachineOSRelease()\fR of the Manager interface, respectively\&. @@ -521,6 +542,19 @@ contains an array of network interface indices that point towards the container, \fBCreateMachineWithNetwork()\fR above\&. .PP +\fIVSockCID\fR +is the VSOCK CID of the VM if it is known, or +\fBVMADDR_CID_ANY\fR +otherwise\&. +.PP +\fISSHAddress\fR +is the address of the VM in a format +\fBssh\fR +can understand if it is known or the empty string\&. +.PP +\fISSHPrivateKeyPath\fR +is the path to the SSH private key of the VM if it is known or the empty string\&. +.PP \fIState\fR is the state of the machine and is one of "opening", @@ -568,12 +602,22 @@ These D\-Bus interfaces follow and \fBCopyToMachineWithFlags()\fR were added in version 252\&. +.PP +\fBGetMachineSSHInfo()\fR +was added in version 256\&. .SS "Machine Objects" .PP \fBCopyFromWithFlags()\fR and \fBCopyToWithFlags()\fR were added in version 252\&. +.PP +\fBGetSSHInfo()\fR, +\fIVSockCID\fR, +\fISSHAddress\fR +and +\fISSHPrivateKeyPath\fR +were added in version 256\&. .SH "NOTES" .IP " 1." 4 New Control Group Interfaces diff --git a/upstream/debian-unstable/man5/org.freedesktop.network1.5 b/upstream/debian-unstable/man5/org.freedesktop.network1.5 index 46092e21..4c227ef8 100644 --- a/upstream/debian-unstable/man5/org.freedesktop.network1.5 +++ b/upstream/debian-unstable/man5/org.freedesktop.network1.5 @@ -1,5 +1,5 @@ '\" t -.TH "ORG\&.FREEDESKTOP\&.NETWORK1" "5" "" "systemd 255" "org.freedesktop.network1" +.TH "ORG\&.FREEDESKTOP\&.NETWORK1" "5" "" "systemd 256~rc3" "org.freedesktop.network1" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -81,6 +81,8 @@ node /org/freedesktop/network1 { readonly s OnlineState = \*(Aq\&.\&.\&.\*(Aq; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const") readonly t NamespaceId = \&.\&.\&.; + @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") + readonly u NamespaceNSID = \&.\&.\&.; }; interface org\&.freedesktop\&.DBus\&.Peer { \&.\&.\&. }; interface org\&.freedesktop\&.DBus\&.Introspectable { \&.\&.\&. }; @@ -121,8 +123,16 @@ node /org/freedesktop/network1 { + .PP Provides information about the manager\&. +.SS "Properties" +.PP +\fINamespaceId\fR +contains the inode number of the network namespace that the network service runs in\&. A client may compare this with the inode number of its own network namespace to verify whether the service manages the same network namespace\&. +.PP +\fINamespaceNSID\fR +contains the "nsid" identifier the kernel maintains for the network namespace, if there\*(Aqs one assigned\&. .SH "LINK OBJECT" .sp .if n \{\ @@ -368,6 +378,10 @@ was added in version 255\&. .PP \fIState\fR was added in version 255\&. +.SS "Manager Object" +.PP +\fINamespaceNSID\fR +was added in version 256\&. .SH "NOTES" .IP " 1." 4 the usual interface versioning guidelines diff --git a/upstream/debian-unstable/man5/org.freedesktop.oom1.5 b/upstream/debian-unstable/man5/org.freedesktop.oom1.5 index 85840abb..a1131c84 100644 --- a/upstream/debian-unstable/man5/org.freedesktop.oom1.5 +++ b/upstream/debian-unstable/man5/org.freedesktop.oom1.5 @@ -1,5 +1,5 @@ '\" t -.TH "ORG\&.FREEDESKTOP\&.OOM1" "5" "" "systemd 255" "org.freedesktop.oom1" +.TH "ORG\&.FREEDESKTOP\&.OOM1" "5" "" "systemd 256~rc3" "org.freedesktop.oom1" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -55,7 +55,7 @@ node /org/freedesktop/oom1 { .SS "Methods" .PP -\fBKilled\fR +\fBKilled()\fR signal is sent when any cgroup is killed by oomd\&. .PP Note that more reasons will be added in the future, and the table below will be expanded accordingly\&. @@ -95,7 +95,7 @@ These D\-Bus interfaces follow .SH "HISTORY" .SS "The Manager Object" .PP -\fBKilled\fR +\fBKilled()\fR was added in version 252\&. .SH "NOTES" .IP " 1." 4 diff --git a/upstream/debian-unstable/man5/org.freedesktop.portable1.5 b/upstream/debian-unstable/man5/org.freedesktop.portable1.5 index 3ecf21a7..12d7a7cb 100644 --- a/upstream/debian-unstable/man5/org.freedesktop.portable1.5 +++ b/upstream/debian-unstable/man5/org.freedesktop.portable1.5 @@ -1,5 +1,5 @@ '\" t -.TH "ORG\&.FREEDESKTOP\&.PORTABLE1" "5" "" "systemd 255" "org.freedesktop.portable1" +.TH "ORG\&.FREEDESKTOP\&.PORTABLE1" "5" "" "systemd 256~rc3" "org.freedesktop.portable1" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -265,7 +265,7 @@ property for a list of available profiles), a boolean indicating whether to atta .sp -1 .IP \(bu 2.3 .\} -(null) +(empty) .RE .sp .RS 4 @@ -290,7 +290,24 @@ copy symlink .RE .sp -This method returns the list of changes applied to the system (for example, which unit was added and is now available as a system service)\&. Each change is represented as a triplet of strings: the type of change applied, the path on which it was applied, and the source (if any)\&. The type of change applied will be one of the following possible values: +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +mixed +.RE +.sp +If an empty string is passed the security profile drop\-ins and images will be symlinked while unit files will be copied, +\fIcopy\fR +will copy, +\fIsymlink\fR +will prefer linking if possible (e\&.g\&.: a unit has to be copied out of an image), and +\fImixed\fR +will prefer linking the resources owned by the OS (e\&.g\&.: the portable profile located within the host\*(Aqs /usr/ tree) but will copy the resources owned by the portable image (e\&.g\&.: the unit files and the images)\&. This method returns the list of changes applied to the system (for example, which unit was added and is now available as a system service)\&. Each change is represented as a triplet of strings: the type of change applied, the path on which it was applied, and the source (if any)\&. The type of change applied will be one of the following possible values: .sp .RS 4 .ie n \{\ @@ -338,6 +355,18 @@ mkdir .sp 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 +In place of the image path a +"\&.v/" +versioned directory may be specified, see +\fBsystemd.v\fR(7) +for details\&. +.PP +In place of the directory path a +"\&.v/" +versioned directory may be specified, see +\fBsystemd.v\fR(7) +for details\&. +.PP \fBAttachImageWithExtensions()\fR attaches a portable image to the system\&. This method is a superset of \fBAttachImage()\fR @@ -370,9 +399,7 @@ Note that an image cannot be detached if a unit that it contains is running\&. N detaches a portable image from the system\&. This method is a superset of \fBDetachImage()\fR with the addition of a list of extensions as input parameter, which were overlaid on top of the main image via -\fBAttachImageWithExtensions()\fR\&. The -\fIflag\fR -parameter is currently unused and reserved for future purposes\&. +\fBAttachImageWithExtensions()\fR\&. .PP \fBReattachImage()\fR combines the effects of the @@ -395,9 +422,7 @@ with the addition of a list of extensions as input parameter, which will be over entry on \fBsystemd.exec\fR(5) and -\fBsystemd-sysext\fR(8)\&. The -\fIflag\fR -parameter is currently unused and reserved for future purposes +\fBsystemd-sysext\fR(8)\&. .PP \fBRemoveImage()\fR removes the image with the specified name\&. diff --git a/upstream/debian-unstable/man5/org.freedesktop.resolve1.5 b/upstream/debian-unstable/man5/org.freedesktop.resolve1.5 index 4f3b397f..69b4a36e 100644 --- a/upstream/debian-unstable/man5/org.freedesktop.resolve1.5 +++ b/upstream/debian-unstable/man5/org.freedesktop.resolve1.5 @@ -1,5 +1,5 @@ '\" t -.TH "ORG\&.FREEDESKTOP\&.RESOLVE1" "5" "" "systemd 255" "org.freedesktop.resolve1" +.TH "ORG\&.FREEDESKTOP\&.RESOLVE1" "5" "" "systemd 256~rc3" "org.freedesktop.resolve1" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -94,7 +94,7 @@ node /org/freedesktop/resolve1 { SetLinkDNSSECNegativeTrustAnchors(in i ifindex, in as names); RevertLink(in i ifindex); - RegisterService(in s name, + RegisterService(in s id, in s name_template, in s type, in q service_port, @@ -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 just 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 @@ -436,35 +462,36 @@ The four methods above accept and return a 64\-bit flags value\&. In most cases .\} .nf /* Input+Output: Protocol/scope */ -#define SD_RESOLVED_DNS (UINT64_C(1) << 0) -#define SD_RESOLVED_LLMNR_IPV4 (UINT64_C(1) << 1) -#define SD_RESOLVED_LLMNR_IPV6 (UINT64_C(1) << 2) -#define SD_RESOLVED_MDNS_IPV4 (UINT64_C(1) << 3) -#define SD_RESOLVED_MDNS_IPV6 (UINT64_C(1) << 4) +#define SD_RESOLVED_DNS (UINT64_C(1) << 0) +#define SD_RESOLVED_LLMNR_IPV4 (UINT64_C(1) << 1) +#define SD_RESOLVED_LLMNR_IPV6 (UINT64_C(1) << 2) +#define SD_RESOLVED_MDNS_IPV4 (UINT64_C(1) << 3) +#define SD_RESOLVED_MDNS_IPV6 (UINT64_C(1) << 4) /* Input: Restrictions */ -#define SD_RESOLVED_NO_CNAME (UINT64_C(1) << 5) -#define SD_RESOLVED_NO_TXT (UINT64_C(1) << 6) -#define SD_RESOLVED_NO_ADDRESS (UINT64_C(1) << 7) -#define SD_RESOLVED_NO_SEARCH (UINT64_C(1) << 8) -#define SD_RESOLVED_NO_VALIDATE (UINT64_C(1) << 10) -#define SD_RESOLVED_NO_SYNTHESIZE (UINT64_C(1) << 11) -#define SD_RESOLVED_NO_CACHE (UINT64_C(1) << 12) -#define SD_RESOLVED_NO_ZONE (UINT64_C(1) << 13) -#define SD_RESOLVED_NO_TRUST_ANCHOR (UINT64_C(1) << 14) -#define SD_RESOLVED_NO_NETWORK (UINT64_C(1) << 15) -#define SD_RESOLVED_NO_STALE (UINT64_C(1) << 24) +#define SD_RESOLVED_NO_CNAME (UINT64_C(1) << 5) +#define SD_RESOLVED_NO_TXT (UINT64_C(1) << 6) +#define SD_RESOLVED_NO_ADDRESS (UINT64_C(1) << 7) +#define SD_RESOLVED_NO_SEARCH (UINT64_C(1) << 8) +#define SD_RESOLVED_NO_VALIDATE (UINT64_C(1) << 10) +#define SD_RESOLVED_NO_SYNTHESIZE (UINT64_C(1) << 11) +#define SD_RESOLVED_NO_CACHE (UINT64_C(1) << 12) +#define SD_RESOLVED_NO_ZONE (UINT64_C(1) << 13) +#define SD_RESOLVED_NO_TRUST_ANCHOR (UINT64_C(1) << 14) +#define SD_RESOLVED_NO_NETWORK (UINT64_C(1) << 15) +#define SD_RESOLVED_NO_STALE (UINT64_C(1) << 24) +#define SD_RESOLVED_RELAX_SINGLE_LABEL (UINT64_C(1) << 25) /* Output: Security */ -#define SD_RESOLVED_AUTHENTICATED (UINT64_C(1) << 9) -#define SD_RESOLVED_CONFIDENTIAL (UINT64_C(1) << 18) +#define SD_RESOLVED_AUTHENTICATED (UINT64_C(1) << 9) +#define SD_RESOLVED_CONFIDENTIAL (UINT64_C(1) << 18) /* Output: Origin */ -#define SD_RESOLVED_SYNTHETIC (UINT64_C(1) << 19) -#define SD_RESOLVED_FROM_CACHE (UINT64_C(1) << 20) -#define SD_RESOLVED_FROM_ZONE (UINT64_C(1) << 21) -#define SD_RESOLVED_FROM_TRUST_ANCHOR (UINT64_C(1) << 22) -#define SD_RESOLVED_FROM_NETWORK (UINT64_C(1) << 23) +#define SD_RESOLVED_SYNTHETIC (UINT64_C(1) << 19) +#define SD_RESOLVED_FROM_CACHE (UINT64_C(1) << 20) +#define SD_RESOLVED_FROM_ZONE (UINT64_C(1) << 21) +#define SD_RESOLVED_FROM_TRUST_ANCHOR (UINT64_C(1) << 22) +#define SD_RESOLVED_FROM_NETWORK (UINT64_C(1) << 23) .fi .if n \{\ .RE @@ -646,6 +673,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 \{\ diff --git a/upstream/debian-unstable/man5/org.freedesktop.systemd1.5 b/upstream/debian-unstable/man5/org.freedesktop.systemd1.5 index ef4ce426..ddfee8e9 100644 --- a/upstream/debian-unstable/man5/org.freedesktop.systemd1.5 +++ b/upstream/debian-unstable/man5/org.freedesktop.systemd1.5 @@ -1,5 +1,5 @@ '\" t -.TH "ORG\&.FREEDESKTOP\&.SYSTEMD1" "5" "" "systemd 255" "org.freedesktop.systemd1" +.TH "ORG\&.FREEDESKTOP\&.SYSTEMD1" "5" "" "systemd 256~rc3" "org.freedesktop.systemd1" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -274,6 +274,11 @@ node /org/freedesktop/systemd1 { GetDynamicUsers(out a(us) users); DumpUnitFileDescriptorStore(in s name, out a(suuutuusu) entries); + StartAuxiliaryScope(in s name, + in ah pidfds, + in t flags, + in a(sv) properties, + out o job); signals: UnitNew(s id, o unit); @@ -332,6 +337,10 @@ node /org/freedesktop/systemd1 { @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const") readonly t FinishTimestampMonotonic = \&.\&.\&.; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const") + readonly t ShutdownStartTimestamp = \&.\&.\&.; + @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const") + readonly t ShutdownStartTimestampMonotonic = \&.\&.\&.; + @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const") readonly t SecurityStartTimestamp = \&.\&.\&.; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const") readonly t SecurityStartTimestampMonotonic = \&.\&.\&.; @@ -548,6 +557,8 @@ node /org/freedesktop/systemd1 { readonly i DefaultOOMScoreAdjust = \&.\&.\&.; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const") readonly s CtrlAltDelBurstAction = \*(Aq\&.\&.\&.\*(Aq; + @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const") + readonly u SoftRebootsCount = \&.\&.\&.; }; interface org\&.freedesktop\&.DBus\&.Peer { \&.\&.\&. }; interface org\&.freedesktop\&.DBus\&.Introspectable { \&.\&.\&. }; @@ -776,6 +787,10 @@ node /org/freedesktop/systemd1 { + + + + .SS "Methods" .PP Note that many of the methods exist twice: once on the @@ -1293,6 +1308,21 @@ returns an array with information about the file descriptors currently in the fi \fBDumpFileDescriptorStore()\fR on the org\&.freedesktop\&.systemd1\&.Service\&. For further details, see below\&. +.PP +\fBStartAuxiliaryScope()\fR +creates a new scope unit from a service where calling process resides\&. Set of processes that will be migrated to newly created scope is passed in as an array of pidfds\&. This is useful for creating auxiliary scopes that should contain worker processes and their lifecycle shouldn\*(Aqt be bound to a lifecycle of the service, e\&.g\&. they should continue running after the restart of the service\&. Note that the main PID of the service can not be migrated to an auxiliary scope\&. Also, +\fIflags\fR +argument must be 0 and is reserved for future extensions\&. +.PP +\fBCleanUnit()\fR +deletes the configuration, state, logs, cache and runtime data directories and clear out the file descriptors store for the unit, as specified in the mask parameters\&. The possible values are +"configuration", +"state", +"logs", +"cache", +"runtime", +"fdstore", and +"all"\&. .SS "Signals" .PP Note that most signals are sent out only after @@ -1377,16 +1407,29 @@ are not symlinks to their counterparts under Added in version 252\&. .RE .PP -"cgroups\-missing" +"unmerged\-bin" .RS 4 -Support for cgroups is unavailable\&. +/usr/sbin +is not a symlink to +/usr/bin/\&. +.sp +Added in version 256\&. +.RE +.PP +"var\-run\-bad" +.RS 4 +/run/ +does not exist or +/var/run +is not a symlink to +/run/\&. .sp Added in version 252\&. .RE .PP "cgroupsv1" .RS 4 -The system is using the old cgroup hierarchy\&. +The system is using the deprecated cgroup v1 hierarchy\&. .sp Added in version 252\&. .RE @@ -1415,17 +1458,6 @@ The system is running a kernel version that is older than the minimum supported Added in version 252\&. .RE .PP -"var\-run\-bad" -.RS 4 -/run/ -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\&. @@ -1450,13 +1482,16 @@ Added in version 252\&. \fIInitRDTimestampMonotonic\fR, \fIUserspaceTimestamp\fR, \fIUserspaceTimestampMonotonic\fR, -\fIFinishTimestamp\fR, and -\fIFinishTimestampMonotonic\fR +\fIFinishTimestamp\fR, +\fIFinishTimestampMonotonic\fR, +\fIShutdownStartTimestamp\fR +and +\fIShutdownStartTimestampMonotonic\fR encode \fBCLOCK_REALTIME\fR and \fBCLOCK_MONOTONIC\fR -microsecond timestamps taken when the firmware first began execution, when the boot loader first began execution, when the kernel first began execution, when the initrd first began execution, when the main systemd instance began execution and finally, when all queued startup jobs finished execution\&. These values are useful for determining boot\-time performance\&. Note that as monotonic time begins with the kernel startup, the +microsecond timestamps taken when the firmware first began execution, when the boot loader first began execution, when the kernel first began execution, when the initrd first began execution, when the main systemd instance began execution, when all queued startup jobs finished execution and finally, when a shutdown operation first began execution\&. These values are useful for determining boot\-time performance\&. Note that as monotonic time begins with the kernel startup, the \fIKernelTimestampMonotonic\fR timestamp will always be 0 and \fIFirmwareTimestampMonotonic\fR @@ -1503,6 +1538,10 @@ encodes the environment block passed to all executed services\&. It may be alter \fIUnitPath\fR encodes the currently active unit file search path\&. It is an array of file system paths encoded as strings\&. .PP +\fISoftRebootsCount\fR +encodes how many soft\-reboots were successfully completed since the last full boot\&. Starts at +"0"\&. +.PP \fIVirtualization\fR contains a short ID string describing the virtualization technology the system runs in\&. On bare\-metal hardware this is the empty string\&. Otherwise, it contains an identifier such as "kvm", @@ -1585,8 +1624,8 @@ org\&.freedesktop\&.systemd1\&.manage\-units\&. Operations which modify unit fil \fBDisableUnitFilesWithFlags()\fR, \fBReenableUnitFiles()\fR, \fBLinkUnitFiles()\fR, -\fBPresetUnitFiles\fR, -\fBMaskUnitFiles\fR, and similar) require +\fBPresetUnitFiles()\fR, +\fBMaskUnitFiles()\fR, and similar) require org\&.freedesktop\&.systemd1\&.manage\-unit\-files\&. Operations which modify the exported environment (\fBSetEnvironment()\fR, \fBUnsetEnvironment()\fR, \fBUnsetAndSetEnvironment()\fR) require @@ -1708,6 +1747,8 @@ node /org/freedesktop/systemd1/unit/avahi_2ddaemon_2eservice { @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const") readonly as RequiresMountsFor = [\*(Aq\&.\&.\&.\*(Aq, \&.\&.\&.]; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const") + readonly as WantsMountsFor = [\*(Aq\&.\&.\&.\*(Aq, \&.\&.\&.]; + @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const") readonly as Documentation = [\*(Aq\&.\&.\&.\*(Aq, \&.\&.\&.]; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const") readonly s Description = \*(Aq\&.\&.\&.\*(Aq; @@ -1946,6 +1987,7 @@ node /org/freedesktop/systemd1/unit/avahi_2ddaemon_2eservice { + .SS "Methods" .PP \fBStart()\fR, @@ -2322,6 +2364,8 @@ node /org/freedesktop/systemd1/unit/avahi_2ddaemon_2eservice { readonly t ExecMainStartTimestampMonotonic = \&.\&.\&.; readonly t ExecMainExitTimestamp = \&.\&.\&.; readonly t ExecMainExitTimestampMonotonic = \&.\&.\&.; + readonly t ExecMainHandoffTimestamp = \&.\&.\&.; + readonly t ExecMainHandoffTimestampMonotonic = \&.\&.\&.; readonly u ExecMainPID = \&.\&.\&.; readonly i ExecMainCode = \&.\&.\&.; readonly i ExecMainStatus = \&.\&.\&.; @@ -2372,6 +2416,10 @@ node /org/freedesktop/systemd1/unit/avahi_2ddaemon_2eservice { @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") readonly t MemoryAvailable = \&.\&.\&.; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") + readonly t EffectiveMemoryMax = \&.\&.\&.; + @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") + readonly t EffectiveMemoryHigh = \&.\&.\&.; + @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") readonly t CPUUsageNSec = \&.\&.\&.; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") readonly ay EffectiveCPUs = [\&.\&.\&.]; @@ -2380,6 +2428,8 @@ node /org/freedesktop/systemd1/unit/avahi_2ddaemon_2eservice { @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") readonly t TasksCurrent = \&.\&.\&.; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") + readonly t EffectiveTasksMax = \&.\&.\&.; + @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") readonly t IPIngressBytes = \&.\&.\&.; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") readonly t IPIngressPackets = \&.\&.\&.; @@ -2484,6 +2534,8 @@ node /org/freedesktop/systemd1/unit/avahi_2ddaemon_2eservice { @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") readonly t StartupMemoryZSwapMax = \&.\&.\&.; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") + readonly b MemoryZSwapWriteback = \&.\&.\&.; + @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") readonly t MemoryLimit = \&.\&.\&.; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") readonly s DevicePolicy = \*(Aq\&.\&.\&.\*(Aq; @@ -3242,6 +3294,12 @@ node /org/freedesktop/systemd1/unit/avahi_2ddaemon_2eservice { + + + + + + .SS "Methods" .PP \fBBindMount()\fR @@ -3309,13 +3367,28 @@ also correspond to the configured settings of the unit files, but instead of bei \fIExecMainStartTimestampMonotonic\fR, \fIExecMainExitTimestamp\fR, \fIExecMainExitTimestampMonotonic\fR, +\fIExecMainHandoffTimestamp\fR, +\fIExecMainHandoffTimestampMonotonic\fR, \fIExecMainPID\fR, \fIExecMainCode\fR, \fIExecMainStatus\fR -contain information about the main process of the service as far as it is known\&. This is often the same runtime information that is stored in -\fIExecStart\fR\&. However, it deviates for +contain information about the main process of the service as far as it is known\&. The +\fIExecMainStartTimestamp\fR +timestamps record when the main process of the service is created\&. +\fIExecMainExitTimestamp\fR +timestamps record when the main process exit has been detected by the service manager\&. +\fIExecMainHandoffTimestamp\fR +timestamps records when the service binary is about to be executed by +\fBsystemd\-executor\fR +(this timestamp is recorded regardless if the immediately following +\fBexecve()\fR +system call succeeds or fails)\&. This is often the same runtime information that is also maintained for +\fIExecStart=\fR\&. However, it deviates for services with \fIType=forking\fR -services where the main process of the service is not forked off systemd directly\&. These fields either contain information of the last run of the process or of the current running process\&. +as well as services that use +\fIMAINPID=\fR +\fBsd_notify()\fR +messages as the main process of the service is not forked off by the service manager directly in that case\&. These fields either contain information of the last run of the process or of the current running process\&. .PP \fIMainPID\fR and @@ -3463,6 +3536,8 @@ node /org/freedesktop/systemd1/unit/avahi_2ddaemon_2esocket { @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const") readonly b PassCredentials = \&.\&.\&.; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const") + readonly b PassFileDescriptorsToExec = \&.\&.\&.; + @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const") readonly b PassSecurity = \&.\&.\&.; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const") readonly b PassPacketInfo = \&.\&.\&.; @@ -3543,6 +3618,10 @@ node /org/freedesktop/systemd1/unit/avahi_2ddaemon_2esocket { @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") readonly t MemoryAvailable = \&.\&.\&.; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") + readonly t EffectiveMemoryMax = \&.\&.\&.; + @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") + readonly t EffectiveMemoryHigh = \&.\&.\&.; + @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") readonly t CPUUsageNSec = \&.\&.\&.; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") readonly ay EffectiveCPUs = [\&.\&.\&.]; @@ -3551,6 +3630,8 @@ node /org/freedesktop/systemd1/unit/avahi_2ddaemon_2esocket { @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") readonly t TasksCurrent = \&.\&.\&.; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") + readonly t EffectiveTasksMax = \&.\&.\&.; + @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") readonly t IPIngressBytes = \&.\&.\&.; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") readonly t IPIngressPackets = \&.\&.\&.; @@ -3655,6 +3736,8 @@ node /org/freedesktop/systemd1/unit/avahi_2ddaemon_2esocket { @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") readonly t StartupMemoryZSwapMax = \&.\&.\&.; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") + readonly b MemoryZSwapWriteback = \&.\&.\&.; + @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") readonly t MemoryLimit = \&.\&.\&.; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") readonly s DevicePolicy = \*(Aq\&.\&.\&.\*(Aq; @@ -4405,6 +4488,11 @@ 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\&. @@ -4574,6 +4662,10 @@ node /org/freedesktop/systemd1/unit/home_2emount { @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") readonly t MemoryAvailable = \&.\&.\&.; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") + readonly t EffectiveMemoryMax = \&.\&.\&.; + @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") + readonly t EffectiveMemoryHigh = \&.\&.\&.; + @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") readonly t CPUUsageNSec = \&.\&.\&.; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") readonly ay EffectiveCPUs = [\&.\&.\&.]; @@ -4582,6 +4674,8 @@ node /org/freedesktop/systemd1/unit/home_2emount { @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") readonly t TasksCurrent = \&.\&.\&.; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") + readonly t EffectiveTasksMax = \&.\&.\&.; + @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") readonly t IPIngressBytes = \&.\&.\&.; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") readonly t IPIngressPackets = \&.\&.\&.; @@ -4686,6 +4780,8 @@ node /org/freedesktop/systemd1/unit/home_2emount { @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") readonly t StartupMemoryZSwapMax = \&.\&.\&.; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") + readonly b MemoryZSwapWriteback = \&.\&.\&.; + @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") readonly t MemoryLimit = \&.\&.\&.; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") readonly s DevicePolicy = \*(Aq\&.\&.\&.\*(Aq; @@ -5392,6 +5488,10 @@ 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 @@ -5632,6 +5732,10 @@ node /org/freedesktop/systemd1/unit/dev_2dsda3_2eswap { @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") readonly t MemoryAvailable = \&.\&.\&.; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") + readonly t EffectiveMemoryMax = \&.\&.\&.; + @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") + readonly t EffectiveMemoryHigh = \&.\&.\&.; + @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") readonly t CPUUsageNSec = \&.\&.\&.; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") readonly ay EffectiveCPUs = [\&.\&.\&.]; @@ -5640,6 +5744,8 @@ node /org/freedesktop/systemd1/unit/dev_2dsda3_2eswap { @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") readonly t TasksCurrent = \&.\&.\&.; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") + readonly t EffectiveTasksMax = \&.\&.\&.; + @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") readonly t IPIngressBytes = \&.\&.\&.; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") readonly t IPIngressPackets = \&.\&.\&.; @@ -5744,6 +5850,8 @@ node /org/freedesktop/systemd1/unit/dev_2dsda3_2eswap { @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") readonly t StartupMemoryZSwapMax = \&.\&.\&.; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") + readonly b MemoryZSwapWriteback = \&.\&.\&.; + @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") readonly t MemoryLimit = \&.\&.\&.; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") readonly s DevicePolicy = \*(Aq\&.\&.\&.\*(Aq; @@ -6443,6 +6551,10 @@ 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 @@ -6569,6 +6681,10 @@ node /org/freedesktop/systemd1/unit/system_2eslice { @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") readonly t MemoryAvailable = \&.\&.\&.; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") + readonly t EffectiveMemoryMax = \&.\&.\&.; + @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") + readonly t EffectiveMemoryHigh = \&.\&.\&.; + @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") readonly t CPUUsageNSec = \&.\&.\&.; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") readonly ay EffectiveCPUs = [\&.\&.\&.]; @@ -6577,6 +6693,8 @@ node /org/freedesktop/systemd1/unit/system_2eslice { @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") readonly t TasksCurrent = \&.\&.\&.; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") + readonly t EffectiveTasksMax = \&.\&.\&.; + @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") readonly t IPIngressBytes = \&.\&.\&.; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") readonly t IPIngressPackets = \&.\&.\&.; @@ -6681,6 +6799,8 @@ node /org/freedesktop/systemd1/unit/system_2eslice { @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") readonly t StartupMemoryZSwapMax = \&.\&.\&.; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") + readonly b MemoryZSwapWriteback = \&.\&.\&.; + @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") readonly t MemoryLimit = \&.\&.\&.; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") readonly s DevicePolicy = \*(Aq\&.\&.\&.\*(Aq; @@ -6830,6 +6950,10 @@ node /org/freedesktop/systemd1/unit/system_2eslice { + + + + .SS "Properties" .PP Most properties correspond directly with the matching settings in slice unit files\&. @@ -6884,6 +7008,10 @@ node /org/freedesktop/systemd1/unit/session_2d1_2escope { @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") readonly t MemoryAvailable = \&.\&.\&.; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") + readonly t EffectiveMemoryMax = \&.\&.\&.; + @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") + readonly t EffectiveMemoryHigh = \&.\&.\&.; + @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") readonly t CPUUsageNSec = \&.\&.\&.; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") readonly ay EffectiveCPUs = [\&.\&.\&.]; @@ -6892,6 +7020,8 @@ node /org/freedesktop/systemd1/unit/session_2d1_2escope { @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") readonly t TasksCurrent = \&.\&.\&.; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") + readonly t EffectiveTasksMax = \&.\&.\&.; + @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") readonly t IPIngressBytes = \&.\&.\&.; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") readonly t IPIngressPackets = \&.\&.\&.; @@ -6996,6 +7126,8 @@ node /org/freedesktop/systemd1/unit/session_2d1_2escope { @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") readonly t StartupMemoryZSwapMax = \&.\&.\&.; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") + readonly b MemoryZSwapWriteback = \&.\&.\&.; + @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") readonly t MemoryLimit = \&.\&.\&.; @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") readonly s DevicePolicy = \*(Aq\&.\&.\&.\*(Aq; @@ -7174,13 +7306,17 @@ node /org/freedesktop/systemd1/unit/session_2d1_2escope { + + + + .SS "Methods" .PP \fBAbandon()\fR may be used to place a scope unit in the "abandoned" state\&. This may be used to inform the system manager that the manager that created the scope lost interest in the scope (for example, because it is terminating), without wanting to shut down the scope entirely\&. .SS "Signals" .PP -\fBRequestStop\fR +\fBRequestStop()\fR is sent to the peer that is configured in the \fIController\fR property when systemd is requested to terminate the scope unit\&. A program registering a scope can use this to cleanly shut down the processes it added to the scope instead of letting systemd do it with the usual @@ -7192,7 +7328,7 @@ All properties correspond directly with the matching properties of service units .PP \fIController\fR contains the bus name (unique or well\-known) that is notified when the scope unit is to be shut down via a -\fBRequestStop\fR +\fBRequestStop()\fR signal (see below)\&. This is set when the scope is created\&. If not set, the scope\*(Aqs processes will terminated with \fBSIGTERM\fR directly\&. @@ -7354,6 +7490,13 @@ were added in version 253\&. \fBSoftReboot()\fR, and \fBDumpUnitFileDescriptorStore()\fR were added in version 254\&. +.PP +\fBStartAuxiliaryScope()\fR, +\fIShutdownStartTimestamp\fR, +\fIShutdownStartTimestampMonotonic\fR +and +\fISoftRebootsCount\fR +were added in version 256\&. .SS "Unit Objects" .PP \fIUpholds\fR @@ -7371,6 +7514,9 @@ was added in version 254\&. .PP \fISurviveFinalKillSignal\fR was added in version 255\&. +.PP +\fIWantsMountsFor\fR +was added in version 256\&. .SS "Service Unit Objects" .PP \fIControlGroupId\fR @@ -7415,6 +7561,14 @@ were added in version 254\&. \fIMemorySwapPeak\fR, and \fIMemoryZSwapCurrent\fR were added in version 255\&. +.PP +\fIEffectiveMemoryHigh\fR, +\fIEffectiveMemoryMax\fR, +\fIEffectiveTasksMax\fR, +\fIMemoryZSwapWriteback\fR, +\fIExecMainHandoffTimestampMonotonic\fR, and +\fIExecMainHandoffTimestamp\fR +were added in version 256\&. .SS "Socket Unit Objects" .PP \fIControlGroupId\fR @@ -7454,6 +7608,13 @@ were added in version 254\&. \fIMemorySwapPeak\fR, and \fIMemoryZSwapCurrent\fR were added in version 255\&. +.PP +\fIEffectiveMemoryHigh\fR, +\fIEffectiveMemoryMax\fR, +\fIEffectiveTasksMax\fR, +\fIMemoryZSwapWriteback\fR, and +\fIPassFileDescriptorsToExec\fR +were added in version 256\&. .SS "Mount Unit Objects" .PP \fIControlGroupId\fR @@ -7491,6 +7652,12 @@ were added in version 254\&. \fIMemorySwapPeak\fR, and \fIMemoryZSwapCurrent\fR were added in version 255\&. +.PP +\fIEffectiveMemoryHigh\fR, +\fIEffectiveMemoryMax\fR, +\fIEffectiveTasksMax\fR, and +\fIMemoryZSwapWriteback\fR +were added in version 256\&. .SS "Swap Unit Objects" .PP \fIControlGroupId\fR @@ -7528,6 +7695,12 @@ were added in version 254\&. \fIMemorySwapPeak\fR, and \fIMemoryZSwapCurrent\fR were added in version 255\&. +.PP +\fIEffectiveMemoryHigh\fR, +\fIEffectiveMemoryMax\fR, +\fIEffectiveTasksMax\fR, and +\fIMemoryZSwapWriteback\fR +were added in version 256\&. .SS "Slice Unit Objects" .PP \fIControlGroupId\fR @@ -7554,6 +7727,12 @@ were added in version 254\&. \fIMemorySwapPeak\fR, and \fIMemoryZSwapCurrent\fR were added in version 255\&. +.PP +\fIEffectiveMemoryHigh\fR, +\fIEffectiveMemoryMax\fR, +\fIEffectiveTasksMax\fR, and +\fIMemoryZSwapWriteback\fR +were added in version 256\&. .SS "Scope Unit Objects" .PP \fIControlGroupId\fR @@ -7582,6 +7761,12 @@ were added in version 254\&. \fIMemorySwapPeak\fR, and \fIMemoryZSwapCurrent\fR were added in version 255\&. +.PP +\fIEffectiveMemoryHigh\fR, +\fIEffectiveMemoryMax\fR, +\fIEffectiveTasksMax\fR, and +\fIMemoryZSwapWriteback\fR +were added in version 256\&. .SS "Job Objects" .PP \fIActivationDetails\fR diff --git a/upstream/debian-unstable/man5/org.freedesktop.timedate1.5 b/upstream/debian-unstable/man5/org.freedesktop.timedate1.5 index 63adbcd7..cca2dc94 100644 --- a/upstream/debian-unstable/man5/org.freedesktop.timedate1.5 +++ b/upstream/debian-unstable/man5/org.freedesktop.timedate1.5 @@ -1,5 +1,5 @@ '\" t -.TH "ORG\&.FREEDESKTOP\&.TIMEDATE1" "5" "" "systemd 255" "org.freedesktop.timedate1" +.TH "ORG\&.FREEDESKTOP\&.TIMEDATE1" "5" "" "systemd 256~rc3" "org.freedesktop.timedate1" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/upstream/debian-unstable/man5/os-release.5 b/upstream/debian-unstable/man5/os-release.5 index 795363d3..fc3297c4 100644 --- a/upstream/debian-unstable/man5/os-release.5 +++ b/upstream/debian-unstable/man5/os-release.5 @@ -1,5 +1,5 @@ '\" t -.TH "OS\-RELEASE" "5" "" "systemd 255" "os-release" +.TH "OS\-RELEASE" "5" "" "systemd 256~rc3" "os-release" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -23,13 +23,18 @@ os-release, initrd-release, extension-release \- Operating system identification .SH "SYNOPSIS" .PP +.RS 4 /etc/os\-release -.PP +.RE +.RS 4 /usr/lib/os\-release -.PP +.RE +.RS 4 /etc/initrd\-release -.PP +.RE +.RS 4 /usr/lib/extension\-release\&.d/extension\-release\&.\fIIMAGE\fR +.RE .SH "DESCRIPTION" .PP The @@ -53,7 +58,7 @@ is the recommended place to store OS release information as part of vendor trees /etc/os\-release should be a relative symlink to /usr/lib/os\-release, to provide compatibility with applications only looking at -/etc/\&. A relative symlink instead of an absolute symlink is necessary to avoid breaking the link in a chroot or initrd environment such as dracut\&. +/etc/\&. A relative symlink instead of an absolute symlink is necessary to avoid breaking the link in a chroot or initrd environment\&. .PP os\-release contains data that is defined by the operating system vendor and should generally not be changed by the administrator\&. @@ -674,11 +679,7 @@ if \*(Aqdebian\*(Aq in [os_release\&.get(\*(AqID\*(Aq, \*(Aqlinux\*(Aq), Note that the above version that uses the built\-in implementation is preferred in most cases, and the open\-coded version here is provided for reference\&. .SH "SEE ALSO" .PP -\fBsystemd\fR(1), -\fBlsb_release\fR(1), -\fBhostname\fR(5), -\fBmachine-id\fR(5), -\fBmachine-info\fR(5) +\fBsystemd\fR(1), \fBlsb_release\fR(1), \fBhostname\fR(5), \fBmachine-id\fR(5), \fBmachine-info\fR(5) .SH "NOTES" .IP " 1." 4 Announcement of /etc/os-release diff --git a/upstream/debian-unstable/man5/pci.ids.5 b/upstream/debian-unstable/man5/pci.ids.5 index 54b370cb..9f1c2a17 100644 --- a/upstream/debian-unstable/man5/pci.ids.5 +++ b/upstream/debian-unstable/man5/pci.ids.5 @@ -1,4 +1,4 @@ -.TH pci.ids 5 "01 May 2023" "pciutils-3.10.0" "The PCI Utilities" +.TH pci.ids 5 "05 April 2024" "pciutils-3.12.0" "The PCI Utilities" .SH NAME pci.ids \- list of known identifiers related to PCI devices diff --git a/upstream/debian-unstable/man5/pfm.5 b/upstream/debian-unstable/man5/pfm.5 index c8266a9d..5653a758 100644 --- a/upstream/debian-unstable/man5/pfm.5 +++ b/upstream/debian-unstable/man5/pfm.5 @@ -3,7 +3,7 @@ .\" Do not hand-hack it! If you have bug fixes or improvements, please find .\" the corresponding HTML page on the Netpbm website, generate a patch .\" against that, and send it to the Netpbm maintainer. -.TH "PFM Format Description" 5 "19 April 2012" "netpbm documentation" +.TH "PFM Format Description" 5 "27 February 2024" "netpbm documentation" .SH NAME @@ -19,14 +19,20 @@ the Netpbm converters .BR "\fBpfmtopam\fP" (1)\c \&. .PP -There are multiple similar formats known as PFM in the world, none -of them authoritatively documented. The format described here is one -that Bryan Henderson deduced from a program he found somewhere that -dealt with a "PFM" format. +There are multiple similar formats known as PFM in the world, none of them +authoritatively documented. The format described here is one that Bryan +Henderson deduced from a program he found somewhere that dealt with a "PFM" +format. This format appears to be the one Gimp calls PFM. + +Another important PFM is used by Adobe Photoshop and appears to be identical +to this except that rows are ordered from top to bottom in the Adobe version. +If you interchange images between systems that use these two formats, it will +work except that your image gets flipped upside down. You can compensate for +that with \f(CWpamflip -topbottom\fP. .PP -The PFM format is inspired by the Netpbm formats, and you will see -lots of similarity. It is not, however, an official Netpbm format. -Its goal is not consistent with those of Netpbm formats. +The PFM format is inspired by the Netpbm formats, and you will see lots of +similarity. It is not, however, an official Netpbm format. Its goal is not +consistent with those of Netpbm formats. .SH The format .PP @@ -77,6 +83,11 @@ The raster is a sequence of pixels, packed one after another, with no delimiters of any kind. They are grouped by row, with the pixels in each row ordered left to right and the rows ordered bottom to top. .PP + \fINote:\fP This is the opposite of Netpbm formats, which order rows +top to bottom. It is also the opposite of the format Adobe Photoshop calls +PFM. See the introduction for more information on this disparity. + +.PP Each pixel consists of 1 or 3 samples, packed one after another, with no delimiters of any kind. 1 sample for a grayscale PFM and 3 for a color PFM (see the Identifier Line of the PFM header). diff --git a/upstream/debian-unstable/man5/proc.5 b/upstream/debian-unstable/man5/proc.5 index 9a488419..f4ac89d4 100644 --- a/upstream/debian-unstable/man5/proc.5 +++ b/upstream/debian-unstable/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 6.8" .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/debian-unstable/man5/proc_apm.5 b/upstream/debian-unstable/man5/proc_apm.5 new file mode 100644 index 00000000..fe07ed33 --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_buddyinfo.5 b/upstream/debian-unstable/man5/proc_buddyinfo.5 new file mode 100644 index 00000000..67576dd3 --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_bus.5 b/upstream/debian-unstable/man5/proc_bus.5 new file mode 100644 index 00000000..7ccd900e --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_cgroups.5 b/upstream/debian-unstable/man5/proc_cgroups.5 new file mode 100644 index 00000000..b85a648d --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_cmdline.5 b/upstream/debian-unstable/man5/proc_cmdline.5 new file mode 100644 index 00000000..437e89d0 --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_config.gz.5 b/upstream/debian-unstable/man5/proc_config.gz.5 new file mode 100644 index 00000000..cd6278dc --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_cpuinfo.5 b/upstream/debian-unstable/man5/proc_cpuinfo.5 new file mode 100644 index 00000000..caaa2ea5 --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_crypto.5 b/upstream/debian-unstable/man5/proc_crypto.5 new file mode 100644 index 00000000..fe4bbc4e --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_devices.5 b/upstream/debian-unstable/man5/proc_devices.5 new file mode 100644 index 00000000..8e22aef6 --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_diskstats.5 b/upstream/debian-unstable/man5/proc_diskstats.5 new file mode 100644 index 00000000..27e81854 --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_dma.5 b/upstream/debian-unstable/man5/proc_dma.5 new file mode 100644 index 00000000..30ff338e --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_driver.5 b/upstream/debian-unstable/man5/proc_driver.5 new file mode 100644 index 00000000..64417fa4 --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.SH NAME +/proc/driver/ \- empty dir +.SH DESCRIPTION +.TP +.I /proc/driver/ +Empty subdirectory. +.SH SEE ALSO +.BR proc (5) diff --git a/upstream/debian-unstable/man5/proc_execdomains.5 b/upstream/debian-unstable/man5/proc_execdomains.5 new file mode 100644 index 00000000..fec20c65 --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_fb.5 b/upstream/debian-unstable/man5/proc_fb.5 new file mode 100644 index 00000000..6a4ed6c2 --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_filesystems.5 b/upstream/debian-unstable/man5/proc_filesystems.5 new file mode 100644 index 00000000..0f51dc44 --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_fs.5 b/upstream/debian-unstable/man5/proc_fs.5 new file mode 100644 index 00000000..b4149d5e --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_ide.5 b/upstream/debian-unstable/man5/proc_ide.5 new file mode 100644 index 00000000..b40d13e8 --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_interrupts.5 b/upstream/debian-unstable/man5/proc_interrupts.5 new file mode 100644 index 00000000..ca4d21f2 --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_iomem.5 b/upstream/debian-unstable/man5/proc_iomem.5 new file mode 100644 index 00000000..b4c6ed0e --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_ioports.5 b/upstream/debian-unstable/man5/proc_ioports.5 new file mode 100644 index 00000000..08d5dc4d --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_kallsyms.5 b/upstream/debian-unstable/man5/proc_kallsyms.5 new file mode 100644 index 00000000..faf45f41 --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_kcore.5 b/upstream/debian-unstable/man5/proc_kcore.5 new file mode 100644 index 00000000..4f5b3bc8 --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_keys.5 b/upstream/debian-unstable/man5/proc_keys.5 new file mode 100644 index 00000000..68cf4c3a --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_kmsg.5 b/upstream/debian-unstable/man5/proc_kmsg.5 new file mode 100644 index 00000000..7faedbdb --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_kpagecgroup.5 b/upstream/debian-unstable/man5/proc_kpagecgroup.5 new file mode 100644 index 00000000..3c56331d --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_kpagecount.5 b/upstream/debian-unstable/man5/proc_kpagecount.5 new file mode 100644 index 00000000..2a589510 --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_kpageflags.5 b/upstream/debian-unstable/man5/proc_kpageflags.5 new file mode 100644 index 00000000..fb2c793d --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_loadavg.5 b/upstream/debian-unstable/man5/proc_loadavg.5 new file mode 100644 index 00000000..a3051ab3 --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_locks.5 b/upstream/debian-unstable/man5/proc_locks.5 new file mode 100644 index 00000000..24e5075f --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_malloc.5 b/upstream/debian-unstable/man5/proc_malloc.5 new file mode 100644 index 00000000..d1dd6027 --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_meminfo.5 b/upstream/debian-unstable/man5/proc_meminfo.5 new file mode 100644 index 00000000..df451db1 --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_modules.5 b/upstream/debian-unstable/man5/proc_modules.5 new file mode 100644 index 00000000..7e47d193 --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_mtrr.5 b/upstream/debian-unstable/man5/proc_mtrr.5 new file mode 100644 index 00000000..f1594c50 --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_partitions.5 b/upstream/debian-unstable/man5/proc_partitions.5 new file mode 100644 index 00000000..4e216cb7 --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_pci.5 b/upstream/debian-unstable/man5/proc_pci.5 new file mode 100644 index 00000000..a2d84daa --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_pid.5 b/upstream/debian-unstable/man5/proc_pid.5 new file mode 100644 index 00000000..084ab77d --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_pid_attr.5 b/upstream/debian-unstable/man5/proc_pid_attr.5 new file mode 100644 index 00000000..eed804d0 --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_pid_autogroup.5 b/upstream/debian-unstable/man5/proc_pid_autogroup.5 new file mode 100644 index 00000000..2f0c2b7e --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_pid_auxv.5 b/upstream/debian-unstable/man5/proc_pid_auxv.5 new file mode 100644 index 00000000..925ada8a --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_pid_cgroup.5 b/upstream/debian-unstable/man5/proc_pid_cgroup.5 new file mode 100644 index 00000000..3a639e85 --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_pid_clear_refs.5 b/upstream/debian-unstable/man5/proc_pid_clear_refs.5 new file mode 100644 index 00000000..1466063a --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_pid_cmdline.5 b/upstream/debian-unstable/man5/proc_pid_cmdline.5 new file mode 100644 index 00000000..ffcc90da --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_pid_comm.5 b/upstream/debian-unstable/man5/proc_pid_comm.5 new file mode 100644 index 00000000..e6000cba --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_pid_coredump_filter.5 b/upstream/debian-unstable/man5/proc_pid_coredump_filter.5 new file mode 100644 index 00000000..523fe430 --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_pid_cpuset.5 b/upstream/debian-unstable/man5/proc_pid_cpuset.5 new file mode 100644 index 00000000..89f0bbd8 --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_pid_cwd.5 b/upstream/debian-unstable/man5/proc_pid_cwd.5 new file mode 100644 index 00000000..398799c7 --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_pid_environ.5 b/upstream/debian-unstable/man5/proc_pid_environ.5 new file mode 100644 index 00000000..86e3cd8c --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_pid_exe.5 b/upstream/debian-unstable/man5/proc_pid_exe.5 new file mode 100644 index 00000000..0fa38f43 --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_pid_fd.5 b/upstream/debian-unstable/man5/proc_pid_fd.5 new file mode 100644 index 00000000..28b0b6b9 --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_pid_fdinfo.5 b/upstream/debian-unstable/man5/proc_pid_fdinfo.5 new file mode 100644 index 00000000..87774695 --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_pid_io.5 b/upstream/debian-unstable/man5/proc_pid_io.5 new file mode 100644 index 00000000..aab550a9 --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_pid_limits.5 b/upstream/debian-unstable/man5/proc_pid_limits.5 new file mode 100644 index 00000000..739946ca --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_pid_map_files.5 b/upstream/debian-unstable/man5/proc_pid_map_files.5 new file mode 100644 index 00000000..854d6c6b --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_pid_maps.5 b/upstream/debian-unstable/man5/proc_pid_maps.5 new file mode 100644 index 00000000..6c8b9961 --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_pid_mem.5 b/upstream/debian-unstable/man5/proc_pid_mem.5 new file mode 100644 index 00000000..7cf5efd1 --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_pid_mountinfo.5 b/upstream/debian-unstable/man5/proc_pid_mountinfo.5 new file mode 100644 index 00000000..dd56dad9 --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_pid_mounts.5 b/upstream/debian-unstable/man5/proc_pid_mounts.5 new file mode 100644 index 00000000..eb50c1b9 --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_pid_mountstats.5 b/upstream/debian-unstable/man5/proc_pid_mountstats.5 new file mode 100644 index 00000000..36999dfa --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_pid_net.5 b/upstream/debian-unstable/man5/proc_pid_net.5 new file mode 100644 index 00000000..095e0dc1 --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_pid_ns.5 b/upstream/debian-unstable/man5/proc_pid_ns.5 new file mode 100644 index 00000000..ec8814a4 --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_pid_numa_maps.5 b/upstream/debian-unstable/man5/proc_pid_numa_maps.5 new file mode 100644 index 00000000..d23b6a2a --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_pid_oom_score.5 b/upstream/debian-unstable/man5/proc_pid_oom_score.5 new file mode 100644 index 00000000..c8e19ccc --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_pid_oom_score_adj.5 b/upstream/debian-unstable/man5/proc_pid_oom_score_adj.5 new file mode 100644 index 00000000..4aa958cd --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_pid_pagemap.5 b/upstream/debian-unstable/man5/proc_pid_pagemap.5 new file mode 100644 index 00000000..ab942b03 --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_pid_personality.5 b/upstream/debian-unstable/man5/proc_pid_personality.5 new file mode 100644 index 00000000..5a4b7d9e --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_pid_projid_map.5 b/upstream/debian-unstable/man5/proc_pid_projid_map.5 new file mode 100644 index 00000000..344d4cc2 --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_pid_root.5 b/upstream/debian-unstable/man5/proc_pid_root.5 new file mode 100644 index 00000000..8b42c399 --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_pid_seccomp.5 b/upstream/debian-unstable/man5/proc_pid_seccomp.5 new file mode 100644 index 00000000..8f9680cb --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_pid_setgroups.5 b/upstream/debian-unstable/man5/proc_pid_setgroups.5 new file mode 100644 index 00000000..38fad2db --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_pid_smaps.5 b/upstream/debian-unstable/man5/proc_pid_smaps.5 new file mode 100644 index 00000000..0653729c --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_pid_stack.5 b/upstream/debian-unstable/man5/proc_pid_stack.5 new file mode 100644 index 00000000..b417ceea --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_pid_stat.5 b/upstream/debian-unstable/man5/proc_pid_stat.5 new file mode 100644 index 00000000..3c379a66 --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_pid_statm.5 b/upstream/debian-unstable/man5/proc_pid_statm.5 new file mode 100644 index 00000000..e077f64f --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_pid_status.5 b/upstream/debian-unstable/man5/proc_pid_status.5 new file mode 100644 index 00000000..970854c4 --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_pid_syscall.5 b/upstream/debian-unstable/man5/proc_pid_syscall.5 new file mode 100644 index 00000000..3b6dc5ff --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_pid_task.5 b/upstream/debian-unstable/man5/proc_pid_task.5 new file mode 100644 index 00000000..10ebb48b --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_pid_timers.5 b/upstream/debian-unstable/man5/proc_pid_timers.5 new file mode 100644 index 00000000..fe3e5b6e --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_pid_timerslack_ns.5 b/upstream/debian-unstable/man5/proc_pid_timerslack_ns.5 new file mode 100644 index 00000000..fb118bd7 --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_pid_uid_map.5 b/upstream/debian-unstable/man5/proc_pid_uid_map.5 new file mode 100644 index 00000000..68f2f471 --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_pid_wchan.5 b/upstream/debian-unstable/man5/proc_pid_wchan.5 new file mode 100644 index 00000000..adc4dbaf --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_profile.5 b/upstream/debian-unstable/man5/proc_profile.5 new file mode 100644 index 00000000..31882b7d --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_scsi.5 b/upstream/debian-unstable/man5/proc_scsi.5 new file mode 100644 index 00000000..28b5d20d --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_slabinfo.5 b/upstream/debian-unstable/man5/proc_slabinfo.5 new file mode 100644 index 00000000..87f7109f --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_stat.5 b/upstream/debian-unstable/man5/proc_stat.5 new file mode 100644 index 00000000..7f1a4193 --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_swaps.5 b/upstream/debian-unstable/man5/proc_swaps.5 new file mode 100644 index 00000000..007fdb99 --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_sys.5 b/upstream/debian-unstable/man5/proc_sys.5 new file mode 100644 index 00000000..50d8d2d8 --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_sys_abi.5 b/upstream/debian-unstable/man5/proc_sys_abi.5 new file mode 100644 index 00000000..2500974f --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_sys_debug.5 b/upstream/debian-unstable/man5/proc_sys_debug.5 new file mode 100644 index 00000000..c243cd5f --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_sys_dev.5 b/upstream/debian-unstable/man5/proc_sys_dev.5 new file mode 100644 index 00000000..2745142f --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_sys_fs.5 b/upstream/debian-unstable/man5/proc_sys_fs.5 new file mode 100644 index 00000000..af3f8a64 --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_sys_kernel.5 b/upstream/debian-unstable/man5/proc_sys_kernel.5 new file mode 100644 index 00000000..373705cb --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_sys_net.5 b/upstream/debian-unstable/man5/proc_sys_net.5 new file mode 100644 index 00000000..598bc3cf --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_sys_proc.5 b/upstream/debian-unstable/man5/proc_sys_proc.5 new file mode 100644 index 00000000..a37a3ab2 --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_sys_sunrpc.5 b/upstream/debian-unstable/man5/proc_sys_sunrpc.5 new file mode 100644 index 00000000..de990ad5 --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_sys_user.5 b/upstream/debian-unstable/man5/proc_sys_user.5 new file mode 100644 index 00000000..50c2d91f --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_sys_vm.5 b/upstream/debian-unstable/man5/proc_sys_vm.5 new file mode 100644 index 00000000..f4aedf05 --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_sysrq-trigger.5 b/upstream/debian-unstable/man5/proc_sysrq-trigger.5 new file mode 100644 index 00000000..488e8a1c --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_sysvipc.5 b/upstream/debian-unstable/man5/proc_sysvipc.5 new file mode 100644 index 00000000..37b4ddee --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_tid_children.5 b/upstream/debian-unstable/man5/proc_tid_children.5 new file mode 100644 index 00000000..212ef5bb --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_timer_list.5 b/upstream/debian-unstable/man5/proc_timer_list.5 new file mode 100644 index 00000000..7a840c70 --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_timer_stats.5 b/upstream/debian-unstable/man5/proc_timer_stats.5 new file mode 100644 index 00000000..a0bb0249 --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_tty.5 b/upstream/debian-unstable/man5/proc_tty.5 new file mode 100644 index 00000000..becc52f8 --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_uptime.5 b/upstream/debian-unstable/man5/proc_uptime.5 new file mode 100644 index 00000000..0fe81855 --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_version.5 b/upstream/debian-unstable/man5/proc_version.5 new file mode 100644 index 00000000..d9230e24 --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_vmstat.5 b/upstream/debian-unstable/man5/proc_vmstat.5 new file mode 100644 index 00000000..3b4ce6ec --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/proc_zoneinfo.5 b/upstream/debian-unstable/man5/proc_zoneinfo.5 new file mode 100644 index 00000000..36fe3be0 --- /dev/null +++ b/upstream/debian-unstable/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 6.8" +.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/debian-unstable/man5/procmailex.5 b/upstream/debian-unstable/man5/procmailex.5 index 0107668e..0ecc6d5c 100644 --- a/upstream/debian-unstable/man5/procmailex.5 +++ b/upstream/debian-unstable/man5/procmailex.5 @@ -3,7 +3,7 @@ .ds Rv \\$3 .ds Dt \\$4 .. -.Id $Id$ +.Id $Id: procmailex.man,v 1.54 2001/08/04 06:08:20 guenther Exp $ .TH PROCMAILEX 5 \*(Dt BuGless .rn SH Sh .de SH @@ -123,8 +123,8 @@ backup If your system doesn't generate or generates incorrect leading `From ' lines on every mail, you can fix this by calling up procmail with the \-f- option. To fix the same problem by -different means, you could have inserted the following -recipe above all other recipes in your rcfile. They will filter the header +different means, you could have inserted the following two +recipes above all other recipes in your rcfile. They will filter the header of any mail through formail which will strip any leading `From ', and automatically regenerates it subsequently. .Sx 2 @@ -209,7 +209,7 @@ This is allowed. Do .B not put comments on the same line as a condition though. .Sx 18 -SHELL=/bin/sh # only needed for older versions of procmail +SHELL=/bin/sh # for other shells, this might need adjustment :0 Whc: vacation.lock # Perform a quick check to see if the mail was addressed to us @@ -555,6 +555,10 @@ Stephen R. van den Berg .RS <srb@cuci.nl> .RE +Philip A. Guenther +.RS +<guenther@sendmail.com> +.RE .\".if n .pl -(\n(.tu-1i) .rm SH .rn Sh SH diff --git a/upstream/debian-unstable/man5/procmailrc.5 b/upstream/debian-unstable/man5/procmailrc.5 index f6ffc73a..12462601 100644 --- a/upstream/debian-unstable/man5/procmailrc.5 +++ b/upstream/debian-unstable/man5/procmailrc.5 @@ -3,7 +3,7 @@ .ds Rv \\$3 .ds Dt \\$4 .. -.Id $Id$ +.Id $Id: procmailrc.man,v 1.85 2001/08/04 06:08:21 guenther Exp $ .TH PROCMAILRC 5 \*(Dt BuGless .rn SH Sh .de SH @@ -312,12 +312,9 @@ multiple directories to deliver to (procmail will do so utilising hardlinks). .SS "Environment variable defaults" .TP 2.2i -.B "LOGNAME, HOME and USER_SHELL" +.B "LOGNAME, HOME and SHELL" Your (the recipient's) defaults .TP -.B SHELL -\&/bin/sh -.TP .B PATH .na \&$HOME/bin\h'-\w' 'u' :/usr/local/bin\h'-\w' 'u' :/usr/bin\h'-\w' 'u' :/bin @@ -371,7 +368,7 @@ The current hostname (If an rcfile is specified on the command line) .TP .B PROCMAIL_VERSION -\&3.24 +\&3.23pre .TP .B LOCKEXT \&.lock @@ -835,7 +832,7 @@ one trailing newline will be stripped. .PP Some non-optimal and non-obvious regexps set MATCH to an incorrect value. The regexp can be made to work by removing one or more unneeded -\&'*', '+', or '?' operators on the left-hand side of the \e/ token. +\&'*', '+', or '?' operator on the left-hand side of the \e/ token. .SH MISCELLANEOUS If the regular expression contains `\fB^TO_\fP' it will be substituted by .na @@ -916,6 +913,10 @@ Stephen R. van den Berg .RS <srb@cuci.nl> .RE +Philip A. Guenther +.RS +<guenther@sendmail.com> +.RE .\".if n .pl -(\n(.tu-1i) .rm SH .rn Sh SH diff --git a/upstream/debian-unstable/man5/procmailsc.5 b/upstream/debian-unstable/man5/procmailsc.5 index b3127609..40d86fdb 100644 --- a/upstream/debian-unstable/man5/procmailsc.5 +++ b/upstream/debian-unstable/man5/procmailsc.5 @@ -3,7 +3,7 @@ .ds Rv \\$3 .ds Dt \\$4 .. -.Id $Id$ +.Id $Id: procmailsc.man,v 1.15 2001/08/04 06:08:22 guenther Exp $ .TH PROCMAILSC 5 \*(Dt BuGless .rn SH Sh .de SH @@ -311,6 +311,10 @@ Stephen R. van den Berg .RS <srb@cuci.nl> .RE +Philip A. Guenther +.RS +<guenther@sendmail.com> +.RE .\".if n .pl -(\n(.tu-1i) .rm SH .rn Sh SH diff --git a/upstream/debian-unstable/man5/protocols.5 b/upstream/debian-unstable/man5/protocols.5 index 7939407a..39462988 100644 --- a/upstream/debian-unstable/man5/protocols.5 +++ b/upstream/debian-unstable/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 6.8" .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/debian-unstable/man5/pstore.conf.5 b/upstream/debian-unstable/man5/pstore.conf.5 index 247722c9..25858a09 100644 --- a/upstream/debian-unstable/man5/pstore.conf.5 +++ b/upstream/debian-unstable/man5/pstore.conf.5 @@ -1,5 +1,5 @@ '\" t -.TH "PSTORE\&.CONF" "5" "" "systemd 255" "pstore.conf" +.TH "PSTORE\&.CONF" "5" "" "systemd 256~rc3" "pstore.conf" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -23,8 +23,24 @@ pstore.conf, pstore.conf.d \- PStore configuration file .SH "SYNOPSIS" .PP +.RS 4 /etc/systemd/pstore\&.conf -/etc/systemd/pstore\&.conf\&.d/* +.RE +.RS 4 +/run/systemd/pstore\&.conf +.RE +.RS 4 +/usr/lib/systemd/pstore\&.conf +.RE +.RS 4 +/etc/systemd/pstore\&.conf\&.d/*\&.conf +.RE +.RS 4 +/run/systemd/pstore\&.conf\&.d/*\&.conf +.RE +.RS 4 +/usr/lib/systemd/pstore\&.conf\&.d/*\&.conf +.RE .SH "DESCRIPTION" .PP This file configures the behavior of @@ -32,16 +48,16 @@ This file configures the behavior of \m[blue]\fBpstore\fR\m[]\&\s-2\u[1]\d\s+2\&. .SH "CONFIGURATION DIRECTORIES AND PRECEDENCE" .PP -The default configuration is set during compilation, so configuration is only needed when it is necessary to deviate from those defaults\&. The main configuration file is either in -/usr/lib/systemd/ -or -/etc/systemd/ -and contains commented out entries showing the defaults as a guide to the administrator\&. Local overrides can be created by creating drop\-ins, as described below\&. The main configuration file can also be edited for this purpose (or a copy in +The default configuration is set during compilation, so configuration is only needed when it is necessary to deviate from those defaults\&. The main configuration file is loaded from one of the listed directories in order of priority, only the first file found is used: +/etc/systemd/, +/run/systemd/, +/usr/local/lib/systemd/, +/usr/lib/systemd/\&. The vendor version of the file contains commented out entries showing the defaults as a guide to the administrator\&. Local overrides can also be created by creating drop\-ins, as described below\&. The main configuration file can also be edited for this purpose (or a copy in /etc/ -if it\*(Aqs shipped in -/usr/) however using drop\-ins for local configuration is recommended over modifications to the main configuration file\&. +if it\*(Aqs shipped under +/usr/), however using drop\-ins for local configuration is recommended over modifications to the main configuration file\&. .PP -In addition to the "main" configuration file, drop\-in configuration snippets are read from +In addition to the main configuration file, drop\-in configuration snippets are read from /usr/lib/systemd/*\&.conf\&.d/, /usr/local/lib/systemd/*\&.conf\&.d/, and /etc/systemd/*\&.conf\&.d/\&. Those drop\-ins have higher precedence and override the main configuration file\&. Files in the @@ -51,7 +67,12 @@ configuration subdirectories are sorted by their filename in lexicographic order When packages need to customize the configuration, they can install drop\-ins under /usr/\&. Files in /etc/ -are reserved for the local administrator, who may use this logic to override the configuration files installed by vendor packages\&. Drop\-ins have to be used to override package drop\-ins, since the main configuration file has lower precedence\&. It is recommended to prefix all filenames in those subdirectories with a two\-digit number and a dash, to simplify the ordering of the files\&. This also defined a concept of drop\-in priority to allow distributions to ship drop\-ins within a specific range lower than the range used by users\&. This should lower the risk of package drop\-ins overriding accidentally drop\-ins defined by users\&. +are reserved for the local administrator, who may use this logic to override the configuration files installed by vendor packages\&. Drop\-ins have to be used to override package drop\-ins, since the main configuration file has lower precedence\&. It is recommended to prefix all filenames in those subdirectories with a two\-digit number and a dash, to simplify the ordering of the files\&. This also defines a concept of drop\-in priorities to allow OS vendors to ship drop\-ins within a specific range lower than the range used by users\&. This should lower the risk of package drop\-ins overriding accidentally drop\-ins defined by users\&. It is recommended to use the range 10\-40 for drop\-ins in +/usr/ +and the range 60\-90 for drop\-ins in +/etc/ +and +/run/, to make sure that local and transient drop\-ins take priority over drop\-ins shipped by the OS vendor\&. .PP To disable a configuration file supplied by the vendor, the recommended way is to place a symlink to /dev/null diff --git a/upstream/debian-unstable/man5/repart.d.5 b/upstream/debian-unstable/man5/repart.d.5 index 17e247f9..c2f5ff87 100644 --- a/upstream/debian-unstable/man5/repart.d.5 +++ b/upstream/debian-unstable/man5/repart.d.5 @@ -1,5 +1,5 @@ '\" t -.TH "REPART\&.D" "5" "" "systemd 255" "repart.d" +.TH "REPART\&.D" "5" "" "systemd 256~rc3" "repart.d" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -23,12 +23,15 @@ repart.d \- Partition Definition Files for Automatic Boot\-Time Repartitioning .SH "SYNOPSIS" .PP -.nf +.RS 4 /etc/repart\&.d/*\&.conf +.RE +.RS 4 /run/repart\&.d/*\&.conf +.RE +.RS 4 /usr/lib/repart\&.d/*\&.conf - -.fi +.RE .SH "DESCRIPTION" .PP repart\&.d/*\&.conf @@ -366,7 +369,7 @@ too\&. The logic is capable of automatically tracking down the backing partition "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 +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 at 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 @@ -390,7 +393,7 @@ Takes a file system name, such as "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)\&. +"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 at 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 @@ -539,6 +542,21 @@ Note that due to limitations of Added in version 255\&. .RE .PP +\fIDefaultSubvolume=\fR +.RS 4 +Takes an absolute path specifying the default subvolume within the new filesystem\&. Note that this setting does not create the subvolume itself, that can be configured with +\fISubvolumes=\fR\&. +.sp +Note that this option only takes effect if the target filesystem supports subvolumes, such as +"btrfs"\&. +.sp +Note that due to limitations of +"mkfs\&.btrfs", this option is only supported when running with +\fB\-\-offline=no\fR\&. +.sp +Added in version 256\&. +.RE +.PP \fIEncrypt=\fR .RS 4 Takes one of @@ -744,6 +762,41 @@ will have to populate the filesystem twice to guess the minimal required size, s .sp Added in version 253\&. .RE +.PP +\fIMountPoint=\fR +.RS 4 +Specifies where and how the partition should be mounted\&. Takes at least one and at most two fields separated with a colon (":")\&. The first field specifies where the partition should be mounted\&. The second field specifies extra mount options to append to the default mount options\&. These fields correspond to the second and fourth column of the +\fBfstab\fR(5) +format\&. This setting may be specified multiple times to mount the partition multiple times\&. This can be used to add mounts for different btrfs subvolumes located on the same btrfs partition\&. +.sp +Note that this setting is only taken into account when +\fB\-\-generate\-fstab=\fR +is specified on the +\fBsystemd\-repart\fR +command line\&. +.sp +Added in version 256\&. +.RE +.PP +\fIEncryptedVolume=\fR +.RS 4 +Specify how the encrypted partition should be set up\&. Takes at least one and at most three fields separated with a colon (":")\&. The first field specifies the encrypted volume name under +/dev/mapper/\&. If not specified, +"luks\-UUID" +will be used where +"UUID" +is the LUKS UUID\&. The second field specifies the keyfile to use following the same format as specified in crypttab\&. The third field specifies a comma\-delimited list of crypttab options\&. These fields correspond to the first, third and fourth column of the +\fBcrypttab\fR(5) +format\&. +.sp +Note that this setting is only taken into account when +\fB\-\-generate\-crypttab=\fR +is specified on the +\fBsystemd\-repart\fR +command line\&. +.sp +Added in version 256\&. +.RE .SH "SPECIFIERS" .PP Specifiers may be used in the @@ -947,6 +1000,16 @@ The partition number assigned to the partition T} .TE .sp 1 +.SH "ENVIRONMENT" +.PP +Extra filesystem formatting options can be provided using filesystem\-specific environment variables: +\fI$SYSTEMD_REPART_MKFS_OPTIONS_BTRFS\fR, +\fI$SYSTEMD_REPART_MKFS_OPTIONS_XFS\fR, +\fI$SYSTEMD_REPART_MKFS_OPTIONS_VFAT\fR, +\fI$SYSTEMD_REPART_MKFS_OPTIONS_EROFS\fR, and +\fI$SYSTEMD_REPART_MKFS_OPTIONS_SQUASHFS\fR\&. Each variable accepts valid +\fBmkfs\&.\fR\fB\fIfilesystem\fR\fR +command\-line arguments\&. The content of those variables is passed as\-is to the command, without any verification\&. .SH "EXAMPLES" .PP \fBExample\ \&1.\ \&Grow the root partition to the full disk size at first boot\fR @@ -1101,10 +1164,7 @@ VerityMatchKey=root .SH "SEE ALSO" .PP -\fBsystemd\fR(1), -\fBsystemd-repart\fR(8), -\fBsfdisk\fR(8), -\fBsystemd-cryptenroll\fR(1) +\fBsystemd\fR(1), \fBsystemd-repart\fR(8), \fBsfdisk\fR(8), \fBsystemd-cryptenroll\fR(1) .SH "NOTES" .IP " 1." 4 Discoverable Partitions Specification diff --git a/upstream/debian-unstable/man5/repertoiremap.5 b/upstream/debian-unstable/man5/repertoiremap.5 index bf1238d7..cc6b4146 100644 --- a/upstream/debian-unstable/man5/repertoiremap.5 +++ b/upstream/debian-unstable/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 6.8" .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/debian-unstable/man5/resolv.conf.5 b/upstream/debian-unstable/man5/resolv.conf.5 index e2c4070c..1dbccb54 100644 --- a/upstream/debian-unstable/man5/resolv.conf.5 +++ b/upstream/debian-unstable/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 6.8" .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 @@ -375,22 +375,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 @@ -404,5 +404,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/debian-unstable/man5/resolved.conf.5 b/upstream/debian-unstable/man5/resolved.conf.5 index cd0d5721..4979ca77 100644 --- a/upstream/debian-unstable/man5/resolved.conf.5 +++ b/upstream/debian-unstable/man5/resolved.conf.5 @@ -1,5 +1,5 @@ '\" t -.TH "RESOLVED\&.CONF" "5" "" "systemd 255" "resolved.conf" +.TH "RESOLVED\&.CONF" "5" "" "systemd 256~rc3" "resolved.conf" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -23,28 +23,39 @@ resolved.conf, resolved.conf.d \- Network Name Resolution configuration files .SH "SYNOPSIS" .PP +.RS 4 /etc/systemd/resolved\&.conf -.PP +.RE +.RS 4 +/run/systemd/resolved\&.conf +.RE +.RS 4 +/usr/lib/systemd/resolved\&.conf +.RE +.RS 4 /etc/systemd/resolved\&.conf\&.d/*\&.conf -.PP +.RE +.RS 4 /run/systemd/resolved\&.conf\&.d/*\&.conf -.PP +.RE +.RS 4 /usr/lib/systemd/resolved\&.conf\&.d/*\&.conf +.RE .SH "DESCRIPTION" .PP These configuration files control local DNS and LLMNR name resolution\&. .SH "CONFIGURATION DIRECTORIES AND PRECEDENCE" .PP -The default configuration is set during compilation, so configuration is only needed when it is necessary to deviate from those defaults\&. The main configuration file is either in -/usr/lib/systemd/ -or -/etc/systemd/ -and contains commented out entries showing the defaults as a guide to the administrator\&. Local overrides can be created by creating drop\-ins, as described below\&. The main configuration file can also be edited for this purpose (or a copy in +The default configuration is set during compilation, so configuration is only needed when it is necessary to deviate from those defaults\&. The main configuration file is loaded from one of the listed directories in order of priority, only the first file found is used: +/etc/systemd/, +/run/systemd/, +/usr/local/lib/systemd/, +/usr/lib/systemd/\&. The vendor version of the file contains commented out entries showing the defaults as a guide to the administrator\&. Local overrides can also be created by creating drop\-ins, as described below\&. The main configuration file can also be edited for this purpose (or a copy in /etc/ -if it\*(Aqs shipped in -/usr/) however using drop\-ins for local configuration is recommended over modifications to the main configuration file\&. +if it\*(Aqs shipped under +/usr/), however using drop\-ins for local configuration is recommended over modifications to the main configuration file\&. .PP -In addition to the "main" configuration file, drop\-in configuration snippets are read from +In addition to the main configuration file, drop\-in configuration snippets are read from /usr/lib/systemd/*\&.conf\&.d/, /usr/local/lib/systemd/*\&.conf\&.d/, and /etc/systemd/*\&.conf\&.d/\&. Those drop\-ins have higher precedence and override the main configuration file\&. Files in the @@ -54,7 +65,12 @@ configuration subdirectories are sorted by their filename in lexicographic order When packages need to customize the configuration, they can install drop\-ins under /usr/\&. Files in /etc/ -are reserved for the local administrator, who may use this logic to override the configuration files installed by vendor packages\&. Drop\-ins have to be used to override package drop\-ins, since the main configuration file has lower precedence\&. It is recommended to prefix all filenames in those subdirectories with a two\-digit number and a dash, to simplify the ordering of the files\&. This also defined a concept of drop\-in priority to allow distributions to ship drop\-ins within a specific range lower than the range used by users\&. This should lower the risk of package drop\-ins overriding accidentally drop\-ins defined by users\&. +are reserved for the local administrator, who may use this logic to override the configuration files installed by vendor packages\&. Drop\-ins have to be used to override package drop\-ins, since the main configuration file has lower precedence\&. It is recommended to prefix all filenames in those subdirectories with a two\-digit number and a dash, to simplify the ordering of the files\&. This also defines a concept of drop\-in priorities to allow OS vendors to ship drop\-ins within a specific range lower than the range used by users\&. This should lower the risk of package drop\-ins overriding accidentally drop\-ins defined by users\&. It is recommended to use the range 10\-40 for drop\-ins in +/usr/ +and the range 60\-90 for drop\-ins in +/etc/ +and +/run/, to make sure that local and transient drop\-ins take priority over drop\-ins shipped by the OS vendor\&. .PP To disable a configuration file supplied by the vendor, the recommended way is to place a symlink to /dev/null @@ -173,9 +189,7 @@ If set to true, all DNS lookups are DNSSEC\-validated locally (excluding LLMNR a If set to "allow\-downgrade", DNSSEC validation is attempted, but if the server does not support DNSSEC properly, DNSSEC mode is automatically disabled\&. Note that this mode makes DNSSEC validation vulnerable to "downgrade" attacks, where an attacker might be able to trigger a downgrade to non\-DNSSEC mode by synthesizing a DNS response that suggests DNSSEC was not supported\&. .sp -If set to false, DNS lookups are not DNSSEC validated\&. In this mode, or when set to -"allow\-downgrade" -and the downgrade has happened, the resolver becomes security\-unaware and all forwarded queries have DNSSEC OK (DO) bit unset\&. +If set to false, DNS lookups are not DNSSEC validated\&. .sp Note that DNSSEC validation requires retrieval of additional DNS data, and thus results in a small DNS lookup time penalty\&. .sp @@ -366,11 +380,7 @@ Added in version 254\&. .RE .SH "SEE ALSO" .PP -\fBsystemd\fR(1), -\fBsystemd-resolved.service\fR(8), -\fBsystemd-networkd.service\fR(8), -\fBdnssec-trust-anchors.d\fR(5), -\fBresolv.conf\fR(5) +\fBsystemd\fR(1), \fBsystemd-resolved.service\fR(8), \fBsystemd-networkd.service\fR(8), \fBdnssec-trust-anchors.d\fR(5), \fBresolv.conf\fR(5) .SH "NOTES" .IP " 1." 4 RFC 4795 diff --git a/upstream/debian-unstable/man5/rpc.5 b/upstream/debian-unstable/man5/rpc.5 index 4f1fe2c8..27574a3d 100644 --- a/upstream/debian-unstable/man5/rpc.5 +++ b/upstream/debian-unstable/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 6.8" .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/debian-unstable/man5/rsyncd.conf.5 b/upstream/debian-unstable/man5/rsyncd.conf.5 index 249edd46..ce91b49a 100644 --- a/upstream/debian-unstable/man5/rsyncd.conf.5 +++ b/upstream/debian-unstable/man5/rsyncd.conf.5 @@ -1,4 +1,4 @@ -.TH "rsyncd.conf" "5" "20 Oct 2022" "rsyncd.conf from rsync 3.2.7" "User Commands" +.TH "rsyncd.conf" "5" "6 Apr 2024" "rsyncd.conf from rsync 3.3.0" "User Commands" .\" prefix=/usr .P .SH "NAME" @@ -10,7 +10,9 @@ rsyncd.conf \- configuration file for rsync in daemon mode rsyncd.conf .P The online version of this manpage (that includes cross-linking of topics) -is available at https://download.samba.org/pub/rsync/rsyncd.conf.5. +is available at +.UR https://download.samba.org/pub/rsync/rsyncd.conf.5 +.UE . .P .SH "DESCRIPTION" .P @@ -85,25 +87,7 @@ reread the \fBrsyncd.conf\fP file. The file is re-read on each client connection .SH "GLOBAL PARAMETERS" .P The first parameters in the file (before a [module] header) are the global -parameters. Rsync also allows for the use of a "[global]" module name to -indicate the start of one or more global-parameter sections (the name must be -lower case). -.P -You may also include any module parameters in the global part of the config -file in which case the supplied value will override the default for that -parameter. -.P -You may use references to environment variables in the values of parameters. -String parameters will have %VAR% references expanded as late as possible (when -the string is first used in the program), allowing for the use of variables -that rsync sets at connection time, such as RSYNC_USER_NAME. Non-string -parameters (such as true/false settings) are expanded when read from the config -file. If a variable does not exist in the environment, or if a sequence of -characters is not a valid reference (such as an un-paired percent sign), the -raw characters are passed through unchanged. This helps with backward -compatibility and safety (e.g. expanding a non-existent %VAR% to an empty -string in a path could result in a very unsafe path). The safest way to insert -a literal % into a value is to use %%. +parameters: .P .IP "\fBmotd\ file\fP" This parameter allows you to specify a "message of the day" (MOTD) to display @@ -136,6 +120,22 @@ can also be specified via the \fB\-\-sockopts\fP command-line option. You can override the default backlog value when the daemon listens for connections. It defaults to 5. .P +You may also include any MODULE PARAMETERS in the global part of the +config file, in which case the supplied value will override the default for +that parameter. +.P +You may use references to environment variables in the values of parameters. +String parameters will have %VAR% references expanded as late as possible (when +the string is first used in the program), allowing for the use of variables +that rsync sets at connection time, such as RSYNC_USER_NAME. Non-string +parameters (such as true/false settings) are expanded when read from the config +file. If a variable does not exist in the environment, or if a sequence of +characters is not a valid reference (such as an un-paired percent sign), the +raw characters are passed through unchanged. This helps with backward +compatibility and safety (e.g. expanding a non-existent %VAR% to an empty +string in a path could result in a very unsafe path). The safest way to insert +a literal % into a value is to use %%. +.P .SH "MODULE PARAMETERS" .P After the global parameters you should define a number of modules, each module @@ -144,11 +144,17 @@ a module name in square brackets [module] followed by the parameters for that module. The module name cannot contain a slash or a closing square bracket. If the name contains whitespace, each internal sequence of whitespace will be changed into a single space, while leading or trailing whitespace will be -discarded. Also, the name cannot be "global" as that exact name indicates that -global parameters follow (see above). +discarded. +.P +There is also a special module name of "[global]" that does not define a module +but instead switches back to the global settings context where default +parameters can be specified. Because each defined module gets its full set of +parameters as a combination of the default values that are set at that position +in the config file plus its own parameter list, the use of a "[global]" section +can help to maintain shared config values for multiple modules. .P -As with GLOBAL PARAMETERS, you may use references to environment variables in -the values of parameters. See the GLOBAL PARAMETERS section for more details. +As with GLOBAL PARAMETERS, you may use references to environment variables +in the values of parameters. See that section for details. .P .IP "\fBcomment\fP" This parameter specifies a description string that is displayed next to the @@ -1021,7 +1027,7 @@ before it begins. Any output from the \fBpre-xfer\ exec\fP command on stdout \fInot\fP displayed if the script returns success. The other programs cannot send any text to the user. All output except for the \fBpre-xfer\ exec\fP stdout goes to the corresponding daemon's stdout/stderr, which is typically -discarded. See the \fB\-\-no-detatch\fP option for a way to see the daemon's +discarded. See the \fB\-\-no-detach\fP option for a way to see the daemon's output, which can assist with debugging. .IP Note that the \fBearly\ exec\fP command runs before any part of the transfer @@ -1284,19 +1290,25 @@ susan:herpass .SH "BUGS" .P Please report bugs! The rsync bug tracking system is online at -https://rsync.samba.org/. +.UR https://rsync.samba.org/ +.UE . .P .SH "VERSION" .P -This manpage is current for version 3.2.7 of rsync. +This manpage is current for version 3.3.0 of rsync. .P .SH "CREDITS" .P Rsync is distributed under the GNU General Public License. See the file COPYING for details. .P -An rsync web site is available at https://rsync.samba.org/ and its github -project is https://github.com/WayneD/rsync. +An rsync web site is available at +.UR https://rsync.samba.org/ +.UE +and its github +project is +.UR https://github.com/WayneD/rsync +.UE . .P .SH "THANKS" .P @@ -1310,4 +1322,5 @@ people have later contributed to it. It is currently maintained by Wayne Davison. .P Mailing lists for support and development are available at -https://lists.samba.org/. +.UR https://lists.samba.org/ +.UE . diff --git a/upstream/debian-unstable/man5/sane-apple.5 b/upstream/debian-unstable/man5/sane-apple.5 index 513723b7..a7f5fb63 100644 --- a/upstream/debian-unstable/man5/sane-apple.5 +++ b/upstream/debian-unstable/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/debian-unstable/man5/sane-artec_eplus48u.5 b/upstream/debian-unstable/man5/sane-artec_eplus48u.5 index 32745ead..37150b36 100644 --- a/upstream/debian-unstable/man5/sane-artec_eplus48u.5 +++ b/upstream/debian-unstable/man5/sane-artec_eplus48u.5 @@ -49,7 +49,9 @@ find the firmware file under c:\\windows\\system32\\drivers. .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 @@ -58,7 +60,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/debian-unstable/man5/sane-bh.5 b/upstream/debian-unstable/man5/sane-bh.5 index b57dd951..72785c67 100644 --- a/upstream/debian-unstable/man5/sane-bh.5 +++ b/upstream/debian-unstable/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/debian-unstable/man5/sane-canon_pp.5 b/upstream/debian-unstable/man5/sane-canon_pp.5 index af864f2e..8882cf7e 100644 --- a/upstream/debian-unstable/man5/sane-canon_pp.5 +++ b/upstream/debian-unstable/man5/sane-canon_pp.5 @@ -68,30 +68,28 @@ The supported options are currently and .BR force_nibble -Option -.B ieee1284 -.IR port-name -defines which port to use. The format of port-name is OS dependent, based on -the names presented by libieee1284. Please only have one of these lines, or +.TP +.B ieee1284 port-name +Defines which port to use. The format of port-name is OS dependent, based on +the names presented by +.BR libieee1284 (3). +Please only have one of these lines, or all but one will be ignored. -Option -.B calibrate -.IR cal-file -.IR [port-name] -defines which calibration file to use on a per-port basis. If you only have +.TP +.B calibrate cal-file [port-name] +Defines which calibration file to use on a per-port basis. If you only have one parport, the port-name argument may be omitted \- but be careful as this will cause problems on multi-scanner systems. You may have as many of these lines as you like, as long as each has a unique port name. The tilde (`~') -character is acceptable and will be expanded to the value of the HOME -environment. +character is acceptable and will be expanded to the value of the +.B HOME +environment variable. -Option -.B init_mode -.IR <AUTO|FB620P|FB630P> -.IR [portname] -defines which initialisation (wake-up) mode to use on a per-port basis. -If you only have one parport, the portname argument may be omitted \- but +.TP +.B init_mode <AUTO|FB620P|FB630P> [port-name] +Defines which initialisation (wake-up) mode to use on a per-port basis. +If you only have one parport, the port-name argument may be omitted \- but be careful as this may cause problems on multi-scanner systems. You may have as many of these lines as you like, as long as each has a unique port name. The valid initialisation modes are FB620P (which strobes 10101010 @@ -100,10 +98,11 @@ on the data pins) and AUTO, which will try FB630P mode first then FB620P mode second. The FB620P mode is also used by the FB320P. The FB630P mode is used by the FB330P, N340P, and N640P. -Option +.TP .B force_nibble -forces the driver to use nibble mode even if ECP mode is reported to work by -libieee1284. This works-around the rare issue of ECP mode being reported to +Forces the driver to use nibble mode even if ECP mode is reported to work by +.BR libieee1284 (3). +This works-around the rare issue of ECP mode being reported to work by the library, then not working. .SH TIPS @@ -174,7 +173,9 @@ one returned during calibration) will be loaded. .PP .B Communication Problems .PP -ECP mode in libieee1284 doesn't always work properly, even with new hardware. +ECP mode in +.BR libieee1284 (3) +doesn't always work properly, even with new hardware. We believe that this is a ppdev problem. If you change the configuration file to include .B force_nibble diff --git a/upstream/debian-unstable/man5/sane-coolscan2.5 b/upstream/debian-unstable/man5/sane-coolscan2.5 index 4274f1ec..9e423754 100644 --- a/upstream/debian-unstable/man5/sane-coolscan2.5 +++ b/upstream/debian-unstable/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/debian-unstable/man5/sane-coolscan3.5 b/upstream/debian-unstable/man5/sane-coolscan3.5 index ebcfbe45..dccf3ffe 100644 --- a/upstream/debian-unstable/man5/sane-coolscan3.5 +++ b/upstream/debian-unstable/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/debian-unstable/man5/sane-dmc.5 b/upstream/debian-unstable/man5/sane-dmc.5 index 2b5b2958..224995cc 100644 --- a/upstream/debian-unstable/man5/sane-dmc.5 +++ b/upstream/debian-unstable/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/debian-unstable/man5/sane-epjitsu.5 b/upstream/debian-unstable/man5/sane-epjitsu.5 index 7eb345bd..7b462166 100644 --- a/upstream/debian-unstable/man5/sane-epjitsu.5 +++ b/upstream/debian-unstable/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/debian-unstable/man5/sane-epson.5 b/upstream/debian-unstable/man5/sane-epson.5 index 30b1b65d..e4dc3c51 100644 --- a/upstream/debian-unstable/man5/sane-epson.5 +++ b/upstream/debian-unstable/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/debian-unstable/man5/sane-epson2.5 b/upstream/debian-unstable/man5/sane-epson2.5 index f6ad0f1a..7bef4ec3 100644 --- a/upstream/debian-unstable/man5/sane-epson2.5 +++ b/upstream/debian-unstable/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/debian-unstable/man5/sane-fujitsu.5 b/upstream/debian-unstable/man5/sane-fujitsu.5 index 34864cb6..3885cde2 100644 --- a/upstream/debian-unstable/man5/sane-fujitsu.5 +++ b/upstream/debian-unstable/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/debian-unstable/man5/sane-genesys.5 b/upstream/debian-unstable/man5/sane-genesys.5 index 71591ac9..f3720463 100644 --- a/upstream/debian-unstable/man5/sane-genesys.5 +++ b/upstream/debian-unstable/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/debian-unstable/man5/sane-gphoto2.5 b/upstream/debian-unstable/man5/sane-gphoto2.5 index 7fd16d69..faaa8416 100644 --- a/upstream/debian-unstable/man5/sane-gphoto2.5 +++ b/upstream/debian-unstable/man5/sane-gphoto2.5 @@ -32,7 +32,7 @@ through the gphoto2 interface. Valid ports and cameras can be obtained by .I "gphoto2 \-\-list\-cameras" and -.I "gphoto2 \-\-list\-ports". +.IR "gphoto2 \-\-list\-ports" . .PP The .B dumpinquiry @@ -122,9 +122,9 @@ Set to 1, 2, or 3, to enable various levels of debugging within the gphoto2 libraries. .SH "SEE ALSO" -.BR sane (7) , -.BR scanimage (1) , -.BR xscanimage (1) , +.BR sane (7), +.BR scanimage (1), +.BR xscanimage (1), .BR libgphoto2 (3) .SH AUTHOR diff --git a/upstream/debian-unstable/man5/sane-hp.5 b/upstream/debian-unstable/man5/sane-hp.5 index d8182d2d..a913bb5a 100644 --- a/upstream/debian-unstable/man5/sane-hp.5 +++ b/upstream/debian-unstable/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/debian-unstable/man5/sane-hp5590.5 b/upstream/debian-unstable/man5/sane-hp5590.5 index ae8a8877..0ec4a834 100644 --- a/upstream/debian-unstable/man5/sane-hp5590.5 +++ b/upstream/debian-unstable/man5/sane-hp5590.5 @@ -45,7 +45,7 @@ or Valid command line options and their syntax can be listed by using: .IP .nf -\f[C] +\f[I] scanimage --help -d hp5590:interface:device \f[R] .fi @@ -63,7 +63,7 @@ on the first scanner identified. Use the command: .IP .nf -\f[C] +\f[I] scanimage -L \f[R] .fi @@ -255,7 +255,7 @@ to be included in .I hp5590.conf .IP .nf -\f[C] +\f[I] device hp5590 { # Device matching filter = \[dq]\[ha]hp5590.*\[dq] @@ -285,7 +285,7 @@ device hp5590 { \f[B]scan_action.script\f[R] .IP .nf -\f[C] +\f[I] #!/bin/bash echo device = $SCANBD_DEVICE echo action = $SCANBD_ACTION @@ -319,7 +319,7 @@ variable controls the debug level for this backend. Higher debug levels increase the verbosity of the output: .IP .nf -\f[C] +\f[I] 10 - generic processing 20 - verbose backend messages 40 - HP5590 high-level commands diff --git a/upstream/debian-unstable/man5/sane-lexmark_x2600.5 b/upstream/debian-unstable/man5/sane-lexmark_x2600.5 new file mode 100644 index 00000000..3be075f0 --- /dev/null +++ b/upstream/debian-unstable/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/lib/x86_64-linux-gnu/sane/libsane\-lexmark_x2600.a +The static library implementing this backend. +.TP +.I /usr/lib/x86_64-linux-gnu/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/debian-unstable/man5/sane-matsushita.5 b/upstream/debian-unstable/man5/sane-matsushita.5 index 4d92913c..877f4254 100644 --- a/upstream/debian-unstable/man5/sane-matsushita.5 +++ b/upstream/debian-unstable/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/debian-unstable/man5/sane-microtek.5 b/upstream/debian-unstable/man5/sane-microtek.5 index 5638b970..d373a3d3 100644 --- a/upstream/debian-unstable/man5/sane-microtek.5 +++ b/upstream/debian-unstable/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/debian-unstable/man5/sane-microtek2.5 b/upstream/debian-unstable/man5/sane-microtek2.5 index 4ebccfb6..fadf00d5 100644 --- a/upstream/debian-unstable/man5/sane-microtek2.5 +++ b/upstream/debian-unstable/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/debian-unstable/man5/sane-mustek.5 b/upstream/debian-unstable/man5/sane-mustek.5 index 53c49161..94991eab 100644 --- a/upstream/debian-unstable/man5/sane-mustek.5 +++ b/upstream/debian-unstable/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/debian-unstable/man5/sane-mustek_pp.5 b/upstream/debian-unstable/man5/sane-mustek_pp.5 index 156c96c7..50cd9a67 100644 --- a/upstream/debian-unstable/man5/sane-mustek_pp.5 +++ b/upstream/debian-unstable/man5/sane-mustek_pp.5 @@ -100,7 +100,7 @@ Note that the backend needs to run as root or has to have appropriate access rights to .I /dev/parport* if libieee1284 support is compiled in. To allow user -access to the scanner run the backend through the network interface (See +access to the scanner run the backend through the network interface (see .BR saned (8) and .BR sane\-net (5)). @@ -109,15 +109,12 @@ Note also that the backend support .IR "parport sharing" , i.e. if you try printing while scanning, your computer may crash. To enable -parport sharing, you have to enable libieee1284 at compile time. This backend -also conflicts with the -.BR sane\-musteka4s2 (5) -backend. You can only enable one of them in your +parport sharing, you have to enable +.BR libieee1284 (3) +at compile time. +You may also have to enable the backend explicitly in your .IR dll.conf . -However, you have -to enable the backend explicitly in your -.IR dll.conf , -just remove the hash mark in the line "mustek_pp". +Just remove the hash mark in the line "mustek_pp". .SH "DEVICE DEFINITION" This backend allows multiple devices being defined and configured via the diff --git a/upstream/debian-unstable/man5/sane-mustek_usb.5 b/upstream/debian-unstable/man5/sane-mustek_usb.5 index 8d24accb..c0d9114f 100644 --- a/upstream/debian-unstable/man5/sane-mustek_usb.5 +++ b/upstream/debian-unstable/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/debian-unstable/man5/sane-net.5 b/upstream/debian-unstable/man5/sane-net.5 index e882b166..369b43d0 100644 --- a/upstream/debian-unstable/man5/sane-net.5 +++ b/upstream/debian-unstable/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/debian-unstable/man5/sane-p5.5 b/upstream/debian-unstable/man5/sane-p5.5 index d40ca453..b5c4b1a7 100644 --- a/upstream/debian-unstable/man5/sane-p5.5 +++ b/upstream/debian-unstable/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/debian-unstable/man5/sane-pixma.5 b/upstream/debian-unstable/man5/sane-pixma.5 index d962a6a8..25caa21a 100644 --- a/upstream/debian-unstable/man5/sane-pixma.5 +++ b/upstream/debian-unstable/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/debian-unstable/man5/sane-plustek.5 b/upstream/debian-unstable/man5/sane-plustek.5 index 8deef10a..cf4953cc 100644 --- a/upstream/debian-unstable/man5/sane-plustek.5 +++ b/upstream/debian-unstable/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/debian-unstable/man5/sane-plustek_pp.5 b/upstream/debian-unstable/man5/sane-plustek_pp.5 index 955c4ebd..bd3b2734 100644 --- a/upstream/debian-unstable/man5/sane-plustek_pp.5 +++ b/upstream/debian-unstable/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/debian-unstable/man5/sane-scsi.5 b/upstream/debian-unstable/man5/sane-scsi.5 index 01f00f7d..87894ae1 100644 --- a/upstream/debian-unstable/man5/sane-scsi.5 +++ b/upstream/debian-unstable/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/debian-unstable/man5/sane-sharp.5 b/upstream/debian-unstable/man5/sane-sharp.5 index 1235ea99..e0706d4c 100644 --- a/upstream/debian-unstable/man5/sane-sharp.5 +++ b/upstream/debian-unstable/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/debian-unstable/man5/sane-stv680.5 b/upstream/debian-unstable/man5/sane-stv680.5 index 514b4ce1..ccd8c64e 100644 --- a/upstream/debian-unstable/man5/sane-stv680.5 +++ b/upstream/debian-unstable/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/debian-unstable/man5/sane-teco2.5 b/upstream/debian-unstable/man5/sane-teco2.5 index 5bf3ef8f..fdf81024 100644 --- a/upstream/debian-unstable/man5/sane-teco2.5 +++ b/upstream/debian-unstable/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/debian-unstable/man5/sane-test.5 b/upstream/debian-unstable/man5/sane-test.5 index a03fdc54..a911f917 100644 --- a/upstream/debian-unstable/man5/sane-test.5 +++ b/upstream/debian-unstable/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/debian-unstable/man5/sane-u12.5 b/upstream/debian-unstable/man5/sane-u12.5 index cfc725fa..5f3230b8 100644 --- a/upstream/debian-unstable/man5/sane-u12.5 +++ b/upstream/debian-unstable/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/debian-unstable/man5/sane-umax_pp.5 b/upstream/debian-unstable/man5/sane-umax_pp.5 index 76c72a67..68e6aa8f 100644 --- a/upstream/debian-unstable/man5/sane-umax_pp.5 +++ b/upstream/debian-unstable/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/debian-unstable/man5/sane-usb.5 b/upstream/debian-unstable/man5/sane-usb.5 index 69083321..40e5f5fc 100644 --- a/upstream/debian-unstable/man5/sane-usb.5 +++ b/upstream/debian-unstable/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/debian-unstable/man5/scr_dump.5 b/upstream/debian-unstable/man5/scr_dump.5 index c766b94d..b1f9a2e3 100644 --- a/upstream/debian-unstable/man5/scr_dump.5 +++ b/upstream/debian-unstable/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/debian-unstable/man5/securetty.5 b/upstream/debian-unstable/man5/securetty.5 index a32db97d..e81a54d2 100644 --- a/upstream/debian-unstable/man5/securetty.5 +++ b/upstream/debian-unstable/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 6.8" .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/debian-unstable/man5/services.5 b/upstream/debian-unstable/man5/services.5 index 5003f615..b1dd52ce 100644 --- a/upstream/debian-unstable/man5/services.5 +++ b/upstream/debian-unstable/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 6.8" .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/debian-unstable/man5/shells.5 b/upstream/debian-unstable/man5/shells.5 index fcbbd22e..7518b534 100644 --- a/upstream/debian-unstable/man5/shells.5 +++ b/upstream/debian-unstable/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 6.8" .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/debian-unstable/man5/slabinfo.5 b/upstream/debian-unstable/man5/slabinfo.5 index e27ff80f..1055dc08 100644 --- a/upstream/debian-unstable/man5/slabinfo.5 +++ b/upstream/debian-unstable/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 6.8" .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/debian-unstable/man5/smb.conf.5 b/upstream/debian-unstable/man5/smb.conf.5 index ef2ab3d2..c54f7bd1 100644 --- a/upstream/debian-unstable/man5/smb.conf.5 +++ b/upstream/debian-unstable/man5/smb.conf.5 @@ -2,12 +2,12 @@ .\" Title: smb.conf .\" Author: [see the "AUTHOR" section] .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> -.\" Date: 02/19/2024 +.\" Date: 05/29/2024 .\" Manual: File Formats and Conventions -.\" Source: Samba 4.19.5-Debian +.\" Source: Samba 4.20.1-Debian .\" Language: English .\" -.TH "SMB\&.CONF" "5" "02/19/2024" "Samba 4\&.19\&.5\-Debian" "File Formats and Conventions" +.TH "SMB\&.CONF" "5" "05/29/2024" "Samba 4\&.20\&.1\-Debian" "File Formats and Conventions" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -605,7 +605,7 @@ The options are: .PP case sensitive = yes/no/auto .RS 4 -controls whether filenames are case sensitive\&. If they aren\*(Aqt, Samba must do a filename search and match on passed names\&. The default setting of auto allows clients that support case sensitive filenames (Linux CIFSVFS and smbclient 3\&.0\&.5 and above currently) to tell the Samba server on a per\-packet basis that they wish to access the file system in a case\-sensitive manner (to support UNIX case sensitive semantics)\&. No Windows or DOS system supports case\-sensitive filename so setting this option to auto is that same as setting it to no for them\&. Default +controls whether filenames are case sensitive\&. If they aren\*(Aqt, Samba must do a filename search and match on passed names\&. The default setting of auto allows clients that support case sensitive filenames (Linux CIFSVFS and smbclient 3\&.0\&.5 and above currently) to tell the Samba server on a per\-packet basis that they wish to access the file system in a case\-sensitive manner (to support UNIX case sensitive semantics)\&. No Windows or DOS system supports case\-sensitive filename so setting this option to auto is the same as setting it to no for them\&. Default \fIauto\fR\&. .RE .PP @@ -813,6 +813,46 @@ Default: \fI\fIacl check permissions\fR\fR\fI = \fR\fIyes\fR\fI \fR .RE +acl claims evaluation (G) +.PP +.RS 4 +This option controls the way Samba handles evaluation of security descriptors in Samba, with regards to Active Directory Claims\&. AD Claims, introduced with Windows 2012, are essentially administrator\-defined key\-value pairs that can be set both in Active Directory (communicated via the Kerberos PAC) and in the security descriptor themselves\&. +.sp +Active Directory claims are new with Samba 4\&.20\&. Because the claims are evaluated against a very flexible expression language within the security descriptor, this option provides a mechanism to disable this logic if required by the administrator\&. +.sp +This default behaviour is that claims evaluation is enabled in the AD DC only\&. Additionally, claims evaluation on the AD DC is only enabled if the DC functional level is 2012 or later\&. See +\m[blue]\fBad dc functional level\fR\m[]\&. +.sp +Possible values are : +.RS +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fBAD DC only\fR: Enabled for the Samba AD DC (for DC functional level 2012 or higher)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fBnever\fR: Disabled in all cases\&. This option disables some but not all of the Authentication Policies and Authentication Policy Silos features of the Windows 2012R2 functional level in the AD DC\&. +.RE +.sp +.RE +Default: +\fI\fIacl claims evaluation\fR\fR\fI = \fR\fIAD DC only\fR\fI \fR +.RE + acl flag inherited canonicalization (S) .PP .RS 4 @@ -821,7 +861,7 @@ This option controls the way Samba handles client requests setting the Security On the other hand when a Security Descriptor is explicitly set on a file, the DI flag is cleared, unless the flag "DACL Inheritance Required" (DR) is also set in the new Security Descriptor (fwiw, DR is never stored on disk)\&. .sp This is the default behaviour when this option is enabled (the default)\&. When setting this option to -no, the resulting value of the DI flag on\-disk is directly taken from the DI value of the to\-be\-set Security Descriptor\&. This can be used so dump tools like rsync that copy data blobs from xattrs that represent ACLs created by the acl_xattr VFS module will result in copies of the ACL that are identical to the source\&. Without this option, the copied ACLs would all loose the DI flag if set on the source\&. +no, the resulting value of the DI flag on\-disk is directly taken from the DI value of the to\-be\-set Security Descriptor\&. This can be used so dump tools like rsync that copy data blobs from xattrs that represent ACLs created by the acl_xattr VFS module will result in copies of the ACL that are identical to the source\&. Without this option, the copied ACLs would all lose the DI flag if set on the source\&. .sp Default: \fI\fIacl flag inherited canonicalization\fR\fR\fI = \fR\fIyes\fR\fI \fR @@ -2810,7 +2850,7 @@ Possible option settings are: .IP \(bu 2.3 .\} \fIrequired\fR -\- Kerberos authentication will be required\&. There will be no falllback to NTLM or a different alternative\&. +\- Kerberos authentication will be required\&. There will be no fallback to NTLM or a different alternative\&. .RE .sp .RS 4 @@ -9190,7 +9230,7 @@ will attempt to authenticate users using the NTLM encrypted password response fo .sp If disabled, both NTLM and LanMan authentication against the local passdb is disabled\&. .sp -Note that these settings apply only to local users, authentication will still be forwarded to and NTLM authentication accepted against any domain we are joined to, and any trusted domain, even if disabled or if NTLMv2\-only is enforced here\&. To control NTLM authentiation for domain users, this must option must be configured on each DC\&. +Note that these settings apply only to local users, authentication will still be forwarded to and NTLM authentication accepted against any domain we are joined to, and any trusted domain, even if disabled or if NTLMv2\-only is enforced here\&. To control NTLM authentication for domain users, this option must be configured on each DC\&. .sp By default with ntlm auth @@ -9215,7 +9255,7 @@ The available settings are: (alias \fByes\fR) \- Allow NTLMv1 and above for all clients\&. .sp -This is the required setting for to enable the +This is the required setting to enable the \fIlanman auth\fR parameter\&. .RE @@ -12349,10 +12389,204 @@ Default: \fI\fIsmb2 max write\fR\fR\fI = \fR\fI8388608\fR\fI \fR .RE -smb3 unix extensions (G) +smb3 share cap:CONTINUOUS AVAILABILITY (S) +.PP +.RS 4 +The SMB3 protocol introduced the SMB2_SHARE_CAP_CONTINUOUS_AVAILABILITY flag\&. It means clients can have different expectations from the server (or cluster of servers)\&. +.sp +Note: this option only applies to disk shares\&. +.sp +In a ctdb cluster shares are continuously available, but windows clients mix this with the global persistent handles support\&. +.sp +Persistent handles are requested if SMB2_SHARE_CAP_CONTINUOUS_AVAILABILITY is present even without SMB2_CAP_PERSISTENT_HANDLES\&. +.sp +And SMB2_SHARE_CAP_CONTINUOUS_AVAILABILITY is required for SMB2_SHARE_CAP_CLUSTER to have an effect\&. +.sp +So we better don\*(Aqt announce this by default until we support persistent handles\&. +.sp +The +\m[blue]\fBsmb3 share cap:CONTINUOUS AVAILABILITY\fR\m[] +option can be used to force the announcement of SMB2_SHARE_CAP_CONTINUOUS_AVAILABILITY\&. +.sp +Warning: only use this if you know what you are doing! +.sp +.if n \{\ +.RS 4 +.\} +.nf + smb3 share cap:CONTINUOUS AVAILABILITY = yes + +.fi +.if n \{\ +.RE +.\} +.sp +\fINo default\fR +.RE + +smb3 share cap:SCALE OUT (S) +.PP +.RS 4 +The SMB3 protocol introduced the SMB2_SHARE_CAP_SCALEOUT flag\&. It means clients can have different expectations from cluster of multiple servers and alters the retry/reconnect behavior\&. +.sp +Note: this option only applies to disk shares\&. +.sp +In a ctdb cluster we have multiple active nodes, so we announce SMB2_SHARE_CAP_SCALEOUT in a cluster\&. +.sp +The +\m[blue]\fBsmb3 share cap:SCALE OUT\fR\m[] +option can be used to disable the announcement of SMB2_SHARE_CAP_SCALEOUT, even if +\m[blue]\fBclustering\fR\m[] +is yes\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf + clustering = yes + smb3 share cap: SCALE OUT = no + +.fi +.if n \{\ +.RE +.\} +.sp +\fINo default\fR +.RE + +smb3 share cap:CLUSTER (S) +.PP +.RS 4 +The SMB3 protocol introduced the SMB2_SHARE_CAP_CLUSTER flag\&. It means clients can expect that all cluster nodes provide a witness service in order to use the [MS\-SWN] protocol to monitor the server cluster\&. +.sp +Note: this option only applies to disk shares\&. +.sp +rpcd_witness is only active if +\fBsamba-dcerpcd\fR(8) +is not started as on demand helper and only in a ctdb cluster\&. +.sp +So we announce SMB2_SHARE_CAP_CLUSTER only if +\m[blue]\fBclustering\fR\m[] +is yes and +\m[blue]\fBrpc start on demand helpers\fR\m[] +is no\&. +.sp +The +\m[blue]\fBsmb3 share cap:SCALE OUT\fR\m[] +option can be used to control the announcement of SMB2_SHARE_CAP_CLUSTER independent of +\m[blue]\fBclustering\fR\m[] +and +\m[blue]\fBrpc start on demand helpers\fR\m[]\&. +.sp +Example to disable the announcement of SMB2_SHARE_CAP_CLUSTER: +.sp +.if n \{\ +.RS 4 +.\} +.nf + clustering = yes + rpc start on demand helpers = no + smb3 share cap: CLUSTER = no + +.fi +.if n \{\ +.RE +.\} +.sp +Example to force the announcement of SMB2_SHARE_CAP_CLUSTER: +.sp +.if n \{\ +.RS 4 +.\} +.nf + smb3 share cap: CLUSTER = yes + +.fi +.if n \{\ +.RE +.\} +.sp +Example to let Windows clients use the witness service, see +\m[blue]\fBsmb3 share cap:CONTINUOUS AVAILABILITY\fR\m[] +option and USE AT YOUR OWN RISK!: +.sp +.if n \{\ +.RS 4 +.\} +.nf + clustering = yes + rpc start on demand helpers = no + # This is the default with the above: + # smb3 share cap: CLUSTER = yes + # + # Use at you own risk! + smb3 share cap: CONTINUOUS AVAILABILITY = yes + +.fi +.if n \{\ +.RE +.\} +.sp +\fINo default\fR +.RE + +smb3 share cap:ASYMMETRIC (S) .PP .RS 4 -Incomplete SMB 3\&.11 Unix Extensions\&. This is only available if Samba is compiled in DEVELOPER mode\&. +The SMB3_02 protocol introduced the SMB2_SHARE_CAP_ASYMMETRIC flag\&. It means clients alters its behavior and uses isolated transport connections and witness registrations for the share\&. It means a client may connect to different cluster nodes for individual shares and +net witness share\-move +can be used to control the node usage\&. +.sp +Note: this option only applies to disk shares\&. +.sp +Shares in a ctdb cluster are symmetric by design, so we don\*(Aqt announce SMB2_SHARE_CAP_ASYMMETRIC by default\&. +.sp +The +\m[blue]\fBsmb3 share cap:ASYMMETRIC\fR\m[] +option can be used to force the announcement of SMB2_SHARE_CAP_ASYMMETRIC\&. +.sp +Example to force the announcement of SMB2_SHARE_CAP_ASYMMETRIC: +.sp +.if n \{\ +.RS 4 +.\} +.nf + smb3 share cap: ASYMMETRIC = yes + +.fi +.if n \{\ +.RE +.\} +.sp +Example to let Windows clients use the witness service, see +\m[blue]\fBsmb3 share cap:CONTINUOUS AVAILABILITY\fR\m[] +option and USE AT YOUR OWN RISK!: +.sp +.if n \{\ +.RS 4 +.\} +.nf + clustering = yes + rpc start on demand helpers = no + # This is the default with the above: + # smb3 share cap: CLUSTER = yes + # + # Use at you own risk! + smb3 share cap: CONTINUOUS AVAILABILITY = yes + smb3 share cap: ASYMMETRIC = yes + +.fi +.if n \{\ +.RE +.\} +.sp +\fINo default\fR +.RE + +smb3 unix extensions (S) +.PP +.RS 4 +Experimental SMB 3\&.1\&.1 Unix Extensions\&. .sp Default: \fI\fIsmb3 unix extensions\fR\fR\fI = \fR\fIno\fR\fI \fR @@ -14061,7 +14295,7 @@ winbind max domain connections (G) .RS 4 This parameter specifies the maximum number of simultaneous connections that the \fBwinbindd\fR(8) -daemon should open to the domain controller of one domain\&. Setting this parameter to a value greater than 1 can improve scalability with many simultaneous winbind requests, some of which might be slow\&. +daemon should open to the domain controller of one domain\&. Setting this parameter to a value greater than 1 can improve scalability with many simultaneous winbind requests, some of which might be slow\&. Changing this value requires a restart of winbindd\&. .sp Note that if \m[blue]\fBwinbind offline logon\fR\m[] @@ -14591,6 +14825,62 @@ Default: \fI\fIwrite raw\fR\fR\fI = \fR\fIyes\fR\fI \fR .RE +wsp property file (G) +.PP +.RS 4 +\m[blue]\fBwsp property file\fR\m[] +parameter\&. This parameter specifies the file where additional WSP Windows Search Protocol properties are stored\&. The format of the file is a csv consisting of 10 comma separated columns\&. The first 3 columns are required, the other columns are desirable but not necessary\&. +.PP +Property Name +.RS 4 +A property name e\&.g\&. System\&.ItemUrl\&. +.RE +.PP +GUID +.RS 4 +A guid that identifies the propertyset the property belongs to\&. +.RE +.PP +prop ID +.RS 4 +A number that together with the GUID uniquely identifies the property\&. +.RE +.PP +inInverted Index +.RS 4 +Set to TRUE is the property is indexed\&. +.RE +.PP +isColumn +.RS 4 +Set to TRUE if the property is one that can be returned in rows returned from WSP query\&. +.RE +.PP +type +.RS 4 +One of +\fIBoolean\fR,\fIBuffer\fR,\fIByte\fR,\fIDateTime\fR,\fIDouble\fR,\fIInt32\fR,\fIString\fR,\fIUInt16\fR,\fIUInt32\fR,\fIUInt64\fR +.RE +.PP +MaxSize +.RS 4 +maximum size when stored\&. +.RE +.PP +Vector Property +.RS 4 +TRUE if this is a multivalue property\&. +.RE +.PP +Description +.RS 4 +Description of what the property is used for\&. +.RE +.sp +Default: +\fI\fIwsp property file\fR\fR\fI = \fR\fI\fR\fI \fR +.RE + wtmp directory (G) .PP .RS 4 @@ -14622,7 +14912,7 @@ and special sections make life for an administrator easy, but the various combinations of default attributes can be tricky\&. Take extreme care when designing these sections\&. In particular, ensure that the permissions on spool directories are correct\&. .SH "VERSION" .PP -This man page is part of version 4\&.19\&.5\-Debian of the Samba suite\&. +This man page is part of version 4\&.20\&.1\-Debian of the Samba suite\&. .SH "SEE ALSO" .PP \fBsamba\fR(7), diff --git a/upstream/debian-unstable/man5/smbpasswd.5 b/upstream/debian-unstable/man5/smbpasswd.5 index 39388a30..e559b627 100644 --- a/upstream/debian-unstable/man5/smbpasswd.5 +++ b/upstream/debian-unstable/man5/smbpasswd.5 @@ -2,12 +2,12 @@ .\" Title: smbpasswd .\" Author: [see the "AUTHOR" section] .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> -.\" Date: 02/19/2024 +.\" Date: 05/29/2024 .\" Manual: File Formats and Conventions -.\" Source: Samba 4.19.5-Debian +.\" Source: Samba 4.20.1-Debian .\" Language: English .\" -.TH "SMBPASSWD" "5" "02/19/2024" "Samba 4\&.19\&.5\-Debian" "File Formats and Conventions" +.TH "SMBPASSWD" "5" "05/29/2024" "Samba 4\&.20\&.1\-Debian" "File Formats and Conventions" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -165,7 +165,7 @@ This field consists of the time the account was last modified\&. It consists of All other colon separated fields are ignored at this time\&. .SH "VERSION" .PP -This man page is part of version 4\&.19\&.5\-Debian of the Samba suite\&. +This man page is part of version 4\&.20\&.1\-Debian of the Samba suite\&. .SH "SEE ALSO" .PP \fBsmbpasswd\fR(8), diff --git a/upstream/debian-unstable/man5/ssh_config.5 b/upstream/debian-unstable/man5/ssh_config.5 index ab05463d..109a7047 100644 --- a/upstream/debian-unstable/man5/ssh_config.5 +++ b/upstream/debian-unstable/man5/ssh_config.5 @@ -33,8 +33,8 @@ .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" -.\" $OpenBSD: ssh_config.5,v 1.391 2023/10/12 02:18:18 djm Exp $ -.Dd $Mdocdate: October 12 2023 $ +.\" $OpenBSD: ssh_config.5,v 1.394 2024/02/21 06:01:13 djm Exp $ +.Dd $Mdocdate: February 21 2024 $ .Dt SSH_CONFIG 5 .Os .Sh NAME @@ -167,7 +167,7 @@ The available criteria keywords are: .Cm localnetwork , .Cm host , .Cm originalhost , -.Cm Tag , +.Cm tagged , .Cm user , and .Cm localuser . @@ -490,8 +490,10 @@ Timeouts are specified as one or more .Dq type=interval pairs separated by whitespace, where the .Dq type -must be a channel type name (as described in the table below), optionally -containing wildcard characters. +must be the special keyword +.Dq global +or a channel type name from the list below, optionally containing +wildcard characters. .Pp The timeout value .Dq interval @@ -500,11 +502,19 @@ is specified in seconds or may use any of the units documented in the section. For example, .Dq session=5m -would cause the interactive session to terminate after five minutes of +would cause interactive sessions to terminate after five minutes of inactivity. Specifying a zero value disables the inactivity timeout. .Pp -The available channel types include: +The special timeout +.Dq global +applies to all active channels, taken together. +Traffic on any active channel will reset the timeout, but when the timeout +expires then all open channels will be closed. +Note that this global timeout is not matched by wildcards and must be +specified explicitly. +.Pp +The available channel type names include: .Bl -tag -width Ds .It Cm agent-connection Open connections to diff --git a/upstream/debian-unstable/man5/sshd_config.5 b/upstream/debian-unstable/man5/sshd_config.5 index 076ed931..c96882ac 100644 --- a/upstream/debian-unstable/man5/sshd_config.5 +++ b/upstream/debian-unstable/man5/sshd_config.5 @@ -33,8 +33,8 @@ .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" -.\" $OpenBSD: sshd_config.5,v 1.350 2023/07/28 05:42:36 jmc Exp $ -.Dd $Mdocdate: July 28 2023 $ +.\" $OpenBSD: sshd_config.5,v 1.355 2024/02/21 06:17:29 djm Exp $ +.Dd $Mdocdate: February 21 2024 $ .Dt SSHD_CONFIG 5 .Os .Sh NAME @@ -438,8 +438,10 @@ Timeouts are specified as one or more .Dq type=interval pairs separated by whitespace, where the .Dq type -must be a channel type name (as described in the table below), optionally -containing wildcard characters. +must be the special keyword +.Dq global +or a channel type name from the list below, optionally containing +wildcard characters. .Pp The timeout value .Dq interval @@ -447,11 +449,20 @@ is specified in seconds or may use any of the units documented in the .Sx TIME FORMATS section. For example, -.Dq session:*=5m -would cause all sessions to terminate after five minutes of inactivity. +.Dq session=5m +would cause interactive sessions to terminate after five minutes of +inactivity. Specifying a zero value disables the inactivity timeout. .Pp -The available channel types include: +The special timeout +.Dq global +applies to all active channels, taken together. +Traffic on any active channel will reset the timeout, but when the timeout +expires then all open channels will be closed. +Note that this global timeout is not matched by wildcards and must be +specified explicitly. +.Pp +The available channel type names include: .Bl -tag -width Ds .It Cm agent-connection Open connections to @@ -472,15 +483,15 @@ listening on behalf of a .Xr ssh 1 remote forwarding, i.e.\& .Cm RemoteForward . -.It Cm session:command -Command execution sessions. -.It Cm session:shell -Interactive shell sessions. -.It Cm session:subsystem:... -Subsystem sessions, e.g. for +.It Cm session +The interactive main session, including shell session, command execution, +.Xr scp 1 , .Xr sftp 1 , -which could be identified as -.Cm session:subsystem:sftp . +etc. +.It Cm tun-connection +Open +.Cm TunnelForward +connections. .It Cm x11-connection Open X11 forwarding sessions. .El @@ -494,9 +505,6 @@ close the SSH connection, nor does it prevent a client from requesting another channel of the same type. In particular, expiring an inactive forwarding session does not prevent another identical forwarding from being subsequently created. -See also -.Cm UnusedConnectionTimeout , -which may be used in conjunction with this option. .Pp The default is not to expire channels of any type for inactivity. .It Cm ChrootDirectory @@ -506,7 +514,7 @@ to after authentication. At session startup .Xr sshd 8 checks that all components of the pathname are root-owned directories -which are not writable by any other user or group. +which are not writable by group or others. After the chroot, .Xr sshd 8 changes the working directory to the user's home directory. @@ -1165,7 +1173,8 @@ DEBUG and DEBUG1 are equivalent. DEBUG2 and DEBUG3 each specify higher levels of debugging output. Logging with a DEBUG level violates the privacy of users and is not recommended. .It Cm LogVerbose -Specify one or more overrides to LogLevel. +Specify one or more overrides to +.Cm LogLevel . An override consists of a pattern lists that matches the source file, function and line number to force detailed logging for. For example, an override pattern of: @@ -1814,6 +1823,14 @@ implements an in-process SFTP server. This may simplify configurations using .Cm ChrootDirectory to force a different filesystem root on clients. +It accepts the same command line arguments as +.Cm sftp-server +and even though it is in-process, settings such as +.Cm LogLevel +or +.Cm SyslogFacility +do not apply to it and must be set explicitly via +command line arguments. .Pp By default no subsystems are defined. .It Cm SyslogFacility diff --git a/upstream/debian-unstable/man5/sysctl.d.5 b/upstream/debian-unstable/man5/sysctl.d.5 index 9b232b02..43455ab4 100644 --- a/upstream/debian-unstable/man5/sysctl.d.5 +++ b/upstream/debian-unstable/man5/sysctl.d.5 @@ -1,5 +1,5 @@ '\" t -.TH "SYSCTL\&.D" "5" "" "systemd 255" "sysctl.d" +.TH "SYSCTL\&.D" "5" "" "systemd 256~rc3" "sysctl.d" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -23,11 +23,15 @@ sysctl.d \- Configure kernel parameters at boot .SH "SYNOPSIS" .PP +.RS 4 /etc/sysctl\&.d/*\&.conf -.PP +.RE +.RS 4 /run/sysctl\&.d/*\&.conf -.PP +.RE +.RS 4 /usr/lib/sysctl\&.d/*\&.conf +.RE .sp .nf key\&.name\&.under\&.proc\&.sys = some value @@ -122,7 +126,12 @@ Packages should install their configuration files in /usr/local/lib/ (local installs)\&. Files in /etc/ -are reserved for the local administrator, who may use this logic to override the configuration files installed by vendor packages\&. It is recommended to prefix all filenames with a two\-digit number and a dash, to simplify the ordering of the files\&. +are reserved for the local administrator, who may use this logic to override the configuration files installed by vendor packages\&. It is recommended to prefix all filenames with a two\-digit number and a dash, to simplify the ordering of the files\&. It is recommended to use the range 10\-40 for configuration files in +/usr/ +and the range 60\-90 for configuration files in +/etc/ +and +/run/, to make sure that local and transient configuration files will always take priority over configuration files shipped by the OS vendor\&. .PP If the administrator wants to disable a configuration file supplied by the vendor, the recommended way is to place a symlink to /dev/null @@ -237,9 +246,4 @@ will get this value (this also covers any interfaces detected while we\*(Aqre ru net\&.ipv4\&.conf\&.all\&.rp_filter, which we don\*(Aqt want to set at all, so it is explicitly excluded\&. And "hub0" is excluded from the glob because it has an explicit setting\&. .SH "SEE ALSO" .PP -\fBsystemd\fR(1), -\fBsystemd-sysctl.service\fR(8), -\fBsystemd-delta\fR(1), -\fBsysctl\fR(8), -\fBsysctl.conf\fR(5), -\fBmodprobe\fR(8) +\fBsystemd\fR(1), \fBsystemd-sysctl.service\fR(8), \fBsystemd-delta\fR(1), \fBsysctl\fR(8), \fBsysctl.conf\fR(5), \fBmodprobe\fR(8) diff --git a/upstream/debian-unstable/man5/sysfs.5 b/upstream/debian-unstable/man5/sysfs.5 index 2edd582e..a45e1568 100644 --- a/upstream/debian-unstable/man5/sysfs.5 +++ b/upstream/debian-unstable/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 6.8" .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/debian-unstable/man5/systemd-sleep.conf.5 b/upstream/debian-unstable/man5/systemd-sleep.conf.5 index 20d3e071..0c81de64 100644 --- a/upstream/debian-unstable/man5/systemd-sleep.conf.5 +++ b/upstream/debian-unstable/man5/systemd-sleep.conf.5 @@ -1,5 +1,5 @@ '\" t -.TH "SYSTEMD\-SLEEP\&.CONF" "5" "" "systemd 255" "systemd-sleep.conf" +.TH "SYSTEMD\-SLEEP\&.CONF" "5" "" "systemd 256~rc3" "systemd-sleep.conf" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -23,13 +23,24 @@ systemd-sleep.conf, sleep.conf.d \- Suspend and hibernation configuration file .SH "SYNOPSIS" .PP +.RS 4 /etc/systemd/sleep\&.conf -.PP +.RE +.RS 4 +/run/systemd/sleep\&.conf +.RE +.RS 4 +/usr/lib/systemd/sleep\&.conf +.RE +.RS 4 /etc/systemd/sleep\&.conf\&.d/*\&.conf -.PP +.RE +.RS 4 /run/systemd/sleep\&.conf\&.d/*\&.conf -.PP +.RE +.RS 4 /usr/lib/systemd/sleep\&.conf\&.d/*\&.conf +.RE .SH "DESCRIPTION" .PP \fBsystemd\fR @@ -89,16 +100,16 @@ attempts to suspend or hibernate the machine\&. See for a general description of the syntax\&. .SH "CONFIGURATION DIRECTORIES AND PRECEDENCE" .PP -The default configuration is set during compilation, so configuration is only needed when it is necessary to deviate from those defaults\&. The main configuration file is either in -/usr/lib/systemd/ -or -/etc/systemd/ -and contains commented out entries showing the defaults as a guide to the administrator\&. Local overrides can be created by creating drop\-ins, as described below\&. The main configuration file can also be edited for this purpose (or a copy in +The default configuration is set during compilation, so configuration is only needed when it is necessary to deviate from those defaults\&. The main configuration file is loaded from one of the listed directories in order of priority, only the first file found is used: +/etc/systemd/, +/run/systemd/, +/usr/local/lib/systemd/, +/usr/lib/systemd/\&. The vendor version of the file contains commented out entries showing the defaults as a guide to the administrator\&. Local overrides can also be created by creating drop\-ins, as described below\&. The main configuration file can also be edited for this purpose (or a copy in /etc/ -if it\*(Aqs shipped in -/usr/) however using drop\-ins for local configuration is recommended over modifications to the main configuration file\&. +if it\*(Aqs shipped under +/usr/), however using drop\-ins for local configuration is recommended over modifications to the main configuration file\&. .PP -In addition to the "main" configuration file, drop\-in configuration snippets are read from +In addition to the main configuration file, drop\-in configuration snippets are read from /usr/lib/systemd/*\&.conf\&.d/, /usr/local/lib/systemd/*\&.conf\&.d/, and /etc/systemd/*\&.conf\&.d/\&. Those drop\-ins have higher precedence and override the main configuration file\&. Files in the @@ -108,7 +119,12 @@ configuration subdirectories are sorted by their filename in lexicographic order When packages need to customize the configuration, they can install drop\-ins under /usr/\&. Files in /etc/ -are reserved for the local administrator, who may use this logic to override the configuration files installed by vendor packages\&. Drop\-ins have to be used to override package drop\-ins, since the main configuration file has lower precedence\&. It is recommended to prefix all filenames in those subdirectories with a two\-digit number and a dash, to simplify the ordering of the files\&. This also defined a concept of drop\-in priority to allow distributions to ship drop\-ins within a specific range lower than the range used by users\&. This should lower the risk of package drop\-ins overriding accidentally drop\-ins defined by users\&. +are reserved for the local administrator, who may use this logic to override the configuration files installed by vendor packages\&. Drop\-ins have to be used to override package drop\-ins, since the main configuration file has lower precedence\&. It is recommended to prefix all filenames in those subdirectories with a two\-digit number and a dash, to simplify the ordering of the files\&. This also defines a concept of drop\-in priorities to allow OS vendors to ship drop\-ins within a specific range lower than the range used by users\&. This should lower the risk of package drop\-ins overriding accidentally drop\-ins defined by users\&. It is recommended to use the range 10\-40 for drop\-ins in +/usr/ +and the range 60\-90 for drop\-ins in +/etc/ +and +/run/, to make sure that local and transient drop\-ins take priority over drop\-ins shipped by the OS vendor\&. .PP To disable a configuration file supplied by the vendor, the recommended way is to place a symlink to /dev/null @@ -142,6 +158,25 @@ can be used to override and enable those specific modes\&. Added in version 240\&. .RE .PP +\fISuspendState=\fR +.RS 4 +The string to be written to +/sys/power/state +by +\fBsystemd-suspend.service\fR(8)\&. More than one value can be specified by separating multiple values with whitespace\&. They will be tried in turn, until one is written without error\&. If none of the writes succeed, the operation will be aborted\&. +.sp +The allowed set of values is determined by the kernel and is shown in the file itself (use +\fBcat /sys/power/state\fR +to display)\&. See +\m[blue]\fBBasic sysfs Interfaces for System Suspend and Hibernation\fR\m[]\&\s-2\u[1]\d\s+2 +for more details\&. +.sp +\fBsystemd-suspend-then-hibernate.service\fR(8) +uses this value when suspending\&. +.sp +Added in version 203\&. +.RE +.PP \fIHibernateMode=\fR .RS 4 The string to be written to @@ -163,23 +198,25 @@ when hibernating\&. Added in version 203\&. .RE .PP -\fISuspendState=\fR +\fIMemorySleepMode=\fR .RS 4 The string to be written to -/sys/power/state -by -\fBsystemd-suspend.service\fR(8)\&. More than one value can be specified by separating multiple values with whitespace\&. They will be tried in turn, until one is written without error\&. If none of the writes succeed, the operation will be aborted\&. +/sys/power/mem_sleep +when +\fBSuspendState=mem\fR +or +\fBhybrid\-sleep\fR +is used\&. More than one value can be specified by separating multiple values with whitespace\&. They will be tried in turn, until one is written without error\&. If none of the writes succeed, the operation will be aborted\&. Defaults to empty, i\&.e\&. the kernel default or kernel command line option +\fImem_sleep_default=\fR +is respected\&. .sp The allowed set of values is determined by the kernel and is shown in the file itself (use -\fBcat /sys/power/state\fR -to display)\&. See +\fBcat /sys/power/mem_sleep\fR +to display)\&. See the kernel documentation page \m[blue]\fBBasic sysfs Interfaces for System Suspend and Hibernation\fR\m[]\&\s-2\u[1]\d\s+2 for more details\&. .sp -\fBsystemd-suspend-then-hibernate.service\fR(8) -uses this value when suspending\&. -.sp -Added in version 203\&. +Added in version 256\&. .RE .PP \fIHibernateDelaySec=\fR @@ -221,16 +258,10 @@ SuspendState=freeze .\} .SH "SEE ALSO" .PP -\fBsystemd-sleep\fR(8), -\fBsystemd-suspend.service\fR(8), -\fBsystemd-hibernate.service\fR(8), -\fBsystemd-hybrid-sleep.service\fR(8), -\fBsystemd-suspend-then-hibernate.service\fR(8), -\fBsystemd\fR(1), -\fBsystemd.directives\fR(7) +\fBsystemd-sleep\fR(8), \fBsystemd-suspend.service\fR(8), \fBsystemd-hibernate.service\fR(8), \fBsystemd-hybrid-sleep.service\fR(8), \fBsystemd-suspend-then-hibernate.service\fR(8), \fBsystemd\fR(1), \fBsystemd.directives\fR(7) .SH "NOTES" .IP " 1." 4 Basic sysfs Interfaces for System Suspend and Hibernation .RS 4 -\%https://www.kernel.org/doc/html/latest/admin-guide/pm/sleep-states.html#basic-sysfs-interfaces-for-system-suspend-and-hibernation +\%https://docs.kernel.org/admin-guide/pm/sleep-states.html#basic-sysfs-interfaces-for-system-suspend-and-hibernation .RE diff --git a/upstream/debian-unstable/man5/systemd-system.conf.5 b/upstream/debian-unstable/man5/systemd-system.conf.5 index 3719b6d0..1092c38c 100644 --- a/upstream/debian-unstable/man5/systemd-system.conf.5 +++ b/upstream/debian-unstable/man5/systemd-system.conf.5 @@ -1,5 +1,5 @@ '\" t -.TH "SYSTEMD\-SYSTEM\&.CONF" "5" "" "systemd 255" "systemd-system.conf" +.TH "SYSTEMD\-SYSTEM\&.CONF" "5" "" "systemd 256~rc3" "systemd-system.conf" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -24,12 +24,16 @@ systemd-system.conf, system.conf.d, systemd-user.conf, user.conf.d \- System and .SH "SYNOPSIS" .PP /etc/systemd/system\&.conf, +/run/systemd/system\&.conf, +/usr/lib/systemd/system\&.conf, /etc/systemd/system\&.conf\&.d/*\&.conf, /run/systemd/system\&.conf\&.d/*\&.conf, /usr/lib/systemd/system\&.conf\&.d/*\&.conf .PP ~/\&.config/systemd/user\&.conf, /etc/systemd/user\&.conf, +/run/systemd/user\&.conf, +/usr/lib/systemd/user\&.conf, /etc/systemd/user\&.conf\&.d/*\&.conf, /run/systemd/user\&.conf\&.d/*\&.conf, /usr/lib/systemd/user\&.conf\&.d/*\&.conf @@ -43,8 +47,10 @@ and the files in system\&.conf\&.d directories; when run as a user instance, it interprets the configuration file user\&.conf -(either in the home directory of the user, or if not found, under -/etc/systemd/) and the files in +(in order of priority, in the home directory of the user and under +/etc/systemd/, +/run/systemd/, and +/usr/lib/systemd/) and the files in user\&.conf\&.d directories\&. These configuration files contain a few settings controlling basic manager operations\&. .PP @@ -53,16 +59,16 @@ See for a general description of the syntax\&. .SH "CONFIGURATION DIRECTORIES AND PRECEDENCE" .PP -The default configuration is set during compilation, so configuration is only needed when it is necessary to deviate from those defaults\&. The main configuration file is either in -/usr/lib/systemd/ -or -/etc/systemd/ -and contains commented out entries showing the defaults as a guide to the administrator\&. Local overrides can be created by creating drop\-ins, as described below\&. The main configuration file can also be edited for this purpose (or a copy in +The default configuration is set during compilation, so configuration is only needed when it is necessary to deviate from those defaults\&. The main configuration file is loaded from one of the listed directories in order of priority, only the first file found is used: +/etc/systemd/, +/run/systemd/, +/usr/local/lib/systemd/, +/usr/lib/systemd/\&. The vendor version of the file contains commented out entries showing the defaults as a guide to the administrator\&. Local overrides can also be created by creating drop\-ins, as described below\&. The main configuration file can also be edited for this purpose (or a copy in /etc/ -if it\*(Aqs shipped in -/usr/) however using drop\-ins for local configuration is recommended over modifications to the main configuration file\&. +if it\*(Aqs shipped under +/usr/), however using drop\-ins for local configuration is recommended over modifications to the main configuration file\&. .PP -In addition to the "main" configuration file, drop\-in configuration snippets are read from +In addition to the main configuration file, drop\-in configuration snippets are read from /usr/lib/systemd/*\&.conf\&.d/, /usr/local/lib/systemd/*\&.conf\&.d/, and /etc/systemd/*\&.conf\&.d/\&. Those drop\-ins have higher precedence and override the main configuration file\&. Files in the @@ -72,7 +78,12 @@ configuration subdirectories are sorted by their filename in lexicographic order When packages need to customize the configuration, they can install drop\-ins under /usr/\&. Files in /etc/ -are reserved for the local administrator, who may use this logic to override the configuration files installed by vendor packages\&. Drop\-ins have to be used to override package drop\-ins, since the main configuration file has lower precedence\&. It is recommended to prefix all filenames in those subdirectories with a two\-digit number and a dash, to simplify the ordering of the files\&. This also defined a concept of drop\-in priority to allow distributions to ship drop\-ins within a specific range lower than the range used by users\&. This should lower the risk of package drop\-ins overriding accidentally drop\-ins defined by users\&. +are reserved for the local administrator, who may use this logic to override the configuration files installed by vendor packages\&. Drop\-ins have to be used to override package drop\-ins, since the main configuration file has lower precedence\&. It is recommended to prefix all filenames in those subdirectories with a two\-digit number and a dash, to simplify the ordering of the files\&. This also defines a concept of drop\-in priorities to allow OS vendors to ship drop\-ins within a specific range lower than the range used by users\&. This should lower the risk of package drop\-ins overriding accidentally drop\-ins defined by users\&. It is recommended to use the range 10\-40 for drop\-ins in +/usr/ +and the range 60\-90 for drop\-ins in +/etc/ +and +/run/, to make sure that local and transient drop\-ins take priority over drop\-ins shipped by the OS vendor\&. .PP To disable a configuration file supplied by the vendor, the recommended way is to place a symlink to /dev/null @@ -82,7 +93,7 @@ in the configuration directory in .PP All options are configured in the [Manager] section: .PP -\fILogColor=\fR, \fILogLevel=\fR, \fILogLocation=\fR, \fILogTarget=\fR, \fILogTime=\fR, \fIDumpCore=yes\fR, \fICrashChangeVT=no\fR, \fICrashShell=no\fR, \fICrashReboot=no\fR, \fIShowStatus=yes\fR, \fIDefaultStandardOutput=journal\fR, \fIDefaultStandardError=inherit\fR +\fILogColor=\fR, \fILogLevel=\fR, \fILogLocation=\fR, \fILogTarget=\fR, \fILogTime=\fR, \fIDumpCore=yes\fR, \fICrashChangeVT=no\fR, \fICrashShell=no\fR, \fICrashAction=freeze\fR, \fIShowStatus=yes\fR, \fIDefaultStandardOutput=journal\fR, \fIDefaultStandardError=inherit\fR .RS 4 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) @@ -263,6 +274,24 @@ Takes a boolean argument\&. If true, ensures that PID 1 and all its children can Added in version 239\&. .RE .PP +\fIProtectSystem=\fR +.RS 4 +Takes a boolean argument or the string +"auto"\&. If set to true this will remount +/usr/ +read\-only\&. If set to +"auto" +(the default) and running in an initrd equivalent to true, otherwise false\&. This implements a restricted subset of the per\-unit setting of the same name, see +\fBsystemd.exec\fR(5) +for details: currently, the +"full" +or +"struct" +values are not supported\&. +.sp +Added in version 256\&. +.RE +.PP \fISystemCallArchitectures=\fR .RS 4 Takes a space\-separated list of architecture identifiers\&. Selects from which architectures system calls may be invoked on this system\&. This may be used as an effective way to disable invocation of non\-native binaries system\-wide, for example to prohibit execution of 32\-bit x86 binaries on 64\-bit x86\-64 systems\&. This option operates system\-wide, and acts similar to the @@ -588,11 +617,11 @@ Added in version 252\&. .PP \fIReloadLimitIntervalSec=\fR, \fIReloadLimitBurst=\fR .RS 4 -Rate limiting for daemon\-reload requests\&. Default to unset, and any number of daemon\-reload operations can be requested at any time\&. +Rate limiting for daemon\-reload and (since v256) daemon\-reexec requests\&. The setting applies to both operations, but the rate limits are tracked separately\&. Defaults to unset, and any number of operations can be requested at any time\&. \fIReloadLimitIntervalSec=\fR 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\&. +takes a positive integer to configure the maximum allowed number of operations within the configured time window\&. .sp Added in version 253\&. .RE @@ -818,12 +847,7 @@ Added in version 252\&. .RE .SH "SEE ALSO" .PP -\fBsystemd\fR(1), -\fBsystemd.directives\fR(7), -\fBsystemd.exec\fR(5), -\fBsystemd.service\fR(5), -\fBenviron\fR(7), -\fBcapabilities\fR(7) +\fBsystemd\fR(1), \fBsystemd.directives\fR(7), \fBsystemd.exec\fR(5), \fBsystemd.service\fR(5), \fBenviron\fR(7), \fBcapabilities\fR(7) .SH "NOTES" .IP " 1." 4 No New Privileges Flag diff --git a/upstream/debian-unstable/man5/systemd.automount.5 b/upstream/debian-unstable/man5/systemd.automount.5 index b61efb9a..1ba25d77 100644 --- a/upstream/debian-unstable/man5/systemd.automount.5 +++ b/upstream/debian-unstable/man5/systemd.automount.5 @@ -1,5 +1,5 @@ '\" t -.TH "SYSTEMD\&.AUTOMOUNT" "5" "" "systemd 255" "systemd.automount" +.TH "SYSTEMD\&.AUTOMOUNT" "5" "" "systemd 256~rc3" "systemd.automount" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -183,10 +183,4 @@ Check for more settings\&. .SH "SEE ALSO" .PP -\fBsystemd\fR(1), -\fBsystemctl\fR(1), -\fBsystemd.unit\fR(5), -\fBsystemd.mount\fR(5), -\fBmount\fR(8), -\fBautomount\fR(8), -\fBsystemd.directives\fR(7) +\fBsystemd\fR(1), \fBsystemctl\fR(1), \fBsystemd.unit\fR(5), \fBsystemd.mount\fR(5), \fBmount\fR(8), \fBautomount\fR(8), \fBsystemd.directives\fR(7) diff --git a/upstream/debian-unstable/man5/systemd.device.5 b/upstream/debian-unstable/man5/systemd.device.5 index 6d6744c4..7c240275 100644 --- a/upstream/debian-unstable/man5/systemd.device.5 +++ b/upstream/debian-unstable/man5/systemd.device.5 @@ -1,5 +1,5 @@ '\" t -.TH "SYSTEMD\&.DEVICE" "5" "" "systemd 255" "systemd.device" +.TH "SYSTEMD\&.DEVICE" "5" "" "systemd 256~rc3" "systemd.device" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -131,8 +131,4 @@ Device unit files may include [Unit] and [Install] sections, which are described \fBsystemd.unit\fR(5)\&. No options specific to this file type are supported\&. .SH "SEE ALSO" .PP -\fBsystemd\fR(1), -\fBsystemctl\fR(1), -\fBsystemd.unit\fR(5), -\fBudev\fR(7), -\fBsystemd.directives\fR(7) +\fBsystemd\fR(1), \fBsystemctl\fR(1), \fBsystemd.unit\fR(5), \fBudev\fR(7), \fBsystemd.directives\fR(7) diff --git a/upstream/debian-unstable/man5/systemd.dnssd.5 b/upstream/debian-unstable/man5/systemd.dnssd.5 index 708d02ca..1b719a77 100644 --- a/upstream/debian-unstable/man5/systemd.dnssd.5 +++ b/upstream/debian-unstable/man5/systemd.dnssd.5 @@ -1,5 +1,5 @@ '\" t -.TH "SYSTEMD\&.DNSSD" "5" "" "systemd 255" "systemd.dnssd" +.TH "SYSTEMD\&.DNSSD" "5" "" "systemd 256~rc3" "systemd.dnssd" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -207,6 +207,15 @@ A type of the network service as defined in the section 4\&.1\&.2 of Added in version 236\&. .RE .PP +\fISubType=\fR +.RS 4 +A subtype of the network service as defined in the section 7\&.1 of +\m[blue]\fBRFC 6763\fR\m[]\&\s-2\u[1]\d\s+2, e\&.g\&. +"_printer"\&. +.sp +Added in version 256\&. +.RE +.PP \fIPort=\fR .RS 4 An IP port number of the network service\&. @@ -325,9 +334,7 @@ $ avahi\-browse \-a \-r .\} .SH "SEE ALSO" .PP -\fBsystemd\fR(1), -\fBsystemd-resolved.service\fR(8), -\fBresolvectl\fR(1) +\fBsystemd\fR(1), \fBsystemd-resolved.service\fR(8), \fBresolvectl\fR(1) .SH "NOTES" .IP " 1." 4 RFC 6763 diff --git a/upstream/debian-unstable/man5/systemd.exec.5 b/upstream/debian-unstable/man5/systemd.exec.5 index 32439ce0..c08fb7a7 100644 --- a/upstream/debian-unstable/man5/systemd.exec.5 +++ b/upstream/debian-unstable/man5/systemd.exec.5 @@ -1,5 +1,5 @@ '\" t -.TH "SYSTEMD\&.EXEC" "5" "" "systemd 255" "systemd.exec" +.TH "SYSTEMD\&.EXEC" "5" "" "systemd 256~rc3" "systemd.exec" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -171,10 +171,10 @@ is relative to the root of the system running the service manager\&. Note that s \fIRootDirectory=\fR .RS 4 Takes a directory path relative to the host\*(Aqs root directory (i\&.e\&. the root of the system running the service manager)\&. Sets the root directory for executed processes, with the +\fBpivot_root\fR(2) +or \fBchroot\fR(2) -system call\&. If this is used, it must be ensured that the process binary and all its auxiliary files are available in the -\fBchroot()\fR -jail\&. Note that setting this parameter might result in additional dependencies to be added to the unit (see above)\&. +system call\&. If this is used, it must be ensured that the process binary and all its auxiliary files are available in the new root\&. Note that setting this parameter might result in additional dependencies to be added to the unit (see above)\&. .sp The \fIMountAPIVFS=\fR @@ -211,6 +211,12 @@ BindReadOnlyPaths=/dev/log /run/systemd/journal/socket /run/systemd/journal/stdo .RE .\} +In place of the directory path a +"\&.v/" +versioned directory may be specified, see +\fBsystemd.v\fR(7) +for details\&. +.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 @@ -268,6 +274,12 @@ file will be made available for the service (read\-only) as /run/host/os\-release\&. It will be updated automatically on soft reboot (see: \fBsystemd-soft-reboot.service\fR(8)), in case the service is configured to survive it\&. .sp +In place of the image path a +"\&.v/" +versioned directory may be specified, see +\fBsystemd.v\fR(7) +for details\&. +.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\&. @@ -549,6 +561,10 @@ creates regular writable bind mounts (unless the source file system mount is alr \fIBindReadOnlyPaths=\fR creates read\-only bind mounts\&. These settings may be used more than once, each usage appends to the unit\*(Aqs list of bind mounts\&. If the empty string is assigned to either of these two options the entire list of bind mounts defined prior to this is reset\&. Note that in this case both read\-only and regular bind mounts are reset, regardless which of the two settings is used\&. .sp +Using this option implies that a mount namespace is allocated for the unit, i\&.e\&. it implies the effect of +\fIPrivateMounts=\fR +(see below)\&. +.sp This option is particularly useful when \fIRootDirectory=\fR/\fIRootImage=\fR is used\&. In this case the source path refers to a path on the host file system, while the destination path refers to a path below the root directory of the unit\&. @@ -696,6 +712,12 @@ or below, as it may change the setting of \fIDevicePolicy=\fR\&. .sp +In place of the image path a +"\&.v/" +versioned directory may be specified, see +\fBsystemd.v\fR(7) +for details\&. +.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\&. @@ -733,6 +755,12 @@ or the host\&. See: .sp Note that usage from user units requires overlayfs support in unprivileged user namespaces, which was first introduced in kernel v5\&.11\&. .sp +In place of the directory path a +"\&.v/" +versioned directory may be specified, see +\fBsystemd.v\fR(7) +for details\&. +.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 @@ -837,17 +865,22 @@ Sets the supplementary Unix groups the processes are executed as\&. This takes a .PP \fISetLoginEnvironment=\fR .RS 4 -Takes a boolean parameter that controls whether to set +Takes a boolean parameter that controls whether to set the \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 +environment variables\&. If not set, this defaults to true if +\fIUser=\fR, +\fIDynamicUser=\fR +or +\fIPAMName=\fR +are set, false otherwise\&. If set to true, the variables 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\&. +is used\&. If set to false, the mentioned variables are not set by the service manager, no matter whether +\fIUser=\fR, +\fIDynamicUser=\fR, or +\fIPAMName=\fR +are used or not\&. This option normally has no effect on services of the per\-user service manager, since in that case these variables are typically inherited from user manager\*(Aqs own environment anyway\&. .sp Added in version 255\&. .RE @@ -1532,6 +1565,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 directories\&. 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 @@ -1556,7 +1595,10 @@ 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\&. @@ -2790,14 +2832,15 @@ and directories\&. .sp Other file system namespace unit settings \(em -\fIPrivateMounts=\fR, \fIPrivateTmp=\fR, \fIPrivateDevices=\fR, \fIProtectSystem=\fR, \fIProtectHome=\fR, \fIReadOnlyPaths=\fR, \fIInaccessiblePaths=\fR, -\fIReadWritePaths=\fR, \&... \(em also enable file system namespacing in a fashion equivalent to this option\&. Hence it is primarily useful to explicitly request this behaviour if none of the other settings are used\&. +\fIReadWritePaths=\fR, +\fIBindPaths=\fR, +\fIBindReadOnlyPaths=\fR, \&... \(em also enable file system namespacing in a fashion equivalent to this option\&. Hence it is primarily useful to explicitly request this behaviour if none of the other settings are used\&. .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 @@ -3481,7 +3524,7 @@ The option may be used to connect a specific file system object to standard output\&. The semantics are similar to the same option of \fIStandardInput=\fR, see above\&. If \fIpath\fR -refers to a regular file on the filesystem, it is opened (created if it doesn\*(Aqt exist yet) for writing at the beginning of the file, but without truncating it\&. If standard input and output are directed to the same file path, it is opened only once \(em for reading as well as writing \(em and duplicated\&. This is particularly useful when the specified path refers to an +refers to a regular file on the filesystem, it is opened (created if it doesn\*(Aqt exist yet using privileges of the user executing the systemd process) for writing at the beginning of the file, but without truncating it\&. If standard input and output are directed to the same file path, it is opened only once \(em for reading as well as writing \(em and duplicated\&. This is particularly useful when the specified path refers to an \fBAF_UNIX\fR socket in the file system, as in that case only a single stream connection is created for both input and output\&. .sp @@ -3543,7 +3586,7 @@ on systemd\-journald\&.socket (also see the "Implicit Dependencies" section above)\&. Also note that in this case stdout (or stderr, see below) will be an \fBAF_UNIX\fR -stream socket, and not a pipe or FIFO that can be re\-opened\&. This means when executing shell scripts the construct +stream socket, and not a pipe or FIFO that can be reopened\&. This means when executing shell scripts the construct \fBecho "hello" > /dev/stderr\fR for writing text to stderr will not work\&. To mitigate this use the construct \fBecho "hello" >&2\fR @@ -3678,6 +3721,8 @@ separated by whitespace\&. See 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 @@ -3727,7 +3772,7 @@ would add a pattern matching "~foobar" to the allow list\&. .sp -Log messages are tested against denied patterns (if any), then against allowed patterns (if any)\&. If a log message matches any of the denied patterns, it will be discarded, whatever the allowed patterns\&. Then, remaining log messages are tested against allowed patterns\&. Messages matching against none of the allowed pattern are discarded\&. If no allowed patterns are defined, then all messages are processed directly after going through denied filters\&. +Log messages are tested against denied patterns (if any), then against allowed patterns (if any)\&. If a log message matches any of the denied patterns, it is discarded immediately without considering allowed patterns\&. Remaining log messages are tested against allowed patterns\&. Messages matching against none of the allowed pattern are discarded\&. If no allowed patterns are defined, then all messages are processed directly after going through denied filters\&. .sp Filtering is based on the unit for which \fILogFilterPatterns=\fR @@ -3735,6 +3780,8 @@ 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 @@ -3934,6 +3981,8 @@ are searched as well\&. .sp If the file system path is omitted it is chosen identical to the credential name, i\&.e\&. this is a terse way to declare credentials to inherit from the service manager into a service\&. This option may be used multiple times, each time defining an additional credential to pass to the unit\&. .sp +Note that if the path is not specified or a valid credential identifier is given, i\&.e\&. in the above two cases, a missing credential is not considered fatal\&. +.sp If an absolute path referring to a directory is specified, every file in that directory (recursively) will be loaded as a separate credential\&. The ID for each credential will be the provided ID suffixed with "_$FILENAME" (e\&.g\&., @@ -3973,6 +4022,11 @@ for the details about or \fIDeviceAllow=\fR\&. .sp +Note that encrypted credentials targeted for services of the per\-user service manager must be encrypted with +\fBsystemd\-creds encrypt \-\-user\fR, and those for the system service manager without the +\fB\-\-user\fR +switch\&. Encrypted credentials are always targeted to a specific user or the system as a whole, and it is ensured that per\-user service managers cannot decrypt secrets intended for the system or for other users\&. +.sp The credential files/IPC sockets must be accessible to the service manager, but don\*(Aqt have to be directly accessible to the unit\*(Aqs processes: the credential data is read and copied into separate, read\-only copies for the unit that are accessible to appropriately privileged processes\&. This is particularly useful in combination with \fIDynamicUser=\fR as this way privileged data can be made available to processes running under a dynamic UID (i\&.e\&. not a previously known one) without having to open up access to all users\&. @@ -5547,23 +5601,7 @@ MONITOR_UNIT=mysuccess\&.service .\} .SH "SEE ALSO" .PP -\fBsystemd\fR(1), -\fBsystemctl\fR(1), -\fBsystemd-analyze\fR(1), -\fBjournalctl\fR(1), -\fBsystemd-system.conf\fR(5), -\fBsystemd.unit\fR(5), -\fBsystemd.service\fR(5), -\fBsystemd.socket\fR(5), -\fBsystemd.swap\fR(5), -\fBsystemd.mount\fR(5), -\fBsystemd.kill\fR(5), -\fBsystemd.resource-control\fR(5), -\fBsystemd.time\fR(7), -\fBsystemd.directives\fR(7), -\fBtmpfiles.d\fR(5), -\fBexec\fR(3), -\fBfork\fR(2) +\fBsystemd\fR(1), \fBsystemctl\fR(1), \fBsystemd-analyze\fR(1), \fBjournalctl\fR(1), \fBsystemd-system.conf\fR(5), \fBsystemd.unit\fR(5), \fBsystemd.service\fR(5), \fBsystemd.socket\fR(5), \fBsystemd.swap\fR(5), \fBsystemd.mount\fR(5), \fBsystemd.kill\fR(5), \fBsystemd.resource-control\fR(5), \fBsystemd.time\fR(7), \fBsystemd.directives\fR(7), \fBtmpfiles.d\fR(5), \fBexec\fR(3), \fBfork\fR(2) .SH "NOTES" .IP " 1." 4 Discoverable Partitions Specification diff --git a/upstream/debian-unstable/man5/systemd.kill.5 b/upstream/debian-unstable/man5/systemd.kill.5 index f8379e5f..57b5de8c 100644 --- a/upstream/debian-unstable/man5/systemd.kill.5 +++ b/upstream/debian-unstable/man5/systemd.kill.5 @@ -1,5 +1,5 @@ '\" t -.TH "SYSTEMD\&.KILL" "5" "" "systemd 255" "systemd.kill" +.TH "SYSTEMD\&.KILL" "5" "" "systemd 256~rc3" "systemd.kill" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -211,15 +211,4 @@ Added in version 240\&. .RE .SH "SEE ALSO" .PP -\fBsystemd\fR(1), -\fBsystemctl\fR(1), -\fBjournalctl\fR(1), -\fBsystemd.unit\fR(5), -\fBsystemd.service\fR(5), -\fBsystemd.socket\fR(5), -\fBsystemd.swap\fR(5), -\fBsystemd.mount\fR(5), -\fBsystemd.exec\fR(5), -\fBsystemd.directives\fR(7), -\fBkill\fR(2), -\fBsignal\fR(7) +\fBsystemd\fR(1), \fBsystemctl\fR(1), \fBjournalctl\fR(1), \fBsystemd.unit\fR(5), \fBsystemd.service\fR(5), \fBsystemd.socket\fR(5), \fBsystemd.swap\fR(5), \fBsystemd.mount\fR(5), \fBsystemd.exec\fR(5), \fBsystemd.directives\fR(7), \fBkill\fR(2), \fBsignal\fR(7) diff --git a/upstream/debian-unstable/man5/systemd.link.5 b/upstream/debian-unstable/man5/systemd.link.5 index 359f1911..63d7e08e 100644 --- a/upstream/debian-unstable/man5/systemd.link.5 +++ b/upstream/debian-unstable/man5/systemd.link.5 @@ -1,5 +1,5 @@ '\" t -.TH "SYSTEMD\&.LINK" "5" "" "systemd 255" "systemd.link" +.TH "SYSTEMD\&.LINK" "5" "" "systemd 256~rc3" "systemd.link" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -345,6 +345,97 @@ A description of the device\&. Added in version 211\&. .RE .PP +\fIProperty=\fR +.RS 4 +Set specified udev properties\&. This takes space separated list of key\-value pairs concatenated with equal sign ("=")\&. Example: +.sp +.if n \{\ +.RS 4 +.\} +.nf +Property=HOGE=foo BAR=baz +.fi +.if n \{\ +.RE +.\} +.sp +This option supports simple specifier expansion, see the Specifiers section below\&. This option can be specified multiple times\&. If an empty string is assigned, then the all previous assignments are cleared\&. +.sp +This setting is useful to configure the +"ID_NET_MANAGED_BY=" +property which declares which network management service shall manage the interface, which is respected by systemd\-networkd and others\&. Use +.sp +.if n \{\ +.RS 4 +.\} +.nf +Property=ID_NET_MANAGED_BY=io\&.systemd\&.Network +.fi +.if n \{\ +.RE +.\} +.sp +to declare explicitly that +\fBsystemd\-networkd\fR +shall manage the interface, or set the property to something else to declare explicitly it shall not do so\&. See +\fBsystemd.network\fR(5) +for details how this property is used to match interface names\&. +.sp +Added in version 256\&. +.RE +.PP +\fIImportProperty=\fR +.RS 4 +Import specified udev properties from the saved database\&. This takes space separated list of property names\&. Example: +.sp +.if n \{\ +.RS 4 +.\} +.nf +ImportProperty=HOGE BAR +.fi +.if n \{\ +.RE +.\} +.sp +This option supports simple specifier expansion, see the Specifiers section below\&. This option can be specified multiple times\&. If an empty string is assigned, then the all previous assignments are cleared\&. +.sp +If the same property is also set in +\fIProperty=\fR +in the above, then the imported property value will be overridden by the value specified in +\fIProperty=\fR\&. +.sp +Added in version 256\&. +.RE +.PP +\fIUnsetProperty=\fR +.RS 4 +Unset specified udev properties\&. This takes space separated list of property names\&. Example: +.sp +.if n \{\ +.RS 4 +.\} +.nf +ImportProperty=HOGE BAR +.fi +.if n \{\ +.RE +.\} +.sp +This option supports simple specifier expansion, see the Specifiers section below\&. This option can be specified multiple times\&. If an empty string is assigned, then the all previous assignments are cleared\&. +.sp +This setting is applied after +\fIImportProperty=\fR +and +\fIProperty=\fR +are applied\&. Hence, if the same property is specified in +\fIImportProperty=\fR +or +\fIProperty=\fR, then the imported or specified property value will be ignored, and the property will be unset\&. +.sp +Added in version 256\&. +.RE +.PP \fIAlias=\fR .RS 4 The @@ -493,7 +584,7 @@ and "%"\&. While "\&." is an allowed character, it\*(Aqs recommended to avoid it when naming interfaces as various tools (such as -\fBresolvconf\fR(1)) use it as separator character\&. Also, fully numeric interface names are not allowed (in order to avoid ambiguity with interface specification by numeric indexes), as are the special strings +\fBresolvconf\fR(1)) use it as separator character\&. Also, fully numeric interface names are not allowed (in order to avoid ambiguity with interface specification by numeric indexes), nor are the special strings "\&.", "\&.\&.", "all" @@ -1584,6 +1675,17 @@ Takes a boolean\&. If set to true, Large Receive Offload (LRO) is enabled\&. Whe Added in version 232\&. .RE .PP +\fIReceivePacketSteeringCPUMask=\fR +.RS 4 +Configures Receive Packet Steering (RPS) list of CPUs to which RPS may forward traffic\&. Takes a list of CPU indices or ranges separated by either whitespace or commas\&. Alternatively, takes the special value +"all" +in which will include all available CPUs in the mask\&. CPU ranges are specified by the lower and upper CPU indices separated by a dash (e\&.g\&. +"2\-6")\&. This option may be specified more than once, in which case the specified CPU affinity masks are merged\&. If an empty string is assigned, the mask is reset, all assignments prior to this will have no effect\&. Defaults to unset and RPS CPU list is unchanged\&. To disable RPS when it was previously enabled, use the special value +"disable"\&. +.sp +Added in version 256\&. +.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\&. @@ -1828,6 +1930,148 @@ Specifies the MAC address for the virtual function\&. .sp Added in version 251\&. .RE +.SH "SPECIFIERS" +.PP +Some settings resolve specifiers which may be used to write generic unit files referring to runtime or unit parameters that are replaced when the unit files are loaded\&. Specifiers must be known and resolvable for the setting to be valid\&. The following specifiers are understood: +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.B Table\ \&2.\ \&Specifiers available in unit files +.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{ +"%q" +T}:T{ +Pretty host name +T}:T{ +The pretty hostname of the running system, as read from the \fIPRETTY_HOSTNAME=\fR field of /etc/machine\-info\&. If not set, resolves to the short hostname\&. See \fBmachine-info\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{ +Kernel release +T}:T{ +Identical to \fBuname \-r\fR output\&. +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{ +"%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} +.TE +.sp 1 .SH "EXAMPLES" .PP \fBExample\ \&1.\ \&/usr/lib/systemd/network/99\-default\&.link\fR @@ -2032,11 +2276,7 @@ MACAddress=cb:a9:87:65:43:21 .\} .SH "SEE ALSO" .PP -\fBsystemd-udevd.service\fR(8), -\fBudevadm\fR(8), -\fBsystemd.netdev\fR(5), -\fBsystemd.network\fR(5), -\fBsystemd-network-generator.service\fR(8) +\fBsystemd-udevd.service\fR(8), \fBudevadm\fR(8), \fBsystemd.netdev\fR(5), \fBsystemd.network\fR(5), \fBsystemd-network-generator.service\fR(8) .SH "NOTES" .IP " 1." 4 System and Service Credentials diff --git a/upstream/debian-unstable/man5/systemd.mount.5 b/upstream/debian-unstable/man5/systemd.mount.5 index 62d7fb91..894df873 100644 --- a/upstream/debian-unstable/man5/systemd.mount.5 +++ b/upstream/debian-unstable/man5/systemd.mount.5 @@ -1,5 +1,5 @@ '\" t -.TH "SYSTEMD\&.MOUNT" "5" "" "systemd 255" "systemd.mount" +.TH "SYSTEMD\&.MOUNT" "5" "" "systemd 256~rc3" "systemd.mount" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -104,10 +104,12 @@ If a mount unit is beneath another mount unit in the file system hierarchy, both .IP \(bu 2.3 .\} Block device backed file systems automatically gain -\fIBindsTo=\fR -and +\fIRequires=\fR, +\fIStopPropagatedFrom=\fR, and \fIAfter=\fR -type dependencies on the device unit encapsulating the block device (see below)\&. +type dependencies on the device unit encapsulating the block device (see +\fIx\-systemd\&.device\-bound=\fR +for details)\&. .RE .sp .RS 4 @@ -180,9 +182,18 @@ local\-fs\-pre\&.target, and a \fIBefore=\fR dependency on local\-fs\&.target -unless -\fBnofail\fR -mount option is set\&. +unless one or more mount options among +\fBnofail\fR, +\fBx\-systemd\&.wanted\-by=\fR, and +\fBx\-systemd\&.required\-by=\fR +is set\&. See below for detailed information\&. +.sp +Additionally, an +\fIAfter=\fR +dependency on +swap\&.target +is added when the file system type is +"tmpfs"\&. .RE .sp .RS 4 @@ -197,17 +208,19 @@ Network mount units automatically acquire \fIAfter=\fR dependencies on remote\-fs\-pre\&.target, -network\&.target +network\&.target, plus +\fIAfter=\fR and -network\-online\&.target, and gain a +\fIWants=\fR +dependencies on +network\-online\&.target, and a \fIBefore=\fR dependency on -remote\-fs\&.target -unless -\fBnofail\fR -mount option is set\&. Towards the latter a -\fIWants=\fR -unit is added as well\&. +remote\-fs\&.target, unless one or more mount options among +\fBnofail\fR, +\fBx\-systemd\&.wanted\-by=\fR, and +\fBx\-systemd\&.required\-by=\fR +is set\&. .RE .PP Mount units referring to local and network file systems are distinguished by their file system type specification\&. In some cases this is not sufficient (for example network block device based mounts, such as iSCSI), in which case @@ -312,8 +325,13 @@ In the created mount unit, configures a \fIWantedBy=\fR or \fIRequiredBy=\fR -dependency on another unit\&. This option may be specified more than once\&. If this is specified, the normal automatic dependencies on the created mount unit, e\&.g\&., -local\-fs\&.target, are not automatically created\&. See +dependency on another unit\&. This option may be specified more than once\&. If this is specified, the default dependencies (see above) other than +umount\&.target +on the created mount unit, e\&.g\&. +local\-fs\&.target, are not automatically created\&. Hence it is likely that some ordering dependencies need to be set up manually through +\fBx\-systemd\&.before=\fR +and +\fBx\-systemd\&.after=\fR\&. See \fIWantedBy=\fR and \fIRequiredBy=\fR @@ -324,12 +342,16 @@ for details\&. Added in version 245\&. .RE .PP -\fBx\-systemd\&.requires\-mounts\-for=\fR +\fBx\-systemd\&.wants\-mounts\-for=\fR, \fBx\-systemd\&.requires\-mounts\-for=\fR .RS 4 Configures a \fIRequiresMountsFor=\fR +or +\fIWantsMountsFor=\fR dependency between the created mount unit and other mount units\&. The argument must be an absolute path\&. This option may be specified more than once\&. See \fIRequiresMountsFor=\fR +or +\fIWantsMountsFor=\fR in \fBsystemd.unit\fR(5) for details\&. @@ -550,13 +572,14 @@ Mount unit files may include [Unit] and [Install] sections, which are described \fBsystemd.unit\fR(5)\&. .PP Mount unit files must include a [Mount] section, which carries information about the file system mount points it supervises\&. A number of options that may be used in this section are shared with other unit types\&. These options are documented in -\fBsystemd.exec\fR(5) +\fBsystemd.exec\fR(5), +\fBsystemd.kill\fR(5) and -\fBsystemd.kill\fR(5)\&. The options specific to the [Mount] section of mount units are the following: +\fBsystemd.resource-control\fR(5)\&. The options specific to the [Mount] section of mount units are the following: .PP \fIWhat=\fR .RS 4 -Takes an absolute path of a device node, file or other resource to mount\&. See +Takes an absolute path or a fstab\-style identifier of a device node, file or other resource to mount\&. See \fBmount\fR(8) for details\&. If this refers to a device node, a dependency on the respective device unit is automatically created\&. (See \fBsystemd.device\fR(5) @@ -574,6 +597,13 @@ Takes an absolute path of a file or directory for the mount point; in particular Takes a string for the file system type\&. See \fBmount\fR(8) for details\&. This setting is optional\&. +.sp +If the type is +"overlay", and +"upperdir=" +or +"workdir=" +are specified as options and they don\*(Aqt exist, they will be created\&. .RE .PP \fIOptions=\fR @@ -649,20 +679,7 @@ Check for more settings\&. .SH "SEE ALSO" .PP -\fBsystemd\fR(1), -\fBsystemctl\fR(1), -\fBsystemd-system.conf\fR(5), -\fBsystemd.unit\fR(5), -\fBsystemd.exec\fR(5), -\fBsystemd.kill\fR(5), -\fBsystemd.resource-control\fR(5), -\fBsystemd.service\fR(5), -\fBsystemd.device\fR(5), -\fBproc\fR(5), -\fBmount\fR(8), -\fBsystemd-fstab-generator\fR(8), -\fBsystemd.directives\fR(7), -\fBsystemd-mount\fR(1) +\fBsystemd\fR(1), \fBsystemctl\fR(1), \fBsystemd-system.conf\fR(5), \fBsystemd.unit\fR(5), \fBsystemd.exec\fR(5), \fBsystemd.kill\fR(5), \fBsystemd.resource-control\fR(5), \fBsystemd.service\fR(5), \fBsystemd.device\fR(5), \fBproc\fR(5), \fBmount\fR(8), \fBsystemd-fstab-generator\fR(8), \fBsystemd.directives\fR(7), \fBsystemd-mount\fR(1) .SH "NOTES" .IP " 1." 4 API File Systems diff --git a/upstream/debian-unstable/man5/systemd.netdev.5 b/upstream/debian-unstable/man5/systemd.netdev.5 index 4cbedb2f..6343ec31 100644 --- a/upstream/debian-unstable/man5/systemd.netdev.5 +++ b/upstream/debian-unstable/man5/systemd.netdev.5 @@ -1,5 +1,5 @@ '\" t -.TH "SYSTEMD\&.NETDEV" "5" "" "systemd 255" "systemd.network" +.TH "SYSTEMD\&.NETDEV" "5" "" "systemd 256~rc3" "systemd.network" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -670,6 +670,16 @@ Specifies the length of the receive queue for broadcast/multicast packets\&. An .sp Added in version 248\&. .RE +.PP +\fIBroadcastQueueThreshold=\fR +.RS 4 +Controls the threshold for broadcast queueing of the macvlan device\&. Takes the special value +"no", or an integer in the range 0\&...2147483647\&. When +"no" +is specified, the broadcast queueing is disabled altogether\&. When an integer is specified, a multicast address will be queued as broadcast if the number of devices using it is greater than the given value\&. Defaults to unset, and the kernel default will be used\&. +.sp +Added in version 256\&. +.RE .SH "[MACVTAP] SECTION OPTIONS" .PP The [MACVTAP] section applies for netdevs of kind @@ -1734,9 +1744,19 @@ The [WireGuard] section accepts the following keys: The Base64 encoded private key for the interface\&. It can be generated using the \fBwg genkey\fR command (see -\fBwg\fR(8))\&. This option or -\fIPrivateKeyFile=\fR -is mandatory to use WireGuard\&. Note that because this information is secret, you may want to set the permissions of the \&.netdev file to be owned by +\fBwg\fR(8))\&. Specially, if the specified key is prefixed with +"@", it is interpreted as the name of the credential from which the actual key shall be read\&. +\fBsystemd\-networkd\&.service\fR +automatically imports credentials matching +"network\&.wireguard\&.*"\&. For more details on credentials, refer to +\fBsystemd.exec\fR(5)\&. A private key is mandatory to use WireGuard\&. If not set, the credential +"network\&.wireguard\&.private\&.\fInetdev\fR" +is used if exists\&. I\&.e\&. for +50\-foobar\&.netdev, +"network\&.wireguard\&.private\&.50\-foobar" +is tried\&. +.sp +Note that because this information is secret, it\*(Aqs strongly recommended to use an (encrypted) credential\&. Alternatively, you may want to set the permissions of the \&.netdev file to be owned by "root:systemd\-network" with a "0640" @@ -1813,7 +1833,13 @@ The [WireGuardPeer] section accepts the following keys: 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\&. +\fBwg\fR(8)) from a private key, and usually transmitted out of band to the author of the configuration file\&. This option honors the +"@" +prefix in the same way as the +\fBPrivateKey=\fR +setting of the +\fB[WireGuard]\fR +section\&. This option is mandatory for this section\&. .sp Added in version 237\&. .RE @@ -1822,7 +1848,15 @@ Added in version 237\&. .RS 4 Optional preshared key for the interface\&. It can be generated by the \fBwg genpsk\fR -command\&. This option adds an additional layer of symmetric\-key cryptography to be mixed into the already existing public\-key cryptography, for post\-quantum resistance\&. Note that because this information is secret, you may want to set the permissions of the \&.netdev file to be owned by +command\&. This option adds an additional layer of symmetric\-key cryptography to be mixed into the already existing public\-key cryptography, for post\-quantum resistance\&. This option honors the +"@" +prefix in the same way as the +\fBPrivateKey=\fR +setting of the +\fB[WireGuard]\fR +section\&. +.sp +Note that because this information is secret, it\*(Aqs strongly recommended to use an (encrypted) credential\&. Alternatively, you may want to set the permissions of the \&.netdev file to be owned by "root:systemd\-network" with a "0640" @@ -1872,6 +1906,14 @@ 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 +This option honors the +"@" +prefix in the same way as the +\fBPrivateKey=\fR +setting of the +\fB[WireGuard]\fR +section\&. +.sp Added in version 237\&. .RE .PP @@ -1952,6 +1994,14 @@ Specifies the frequency that Media Independent Interface link monitoring will oc Added in version 216\&. .RE .PP +\fIPeerNotifyDelaySec=\fR +.RS 4 +Specifies the number of seconds the delay between each peer notification (gratuitous ARP and unsolicited IPv6 Neighbor Advertisement) when they are issued after a failover event\&. This delay should be a multiple of the MII link monitor interval (miimon)\&. The valid range is 0\&.\&.\&.300s\&. The default value is 0, which means to match the value of the +\fIMIIMonitorSec=\fR\&. +.sp +Added in version 256\&. +.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 @@ -2111,6 +2161,13 @@ Specifies the minimum number of links that must be active before asserting carri Added in version 220\&. .RE .PP +\fIARPMissedMax=\fR +.RS 4 +Specify the maximum number of arp interval monitor cycle for missed ARP replies\&. If this number is exceeded, link is reported as down\&. Defaults to unset\&. +.sp +Added in version 256\&. +.RE +.PP For more detail information see \m[blue]\fBLinux Ethernet Bonding Driver HOWTO\fR\m[]\&\s-2\u[1]\d\s+2 .SH "[XFRM] SECTION OPTIONS" @@ -2648,11 +2705,7 @@ Independent=yes .\} .SH "SEE ALSO" .PP -\fBsystemd\fR(1), -\fBsystemd-networkd\fR(8), -\fBsystemd.link\fR(5), -\fBsystemd.network\fR(5), -\fBsystemd-network-generator.service\fR(8) +\fBsystemd\fR(1), \fBsystemd-networkd\fR(8), \fBsystemd.link\fR(5), \fBsystemd.network\fR(5), \fBsystemd-network-generator.service\fR(8) .SH "NOTES" .IP " 1." 4 Linux Ethernet Bonding Driver HOWTO diff --git a/upstream/debian-unstable/man5/systemd.network.5 b/upstream/debian-unstable/man5/systemd.network.5 index 934e7503..5238454e 100644 --- a/upstream/debian-unstable/man5/systemd.network.5 +++ b/upstream/debian-unstable/man5/systemd.network.5 @@ -1,5 +1,5 @@ '\" t -.TH "SYSTEMD\&.NETWORK" "5" "" "systemd 255" "systemd.network" +.TH "SYSTEMD\&.NETWORK" "5" "" "systemd 256~rc3" "systemd.network" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -447,14 +447,16 @@ Added in version 246\&. .PP \fIRequiredForOnline=\fR .RS 4 -Takes a boolean or a minimum operational state and an optional maximum operational state\&. Please see +Takes a boolean, a minimum operational state (e\&.g\&., +"carrier"), or a range of operational state separated with a colon (e\&.g\&., +"degraded:routable")\&. Please see \fBnetworkctl\fR(1) for possible operational states\&. When "yes", the network is deemed required when determining whether the system is online (including when running \fBsystemd\-networkd\-wait\-online\fR)\&. When "no", the network is ignored when determining the online state\&. When a minimum operational state and an optional maximum operational state are set, -"yes" -is implied, and this controls the minimum and maximum operational state required for the network interface to be considered online\&. +\fBsystemd\-networkd\-wait\-online\fR +deems that the interface is online when the operational state is in the specified range\&. .sp Defaults to "yes" @@ -483,6 +485,45 @@ The network will be brought up normally (as configured by if "RequiredForOnline=no"\&. .sp +The boolean value +"yes" +is translated as follows; +.PP +\fBCAN devices\fR +.RS 4 +"carrier", +.sp +Added in version 256\&. +.RE +.PP +\fBMaster devices, e\&.g\&. bond or bridge\fR +.RS 4 +"degraded\-carrier" +with +\fIRequiredFamilyForOnline=any\fR, +.sp +Added in version 256\&. +.RE +.PP +\fBBonding port interfaces\fR +.RS 4 +"enslaved", +.sp +Added in version 256\&. +.RE +.PP +\fBOther interfaces\fR +.RS 4 +"degraded"\&. +.sp +Added in version 236\&. +.RE +.sp +This setting can be overridden by the command line option for +\fBsystemd\-networkd\-wait\-online\fR\&. See +\fBsystemd-networkd-wait-online.service\fR(8) +for more details\&. +.sp Added in version 236\&. .RE .PP @@ -683,14 +724,23 @@ 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 +Even if this is enabled, the DHCP server will not be started automatically and wait for the persistent storage being ready to load/save leases in the storage, unless +\fIRelayTarget=\fR +or +\fIPersistLeases=no\fR +are specified in the [DHCPServer] section\&. It will be started after +systemd\-networkd\-persistent\-storage\&.service +is started, which calls +\fBnetworkctl persistent\-storage yes\fR\&. See +\fBnetworkctl\fR(1) +for more details\&. +.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 @@ -960,6 +1010,8 @@ If the specified address is "::" (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 +If an empty string is specified, then the all previous assignments in both [Network] and [Address] sections are cleared\&. +.sp Added in version 211\&. .RE .PP @@ -989,6 +1041,14 @@ for IPv6\&. If an empty string is assigned, then the all previous assignments ar Added in version 211\&. .RE .PP +\fIUseDomains=\fR +.RS 4 +Specifies the protocol\-independent default value for the same settings in [IPv6AcceptRA], [DHCPv4], and [DHCPv6] sections below\&. Takes a boolean, or the special value +\fBroute\fR\&. See also the same setting in [DHCPv4] below\&. Defaults to unset\&. +.sp +Added in version 256\&. +.RE +.PP \fIDomains=\fR .RS 4 A whitespace\-separated list of domains which should be resolved using the DNS servers on this link\&. Each item in the list should be a domain name, optionally prefixed with a tilde ("~")\&. The domains with the prefix are called "routing\-only domains"\&. The domains without the prefix are called "search domains" and are first used as search suffixes for extending single\-label hostnames (hostnames containing no dots) to become fully qualified domain names (FQDNs)\&. If a single\-label hostname is resolved on this interface, each of the specified search domains are appended to it in turn, converting it into a fully qualified domain name, until one of them may be successfully resolved\&. @@ -1027,25 +1087,42 @@ An NTP server address (either an IP address, or a hostname)\&. This option may b Added in version 216\&. .RE .PP -\fIIPForward=\fR +\fIIPv4Forwarding=\fR .RS 4 -Configures IP packet forwarding for the system\&. If enabled, incoming packets on any network interface will be forwarded to any other interfaces according to the routing table\&. Takes a boolean, or the values -"ipv4" -or -"ipv6", which only enable IP packet forwarding for the specified address family\&. This controls the -net\&.ipv4\&.ip_forward -and -net\&.ipv6\&.conf\&.all\&.forwarding -sysctl options of the network interface (see +Configures IPv4 packet forwarding for the interface\&. Takes a boolean value\&. This controls the +net\&.ipv4\&.conf\&.\fIINTERFACE\fR\&.forwarding +sysctl option of the network interface\&. See \m[blue]\fBIP Sysctl\fR\m[]\&\s-2\u[7]\d\s+2 -for details about sysctl options)\&. Defaults to -"no"\&. +for more details about the sysctl option\&. Defaults to true if +\fIIPMasquerade=\fR +is enabled for IPv4, otherwise the value specified to the same setting in +\fBnetworkd.conf\fR(5) +will be used\&. If none of them are specified, the sysctl option will not be changed\&. .sp -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\&. +To control the global setting, use the same setting in +\fBnetworkd.conf\fR(5)\&. .sp -To allow IP packet forwarding only between specific network interfaces use a firewall\&. +Added in version 256\&. +.RE +.PP +\fIIPv6Forwarding=\fR +.RS 4 +Configures IPv6 packet forwarding for the interface\&. Takes a boolean value\&. This controls the +net\&.ipv6\&.conf\&.\fIINTERFACE\fR\&.forwarding +sysctl option of the network interface\&. See +\m[blue]\fBIP Sysctl\fR\m[]\&\s-2\u[7]\d\s+2 +for more details about the sysctl option\&. Defaults to true if +\fIIPMasquerade=\fR +is enabled for IPv6 or +\fIIPv6SendRA=\fR +is enabled, otherwise the value specified to the same setting in +\fBnetworkd.conf\fR(5) +will be used\&. If none of them are specified, the sysctl option will not be changed\&. .sp -Added in version 219\&. +To control the global setting, use the same setting in +\fBnetworkd.conf\fR(5)\&. +.sp +Added in version 256\&. .RE .PP \fIIPMasquerade=\fR @@ -1055,19 +1132,13 @@ Configures IP masquerading for the network interface\&. If enabled, packets forw "ipv6", "both", or "no"\&. Defaults to -"no"\&. If enabled, this automatically sets -\fIIPForward=\fR -to one of -"ipv4", -"ipv6" -or -"yes"\&. +"no"\&. .sp 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 @@ -1089,7 +1160,11 @@ Added in version 222\&. .PP \fIIPv6AcceptRA=\fR .RS 4 -Takes a boolean\&. Controls IPv6 Router Advertisement (RA) reception support for the interface\&. If true, RAs are accepted; if false, RAs are ignored\&. When RAs are accepted, they may trigger the start of the DHCPv6 client if the relevant flags are set in the RA data, or if no routers are found on the link\&. The default is to disable RA reception for bridge devices or when IP forwarding is enabled, and to enable it otherwise\&. Cannot be enabled on devices aggregated in a bond device or when link\-local addressing is disabled\&. +Takes a boolean\&. Controls IPv6 Router Advertisement (RA) reception support for the interface\&. If true, RAs are accepted; if false, RAs are ignored\&. When RAs are accepted, they may trigger the start of the DHCPv6 client if the relevant flags are set in the RA data, or if no routers are found on the link\&. Defaults to false for bridge devices, when IP forwarding is enabled, +\fIIPv6SendRA=\fR +or +\fIKeepMaster=\fR +is enabled\&. Otherwise, enabled by default\&. Cannot be enabled on devices aggregated in a bond device or when link\-local addressing is disabled\&. .sp Further settings for the IPv6 RA support may be configured in the [IPv6AcceptRA] section, see below\&. .sp @@ -1122,6 +1197,13 @@ Configures IPv6 Hop Limit\&. Takes an integer in the range 1\&...255\&. For each Added in version 228\&. .RE .PP +\fIIPv6RetransmissionTimeSec=\fR +.RS 4 +Configures IPv6 Retransmission Time\&. The time between retransmitted Neighbor Solicitation messages\&. Used by address resolution and the Neighbor Unreachability Detection algorithm\&. A value of zero is ignored and the kernel\*(Aqs current value will be used\&. Defaults to unset, and the kernel\*(Aqs current value will be used\&. +.sp +Added in version 256\&. +.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 @@ -1160,6 +1242,18 @@ Takes a boolean\&. Configures proxy ARP for IPv4\&. Proxy ARP is the technique i Added in version 233\&. .RE .PP +\fIIPv4ProxyARPPrivateVLAN=\fR +.RS 4 +Takes a boolean\&. Configures proxy ARP private VLAN for IPv4, also known as VLAN aggregation, private VLAN, source\-port filtering, port\-isolation, or MAC\-forced forwarding\&. +.sp +This variant of the ARP proxy technique will allow the ARP proxy to reply back to the same interface\&. +.sp +See +\m[blue]\fBRFC 3069\fR\m[]\&\s-2\u[10]\d\s+2\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 256\&. +.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 @@ -1442,7 +1536,7 @@ Added in version 246\&. \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\&. +\m[blue]\fBRFC 6275\fR\m[]\&\s-2\u[11]\d\s+2\&. Supported only on IPv6\&. Defaults to false\&. .sp Added in version 232\&. .RE @@ -1455,9 +1549,9 @@ Takes one of "both", or "none"\&. When "ipv4", performs IPv4 Address Conflict Detection\&. See -\m[blue]\fBRFC 5227\fR\m[]\&\s-2\u[11]\d\s+2\&. When +\m[blue]\fBRFC 5227\fR\m[]\&\s-2\u[12]\d\s+2\&. When "ipv6", performs IPv6 Duplicate Address Detection\&. See -\m[blue]\fBRFC 4862\fR\m[]\&\s-2\u[12]\d\s+2\&. Defaults to +\m[blue]\fBRFC 4862\fR\m[]\&\s-2\u[13]\d\s+2\&. Defaults to "ipv4" for IPv4 link\-local addresses, "ipv6" @@ -1471,7 +1565,7 @@ Added in version 232\&. \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\&. +\m[blue]\fBRFC 3041\fR\m[]\&\s-2\u[14]\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 @@ -1502,22 +1596,34 @@ Added in version 232\&. \fINetLabel=\fR\fIlabel\fR .RS 4 This setting provides a method for integrating static and dynamic network configuration into Linux -\m[blue]\fBNetLabel\fR\m[]\&\s-2\u[14]\d\s+2 +\m[blue]\fBNetLabel\fR\m[]\&\s-2\u[15]\d\s+2 subsystem rules, used by -\m[blue]\fBLinux Security Modules (LSMs)\fR\m[]\&\s-2\u[15]\d\s+2 +\m[blue]\fBLinux Security Modules (LSMs)\fR\m[]\&\s-2\u[16]\d\s+2 for network access control\&. The label, with suitable LSM rules, can be used to control connectivity of (for example) a service with peers in the local network\&. At least with SELinux, only the ingress can be controlled but not egress\&. The benefit of using this setting is that it may be possible to apply interface independent part of NetLabel configuration at very early stage of system boot sequence, at the time when the network interfaces are not available yet, with \fBnetlabelctl\fR(8), and the per\-interface configuration with \fBsystemd\-networkd\fR once the interfaces appear later\&. Currently this feature is only implemented for SELinux\&. .sp The option expects a single NetLabel label\&. The label must conform to lexical restrictions of LSM labels\&. When an interface is configured with IP addresses, the addresses and subnetwork masks will be appended to the -\m[blue]\fBNetLabel Fallback Peer Labeling\fR\m[]\&\s-2\u[16]\d\s+2 +\m[blue]\fBNetLabel Fallback Peer Labeling\fR\m[]\&\s-2\u[17]\d\s+2 rules\&. They will be removed when the interface is deconfigured\&. Failures to manage the labels will be ignored\&. +.if n \{\ .sp -Warning: Once labeling is enabled for network traffic, a lot of LSM access control points in Linux networking stack go from dormant to active\&. Care should be taken to avoid getting into a situation where for example remote connectivity is broken, when the security policy hasn\*(Aqt been updated to consider LSM per\-packet access controls and no rules would allow any network traffic\&. Also note that additional configuration with +.\} +.RS 4 +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.ps +1 +\fBWarning\fR +.ps -1 +.br +Once labeling is enabled for network traffic, a lot of LSM access control points in Linux networking stack go from dormant to active\&. Care should be taken to avoid getting into a situation where for example remote connectivity is broken, when the security policy hasn\*(Aqt been updated to consider LSM per\-packet access controls and no rules would allow any network traffic\&. Also note that additional configuration with \fBnetlabelctl\fR(8) is needed\&. -.sp +.sp .5v +.RE Example: .sp .if n \{\ @@ -1574,7 +1680,7 @@ Added in version 252\&. \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 +\m[blue]\fBNFT\fR\m[]\&\s-2\u[18]\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 @@ -1695,7 +1801,7 @@ Added in version 243\&. .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[18]\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[19]\d\s+2\&. Precedence is managed by userspace, and only the label itself is stored in the kernel\&. .PP \fILabel=\fR .RS 4 @@ -1719,9 +1825,9 @@ 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[19]\d\s+2 +\m[blue]\fBType of Service\fR\m[]\&\s-2\u[20]\d\s+2 and -\m[blue]\fBDifferentiated services\fR\m[]\&\s-2\u[20]\d\s+2 +\m[blue]\fBDifferentiated services\fR\m[]\&\s-2\u[21]\d\s+2 for more details\&. .sp Added in version 235\&. @@ -1786,6 +1892,14 @@ Specifies the outgoing device to match\&. The outgoing interface is only availab Added in version 236\&. .RE .PP +\fIL3MasterDevice=\fR +.RS 4 +A boolean\&. Specifies whether the rule is to direct lookups to the tables associated with level 3 master devices (also known as Virtual Routing and Forwarding or VRF devices)\&. For further details see +\m[blue]\fBVirtual Routing and Forwarding (VRF)\fR\m[]\&\s-2\u[22]\d\s+2\&. Defaults to false\&. +.sp +Added in version 256\&. +.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\&. @@ -1887,7 +2001,10 @@ The [NextHop] section is used to manipulate entries in the kernel\*(Aqs "nexthop .PP \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\&. +The id of the next hop\&. Takes an integer in the range 1\&...4294967295\&. This is mandatory if +\fIManageForeignNextHops=no\fR +is specified in +\fBnetworkd.conf\fR(5)\&. Otherwise, if unspecified, an unused ID will be automatically picked\&. .sp Added in version 244\&. .RE @@ -1990,7 +2107,7 @@ Added in version 216\&. \fIIPv6Preference=\fR .RS 4 Specifies the route preference as defined in -\m[blue]\fBRFC 4191\fR\m[]\&\s-2\u[21]\d\s+2 +\m[blue]\fBRFC 4191\fR\m[]\&\s-2\u[23]\d\s+2 for Router Discovery messages\&. Which can be one of "low" the route has a lowest priority, @@ -2118,7 +2235,9 @@ is "nat", then "local" is used\&. In other cases, defaults to -"main"\&. +"main"\&. Ignored if +\fIL3MasterDevice=\fR +is true\&. .sp Added in version 230\&. .RE @@ -2197,13 +2316,6 @@ Takes a boolean\&. When true enables TCP fastopen without a cookie on a per\-rou 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\&. @@ -2280,7 +2392,7 @@ Added in version 223\&. \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[22]\d\s+2\&. +\m[blue]\fBRFC 8520\fR\m[]\&\s-2\u[24]\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 @@ -2350,7 +2462,7 @@ Added in version 230\&. \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 +\m[blue]\fBRFC 4039\fR\m[]\&\s-2\u[25]\d\s+2 for details\&. Defaults to true when \fIAnonymize=no\fR and neither @@ -2365,7 +2477,7 @@ Added in version 255\&. \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[24]\d\s+2 +\m[blue]\fBRFC 7844\fR\m[]\&\s-2\u[26]\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 @@ -2388,7 +2500,7 @@ When true, are implied and these settings in the \&.network file are silently ignored\&. Also, \fIHostname=\fR, \fIMUDURL=\fR, -\fIRequestAddress\fR, +\fIRequestAddress=\fR, \fIRequestOptions=\fR, \fISendOption=\fR, \fISendVendorOption=\fR, @@ -2416,7 +2528,7 @@ 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[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\&. +\m[blue]\fBC\-style escapes\fR\m[]\&\s-2\u[27]\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 @@ -2429,7 +2541,7 @@ 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[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\&. +\m[blue]\fBC\-style escapes\fR\m[]\&\s-2\u[27]\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 @@ -2557,7 +2669,14 @@ setting\&. If set to \fBroute\fR, the domain name received from the DHCP server will be used for routing DNS queries only, but not for searching, similarly to the effect of the \fBDomains=\fR setting when the argument is prefixed with -"~"\&. Defaults to false\&. +"~"\&. +.sp +When unspecified, the value specified in the same setting in the [Network] section will be used\&. When it is unspecified, the value specified in the same setting in the [DHCPv4] section in +\fBnetworkd.conf\fR(5) +will be used\&. When it is unspecified, the value specified in the same setting in the [Network] section in +\fBnetworkd.conf\fR(5) +will be used\&. When none of them are specified, defaults to +"no"\&. .sp It is recommended to enable this option only on trusted networks, as setting this affects resolution of all hostnames, in particular of single\-label names\&. It is generally safer to use the supplied domain only as routing domain, rather than as search domain, in order to not have it affect local resolution of single\-label names\&. .sp @@ -2644,7 +2763,7 @@ will be used\&. 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\&. +\m[blue]\fBRFC 3442\fR\m[]\&\s-2\u[28]\d\s+2\&. .sp Added in version 246\&. .RE @@ -2662,7 +2781,7 @@ 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[27]\d\s+2\&. Defaults to false\&. +\m[blue]\fBRFC 5969\fR\m[]\&\s-2\u[29]\d\s+2\&. Defaults to false\&. .sp Added in version 250\&. .RE @@ -2670,7 +2789,7 @@ Added in version 250\&. \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\&. +\m[blue]\fBRFC 8925\fR\m[]\&\s-2\u[30]\d\s+2\&. Defaults to false\&. .sp Added in version 255\&. .RE @@ -2708,6 +2827,13 @@ Set the port from which the DHCP client packets originate\&. Added in version 233\&. .RE .PP +\fIServerPort=\fR +.RS 4 +Set the port on which the DHCP server is listening\&. +.sp +Added in version 256\&. +.RE +.PP \fIDenyList=\fR .RS 4 A whitespace\-separated list of IPv4 addresses\&. Each address can optionally take a prefix length after @@ -2717,7 +2843,7 @@ is configured then \fIDenyList=\fR is ignored\&. .sp -Note that this filters only DHCP offers, so the filtering may not work when +Note that this filters only DHCP offers, so the filtering might not work when \fIRapidCommit=\fR is enabled\&. See also \fIRapidCommit=\fR @@ -2731,7 +2857,7 @@ Added in version 246\&. 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 +Note that this filters only DHCP offers, so the filtering might not work when \fIRapidCommit=\fR is enabled\&. See also \fIRapidCommit=\fR @@ -2754,7 +2880,7 @@ A boolean\&. When true, performs IPv4 Duplicate Address Detection to the acquired address by the DHCPv4 client\&. If duplicate is detected, the DHCPv4 client rejects the address by sending a \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\&. +\m[blue]\fBRFC 5227\fR\m[]\&\s-2\u[12]\d\s+2\&. Defaults to false\&. .sp Added in version 245\&. .RE @@ -2814,7 +2940,7 @@ 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[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\&. +\m[blue]\fBC\-style escapes\fR\m[]\&\s-2\u[27]\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 @@ -2822,7 +2948,7 @@ Added in version 246\&. \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[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 +\m[blue]\fBC\-style escapes\fR\m[]\&\s-2\u[27]\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 @@ -2848,7 +2974,7 @@ Added in version 244\&. \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[29]\d\s+2 +\m[blue]\fBRFC 3315\fR\m[]\&\s-2\u[31]\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\&. @@ -2891,7 +3017,7 @@ 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[30]\d\s+2\&. +\m[blue]\fBRFC 8415\fR\m[]\&\s-2\u[32]\d\s+2\&. .sp Added in version 250\&. .RE @@ -2965,7 +3091,7 @@ Added in version 250\&. \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[31]\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[33]\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 @@ -3047,6 +3173,13 @@ The [IPv6AcceptRA] section configures the IPv6 Router Advertisement (RA) client, \fIIPv6AcceptRA=\fR setting described above: .PP +\fIUseRedirect=\fR +.RS 4 +When true (the default), Redirect message sent by the current first\-hop router will be accepted, and configures routes to redirected nodes will be configured\&. +.sp +Added in version 256\&. +.RE +.PP \fIToken=\fR .RS 4 Specifies an optional address generation mode for the Stateless Address Autoconfiguration (SLAAC)\&. The following values are supported: @@ -3070,7 +3203,7 @@ Added in version 250\&. \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[32]\d\s+2 +\m[blue]\fBRFC 7217\fR\m[]\&\s-2\u[34]\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 @@ -3197,11 +3330,18 @@ Takes a boolean\&. When true, the hop limit received in the Router Advertisement Added in version 255\&. .RE .PP -\fIUseICMP6RateLimit=\fR +\fIUseReachableTime=\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\&. +Takes a boolean\&. When true, the reachable time received in the Router Advertisement will be set on the interface receiving the advertisement\&. It is used as the base timespan of the validity of a neighbor entry\&. Defaults to true\&. .sp -Added in version 255\&. +Added in version 256\&. +.RE +.PP +\fIUseRetransmissionTime=\fR +.RS 4 +Takes a boolean\&. When true, the retransmission time received in the Router Advertisement will be set on the interface receiving the advertisement\&. It is used as the time between retransmissions of Neighbor Solicitation messages to a neighbor when resolving the address or when probing the reachability of a neighbor\&. Defaults to true\&. +.sp +Added in version 256\&. .RE .PP \fIUseGateway=\fR @@ -3232,7 +3372,7 @@ Added in version 254\&. 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\&. +\m[blue]\fBRFC 8781\fR\m[]\&\s-2\u[35]\d\s+2\&. Defaults to false\&. .sp Added in version 255\&. .RE @@ -3415,7 +3555,7 @@ ServerAddress=192\&.168\&.0\&.1/24 .RE .\} .sp -are equivalent to the following\&. +are equivalent to the following: .sp .if n \{\ .RS 4 @@ -3550,7 +3690,7 @@ Added in version 226\&. 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[34]\d\s+2 +\m[blue]\fBRFC 2131\fR\m[]\&\s-2\u[36]\d\s+2 for more details\&. Defaults to unset\&. .sp Added in version 251\&. @@ -3559,7 +3699,7 @@ Added in version 251\&. \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[35]\d\s+2 +\m[blue]\fBRFC 2132\fR\m[]\&\s-2\u[37]\d\s+2 for more details\&. Defaults to unset\&. .sp Note that typically setting one of @@ -3574,7 +3714,7 @@ Added in version 251\&. \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[35]\d\s+2 +\m[blue]\fBRFC 2132\fR\m[]\&\s-2\u[37]\d\s+2 for more details\&. Defaults to unset\&. .sp Added in version 251\&. @@ -3583,7 +3723,7 @@ Added in version 251\&. \fIIPv6OnlyPreferredSec=\fR .RS 4 Takes a timespan\&. Controls the -\m[blue]\fBRFC 8925\fR\m[]\&\s-2\u[28]\d\s+2 +\m[blue]\fBRFC 8925\fR\m[]\&\s-2\u[30]\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\&. @@ -3598,7 +3738,7 @@ 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[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\&. +\m[blue]\fBC\-style escapes\fR\m[]\&\s-2\u[27]\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 @@ -3611,7 +3751,7 @@ 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[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\&. +\m[blue]\fBC\-style escapes\fR\m[]\&\s-2\u[27]\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 @@ -3632,7 +3772,7 @@ Added in version 249\&. .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[36]\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[38]\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 @@ -3664,10 +3804,22 @@ Added in version 249\&. \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\&. +\m[blue]\fBRFC 4039\fR\m[]\&\s-2\u[39]\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 +.PP +\fIPersistLeases=\fR +.RS 4 +Takes a boolean\&. When true, the DHCP server will load and save leases in the persistent storage\&. When false, the DHCP server will neither load nor save leases in the persistent storage\&. Hence, bound leases will be lost when the interface is reconfigured e\&.g\&. by +\fBnetworkctl reconfigure\fR, or +systemd\-networkd\&.service +is restarted\&. That may cause address conflict on the network\&. So, please take an extra care when disable this setting\&. When unspecified, the value specified in the same setting in +\fBnetworkd.conf\fR(5), which defaults to +"yes", will be used\&. +.sp +Added in version 256\&. +.RE .SH "[DHCPSERVERSTATICLEASE] SECTION OPTIONS" .PP The @@ -3716,9 +3868,16 @@ Takes a timespan\&. Configures the IPv6 router lifetime in seconds\&. The value Added in version 235\&. .RE .PP +\fIReachableTimeSec=\fR +.RS 4 +Configures the time, used in the Neighbor Unreachability Detection algorithm, for which clients can assume a neighbor is reachable after having received a reachability confirmation\&. Takes a time span in the range 0\&...4294967295 ms\&. When 0, clients will handle it as if the value wasn\*(Aqt specified\&. Defaults to 0\&. +.sp +Added in version 256\&. +.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 of seconds, in the range 0\&...4294967295 msec\&. Defaults to 0\&. +Configures the time, used in the Neighbor Unreachability Detection algorithm, for which clients can use as retransmit time on address resolution and the Neighbor Unreachability Detection algorithm\&. Takes a time span in the range 0\&...4294967295 ms\&. When 0, clients will handle it as if the value wasn\*(Aqt specified\&. Defaults to 0\&. .sp Added in version 255\&. .RE @@ -3738,7 +3897,7 @@ and added as synonyms for "medium" just to make configuration easier\&. See -\m[blue]\fBRFC 4191\fR\m[]\&\s-2\u[21]\d\s+2 +\m[blue]\fBRFC 4191\fR\m[]\&\s-2\u[23]\d\s+2 for details\&. Defaults to "medium"\&. .sp @@ -3818,8 +3977,8 @@ Added in version 235\&. .PP \fIHomeAgent=\fR .RS 4 -Takes a boolean\&. Specifies that IPv6 router advertisements which indicates 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 +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[11]\d\s+2 for further details\&. .sp Added in version 255\&. @@ -3827,7 +3986,7 @@ Added in version 255\&. .PP \fIHomeAgentLifetimeSec=\fR .RS 4 -Takes a timespan\&. Specifies the lifetime of the Home Agent\&. An integer the default unit of seconds, in the range 1\&...65535\&. Defaults to the value set to +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\&. @@ -3842,7 +4001,7 @@ Added in version 255\&. .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[38]\d\s+2 +\m[blue]\fBRFC 4861\fR\m[]\&\s-2\u[40]\d\s+2 for further details\&. .PP \fIAddressAutoconfiguration=\fR, \fIOnLink=\fR @@ -3903,7 +4062,7 @@ Added in version 249\&. .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[21]\d\s+2 +\m[blue]\fBRFC 4191\fR\m[]\&\s-2\u[23]\d\s+2 for further details\&. .PP \fIRoute=\fR @@ -3926,7 +4085,7 @@ Added in version 244\&. .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 +\m[blue]\fBRFC 8781\fR\m[]\&\s-2\u[35]\d\s+2 for further details\&. .PP \fIPrefix=\fR @@ -5501,14 +5660,14 @@ Added in version 246\&. .RE .SH "[BRIDGEVLAN] SECTION OPTIONS" .PP -The [BridgeVLAN] section manages the VLAN ID configuration of a bridge port and accepts the following keys\&. Specify several [BridgeVLAN] sections to configure several VLAN entries\&. The +The [BridgeVLAN] section manages the VLAN ID configurations of a bridge master or port, and accepts the following keys\&. To make the settings in this section take an effect, \fIVLANFiltering=\fR -option has to be enabled, see the [Bridge] section in -\fBsystemd.netdev\fR(5)\&. +option has to be enabled on the bridge master, see the [Bridge] section in +\fBsystemd.netdev\fR(5)\&. If at least one valid settings specified in this section in a \&.network file for an interface, all assigned VLAN IDs on the interface that are not configured in the \&.network file will be removed\&. If VLAN IDs on an interface need to be managed by other tools, then the settings in this section cannot be used in the matching \&.network file\&. .PP \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\&. +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\&. This setting can be specified multiple times\&. If an empty string is assigned, then the all previous assignments are cleared\&. .sp Added in version 231\&. .RE @@ -5519,20 +5678,19 @@ The VLAN ID specified here will be used to untag frames on egress\&. Configuring \fIEgressUntagged=\fR 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\&. +above and will enable the VLAN ID for ingress as well\&. This can be either a single ID or a range M\-N\&. This setting can be specified multiple times\&. If an empty string is assigned, then the all previous assignments are cleared\&. .sp Added in version 231\&. .RE .PP \fIPVID=\fR .RS 4 -The Port VLAN ID specified here is assigned to all untagged frames at ingress\&. -\fIPVID=\fR -can be used only once\&. Configuring +The port VLAN ID specified here is assigned to all untagged frames at ingress\&. Takes an VLAN ID or negative boolean value (e\&.g\&. +"no")\&. When false, the currently assigned port VLAN ID will be dropped\&. Configuring \fIPVID=\fR implicates the use of \fIVLAN=\fR -above and will enable the VLAN ID for ingress as well\&. +setting in the above and will enable the VLAN ID for ingress as well\&. Defaults to unset, and will keep the assigned port VLAN ID if exists\&. .sp Added in version 231\&. .RE @@ -6025,12 +6183,7 @@ nic\&. If offloading is not needed, xfrm interfaces can be assigned to the device\&. .SH "SEE ALSO" .PP -\fBsystemd\fR(1), -\fBsystemd-networkd.service\fR(8), -\fBsystemd.link\fR(5), -\fBsystemd.netdev\fR(5), -\fBsystemd-network-generator.service\fR(8), -\fBsystemd-resolved.service\fR(8) +\fBsystemd\fR(1), \fBsystemd-networkd.service\fR(8), \fBsystemd.link\fR(5), \fBsystemd.netdev\fR(5), \fBsystemd-network-generator.service\fR(8), \fBsystemd-resolved.service\fR(8) .SH "NOTES" .IP " 1." 4 System and Service Credentials @@ -6078,146 +6231,156 @@ RFC 3704 \%https://tools.ietf.org/html/rfc1027 .RE .IP "10." 4 +RFC 3069 +.RS 4 +\%https://tools.ietf.org/html/rfc3069 +.RE +.IP "11." 4 RFC 6275 .RS 4 \%https://tools.ietf.org/html/rfc6275 .RE -.IP "11." 4 +.IP "12." 4 RFC 5227 .RS 4 \%https://tools.ietf.org/html/rfc5227 .RE -.IP "12." 4 +.IP "13." 4 RFC 4862 .RS 4 \%https://tools.ietf.org/html/rfc4862 .RE -.IP "13." 4 +.IP "14." 4 RFC 3041 .RS 4 \%https://tools.ietf.org/html/rfc3041 .RE -.IP "14." 4 +.IP "15." 4 NetLabel .RS 4 \%https://docs.kernel.org/netlabel/index.html .RE -.IP "15." 4 +.IP "16." 4 Linux Security Modules (LSMs) .RS 4 \%https://en.wikipedia.org/wiki/Linux_Security_Modules .RE -.IP "16." 4 +.IP "17." 4 NetLabel Fallback Peer Labeling .RS 4 \%https://github.com/SELinuxProject/selinux-notebook/blob/main/src/network_support.md .RE -.IP "17." 4 +.IP "18." 4 NFT .RS 4 \%https://netfilter.org/projects/nftables/index.html .RE -.IP "18." 4 +.IP "19." 4 RFC 3484 .RS 4 \%https://tools.ietf.org/html/rfc3484 .RE -.IP "19." 4 +.IP "20." 4 Type of Service .RS 4 \%https://en.wikipedia.org/wiki/Type_of_service .RE -.IP "20." 4 +.IP "21." 4 Differentiated services .RS 4 \%https://en.wikipedia.org/wiki/Differentiated_services .RE -.IP "21." 4 +.IP "22." 4 +Virtual Routing and Forwarding (VRF) +.RS 4 +\%https://docs.kernel.org/networking/vrf.html +.RE +.IP "23." 4 RFC 4191 .RS 4 \%https://tools.ietf.org/html/rfc4191 .RE -.IP "22." 4 +.IP "24." 4 RFC 8520 .RS 4 \%https://tools.ietf.org/html/rfc8520 .RE -.IP "23." 4 +.IP "25." 4 RFC 4039 .RS 4 \%https://tools.ietf.org/html/rfc4039 .RE -.IP "24." 4 +.IP "26." 4 RFC 7844 .RS 4 \%https://tools.ietf.org/html/rfc7844 .RE -.IP "25." 4 +.IP "27." 4 C-style escapes .RS 4 \%https://en.wikipedia.org/wiki/Escape_sequences_in_C#Table_of_escape_sequences .RE -.IP "26." 4 +.IP "28." 4 RFC 3442 .RS 4 \%https://datatracker.ietf.org/doc/html/rfc3442 .RE -.IP "27." 4 +.IP "29." 4 RFC 5969 .RS 4 \%https://tools.ietf.org/html/rfc5969 .RE -.IP "28." 4 +.IP "30." 4 RFC 8925 .RS 4 \%https://tools.ietf.org/html/rfc8925 .RE -.IP "29." 4 +.IP "31." 4 RFC 3315 .RS 4 \%https://tools.ietf.org/html/rfc3315#section-17.2.1 .RE -.IP "30." 4 +.IP "32." 4 RFC 8415 .RS 4 \%https://www.rfc-editor.org/rfc/rfc8415.html#section-6.3 .RE -.IP "31." 4 +.IP "33." 4 RFC 4291 .RS 4 \%https://tools.ietf.org/html/rfc4291#section-2.5.4 .RE -.IP "32." 4 +.IP "34." 4 RFC 7217 .RS 4 \%https://tools.ietf.org/html/rfc7217 .RE -.IP "33." 4 +.IP "35." 4 RFC 8781 .RS 4 \%https://tools.ietf.org/html/rfc8781 .RE -.IP "34." 4 +.IP "36." 4 RFC 2131 .RS 4 \%https://www.rfc-editor.org/rfc/rfc2131.html .RE -.IP "35." 4 +.IP "37." 4 RFC 2132 .RS 4 \%https://www.rfc-editor.org/rfc/rfc2132.html .RE -.IP "36." 4 +.IP "38." 4 RFC 1542 .RS 4 \%https://tools.ietf.org/html/rfc1542 .RE -.IP "37." 4 +.IP "39." 4 RFC 4039 .RS 4 \%https://datatracker.ietf.org/doc/html/rfc4039 .RE -.IP "38." 4 +.IP "40." 4 RFC 4861 .RS 4 \%https://tools.ietf.org/html/rfc4861 diff --git a/upstream/debian-unstable/man5/systemd.nspawn.5 b/upstream/debian-unstable/man5/systemd.nspawn.5 index 0c441ba1..5bb98a83 100644 --- a/upstream/debian-unstable/man5/systemd.nspawn.5 +++ b/upstream/debian-unstable/man5/systemd.nspawn.5 @@ -1,5 +1,5 @@ '\" t -.TH "SYSTEMD\&.NSPAWN" "5" "" "systemd 255" "systemd.nspawn" +.TH "SYSTEMD\&.NSPAWN" "5" "" "systemd 256~rc3" "systemd.nspawn" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -23,11 +23,15 @@ systemd.nspawn \- Container settings .SH "SYNOPSIS" .PP +.RS 4 /etc/systemd/nspawn/\fImachine\fR\&.nspawn -.PP +.RE +.RS 4 /run/systemd/nspawn/\fImachine\fR\&.nspawn -.PP +.RE +.RS 4 /var/lib/machines/\fImachine\fR\&.nspawn +.RE .SH "DESCRIPTION" .PP An nspawn container settings file (suffix @@ -587,6 +591,4 @@ Added in version 226\&. .RE .SH "SEE ALSO" .PP -\fBsystemd\fR(1), -\fBsystemd-nspawn\fR(1), -\fBsystemd.directives\fR(7) +\fBsystemd\fR(1), \fBsystemd-nspawn\fR(1), \fBsystemd.directives\fR(7) diff --git a/upstream/debian-unstable/man5/systemd.path.5 b/upstream/debian-unstable/man5/systemd.path.5 index 9fbc4d47..11d47179 100644 --- a/upstream/debian-unstable/man5/systemd.path.5 +++ b/upstream/debian-unstable/man5/systemd.path.5 @@ -1,5 +1,5 @@ '\" t -.TH "SYSTEMD\&.PATH" "5" "" "systemd 255" "systemd.path" +.TH "SYSTEMD\&.PATH" "5" "" "systemd 256~rc3" "systemd.path" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -203,9 +203,4 @@ in \fBsystemd.exec\fR(5) for more details\&. .PP -\fBsystemd\fR(1), -\fBsystemctl\fR(1), -\fBsystemd.unit\fR(5), -\fBsystemd.service\fR(5), -\fBinotify\fR(7), -\fBsystemd.directives\fR(7) +\fBsystemd\fR(1), \fBsystemctl\fR(1), \fBsystemd.unit\fR(5), \fBsystemd.service\fR(5), \fBinotify\fR(7), \fBsystemd.directives\fR(7) diff --git a/upstream/debian-unstable/man5/systemd.pcrlock.5 b/upstream/debian-unstable/man5/systemd.pcrlock.5 index cadc0742..a3eecafe 100644 --- a/upstream/debian-unstable/man5/systemd.pcrlock.5 +++ b/upstream/debian-unstable/man5/systemd.pcrlock.5 @@ -1,5 +1,5 @@ '\" t -.TH "SYSTEMD\&.PCRLOCK" "5" "" "systemd 255" "systemd.pcrlock" +.TH "SYSTEMD\&.PCRLOCK" "5" "" "systemd 256~rc3" "systemd.pcrlock" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -23,25 +23,43 @@ systemd.pcrlock, systemd.pcrlock.d \- PCR measurement prediction files .SH "SYNOPSIS" .PP -.nf +.RS 4 /etc/pcrlock\&.d/*\&.pcrlock +.RE +.RS 4 /etc/pcrlock\&.d/*\&.pcrlock\&.d/*\&.pcrlock +.RE +.RS 4 /run/pcrlock\&.d/*\&.pcrlock +.RE +.RS 4 /run/pcrlock\&.d/*\&.pcrlock\&.d/*\&.pcrlock +.RE +.RS 4 /var/lib/pcrlock\&.d/*\&.pcrlock +.RE +.RS 4 /var/lib/pcrlock\&.d/*\&.pcrlock\&.d/*\&.pcrlock +.RE +.RS 4 /usr/local/pcrlock\&.d/*\&.pcrlock +.RE +.RS 4 /usr/local/pcrlock\&.d/*\&.pcrlock\&.d/*\&.pcrlock +.RE +.RS 4 /usr/lib/pcrlock\&.d/*\&.pcrlock +.RE +.RS 4 /usr/lib/pcrlock\&.d/*\&.pcrlock\&.d/*\&.pcrlock -.fi +.RE .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 Common Event Log Format (CEL\-JSON)\fR\m[]\&\s-2\u[1]\d\s+2 +\m[blue]\fBTCG Canonical Event Log Format (CEL\-JSON)\fR\m[]\&\s-2\u[1]\d\s+2 specification\&. Specifically the "recnum", "content", and @@ -90,7 +108,7 @@ Added in version 255\&. 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\&. +400\-secureboot\-separator\&.pcrlock below)\&. May be generated via \fBsystemd\-pcrlock lock\-firmware\-code\fR\&. .sp @@ -100,7 +118,7 @@ Added in version 255\&. 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\&. +400\-secureboot\-separator\&.pcrlock below)\&. May be generated via \fBsystemd\-pcrlock lock\-firmware\-config\fR\&. .sp @@ -131,7 +149,7 @@ Added in version 255\&. 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\&. +400\-secureboot\-separator\&.pcrlock above)\&. May be generated via \fBsystemd\-pcrlock lock\-firmware\-code\fR\&. .sp @@ -141,7 +159,7 @@ Added in version 255\&. 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\&. +400\-secureboot\-separator\&.pcrlock above)\&. May be generated via \fBsystemd\-pcrlock lock\-firmware\-config\fR\&. .sp @@ -168,7 +186,7 @@ Added in version 255\&. .RS 4 The EFI action generated when \fBExitBootServices()\fR -is generated, i\&.e\&. the UEFI environment is left and the OS takes over\&. Covers the PCR 5 measurement\&. Statically defined\&. +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 @@ -266,11 +284,10 @@ Added in version 255\&. .RE .SH "SEE ALSO" .PP -\fBsystemd\fR(1), -\fBsystemd-pcrlock\fR(1) +\fBsystemd\fR(1), \fBsystemd-pcrlock\fR(1) .SH "NOTES" .IP " 1." 4 -TCG Common Event Log Format (CEL-JSON) +TCG Canonical Event Log Format (CEL-JSON) .RS 4 \%https://trustedcomputinggroup.org/resource/canonical-event-log-format/ .RE diff --git a/upstream/debian-unstable/man5/systemd.preset.5 b/upstream/debian-unstable/man5/systemd.preset.5 index 945e0d62..c75ee687 100644 --- a/upstream/debian-unstable/man5/systemd.preset.5 +++ b/upstream/debian-unstable/man5/systemd.preset.5 @@ -1,5 +1,5 @@ '\" t -.TH "SYSTEMD\&.PRESET" "5" "" "systemd 255" "systemd.preset" +.TH "SYSTEMD\&.PRESET" "5" "" "systemd 256~rc3" "systemd.preset" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -23,17 +23,24 @@ systemd.preset \- Service enablement presets .SH "SYNOPSIS" .PP +.RS 4 /etc/systemd/system\-preset/*\&.preset -.PP +.RE +.RS 4 /run/systemd/system\-preset/*\&.preset -.PP +.RE +.RS 4 /usr/lib/systemd/system\-preset/*\&.preset -.PP +.RE +.RS 4 /etc/systemd/user\-preset/*\&.preset -.PP +.RE +.RS 4 /run/systemd/user\-preset/*\&.preset -.PP +.RE +.RS 4 /usr/lib/systemd/user\-preset/*\&.preset +.RE .SH "DESCRIPTION" .PP Preset files may be used to encode policy which units shall be enabled by default and which ones shall be disabled\&. They are read by @@ -45,7 +52,7 @@ is identical to or \fBsystemctl disable\fR\&. \fBsystemctl preset\fR -is used by the post install scriptlets of rpm packages (or other OS package formats), to enable/disable specific units by default on package installation, enforcing distribution, spin or administrator preset policy\&. This allows choosing a certain set of units to be enabled/disabled even before installing the actual package\&. For more information, see +is used by the post install scriptlets of rpm packages (or other OS package formats), to enable/disable specific units by default on package installation, enforcing distribution, spin, or administrator preset policy\&. This allows choosing a certain set of units to be enabled/disabled even before installing the actual package\&. For more information, see \fBsystemctl\fR(1)\&. .PP It is not recommended to ship preset files within the respective software packages implementing the units, but rather centralize them in a distribution or spin default policy, which can be amended by administrator policy, see below\&. @@ -55,7 +62,11 @@ If no preset files exist, preset operations will enable all units that are insta When the machine is booted for the first time, \fBsystemd\fR(1) will enable/disable all units according to preset policy, similarly to -\fBsystemctl preset\-all\fR\&. Also see "First Boot Semantics" in +\fBsystemctl preset\-all\fR\&. Also see +\fIConditionFirstBoot=\fR +in +\fBsystemd.unit\fR(5) +and "First Boot Semantics" in \fBmachine-id\fR(5)\&. .SH "PRESET FILE FORMAT" .PP @@ -203,9 +214,7 @@ The preset mechanism allows clean separation of the enablement mechanism (inside \fBsystemctl preset\fR) and enablement policy (centralized in the preset files), and lifts the configuration out of individual packages\&. Preset files may be written for specific distributions, for specific spins or for specific sites, in order to enforce different policies as needed\&. It is recommended to apply the policy encoded in preset files in package installation scriptlets\&. .SH "SEE ALSO" .PP -\fBsystemd\fR(1), -\fBsystemctl\fR(1), -\fBsystemd-delta\fR(1) +\fBsystemd\fR(1), \fBsystemctl\fR(1), \fBsystemd-delta\fR(1) .PP \fBdaemon\fR(7) has a discussion of packaging scriptlets\&. diff --git a/upstream/debian-unstable/man5/systemd.resource-control.5 b/upstream/debian-unstable/man5/systemd.resource-control.5 index 3e1a9ae0..a2829b60 100644 --- a/upstream/debian-unstable/man5/systemd.resource-control.5 +++ b/upstream/debian-unstable/man5/systemd.resource-control.5 @@ -1,5 +1,5 @@ '\" t -.TH "SYSTEMD\&.RESOURCE\-CONTROL" "5" "" "systemd 255" "systemd.resource-control" +.TH "SYSTEMD\&.RESOURCE\-CONTROL" "5" "" "systemd 256~rc3" "systemd.resource-control" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -161,6 +161,7 @@ user\-\fInnn\fR\&.slice\&. Drop\-ins with local configuration that affect user 1 /etc/systemd/system/user\-1000\&.slice, /etc/systemd/system/user\-1000\&.slice\&.d/*\&.conf, but also /etc/systemd/system/user\-\&.slice\&.d/*\&.conf\&. This last directory applies to all user slices\&. +.SS "" .PP See the \m[blue]\fBNew Control Group Interfaces\fR\m[]\&\s-2\u[1]\d\s+2 @@ -422,7 +423,10 @@ Takes a memory size in bytes\&. If the value is suffixed with K, M, G or T, the "infinity", no memory throttling is applied\&. This controls the "memory\&.high" control group attribute\&. For details about this control group attribute, see -\m[blue]\fBMemory Interface Files\fR\m[]\&\s-2\u[5]\d\s+2\&. +\m[blue]\fBMemory Interface Files\fR\m[]\&\s-2\u[5]\d\s+2\&. The effective configuration is reported as +\fIEffectiveMemoryHigh=\fR +(see also +\fIEffectiveMemoryMax=\fR)\&. .sp While \fIStartupMemoryHigh=\fR @@ -451,7 +455,9 @@ Takes a memory size in bytes\&. If the value is suffixed with K, M, G or T, the "infinity", no memory limit is applied\&. This controls the "memory\&.max" control group attribute\&. For details about this control group attribute, see -\m[blue]\fBMemory Interface Files\fR\m[]\&\s-2\u[5]\d\s+2\&. +\m[blue]\fBMemory Interface Files\fR\m[]\&\s-2\u[5]\d\s+2\&. The effective configuration is reported as +\fIEffectiveMemoryMax=\fR +(the value is the most stringent limit of the unit and parent slices and it is capped by physical memory)\&. .sp While \fIStartupMemoryMax=\fR @@ -516,6 +522,19 @@ allows prioritizing specific services at boot\-up and shutdown differently than Added in version 253\&. .RE .PP +\fIMemoryZSwapWriteback=\fR +.RS 4 +This setting controls the +\fBmemory\fR +controller in the unified hierarchy\&. +.sp +Takes a boolean argument\&. When true, pages stored in the Zswap cache are permitted to be written to the backing storage, false otherwise\&. Defaults to true\&. This allows disabling writeback of swap pages for IO\-intensive applications, while retaining the ability to store compressed pages in Zswap\&. See the kernel\*(Aqs +\m[blue]\fBZswap\fR\m[]\&\s-2\u[6]\d\s+2 +documentation for more details\&. +.sp +Added in version 256\&. +.RE +.PP \fIAllowedMemoryNodes=\fR, \fIStartupAllowedMemoryNodes=\fR .RS 4 These settings control the @@ -569,7 +588,8 @@ Specify the maximum number of tasks that may be created in the unit\&. This ensu "infinity", no tasks limit is applied\&. This controls the "pids\&.max" control group attribute\&. For details about this control group attribute, the -\m[blue]\fBpids controller\fR\m[]\&\s-2\u[7]\d\s+2\&. +\m[blue]\fBpids controller\fR\m[]\&\s-2\u[7]\d\s+2\&. The effective configuration is reported as +\fIEffectiveTasksMax=\fR\&. .sp The system default for this setting may be controlled with \fIDefaultTasksMax=\fR @@ -702,6 +722,8 @@ The system default for this setting may be controlled with 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 @@ -833,9 +855,9 @@ Added in version 235\&. .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 @@ -964,6 +986,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 \{\ @@ -1739,20 +1766,7 @@ Added in version 252\&. .RE .SH "SEE ALSO" .PP -\fBsystemd\fR(1), -\fBsystemd-system.conf\fR(5), -\fBsystemd.unit\fR(5), -\fBsystemd.service\fR(5), -\fBsystemd.slice\fR(5), -\fBsystemd.scope\fR(5), -\fBsystemd.socket\fR(5), -\fBsystemd.mount\fR(5), -\fBsystemd.swap\fR(5), -\fBsystemd.exec\fR(5), -\fBsystemd.directives\fR(7), -\fBsystemd.special\fR(7), -\fBsystemd-oomd.service\fR(8), The documentation for control groups and specific controllers in the Linux kernel: -\m[blue]\fBControl Groups v2\fR\m[]\&\s-2\u[2]\d\s+2\&. +\fBsystemd\fR(1), \fBsystemd-system.conf\fR(5), \fBsystemd.unit\fR(5), \fBsystemd.service\fR(5), \fBsystemd.slice\fR(5), \fBsystemd.scope\fR(5), \fBsystemd.socket\fR(5), \fBsystemd.mount\fR(5), \fBsystemd.swap\fR(5), \fBsystemd.exec\fR(5), \fBsystemd.directives\fR(7), \fBsystemd.special\fR(7), \fBsystemd-oomd.service\fR(8), The documentation for control groups and specific controllers in the Linux kernel: \m[blue]\fBControl Groups v2\fR\m[]\&\s-2\u[2]\d\s+2 .SH "NOTES" .IP " 1." 4 New Control Group Interfaces @@ -1782,12 +1796,12 @@ Memory Interface Files .IP " 6." 4 Zswap .RS 4 -\%https://www.kernel.org/doc/html/latest/admin-guide/mm/zswap.html +\%https://docs.kernel.org/admin-guide/mm/zswap.html .RE .IP " 7." 4 pids controller .RS 4 -\%https://www.kernel.org/doc/html/latest/admin-guide/cgroup-v2.html#pid +\%https://docs.kernel.org/admin-guide/cgroup-v2.html#pid .RE .IP " 8." 4 IO Interface Files diff --git a/upstream/debian-unstable/man5/systemd.scope.5 b/upstream/debian-unstable/man5/systemd.scope.5 index 64cb28d7..45f17811 100644 --- a/upstream/debian-unstable/man5/systemd.scope.5 +++ b/upstream/debian-unstable/man5/systemd.scope.5 @@ -1,5 +1,5 @@ '\" t -.TH "SYSTEMD\&.SCOPE" "5" "" "systemd 255" "systemd.scope" +.TH "SYSTEMD\&.SCOPE" "5" "" "systemd 256~rc3" "systemd.scope" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -121,7 +121,7 @@ This setting also applies to \fBsystemd\-oomd\fR kills a cgroup associated with it\&. .sp -Added in version 243\&. +Added in version 253\&. .RE .PP \fIRuntimeMaxSec=\fR @@ -151,12 +151,7 @@ Check for more settings\&. .SH "SEE ALSO" .PP -\fBsystemd\fR(1), -\fBsystemd-run\fR(1), -\fBsystemd.unit\fR(5), -\fBsystemd.resource-control\fR(5), -\fBsystemd.service\fR(5), -\fBsystemd.directives\fR(7)\&. +\fBsystemd\fR(1), \fBsystemd-run\fR(1), \fBsystemd.unit\fR(5), \fBsystemd.resource-control\fR(5), \fBsystemd.service\fR(5), \fBsystemd.directives\fR(7)\&. .SH "NOTES" .IP " 1." 4 New Control Group Interfaces diff --git a/upstream/debian-unstable/man5/systemd.service.5 b/upstream/debian-unstable/man5/systemd.service.5 index 19597a2e..a53894ed 100644 --- a/upstream/debian-unstable/man5/systemd.service.5 +++ b/upstream/debian-unstable/man5/systemd.service.5 @@ -1,5 +1,5 @@ '\" t -.TH "SYSTEMD\&.SERVICE" "5" "" "systemd 255" "systemd.service" +.TH "SYSTEMD\&.SERVICE" "5" "" "systemd 256~rc3" "systemd.service" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -1322,21 +1322,9 @@ Added in version 189\&. \fIRestartPreventExitStatus=\fR .RS 4 Takes a list of exit status definitions that, when returned by the main service process, will prevent automatic service restarts, regardless of the restart setting configured with -\fIRestart=\fR\&. Exit status definitions can either be numeric exit codes or termination signal names, and are separated by spaces\&. Defaults to the empty list, so that, by default, no exit status is excluded from the configured restart logic\&. For example: -.sp -.if n \{\ -.RS 4 -.\} -.nf -RestartPreventExitStatus=1 6 SIGABRT -.fi -.if n \{\ -.RE -.\} -.sp -ensures that exit codes 1 and 6 and the termination signal -\fBSIGABRT\fR -will not result in automatic service restarting\&. This option may appear more than once, in which case the list of restart\-preventing statuses is merged\&. If the empty string is assigned to this option, the list is reset and all prior assignments of this option will have no effect\&. +\fIRestart=\fR\&. Exit status definitions can be numeric termination statuses, termination status names, or termination signal names, separated by spaces\&. Defaults to the empty list, so that, by default, no exit status is excluded from the configured restart logic\&. +.PP \fBExample\ \&2.\ \&A service with the \fIRestartPreventExitStatus=\fR setting\fR .sp .if n \{\ .RS 4 .\} .nf RestartPreventExitStatus=TEMPFAIL 250 SIGKILL .fi .if n \{\ .RE .\} .sp Exit status 75 (\fBTEMPFAIL\fR), 250, and the termination signal \fBSIGKILL\fR will not result in automatic service restarting\&. +This option may appear more than once, in which case the list of restart\-preventing statuses is merged\&. If the empty string is assigned to this option, the list is reset and all prior assignments of this option will have no effect\&. .sp Note that this setting has no effect on processes configured via \fIExecStartPre=\fR, @@ -1359,6 +1347,10 @@ Takes a list of exit status definitions that, when returned by the main service \fIRestart=\fR\&. The argument format is similar to \fIRestartPreventExitStatus=\fR\&. .sp +Note that for +\fIType=oneshot\fR +services, a success exit status will prevent them from auto\-restarting, no matter whether the corresponding exit statuses are listed in this option or not\&. +.sp Added in version 215\&. .RE .PP @@ -1737,7 +1729,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{ "+" @@ -1935,7 +1927,7 @@ with five arguments: "ls"\&. .SH "EXAMPLES" .PP -\fBExample\ \&2.\ \&Simple service\fR +\fBExample\ \&3.\ \&Simple service\fR .PP The following unit file creates a service that will execute /usr/sbin/foo\-daemon\&. Since no @@ -1979,7 +1971,7 @@ if the service can background itself or \fIType=\fR\fBdbus\fR if the unit acquires a DBus name once initialization is complete\&. See below\&. .PP -\fBExample\ \&3.\ \&Oneshot service\fR +\fBExample\ \&4.\ \&Oneshot service\fR .PP Sometimes, units should just execute an action without keeping active processes, such as a filesystem check or a cleanup action on boot\&. For this, \fIType=\fR\fBoneshot\fR @@ -2019,7 +2011,7 @@ are \fInot\fR allowed\&. .PP -\fBExample\ \&4.\ \&Stoppable oneshot service\fR +\fBExample\ \&5.\ \&Stoppable oneshot service\fR .PP Similarly to the oneshot services, there are sometimes units that need to execute a program to set up something and then execute another to shut it down, but no process remains active while they are considered "started"\&. Network configuration can sometimes fall into this category\&. Another use case is if a oneshot service shall not be executed each time when they are pulled in as a dependency, but only the first time\&. .PP @@ -2055,7 +2047,7 @@ Since the unit is considered to be running after the start action has exited, in \fBsystemctl start\fR on that unit again will cause no action to be taken\&. .PP -\fBExample\ \&5.\ \&Traditional forking services\fR +\fBExample\ \&6.\ \&Traditional forking services\fR .PP Many traditional daemons/services background (i\&.e\&. fork, daemonize) themselves when starting\&. Set \fIType=\fR\fBforking\fR @@ -2098,7 +2090,7 @@ Please see \fBsystemd.kill\fR(5) for details on how you can influence the way systemd terminates the service\&. .PP -\fBExample\ \&6.\ \&DBus services\fR +\fBExample\ \&7.\ \&DBus services\fR .PP For services that acquire a name on the DBus system bus, use \fIType=\fR\fBdbus\fR @@ -2149,7 +2141,7 @@ Please see \fBsystemd.kill\fR(5) for details on how you can influence the way systemd terminates the service\&. .PP -\fBExample\ \&7.\ \&Services that notify systemd about their initialization\fR +\fBExample\ \&8.\ \&Services that notify systemd about their initialization\fR .PP \fIType=\fR\fBsimple\fR services are really easy to write, but have the major disadvantage of systemd not being able to tell when initialization of the given service is complete\&. For this reason, systemd supports a simple notification protocol that allows daemons to make systemd aware that they are done initializing\&. Use @@ -2166,7 +2158,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] @@ -2182,17 +2174,17 @@ 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), -\fBsystemctl\fR(1), -\fBsystemd-system.conf\fR(5), -\fBsystemd.unit\fR(5), -\fBsystemd.exec\fR(5), -\fBsystemd.resource-control\fR(5), -\fBsystemd.kill\fR(5), -\fBsystemd.directives\fR(7), -\fBsystemd-run\fR(1) +\fBsystemd\fR(1), \fBsystemctl\fR(1), \fBsystemd-system.conf\fR(5), \fBsystemd.unit\fR(5), \fBsystemd.exec\fR(5), \fBsystemd.resource-control\fR(5), \fBsystemd.kill\fR(5), \fBsystemd.directives\fR(7), \fBsystemd-run\fR(1) .SH "NOTES" .IP " 1." 4 File Descriptor Store @@ -2209,3 +2201,8 @@ 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/debian-unstable/man5/systemd.slice.5 b/upstream/debian-unstable/man5/systemd.slice.5 index e4e179cc..98e7cc0b 100644 --- a/upstream/debian-unstable/man5/systemd.slice.5 +++ b/upstream/debian-unstable/man5/systemd.slice.5 @@ -1,5 +1,5 @@ '\" t -.TH "SYSTEMD\&.SLICE" "5" "" "systemd 255" "systemd.slice" +.TH "SYSTEMD\&.SLICE" "5" "" "systemd 256~rc3" "systemd.slice" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -102,16 +102,13 @@ option\&. .SH "OPTIONS" .PP Slice unit files may include [Unit] and [Install] sections, which are described in -\fBsystemd.unit\fR(5)\&. No options specific to this file type are supported\&. +\fBsystemd.unit\fR(5)\&. +.PP +Slice files may include a [Slice] section\&. Options that may be used in this section are shared with other unit types\&. These options are documented in +\fBsystemd.resource-control\fR(5)\&. .SH "SEE ALSO" .PP -\fBsystemd\fR(1), -\fBsystemd.unit\fR(5), -\fBsystemd.resource-control\fR(5), -\fBsystemd.service\fR(5), -\fBsystemd.scope\fR(5), -\fBsystemd.special\fR(7), -\fBsystemd.directives\fR(7) +\fBsystemd\fR(1), \fBsystemd.unit\fR(5), \fBsystemd.resource-control\fR(5), \fBsystemd.service\fR(5), \fBsystemd.scope\fR(5), \fBsystemd.special\fR(7), \fBsystemd.directives\fR(7) .SH "NOTES" .IP " 1." 4 New Control Group Interfaces diff --git a/upstream/debian-unstable/man5/systemd.socket.5 b/upstream/debian-unstable/man5/systemd.socket.5 index 1cd05d5c..3112c60a 100644 --- a/upstream/debian-unstable/man5/systemd.socket.5 +++ b/upstream/debian-unstable/man5/systemd.socket.5 @@ -1,5 +1,5 @@ '\" t -.TH "SYSTEMD\&.SOCKET" "5" "" "systemd 255" "systemd.socket" +.TH "SYSTEMD\&.SOCKET" "5" "" "systemd 256~rc3" "systemd.socket" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -191,9 +191,10 @@ Socket unit files may include [Unit] and [Install] sections, which are described \fBsystemd.unit\fR(5)\&. .PP Socket unit files must include a [Socket] section, which carries information about the socket or FIFO it supervises\&. A number of options that may be used in this section are shared with other unit types\&. These options are documented in -\fBsystemd.exec\fR(5) +\fBsystemd.exec\fR(5), +\fBsystemd.kill\fR(5) and -\fBsystemd.kill\fR(5)\&. The options specific to the [Socket] section of socket units are the following: +\fBsystemd.resource-control\fR(5)\&. The options specific to the [Socket] section of socket units are the following: .PP \fIListenStream=\fR, \fIListenDatagram=\fR, \fIListenSequentialPacket=\fR .RS 4 @@ -243,6 +244,13 @@ address in the family\&. The CID is a unique 32\-bit integer identifier in \fBAF_VSOCK\fR analogous to an IP address\&. Specifying the CID is optional, and may be set to the empty string\&. +"vsock" +may be replaced with +"vsock\-stream", +"vsock\-dgram" +or +"vsock\-seqpacket" +to force usage of the corresponding socket type\&. .sp Note that \fBSOCK_SEQPACKET\fR @@ -453,9 +461,11 @@ or datagram sockets\&. Defaults to 64\&. .PP \fIMaxConnectionsPerSource=\fR .RS 4 -The maximum number of connections for a service per source IP address\&. This is very similar to the +The maximum number of connections for a service per source IP address (in case of IPv4/IPv6), per source CID (in case of +\fBAF_VSOCK\fR), or source UID (in case of +\fBAF_UNIX\fR)\&. This is very similar to the \fIMaxConnections=\fR -directive above\&. Disabled by default\&. +directive above\&. Defaults to 0, i\&.e\&. disabled\&. .sp Added in version 232\&. .RE @@ -727,7 +737,7 @@ Added in version 247\&. .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\&. @@ -853,6 +863,21 @@ These setting defaults to 150 (in case of Added in version 255\&. .RE .PP +\fIPassFileDescriptorsToExec=\fR +.RS 4 +Takes a boolean argument\&. Defaults to off\&. If enabled, file descriptors created by the socket unit are passed to +\fIExecStartPost=\fR, +\fIExecStopPre=\fR, and +\fIExecStopPost=\fR +commands from the socket unit\&. The passed file descriptors can be accessed with +\fBsd_listen_fds\fR(3) +as if the commands were invoked from the associated service units\&. Note that +\fIExecStartPre=\fR +command cannot access socket file descriptors\&. +.sp +Added in version 256\&. +.RE +.PP Check \fBsystemd.unit\fR(5), \fBsystemd.exec\fR(5), and @@ -860,23 +885,10 @@ Check for more settings\&. .SH "SEE ALSO" .PP -\fBsystemd\fR(1), -\fBsystemctl\fR(1), -\fBsystemd-system.conf\fR(5), -\fBsystemd.unit\fR(5), -\fBsystemd.exec\fR(5), -\fBsystemd.kill\fR(5), -\fBsystemd.resource-control\fR(5), -\fBsystemd.service\fR(5), -\fBsystemd.directives\fR(7), -\fBsd_listen_fds\fR(3), -\fBsd_listen_fds_with_names\fR(3) +\fBsystemd\fR(1), \fBsystemctl\fR(1), \fBsystemd-system.conf\fR(5), \fBsystemd.unit\fR(5), \fBsystemd.exec\fR(5), \fBsystemd.kill\fR(5), \fBsystemd.resource-control\fR(5), \fBsystemd.service\fR(5), \fBsystemd.directives\fR(7), \fBsd_listen_fds\fR(3), \fBsd_listen_fds_with_names\fR(3) .PP For more extensive descriptions see the "systemd for Developers" series: -\m[blue]\fBSocket Activation\fR\m[]\&\s-2\u[4]\d\s+2, -\m[blue]\fBSocket Activation, part II\fR\m[]\&\s-2\u[5]\d\s+2, -\m[blue]\fBConverting inetd Services\fR\m[]\&\s-2\u[6]\d\s+2, -\m[blue]\fBSocket Activated Internet Services and OS Containers\fR\m[]\&\s-2\u[7]\d\s+2\&. +\m[blue]\fBSocket Activation\fR\m[]\&\s-2\u[4]\d\s+2, \m[blue]\fBSocket Activation, part II\fR\m[]\&\s-2\u[5]\d\s+2, \m[blue]\fBConverting inetd Services\fR\m[]\&\s-2\u[6]\d\s+2, \m[blue]\fBSocket Activated Internet Services and OS Containers\fR\m[]\&\s-2\u[7]\d\s+2\&. .SH "NOTES" .IP " 1." 4 USB FunctionFS diff --git a/upstream/debian-unstable/man5/systemd.swap.5 b/upstream/debian-unstable/man5/systemd.swap.5 index 1cb7edb2..3adcd21b 100644 --- a/upstream/debian-unstable/man5/systemd.swap.5 +++ b/upstream/debian-unstable/man5/systemd.swap.5 @@ -1,5 +1,5 @@ '\" t -.TH "SYSTEMD\&.SWAP" "5" "" "systemd 255" "systemd.swap" +.TH "SYSTEMD\&.SWAP" "5" "" "systemd 256~rc3" "systemd.swap" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -176,13 +176,14 @@ Swap unit files may include [Unit] and [Install] sections, which are described i \fBsystemd.unit\fR(5)\&. .PP Swap unit files must include a [Swap] section, which carries information about the swap device it supervises\&. A number of options that may be used in this section are shared with other unit types\&. These options are documented in -\fBsystemd.exec\fR(5) +\fBsystemd.exec\fR(5), +\fBsystemd.kill\fR(5) and -\fBsystemd.kill\fR(5)\&. The options specific to the [Swap] section of swap units are the following: +\fBsystemd.resource-control\fR(5)\&. The options specific to the [Swap] section of swap units are the following: .PP \fIWhat=\fR .RS 4 -Takes an absolute path of a device node or file to use for paging\&. See +Takes an absolute path or a fstab\-style identifier of a device node or file to use for paging\&. See \fBswapon\fR(8) for details\&. If this refers to a device node, a dependency on the respective device unit is automatically created\&. (See \fBsystemd.device\fR(5) @@ -233,15 +234,4 @@ Check for more settings\&. .SH "SEE ALSO" .PP -\fBsystemd\fR(1), -\fBsystemctl\fR(1), -\fBsystemd-system.conf\fR(5), -\fBsystemd.unit\fR(5), -\fBsystemd.exec\fR(5), -\fBsystemd.kill\fR(5), -\fBsystemd.resource-control\fR(5), -\fBsystemd.device\fR(5), -\fBsystemd.mount\fR(5), -\fBswapon\fR(8), -\fBsystemd-fstab-generator\fR(8), -\fBsystemd.directives\fR(7) +\fBsystemd\fR(1), \fBsystemctl\fR(1), \fBsystemd-system.conf\fR(5), \fBsystemd.unit\fR(5), \fBsystemd.exec\fR(5), \fBsystemd.kill\fR(5), \fBsystemd.resource-control\fR(5), \fBsystemd.device\fR(5), \fBsystemd.mount\fR(5), \fBswapon\fR(8), \fBsystemd-fstab-generator\fR(8), \fBsystemd.directives\fR(7) diff --git a/upstream/debian-unstable/man5/systemd.target.5 b/upstream/debian-unstable/man5/systemd.target.5 index ba0aa547..8d5cb678 100644 --- a/upstream/debian-unstable/man5/systemd.target.5 +++ b/upstream/debian-unstable/man5/systemd.target.5 @@ -1,5 +1,5 @@ '\" t -.TH "SYSTEMD\&.TARGET" "5" "" "systemd 255" "systemd.target" +.TH "SYSTEMD\&.TARGET" "5" "" "systemd 256~rc3" "systemd.target" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -170,8 +170,4 @@ without modifying them by using \fBsystemctl add\-wants\fR\&. .SH "SEE ALSO" .PP -\fBsystemd\fR(1), -\fBsystemctl\fR(1), -\fBsystemd.unit\fR(5), -\fBsystemd.special\fR(7), -\fBsystemd.directives\fR(7) +\fBsystemd\fR(1), \fBsystemctl\fR(1), \fBsystemd.unit\fR(5), \fBsystemd.special\fR(7), \fBsystemd.directives\fR(7) diff --git a/upstream/debian-unstable/man5/systemd.timer.5 b/upstream/debian-unstable/man5/systemd.timer.5 index de75ccde..1f5a8fce 100644 --- a/upstream/debian-unstable/man5/systemd.timer.5 +++ b/upstream/debian-unstable/man5/systemd.timer.5 @@ -1,5 +1,5 @@ '\" t -.TH "SYSTEMD\&.TIMER" "5" "" "systemd 255" "systemd.timer" +.TH "SYSTEMD\&.TIMER" "5" "" "systemd 256~rc3" "systemd.timer" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -378,11 +378,4 @@ section in \fBsystemd.exec\fR(5) for more details\&. .PP -\fBsystemd\fR(1), -\fBsystemctl\fR(1), -\fBsystemd.unit\fR(5), -\fBsystemd.service\fR(5), -\fBsystemd.time\fR(7), -\fBsystemd.directives\fR(7), -\fBsystemd-system.conf\fR(5), -\fBprctl\fR(2) +\fBsystemd\fR(1), \fBsystemctl\fR(1), \fBsystemd.unit\fR(5), \fBsystemd.service\fR(5), \fBsystemd.time\fR(7), \fBsystemd.directives\fR(7), \fBsystemd-system.conf\fR(5), \fBprctl\fR(2) diff --git a/upstream/debian-unstable/man5/systemd.unit.5 b/upstream/debian-unstable/man5/systemd.unit.5 index 9c3e27c6..7e3e6fae 100644 --- a/upstream/debian-unstable/man5/systemd.unit.5 +++ b/upstream/debian-unstable/man5/systemd.unit.5 @@ -1,5 +1,5 @@ '\" t -.TH "SYSTEMD\&.UNIT" "5" "" "systemd 255" "systemd.unit" +.TH "SYSTEMD\&.UNIT" "5" "" "systemd 256~rc3" "systemd.unit" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -23,52 +23,92 @@ systemd.unit \- Unit configuration .SH "SYNOPSIS" .PP -\fIservice\fR\&.service, -\fIsocket\fR\&.socket, -\fIdevice\fR\&.device, -\fImount\fR\&.mount, -\fIautomount\fR\&.automount, -\fIswap\fR\&.swap, -\fItarget\fR\&.target, -\fIpath\fR\&.path, -\fItimer\fR\&.timer, -\fIslice\fR\&.slice, -\fIscope\fR\&.scope +\fIservice\fR\&.service, \fIsocket\fR\&.socket, \fIdevice\fR\&.device, \fImount\fR\&.mount, \fIautomount\fR\&.automount, \fIswap\fR\&.swap, \fItarget\fR\&.target, \fIpath\fR\&.path, \fItimer\fR\&.timer, \fIslice\fR\&.slice, \fIscope\fR\&.scope .SS "System Unit Search Path" .PP -.nf +.RS 4 /etc/systemd/system\&.control/* +.RE +.RS 4 /run/systemd/system\&.control/* +.RE +.RS 4 /run/systemd/transient/* +.RE +.RS 4 /run/systemd/generator\&.early/* +.RE +.RS 4 /etc/systemd/system/* +.RE +.RS 4 /etc/systemd/system\&.attached/* +.RE +.RS 4 /run/systemd/system/* +.RE +.RS 4 /run/systemd/system\&.attached/* +.RE +.RS 4 /run/systemd/generator/* +.RE +.RS 4 \&... +.RE +.RS 4 /usr/lib/systemd/system/* +.RE +.RS 4 /run/systemd/generator\&.late/* -.fi +.RE .SS "User Unit Search Path" .PP -.nf +.RS 4 ~/\&.config/systemd/user\&.control/* +.RE +.RS 4 $XDG_RUNTIME_DIR/systemd/user\&.control/* +.RE +.RS 4 $XDG_RUNTIME_DIR/systemd/transient/* +.RE +.RS 4 $XDG_RUNTIME_DIR/systemd/generator\&.early/* +.RE +.RS 4 ~/\&.config/systemd/user/* +.RE +.RS 4 $XDG_CONFIG_DIRS/systemd/user/* +.RE +.RS 4 /etc/systemd/user/* +.RE +.RS 4 $XDG_RUNTIME_DIR/systemd/user/* +.RE +.RS 4 /run/systemd/user/* +.RE +.RS 4 $XDG_RUNTIME_DIR/systemd/generator/* +.RE +.RS 4 $XDG_DATA_HOME/systemd/user/* +.RE +.RS 4 $XDG_DATA_DIRS/systemd/user/* +.RE +.RS 4 \&... +.RE +.RS 4 /usr/lib/systemd/user/* +.RE +.RS 4 $XDG_RUNTIME_DIR/systemd/generator\&.late/* -.fi +.RE .SH "DESCRIPTION" .PP A unit file is a plain text ini\-style file that encodes information about a service, a socket, a device, a mount point, an automount point, a swap file or partition, a start\-up target, a watched file system path, a timer controlled and supervised by @@ -152,7 +192,7 @@ Aliases obey the following restrictions: a unit of a certain type ("\&.service", "alias@inst\&.service") may be a symlink to different template (e\&.g\&. "template@inst\&.service")\&. In that case, just this specific instance is aliased, while other instances of the template (e\&.g\&. "alias@foo\&.service", -"alias@bar\&.service") are not aliased\&. Those rules preserve the requirement that the instance (if any) is always uniquely defined for a given unit and all its aliases\&. The target of alias symlink must point to a valid unit file location, i\&.e\&. the symlink target name must match the symlink source name as described, and the destination path must be in one of the unit search paths, see UNIT FILE LOAD PATH section below for more details\&. Note that the target file may not exist, i\&.e\&. the symlink may be dangling\&. +"alias@bar\&.service") are not aliased\&. Those rules preserve the requirement that the instance (if any) is always uniquely defined for a given unit and all its aliases\&. The target of alias symlink must point to a valid unit file location, i\&.e\&. the symlink target name must match the symlink source name as described, and the destination path must be in one of the unit search paths, see UNIT FILE LOAD PATH section below for more details\&. Note that the target file might not exist, i\&.e\&. the symlink may be dangling\&. .PP Unit files may specify aliases through the \fIAlias=\fR @@ -199,7 +239,7 @@ commands of \&.wants/ or \&.requires/ -must thus point to a valid unit file location, i\&.e\&. the symlink target name must satisfy the described requirements, and the destination path must be in one of the unit search paths, see UNIT FILE LOAD PATH section below for more details\&. Note that the target file may not exist, i\&.e\&. the symlink may be dangling\&. +must thus point to a valid unit file location, i\&.e\&. the symlink target name must satisfy the described requirements, and the destination path must be in one of the unit search paths, see UNIT FILE LOAD PATH section below for more details\&. Note that the target file might not exist, i\&.e\&. the symlink may be dangling\&. .PP Along with a unit file foo\&.service, a "drop\-in" directory @@ -1057,6 +1097,17 @@ local\-fs\&.target, but are still honored for the purposes of this option, i\&.e Added in version 201\&. .RE .PP +\fIWantsMountsFor=\fR +.RS 4 +Same as +\fIRequiresMountsFor=\fR, but adds dependencies of type +\fIWants=\fR +instead of +\fIRequires=\fR\&. +.sp +Added in version 256\&. +.RE +.PP \fIOnSuccessJobMode=\fR, \fIOnFailureJobMode=\fR .RS 4 Takes a value of @@ -1196,11 +1247,8 @@ Configure the action to take when the unit stops and enters a failed state or in and \fBhalt\-immediate\fR\&. In system mode, all options are allowed\&. In user mode, only \fBnone\fR, -\fBexit\fR, -\fBexit\-force\fR, -\fBsoft\-reboot\fR -and -\fBsoft\-reboot\-force\fR +\fBexit\fR, and +\fBexit\-force\fR are allowed\&. Both options default to \fBnone\fR\&. .sp @@ -1290,7 +1338,7 @@ optionally configures an additional action to take when the timeout is hit, see and \fIJobRunningTimeoutSec=\fR above\&. It takes the same values as -\fIStartLimitAction=\fR\&. Defaults to +\fIFailureAction=\fR/\fISuccessAction=\fR\&. Defaults to \fBnone\fR\&. .sp \fIJobTimeoutRebootArgument=\fR @@ -1446,6 +1494,10 @@ Check whether the system is running on a specific architecture\&. Takes one of "arc\-be", or "native"\&. .sp +Use +\fBsystemd-analyze\fR(1) +for the complete list of known architectures\&. +.sp The architecture is determined from the information returned by \fBuname\fR(2) and is thus subject to @@ -1780,7 +1832,7 @@ on the next following boot\&. Units making use of this condition should order th \fBsystemd-update-done.service\fR(8), to make sure they run before the stamp file\*(Aqs modification time gets reset indicating a completed update\&. .sp If the -\fIsystemd\&.condition\-needs\-update=\fR +\fIsystemd\&.condition_needs_update=\fR option is specified on the kernel command line (taking a boolean), it will override the result of this condition check, taking precedence over any file modification time checks\&. If the kernel command line option is used, systemd\-update\-done\&.service will not have immediate effect on any following @@ -1806,12 +1858,19 @@ Added in version 244\&. Takes a boolean argument\&. This condition may be used to conditionalize units on whether the system is booting up for the first time\&. This roughly means that /etc/ was unpopulated when the system started booting (for details, see "First Boot Semantics" in -\fBmachine-id\fR(5))\&. First boot is considered finished (this condition will evaluate as false) after the manager has finished the startup phase\&. +\fBmachine-id\fR(5))\&. First Boot is considered finished (this condition will evaluate as false) after the manager has finished the startup phase\&. .sp This condition may be used to populate /etc/ on the first boot after factory reset, or when a new system instance boots up for the first time\&. .sp +Note that the service manager itself will perform setup steps during First Boot: it will initialize +\fBmachine-id\fR(5) +and preset all units, enabling or disabling them according to the +\fBsystemd.preset\fR(5) +settings\&. Additional setup may be performed via units with +\fIConditionFirstBoot=yes\fR\&. +.sp For robustness, units with \fIConditionFirstBoot=yes\fR should order themselves before @@ -1820,7 +1879,7 @@ and pull in this passive target with \fIWants=\fR\&. This ensures that in a case of an aborted first boot, these units will be re\-run during the next system startup\&. .sp If the -\fIsystemd\&.condition\-first\-boot=\fR +\fIsystemd\&.condition_first_boot=\fR 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\&. @@ -2470,6 +2529,7 @@ l l l l l l l l l l l l +l l l l l l. T{ "%a" @@ -2514,6 +2574,13 @@ T}:T{ This is the value of the "$CREDENTIALS_DIRECTORY" environment variable if available\&. See section "Credentials" in \fBsystemd.exec\fR(5) for more information\&. T} T{ +"%D" +T}:T{ +Shared data directory +T}:T{ +This is either /usr/share/ (for the system manager) or the path "$XDG_DATA_HOME" resolves to (for user managers)\&. +T} +T{ "%E" T}:T{ Configuration directory root @@ -2972,26 +3039,7 @@ instance fails it will not trigger an instance named failure\-handler@failure\-handler\&.service\&. .SH "SEE ALSO" .PP -\fBsystemd\fR(1), -\fBsystemctl\fR(1), -\fBsystemd-system.conf\fR(5), -\fBsystemd.special\fR(7), -\fBsystemd.service\fR(5), -\fBsystemd.socket\fR(5), -\fBsystemd.device\fR(5), -\fBsystemd.mount\fR(5), -\fBsystemd.automount\fR(5), -\fBsystemd.swap\fR(5), -\fBsystemd.target\fR(5), -\fBsystemd.path\fR(5), -\fBsystemd.timer\fR(5), -\fBsystemd.scope\fR(5), -\fBsystemd.slice\fR(5), -\fBsystemd.time\fR(7), -\fBsystemd-analyze\fR(1), -\fBcapabilities\fR(7), -\fBsystemd.directives\fR(7), -\fBuname\fR(1) +\fBsystemd\fR(1), \fBsystemctl\fR(1), \fBsystemd-system.conf\fR(5), \fBsystemd.special\fR(7), \fBsystemd.service\fR(5), \fBsystemd.socket\fR(5), \fBsystemd.device\fR(5), \fBsystemd.mount\fR(5), \fBsystemd.automount\fR(5), \fBsystemd.swap\fR(5), \fBsystemd.target\fR(5), \fBsystemd.path\fR(5), \fBsystemd.timer\fR(5), \fBsystemd.scope\fR(5), \fBsystemd.slice\fR(5), \fBsystemd.time\fR(7), \fBsystemd-analyze\fR(1), \fBcapabilities\fR(7), \fBsystemd.directives\fR(7), \fBuname\fR(1) .SH "NOTES" .IP " 1." 4 Interface Portability and Stability Promise diff --git a/upstream/debian-unstable/man5/sysupdate.d.5 b/upstream/debian-unstable/man5/sysupdate.d.5 index 456bdb01..fbf4facb 100644 --- a/upstream/debian-unstable/man5/sysupdate.d.5 +++ b/upstream/debian-unstable/man5/sysupdate.d.5 @@ -1,5 +1,5 @@ '\" t -.TH "SYSUPDATE\&.D" "5" "" "systemd 255" "sysupdate.d" +.TH "SYSUPDATE\&.D" "5" "" "systemd 256~rc3" "sysupdate.d" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -23,12 +23,15 @@ sysupdate.d \- Transfer Definition Files for Automatic Updates .SH "SYNOPSIS" .PP -.nf +.RS 4 /etc/sysupdate\&.d/*\&.conf +.RE +.RS 4 /run/sysupdate\&.d/*\&.conf +.RE +.RS 4 /usr/lib/sysupdate\&.d/*\&.conf - -.fi +.RE .SH "DESCRIPTION" .PP sysupdate\&.d/*\&.conf @@ -1319,9 +1322,7 @@ and decompresses/unpacks it to is created/updated always pointing to the most recent update\&. .SH "SEE ALSO" .PP -\fBsystemd\fR(1), -\fBsystemd-sysupdate\fR(8), -\fBsystemd-repart\fR(8) +\fBsystemd\fR(1), \fBsystemd-sysupdate\fR(8), \fBsystemd-repart\fR(8) .SH "NOTES" .IP " 1." 4 Discoverable Partitions Specification diff --git a/upstream/debian-unstable/man5/sysusers.d.5 b/upstream/debian-unstable/man5/sysusers.d.5 index a44d461f..22c19b4b 100644 --- a/upstream/debian-unstable/man5/sysusers.d.5 +++ b/upstream/debian-unstable/man5/sysusers.d.5 @@ -1,5 +1,5 @@ '\" t -.TH "SYSUSERS\&.D" "5" "" "systemd 255" "sysusers.d" +.TH "SYSUSERS\&.D" "5" "" "systemd 256~rc3" "sysusers.d" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -23,11 +23,15 @@ sysusers.d \- Declarative allocation of system users and groups .SH "SYNOPSIS" .PP +.RS 4 /etc/sysusers\&.d/*\&.conf -.PP +.RE +.RS 4 /run/sysusers\&.d/*\&.conf -.PP +.RE +.RS 4 /usr/lib/sysusers\&.d/*\&.conf +.RE .sp .nf #Type Name ID GECOS Home directory Shell @@ -367,8 +371,7 @@ sysusers\&.d vendor configuration, except to block certain users or groups from being created\&. .SH "SEE ALSO" .PP -\fBsystemd\fR(1), -\fBsystemd-sysusers\fR(8) +\fBsystemd\fR(1), \fBsystemd-sysusers\fR(8) .SH "NOTES" .IP " 1." 4 User/Group Name Syntax diff --git a/upstream/debian-unstable/man5/term.5 b/upstream/debian-unstable/man5/term.5 index cb7a97cf..d438dbdf 100644 --- a/upstream/debian-unstable/man5/term.5 +++ b/upstream/debian-unstable/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/debian-unstable/man5/termcap.5 b/upstream/debian-unstable/man5/termcap.5 index 880c957f..b0f7fade 100644 --- a/upstream/debian-unstable/man5/termcap.5 +++ b/upstream/debian-unstable/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 6.8" .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/debian-unstable/man5/terminfo.5 b/upstream/debian-unstable/man5/terminfo.5 index 5e6a8215..c4c24949 100644 --- a/upstream/debian-unstable/man5/terminfo.5 +++ b/upstream/debian-unstable/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 20240113). +This document describes +.I \%ncurses +version 6.5 +(patch 20240427). .SS "\fIterminfo\fP Entry Syntax" Entries in .I terminfo @@ -229,60 +231,79 @@ 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 center; -Lb Cb S Lb -Lb Lb Lb Lb -Lb Lb Lb Lx. +Lb Cb S Lb +Lb Lb Lb Lb +Lbw(25n)2 Lbw(8n)2 Lb2 Lx. \& Code \& Boolean Capability Name TI TC Description _ @@ -439,9 +460,9 @@ T} . .TS center; -Lb Cb S Lb -Lb Lb Lb Lb -Lb Lb Lb Lx. +Lb Cb S Lb +Lb Lb Lb Lb +Lbw(25n)2 Lbw(8n)2 Lb2 Lx. \& Code \& Numeric Capability Name TI TC Description _ @@ -519,9 +540,9 @@ They came in with SVr4's printer support. .PP .TS center; -Lb Cb S Lb -Lb Lb Lb Lb -Lb Lb Lb Lx. +Lb Cb S Lb +Lb Lb Lb Lb +Lbw(25n)2 Lbw(8n)2 Lb2 Lx. \& Code \& Numeric Capability Name TI TC Description _ @@ -598,9 +619,9 @@ T} . .TS center; -Lb Cb S Lb -Lb Lb Lb Lb -Lb Lb Lb Lx. +Lb Cb S Lb +Lb Lb Lb Lb +Lbw(25n)2 Lbw(8n)2 Lb2 Lx. \& Code \& String Capability Name TI TC Description _ @@ -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 @@ -2029,9 +2070,9 @@ but were originally not documented in the man page. .PP .TS center; -Lb Cb S Lb -Lb Lb Lb Lb -Lb Lb Lb Lx. +Lb Cb S Lb +Lb Lb Lb Lb +Lbw(25n)2 Lbw(8n)2 Lb2 Lx. \& Code \& String Capability Name TI TC Description _ @@ -2178,9 +2219,9 @@ entries after SVr4.1; beware! .PP .TS center; -Lb Cb S Lb -Lb Lb Lb Lb -Lb Lb Lb Lx. +Lb Cb S Lb +Lb Lb Lb Lb +Lbw(25n)2 Lbw(8n)2 Lb2 Lx. \& Code \& String Capability Name TI TC Description _ @@ -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/debian-unstable/man5/timesyncd.conf.5 b/upstream/debian-unstable/man5/timesyncd.conf.5 index 33f0675d..663f10bd 100644 --- a/upstream/debian-unstable/man5/timesyncd.conf.5 +++ b/upstream/debian-unstable/man5/timesyncd.conf.5 @@ -1,5 +1,5 @@ '\" t -.TH "TIMESYNCD\&.CONF" "5" "" "systemd 255" "timesyncd.conf" +.TH "TIMESYNCD\&.CONF" "5" "" "systemd 256~rc3" "timesyncd.conf" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -23,13 +23,24 @@ timesyncd.conf, timesyncd.conf.d \- Network Time Synchronization configuration files .SH "SYNOPSIS" .PP +.RS 4 /etc/systemd/timesyncd\&.conf -.PP +.RE +.RS 4 +/run/systemd/timesyncd\&.conf +.RE +.RS 4 +/usr/lib/systemd/timesyncd\&.conf +.RE +.RS 4 /etc/systemd/timesyncd\&.conf\&.d/*\&.conf -.PP +.RE +.RS 4 /run/systemd/timesyncd\&.conf\&.d/*\&.conf -.PP +.RE +.RS 4 /usr/lib/systemd/timesyncd\&.conf\&.d/*\&.conf +.RE .SH "DESCRIPTION" .PP These configuration files control NTP network time synchronization\&. See @@ -37,16 +48,16 @@ These configuration files control NTP network time synchronization\&. See for a general description of the syntax\&. .SH "CONFIGURATION DIRECTORIES AND PRECEDENCE" .PP -The default configuration is set during compilation, so configuration is only needed when it is necessary to deviate from those defaults\&. The main configuration file is either in -/usr/lib/systemd/ -or -/etc/systemd/ -and contains commented out entries showing the defaults as a guide to the administrator\&. Local overrides can be created by creating drop\-ins, as described below\&. The main configuration file can also be edited for this purpose (or a copy in +The default configuration is set during compilation, so configuration is only needed when it is necessary to deviate from those defaults\&. The main configuration file is loaded from one of the listed directories in order of priority, only the first file found is used: +/etc/systemd/, +/run/systemd/, +/usr/local/lib/systemd/, +/usr/lib/systemd/\&. The vendor version of the file contains commented out entries showing the defaults as a guide to the administrator\&. Local overrides can also be created by creating drop\-ins, as described below\&. The main configuration file can also be edited for this purpose (or a copy in /etc/ -if it\*(Aqs shipped in -/usr/) however using drop\-ins for local configuration is recommended over modifications to the main configuration file\&. +if it\*(Aqs shipped under +/usr/), however using drop\-ins for local configuration is recommended over modifications to the main configuration file\&. .PP -In addition to the "main" configuration file, drop\-in configuration snippets are read from +In addition to the main configuration file, drop\-in configuration snippets are read from /usr/lib/systemd/*\&.conf\&.d/, /usr/local/lib/systemd/*\&.conf\&.d/, and /etc/systemd/*\&.conf\&.d/\&. Those drop\-ins have higher precedence and override the main configuration file\&. Files in the @@ -56,7 +67,12 @@ configuration subdirectories are sorted by their filename in lexicographic order When packages need to customize the configuration, they can install drop\-ins under /usr/\&. Files in /etc/ -are reserved for the local administrator, who may use this logic to override the configuration files installed by vendor packages\&. Drop\-ins have to be used to override package drop\-ins, since the main configuration file has lower precedence\&. It is recommended to prefix all filenames in those subdirectories with a two\-digit number and a dash, to simplify the ordering of the files\&. This also defined a concept of drop\-in priority to allow distributions to ship drop\-ins within a specific range lower than the range used by users\&. This should lower the risk of package drop\-ins overriding accidentally drop\-ins defined by users\&. +are reserved for the local administrator, who may use this logic to override the configuration files installed by vendor packages\&. Drop\-ins have to be used to override package drop\-ins, since the main configuration file has lower precedence\&. It is recommended to prefix all filenames in those subdirectories with a two\-digit number and a dash, to simplify the ordering of the files\&. This also defines a concept of drop\-in priorities to allow OS vendors to ship drop\-ins within a specific range lower than the range used by users\&. This should lower the risk of package drop\-ins overriding accidentally drop\-ins defined by users\&. It is recommended to use the range 10\-40 for drop\-ins in +/usr/ +and the range 60\-90 for drop\-ins in +/etc/ +and +/run/, to make sure that local and transient drop\-ins take priority over drop\-ins shipped by the OS vendor\&. .PP To disable a configuration file supplied by the vendor, the recommended way is to place a symlink to /dev/null @@ -135,6 +151,4 @@ Added in version 250\&. .RE .SH "SEE ALSO" .PP -\fBsystemd\fR(1), -\fBsystemd-timesyncd.service\fR(8), -\fBsystemd-networkd.service\fR(8) +\fBsystemd\fR(1), \fBsystemd-timesyncd.service\fR(8), \fBsystemd-networkd.service\fR(8) diff --git a/upstream/debian-unstable/man5/tmpfiles.d.5 b/upstream/debian-unstable/man5/tmpfiles.d.5 index 9c32f27f..f84439b7 100644 --- a/upstream/debian-unstable/man5/tmpfiles.d.5 +++ b/upstream/debian-unstable/man5/tmpfiles.d.5 @@ -1,5 +1,5 @@ '\" t -.TH "TMPFILES\&.D" "5" "" "systemd 255" "tmpfiles.d" +.TH "TMPFILES\&.D" "5" "" "systemd 256~rc3" "tmpfiles.d" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -20,25 +20,34 @@ .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- .SH "NAME" -tmpfiles.d \- Configuration for creation, deletion and cleaning of volatile and temporary files +tmpfiles.d \- Configuration for creation, deletion, and cleaning of files and directories .SH "SYNOPSIS" .PP -.nf +.RS 4 /etc/tmpfiles\&.d/*\&.conf +.RE +.RS 4 /run/tmpfiles\&.d/*\&.conf +.RE +.RS 4 /usr/lib/tmpfiles\&.d/*\&.conf - -.fi +.RE .PP -.nf +.RS 4 ~/\&.config/user\-tmpfiles\&.d/*\&.conf +.RE +.RS 4 $XDG_RUNTIME_DIR/user\-tmpfiles\&.d/*\&.conf +.RE +.RS 4 ~/\&.local/share/user\-tmpfiles\&.d/*\&.conf +.RE +.RS 4 \&... +.RE +.RS 4 /usr/share/user\-tmpfiles\&.d/*\&.conf - -.fi - +.RE .sp .nf #Type Path Mode User Group Age Argument @@ -326,21 +335,13 @@ Added in version 214\&. .PP \fIx\fR .RS 4 -Ignore a path during cleaning\&. Use this type to exclude paths from clean\-up as controlled with the Age parameter\&. Note that lines of this type do not influence the effect of -\fIr\fR -or -\fIR\fR -lines\&. Lines of this type accept shell\-style globs in place of normal path names\&. +Ignore a path during cleaning\&. Use this type to exclude paths from clean\-up as controlled with the Age parameter\&. Lines of this type accept shell\-style globs in place of normal path names\&. .RE .PP \fIX\fR .RS 4 Ignore a path during cleaning\&. Use this type to exclude paths from clean\-up as controlled with the Age parameter\&. Unlike -\fIx\fR, this parameter will not exclude the content if path is a directory, but only directory itself\&. Note that lines of this type do not influence the effect of -\fIr\fR -or -\fIR\fR -lines\&. Lines of this type accept shell\-style globs in place of normal path names\&. +\fIx\fR, this parameter will not exclude the content if path is a directory, but only directory itself\&. Lines of this type accept shell\-style globs in place of normal path names\&. .sp Added in version 198\&. .RE @@ -513,7 +514,7 @@ and are combined Base64 decoding is applied to the credential contents\&. .PP Note that for all line types that result in creation of any kind of file node (i\&.e\&. -\fIf\fR/\fIF\fR, +\fIf\fR, \fId\fR/\fID\fR/\fIv\fR/\fIq\fR/\fIQ\fR, \fIp\fR, \fIL\fR, @@ -661,8 +662,8 @@ and \fIb\fR, determines the major/minor of the device node, with major and minor formatted as integers, separated by ":", e\&.g\&. "1:3"\&. For -\fIf\fR, -\fIF\fR, and +\fIf\fR +and \fIw\fR, the argument may be used to specify a short string that is written to the file, suffixed by a newline\&. For \fIC\fR, specifies the source file or directory\&. For \fIt\fR @@ -1000,7 +1001,7 @@ will be removed on boot\&. The directory will not be created\&. .RS 4 .\} .nf -\-smbios type=11,value=io\&.systemd\&.credential\&.binary:tmpfiles\&.extra=$(echo "f~ /root/\&.ssh/authorized_keys 700 root root \- $(ssh\-add \-L | base64 \-w 0)" | base64 \-w 0) +\-smbios type=11,value=io\&.systemd\&.credential\&.binary:tmpfiles\&.extra=$(echo \-e "d /root/\&.ssh 0750 root root \-\enf~ /root/\&.ssh/authorized_keys 0600 root root \- $(ssh\-add \-L | base64 \-w 0)" | base64 \-w 0) .fi .if n \{\ .RE @@ -1021,18 +1022,7 @@ will warn if is used\&. .SH "SEE ALSO" .PP -\fBsystemd\fR(1), -\fBsystemd-tmpfiles\fR(8), -\fBsystemd-delta\fR(1), -\fBsystemd.exec\fR(5), -\fBattr\fR(5), -\fBgetfattr\fR(1), -\fBsetfattr\fR(1), -\fBsetfacl\fR(1), -\fBgetfacl\fR(1), -\fBchattr\fR(1), -\fBbtrfs-subvolume\fR(8), -\fBbtrfs-qgroup\fR(8) +\fBsystemd\fR(1), \fBsystemd-tmpfiles\fR(8), \fBsystemd-delta\fR(1), \fBsystemd.exec\fR(5), \fBattr\fR(5), \fBgetfattr\fR(1), \fBsetfattr\fR(1), \fBsetfacl\fR(1), \fBgetfacl\fR(1), \fBchattr\fR(1), \fBbtrfs-subvolume\fR(8), \fBbtrfs-qgroup\fR(8) .SH "NOTES" .IP " 1." 4 Base64 decoded diff --git a/upstream/debian-unstable/man5/tmpfs.5 b/upstream/debian-unstable/man5/tmpfs.5 index 8e4d063a..f077c509 100644 --- a/upstream/debian-unstable/man5/tmpfs.5 +++ b/upstream/debian-unstable/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 6.8" .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/debian-unstable/man5/ttytype.5 b/upstream/debian-unstable/man5/ttytype.5 index 94030e8b..580257c6 100644 --- a/upstream/debian-unstable/man5/ttytype.5 +++ b/upstream/debian-unstable/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 6.8" .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/debian-unstable/man5/tzfile.5 b/upstream/debian-unstable/man5/tzfile.5 index 27ccc2ff..d0cefa94 100644 --- a/upstream/debian-unstable/man5/tzfile.5 +++ b/upstream/debian-unstable/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 @@ -227,13 +232,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" @@ -245,8 +251,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 @@ -328,15 +334,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 @@ -351,21 +359,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 @@ -383,22 +392,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 @@ -407,12 +416,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 @@ -423,11 +432,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, @@ -435,23 +444,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 @@ -462,38 +471,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/debian-unstable/man5/udev.conf.5 b/upstream/debian-unstable/man5/udev.conf.5 index db1e9cec..635aa734 100644 --- a/upstream/debian-unstable/man5/udev.conf.5 +++ b/upstream/debian-unstable/man5/udev.conf.5 @@ -1,5 +1,5 @@ '\" t -.TH "UDEV\&.CONF" "5" "" "systemd 255" "udev.conf" +.TH "UDEV\&.CONF" "5" "" "systemd 256~rc3" "udev.conf" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -20,15 +20,35 @@ .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- .SH "NAME" -udev.conf \- Configuration for device event managing daemon +udev.conf, udev.conf.d \- Configuration for device event managing daemon .SH "SYNOPSIS" .PP +.RS 4 /etc/udev/udev\&.conf +.RE +.RS 4 +/run/udev/udev\&.conf +.RE +.RS 4 +/usr/lib/udev/udev\&.conf +.RE +.RS 4 +/etc/udev/udev\&.conf\&.d/*\&.conf +.RE +.RS 4 +/run/udev/udev\&.conf\&.d/*\&.conf +.RE +.RS 4 +/usr/lib/udev/udev\&.conf\&.d/*\&.conf +.RE .SH "DESCRIPTION" .PP -\fBsystemd-udevd\fR(8) -expects its main configuration file at -/etc/udev/udev\&.conf\&. It consists of a set of variables allowing the user to override default udev values\&. All empty lines or lines beginning with \*(Aq#\*(Aq are ignored\&. The following variables can be set: +These files contain configuration options for +\fBsystemd-udevd\fR(8)\&. The syntax of these files is very simple: a list of assignments, one per line\&. All empty lines or lines beginning with +"#" +are ignored\&. +.PP +The following options can be set: .PP \fIudev_log=\fR .RS 4 @@ -37,7 +57,22 @@ The log level\&. Valid values are the numerical syslog priorities or their textu \fBinfo\fR and \fBdebug\fR\&. +.if n \{\ .sp +.\} +.RS 4 +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.ps +1 +\fBNote\fR +.ps -1 +.br +This option is also honored by +\fBudevadm\fR(8)\&. +.sp .5v +.RE Added in version 216\&. .RE .PP @@ -107,6 +142,4 @@ can be configured by command line options and the kernel command line (see \fBsystemd-udevd\fR(8))\&. .SH "SEE ALSO" .PP -\fBsystemd-udevd\fR(8), -\fBudev\fR(7), -\fBudevadm\fR(8) +\fBsystemd-udevd\fR(8), \fBudev\fR(7), \fBudevadm\fR(8) diff --git a/upstream/debian-unstable/man5/user@.service.5 b/upstream/debian-unstable/man5/user@.service.5 index 0f068135..e6e5d656 100644 --- a/upstream/debian-unstable/man5/user@.service.5 +++ b/upstream/debian-unstable/man5/user@.service.5 @@ -1,5 +1,5 @@ '\" t -.TH "USER@\&.SERVICE" "5" "" "systemd 255" "user@.service" +.TH "USER@\&.SERVICE" "5" "" "systemd 256~rc3" "user@.service" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -188,10 +188,4 @@ user\-\fIUID\fR\&.slice units by default don\*(Aqt have a unit file\&. The resource limits are set through a drop\-in, which can be easily replaced or extended following standard drop\-in mechanisms discussed in the first section\&. .SH "SEE ALSO" .PP -\fBsystemd\fR(1), -\fBsystemd.service\fR(5), -\fBsystemd.slice\fR(5), -\fBsystemd.resource-control\fR(5), -\fBsystemd.exec\fR(5), -\fBsystemd.special\fR(7), -\fBpam\fR(8) +\fBsystemd\fR(1), \fBsystemd.service\fR(5), \fBsystemd.slice\fR(5), \fBsystemd.resource-control\fR(5), \fBsystemd.exec\fR(5), \fBsystemd.special\fR(7), \fBcapsule@.service\fR(5), \fBpam\fR(8) diff --git a/upstream/debian-unstable/man5/user_caps.5 b/upstream/debian-unstable/man5/user_caps.5 index 2c13d635..f68868e7 100644 --- a/upstream/debian-unstable/man5/user_caps.5 +++ b/upstream/debian-unstable/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/debian-unstable/man5/utmp.5 b/upstream/debian-unstable/man5/utmp.5 index 4a029640..a88997ec 100644 --- a/upstream/debian-unstable/man5/utmp.5 +++ b/upstream/debian-unstable/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 6.8" .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 diff --git a/upstream/debian-unstable/man5/veritytab.5 b/upstream/debian-unstable/man5/veritytab.5 index d68a8af4..c8b0b5d3 100644 --- a/upstream/debian-unstable/man5/veritytab.5 +++ b/upstream/debian-unstable/man5/veritytab.5 @@ -1,5 +1,5 @@ '\" t -.TH "VERITYTAB" "5" "" "systemd 255" "veritytab" +.TH "VERITYTAB" "5" "" "systemd 256~rc3" "veritytab" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -40,7 +40,7 @@ Each line is in the form .RS 4 .\} .nf -\fIvolume\-name\fR \fIdata\-device\fR \fIhash\-device\fR \fIroothash\fR \fIoptions\fR +\fIvolume\-name\fR \fIdata\-device\fR \fIhash\-device\fR \fIroothash\fR [\fIoptions\fR] .fi .if n \{\ .RE @@ -52,15 +52,17 @@ The first field contains the name of the resulting verity volume; its block devi /dev/mapper/\&. .PP The second field contains a path to the underlying block data device, or a specification of a block device via -"UUID=" -followed by the UUID\&. +\fIUUID=\fR +followed by the +\fIUUID\fR\&. .PP The third field contains a path to the underlying block hash device, or a specification of a block device via -"UUID=" -followed by the UUID\&. +\fIUUID=\fR +followed by the +\fIUUID\fR\&. .PP The fourth field is the -"roothash" +\fIroothash\fR in hexadecimal\&. .PP The fifth field, if present, is a comma\-delimited list of options\&. The following options are recognized: @@ -74,7 +76,11 @@ Added in version 254\&. .PP \fBformat=\fR\fB\fINUMBER\fR\fR .RS 4 -Specifies the hash version type\&. Format type 0 is original Chrome OS version\&. Format type 1 is modern version\&. +Specifies the hash version type\&. Format type +"0" +is original Chrome OS version\&. Format type +"1" +is modern version\&. .sp Added in version 254\&. .RE @@ -111,26 +117,38 @@ Added in version 254\&. \fBsalt=\fR\fB\fIHEX\fR\fR .RS 4 Salt used for format or verification\&. Format is a hexadecimal string; 256 bytes long maximum; -"\-"is the special value for empty\&. +"\-" +is the special value for empty\&. .sp Added in version 254\&. .RE .PP \fBuuid=\fR\fB\fIUUID\fR\fR .RS 4 -Use the provided UUID for format command instead of generating new one\&. The UUID must be provided in standard UUID format, e\&.g\&. 12345678\-1234\-1234\-1234\-123456789abc\&. +Use the provided +\fIUUID\fR +instead of generating new one\&. The +\fIUUID\fR +must be provided in standard +UUID +format, e\&.g\&. +"12345678\-1234\-1234\-1234\-123456789abc"\&. .sp Added in version 254\&. .RE .PP \fBignore\-corruption\fR, \fBrestart\-on\-corruption\fR, \fBpanic\-on\-corruption\fR .RS 4 -Defines what to do if a data verity problem is detected (data corruption)\&. Without these options kernel fails the IO operation with I/O error\&. With -"\-\-ignore\-corruption" +Defines what to do if a data verity problem is detected (data corruption)\&. Without these options kernel fails the +IO +operation with +I/O +error\&. With +\fB\-\-ignore\-corruption\fR option the corruption is only logged\&. With -"\-\-restart\-on\-corruption" +\fB\-\-restart\-on\-corruption\fR or -"\-\-panic\-on\-corruption" +\fB\-\-panic\-on\-corruption\fR the kernel is restarted (panicked) immediately\&. (You have to provide way how to avoid restart loops\&.) .sp Added in version 248\&. @@ -138,15 +156,43 @@ Added in version 248\&. .PP \fBignore\-zero\-blocks\fR .RS 4 -Instruct kernel to not verify blocks that are expected to contain zeroes and always directly return zeroes instead\&. WARNING: Use this option only in very specific cases\&. This option is available since Linux kernel version 4\&.5\&. +Instruct kernel to not verify blocks that are expected to contain zeroes and always directly return zeroes instead\&. +.if n \{\ .sp +.\} +.RS 4 +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.ps +1 +\fBWarning\fR +.ps -1 +.br +Use this option only in very specific cases\&. This option is available since Linux kernel version 4\&.5\&. +.sp .5v +.RE Added in version 248\&. .RE .PP \fBcheck\-at\-most\-once\fR .RS 4 -Instruct kernel to verify blocks only the first time they are read from the data device, rather than every time\&. WARNING: It provides a reduced level of security because only offline tampering of the data device\*(Aqs content will be detected, not online tampering\&. This option is available since Linux kernel version 4\&.17\&. +Instruct kernel to verify blocks only the first time they are read from the data device, rather than every time\&. +.if n \{\ .sp +.\} +.RS 4 +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.ps +1 +\fBWarning\fR +.ps -1 +.br +It provides a reduced level of security because only offline tampering of the data device\*(Aqs content will be detected, not online tampering\&. This option is available since Linux kernel version 4\&.17\&. +.sp .5v +.RE Added in version 248\&. .RE .PP @@ -160,14 +206,16 @@ Added in version 254\&. .PP \fBfec\-device=\fR\fB\fIPATH\fR\fR .RS 4 -Use forward error correction (FEC) to recover from corruption if hash verification fails\&. Use encoding data from the specified device\&. The fec device argument can be block device or file image\&. For format, if fec device path doesn\*(Aqt exist, it will be created as file\&. Note: block sizes for data and hash devices must match\&. Also, if the verity data_device is encrypted the fec_device should be too\&. +Use forward error correction (FEC) to recover from corruption if hash verification fails\&. Use encoding data from the specified device\&. The fec device argument can be block device or file image\&. If fec device path doesn\*(Aqt exist, it will be created as file\&. Note: block sizes for data and hash devices must match\&. Also, if the verity data_device is encrypted the fec_device should be too\&. .sp Added in version 254\&. .RE .PP \fBfec\-offset=\fR\fB\fIBYTES\fR\fR .RS 4 -This is the offset, in bytes, from the start of the FEC device to the beginning of the encoding data\&. (Aligned on 512 bytes\&.) +This is the offset, in bytes, from the start of the +FEC +device to the beginning of the encoding data\&. (Aligned on 512 bytes\&.) .sp Added in version 254\&. .RE @@ -268,8 +316,4 @@ data /etc/data /etc/hash a5ee4b42f70ae1f46a08a7c92c2e0a20672ad2f514792730f5d49d7 .\} .SH "SEE ALSO" .PP -\fBsystemd\fR(1), -\fBsystemd-veritysetup@.service\fR(8), -\fBsystemd-veritysetup-generator\fR(8), -\fBfstab\fR(5), -\fBveritysetup\fR(8), +\fBsystemd\fR(1), \fBsystemd-veritysetup@.service\fR(8), \fBsystemd-veritysetup-generator\fR(8), \fBfstab\fR(5), \fBveritysetup\fR(8) diff --git a/upstream/debian-unstable/man5/x509v3_config.5ssl b/upstream/debian-unstable/man5/x509v3_config.5ssl index 99f3d1e6..52f49f69 100644 --- a/upstream/debian-unstable/man5/x509v3_config.5ssl +++ b/upstream/debian-unstable/man5/x509v3_config.5ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "X509V3_CONFIG 5SSL" -.TH X509V3_CONFIG 5SSL 2024-02-03 3.1.5 OpenSSL +.TH X509V3_CONFIG 5SSL 2024-04-04 3.2.2-dev OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -250,14 +250,21 @@ Examples: .SS "Subject Key Identifier" .IX Subsection "Subject Key Identifier" The SKID extension specification has a value with three choices. -If the value is the word \fBnone\fR then no SKID extension will be included. -If the value is the word \fBhash\fR, or by default for the \fBx509\fR, \fBreq\fR, and -\&\fBca\fR apps, the process specified in RFC 5280 section 4.2.1.2. (1) is followed: +.IP \fBnone\fR 4 +.IX Item "none" +No SKID extension will be included. +.IP \fBhash\fR 4 +.IX Item "hash" +The process specified in RFC 5280 section 4.2.1.2. (1) is followed: The keyIdentifier is composed of the 160\-bit SHA\-1 hash of the value of the BIT STRING subjectPublicKey (excluding the tag, length, and number of unused bits). +.ie n .IP "A hex string (possibly with "":"" separating bytes)" 4 +.el .IP "A hex string (possibly with \f(CW:\fR separating bytes)" 4 +.IX Item "A hex string (possibly with : separating bytes)" +The provided value is output directly. +This choice is strongly discouraged. .PP -Otherwise, the value must be a hex string (possibly with \f(CW\*(C`:\*(C'\fR separating bytes) -to output directly, however, this is strongly discouraged. +By default the \fBx509\fR, \fBreq\fR, and \fBca\fR apps behave as if \fBhash\fR was given. .PP Example: .PP @@ -273,8 +280,9 @@ or both of them, separated by \f(CW\*(C`,\*(C'\fR. Either or both can have the option \fBalways\fR, indicated by putting a colon \f(CW\*(C`:\*(C'\fR between the value and this option. For self-signed certificates the AKID is suppressed unless \fBalways\fR is present. -By default the \fBx509\fR, \fBreq\fR, and \fBca\fR apps behave as if -"none" was given for self-signed certificates and "keyid, issuer" otherwise. +.PP +By default the \fBx509\fR, \fBreq\fR, and \fBca\fR apps behave as if \fBnone\fR was given +for self-signed certificates and \fBkeyid\fR\f(CW\*(C`,\*(C'\fR \fBissuer\fR otherwise. .PP If \fBkeyid\fR is present, an attempt is made to copy the subject key identifier (SKID) from the issuer certificate except if @@ -286,6 +294,7 @@ If \fBalways\fR is present but no value can be obtained, an error is returned. If \fBissuer\fR is present, and in addition it has the option \fBalways\fR specified or \fBkeyid\fR is not present, then the issuer DN and serial number are copied from the issuer certificate. +If this fails, an error is returned. .PP Examples: .PP |